0ct0pu5/kafka-ui
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update documentation; fix links (#1603)

Browse source 
* closes 1602

* readme

* fixes

* docs

Co-authored-by: Roman Zabaluev <rzabaluev@provectus.com>
This commit is contained in:
Ottavio M. Hartman 2022-02-17 11:26:15 -05:00 • committed by GitHub
parent e2a3b7b263
commit efb8410bd6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 13 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -69,7 +69,7 @@ We have plenty of [docker-compose files](documentation/compose/DOCKER_COMPOSE.md
- [SSO configuration](documentation/guides/SSO.md) - [SSO configuration](documentation/guides/SSO.md)
- [AWS IAM configuration](documentation/guides/AWS_IAM.md) - [AWS IAM configuration](documentation/guides/AWS_IAM.md)
- [Docker-compose files](documentation/guides/yaml-description.md) - [Docker-compose files](documentation/compose/DOCKER_COMPOSE.md)
- [Connection to a secure broker]() - [Connection to a secure broker]()
## Connecting to a Secure Broker ## Connecting to a Secure Broker

9
documentation/project/contributing/building.md
View file

@ -8,15 +8,16 @@ Build a docker container with the app:
``` ```
Start the app with Kafka clusters: Start the app with Kafka clusters:
```sh ```sh
docker-compose -f ./docker/kafka-ui.yaml up -d docker-compose -f ./documentation/compose/kafka-ui.yaml up -d
``` ```
To see the app, navigate to http://localhost:8080. To see the app, navigate to http://localhost:8080.
If you want to start only kafka clusters (to run the app via `boot:run`): If you want to start only kafka clusters (to run the app via `spring-boot:run`):
```sh ```sh
docker-compose -f ./docker/kafka-clusters-only.yaml up -d docker-compose -f ./documentation/compose/kafka-clusters-only.yaml up -d
``` ```
Then start the app with a **local** profile.
Then, start the app.
## Where to go next ## Where to go next

8
documentation/project/contributing/running.md
View file

@ -3,14 +3,18 @@
### Running locally via docker ### Running locally via docker
If you have built a container locally or wish to run a public one you could bring everything up like this: If you have built a container locally or wish to run a public one you could bring everything up like this:
```shell ```shell
docker-compose -f docker/kafka-ui.yaml up -d docker-compose -f documentation/compose/kafka-ui.yaml up -d
``` ```
### Running locally without docker ### Running locally without docker
Once you built the app, run the following: Once you built the app, run the following in `kafka-ui-api/`:
```sh ```sh
./mvnw spring-boot:run -Pprod ./mvnw spring-boot:run -Pprod
# or
./mvnw spring-boot:run -Pprod -Dspring.config.location=file:///path/to/conf.yaml
``` ```
### Running in kubernetes ### Running in kubernetes

1
documentation/project/contributing/software-required.md
View file

@ -29,4 +29,3 @@ Otherwise, some apps within a stack (e.g. `kafka-ui.yaml`) might crash.
## Where to go next ## Where to go next
In the next section, you'll [learn how to build the application](building.md). In the next section, you'll [learn how to build the application](building.md).
### GIT SETUP

2
kafka-ui-react-app/README.md
View file

@ -54,7 +54,7 @@ Have to be run from root directory.
Start UI for Apache Kafka with your Kafka clusters: Start UI for Apache Kafka with your Kafka clusters:
```sh ```sh
docker-compose -f ./docker/kafka-ui.yaml up docker-compose -f ./documentation/compose/kafka-ui.yaml up
``` ```
Make sure that none of the `.env*` files contain `DEV_PROXY` variable Make sure that none of the `.env*` files contain `DEV_PROXY` variable