From b3ad08f569071d9e70d12d36aa89f6b0e279c9fb Mon Sep 17 00:00:00 2001 From: Kenneth Bingham Date: Sun, 13 Oct 2024 13:12:39 -0400 Subject: [PATCH] Clarify all in one instructions --- quickstart/docker/all-in-one/README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/quickstart/docker/all-in-one/README.md b/quickstart/docker/all-in-one/README.md index dee5183b7..86bfcfdee 100644 --- a/quickstart/docker/all-in-one/README.md +++ b/quickstart/docker/all-in-one/README.md @@ -1,13 +1,12 @@ # All-in-one Docker quickstart This Docker Compose project runs `ziti edge quickstart` in a container while persisting configs, PKI, database, etc. in -a Docker named volume. You may instead persist the state in a filesystem directory on the Docker host by setting env var -`ZITI_HOME` to the directory's path. +a Docker named volume. ## Run Ziti -This is the primary use case for this project: running the `ziti edge quickstart` command in the official -`openziti/ziti-cli` container image. +This is the primary use case for this project: running the `ziti edge quickstart` command in the +`openziti/ziti-controller` container image. 1. You need only the `compose.yml` file in this directory to run your own Ziti network. @@ -28,9 +27,7 @@ This is the primary use case for this project: running the `ziti edge quickstart docker compose up ``` -3. Modify the configuration and bounce the container. - - Modify the configs in the `./quickstart/` sub-directory adjacent to the `compose.yml` file. +3. Modify the configuration files mounted on `/home/ziggy/quickstart/` and bounce the container. ```bash docker compose up --force-recreate @@ -62,7 +59,7 @@ This is the primary use case for this project: running the `ziti edge quickstart ### Save config on the Docker Host -The default storage option is to store the database, etc., in a named volume managed by Docker. Alternatively, you can store things in a subdirectory on the Docker host by setting `ZITI_HOME`. +The default storage option is to store the database, etc., in a named volume managed by Docker. You may instead persist the state in a filesystem directory on the Docker host by setting an env var to the path relative to the compose.yml file on the Docker host, e.g., `ZITI_HOME=./config`. If you choose to mount a folder this way, you must also ensure that the UID assigned by variable ZIGGY_UID has read-write-list permissions for this folder on the Docker host. Destroy the old network so you can start over.