Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify all in one instructions #2481

Merged
merged 2 commits into from
Oct 21, 2024
Merged

Clarify all in one instructions #2481

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b3ad08f
Clarify all in one instructions
qrkourier Oct 13, 2024
f6a48c0
Merge branch 'main' of github.com:openziti/ziti into qrkourier-patch-1
qrkourier Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions quickstart/docker/all-in-one/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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
Expand Down Expand Up @@ -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.

Expand Down
Loading