Update README.md and .env.sample for Versity S3 Gateway configuration. Change path in README to reflect new directory structure and clarify environment variable usage for credentials. Modify .env.sample to include additional credential options and improve documentation for setting up the environment. Adjust compose.yaml to utilize pass-through environment variables, enhancing security and usability for deployment.

This commit is contained in:
Nikholas Pcenicni
2026-03-28 17:46:08 -04:00
parent f154658d79
commit 97b56581ed
3 changed files with 14 additions and 4 deletions

View File

@@ -180,11 +180,11 @@ Shared services used across multiple applications.
**Configuration:** Requires Pangolin endpoint URL, Newt ID, and Newt secret. **Configuration:** Requires Pangolin endpoint URL, Newt ID, and Newt secret.
### versitygw/ (`komodo/common/versitygw/`) ### versitygw/ (`komodo/s3/versitygw/`)
- **[Versity S3 Gateway](https://github.com/versity/versitygw)** (Port: 10000 by default) - S3-compatible API over a POSIX directory (named Docker volumes). Use as shared object storage for apps that expect S3; pair with clients using path-style URLs and your LAN hostname or reverse proxy. - **[Versity S3 Gateway](https://github.com/versity/versitygw)** (Port: 10000 by default) - S3-compatible API over a POSIX directory (named Docker volumes). Use as shared object storage for apps that expect S3; pair with clients using path-style URLs and your LAN hostname or reverse proxy.
**Configuration:** Requires `ROOT_ACCESS_KEY` and `ROOT_SECRET_KEY` for the bundled IAM directory mode. Optional `VERSITYGW_PORT` for the published host port. **Configuration:** Set either `ROOT_ACCESS_KEY` / `ROOT_SECRET_KEY` or `ROOT_ACCESS_KEY_ID` / `ROOT_SECRET_ACCESS_KEY`. Optional `VERSITYGW_PORT`. The compose file uses pass-through env (not `${VAR}`) so secrets from the deploy environment (e.g. Komodo) are not blanked by interpolation; if the UI does not export vars to the compose process, use a `.env` beside `compose.yaml` with those names.
--- ---

View File

@@ -1,9 +1,15 @@
# Versity S3 Gateway — root credentials for the flat-file IAM backend. # Versity S3 Gateway — root credentials for the flat-file IAM backend.
# Copy to `.env` and set strong values before `docker compose up -d`. # Copy to `.env` and set strong values before `docker compose up -d`.
# https://github.com/versity/versitygw/wiki/Quickstart # https://github.com/versity/versitygw/wiki/Quickstart
#
# Set either pair (same names as the Kubernetes Helm chart):
# ROOT_ACCESS_KEY + ROOT_SECRET_KEY
# ROOT_ACCESS_KEY_ID + ROOT_SECRET_ACCESS_KEY
ROOT_ACCESS_KEY= ROOT_ACCESS_KEY=
ROOT_SECRET_KEY= ROOT_SECRET_KEY=
# ROOT_ACCESS_KEY_ID=
# ROOT_SECRET_ACCESS_KEY=
# Host port mapped to the gateway (container listens on 10000). # Host port mapped to the gateway (container listens on 10000).
VERSITYGW_PORT=10000 VERSITYGW_PORT=10000

View File

@@ -6,8 +6,12 @@ services:
container_name: versitygw container_name: versitygw
restart: unless-stopped restart: unless-stopped
environment: environment:
- ROOT_ACCESS_KEY=${ROOT_ACCESS_KEY} # Pass-through (no `${VAR}`): avoids empty interpolation when secrets are
- ROOT_SECRET_KEY=${ROOT_SECRET_KEY} # only in the deploy environment (e.g. Komodo) or not in `.env`.
- ROOT_ACCESS_KEY
- ROOT_SECRET_KEY
- ROOT_ACCESS_KEY_ID
- ROOT_SECRET_ACCESS_KEY
# Matches Helm chart default; enables `/_/health` for probes. # Matches Helm chart default; enables `/_/health` for probes.
- VGW_HEALTH=/_/health - VGW_HEALTH=/_/health
ports: ports: