Browse Source

GITBOOK-24: Add a quickstart page

Roman Zabaluev 2 years ago
parent
commit
aeedef040a
2 changed files with 14 additions and 0 deletions
  1. 1 0
      SUMMARY.md
  2. 13 0
      configuration/quick-start.md

+ 1 - 0
SUMMARY.md

@@ -23,6 +23,7 @@
 
 ## 👷♂ Configuration
 
+* [Quick Start](configuration/quick-start.md)
 * [Configuration wizard](configuration/configuration-wizard.md)
 * [Permissions](configuration/permissions/README.md)
   * [Required Kafka ACLs](configuration/configuration/required-acls.md)

+ 13 - 0
configuration/quick-start.md

@@ -0,0 +1,13 @@
+# Quick Start
+
+1. Ensure you have docker installed
+2. Ensure your kafka cluster is available from the machine you're planning to run the app on
+3. Run the following:
+
+```
+docker run -it -p 8080:8080 -e DYNAMIC_CONFIG_ENABLED=true provectuslabs/kafka-ui
+```
+
+4. Go to \`[http://localhost:8080/ui/clusters/create-new-cluster](http://localhost:8080/ui/clusters/create-new-cluster)\` and configure your first cluster by pressing on "Configure new cluster" button.
+
+When you're done with testing, you can refer to the next articles to persist your config & deploy the app wherever you need to.