diff --git a/README.md b/README.md index 7a0f30e7731a4487c8e45fcea62d6d6959ca78ed..fbf9eacdd8d90b996c043794d6b2f924b063ae1e 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ We have plenty of [docker-compose files](documentation/compose/DOCKER_COMPOSE.md - [SSO configuration](documentation/guides/SSO.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]() ## Connecting to a Secure Broker diff --git a/documentation/project/contributing/building.md b/documentation/project/contributing/building.md index 37596be38fc6ccc572715026872e849764063440..21562426e5edf4ea07eb0961440ae78ece2a1a83 100644 --- a/documentation/project/contributing/building.md +++ b/documentation/project/contributing/building.md @@ -8,15 +8,16 @@ Build a docker container with the app: ``` Start the app with Kafka clusters: ```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. -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 -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 diff --git a/documentation/project/contributing/running.md b/documentation/project/contributing/running.md index aec09804d860b2ed86a95ffaed5f0d56845eb1cb..a74f198f0c166ca50ec053a641e98663b313b8a7 100644 --- a/documentation/project/contributing/running.md +++ b/documentation/project/contributing/running.md @@ -3,14 +3,18 @@ ### 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: ```shell -docker-compose -f docker/kafka-ui.yaml up -d +docker-compose -f documentation/compose/kafka-ui.yaml up -d ``` ### 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 ./mvnw spring-boot:run -Pprod + +# or + +./mvnw spring-boot:run -Pprod -Dspring.config.location=file:///path/to/conf.yaml ``` ### Running in kubernetes diff --git a/documentation/project/contributing/software-required.md b/documentation/project/contributing/software-required.md index dd3fa656c36547b8fafaaedeb72e493e06944785..8d3b86c73116590da2dcb01a8224af6fcbcfd39e 100644 --- a/documentation/project/contributing/software-required.md +++ b/documentation/project/contributing/software-required.md @@ -29,4 +29,3 @@ Otherwise, some apps within a stack (e.g. `kafka-ui.yaml`) might crash. ## Where to go next In the next section, you'll [learn how to build the application](building.md). -### GIT SETUP \ No newline at end of file diff --git a/kafka-ui-react-app/README.md b/kafka-ui-react-app/README.md index 3eabe899264cb49aa0a16cdc157eac58d9162bb9..43af77d4f5a38d6d1b8261aca814f239781b3e35 100644 --- a/kafka-ui-react-app/README.md +++ b/kafka-ui-react-app/README.md @@ -54,7 +54,7 @@ Have to be run from root directory. Start UI for Apache Kafka with your Kafka clusters: ```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