Add Versity S3 Gateway documentation to README.md, detailing configuration requirements and usage for shared object storage. This addition enhances clarity for users integrating S3-compatible APIs with POSIX directories.

This commit is contained in:
Nikholas Pcenicni
2026-03-28 17:25:44 -04:00
parent 90509bacc5
commit f154658d79
3 changed files with 59 additions and 0 deletions

View File

@@ -180,6 +180,12 @@ 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/`)
- **[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.
--- ---
## 📊 Monitoring (`komodo/monitor/`) ## 📊 Monitoring (`komodo/monitor/`)

View File

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

View File

@@ -0,0 +1,44 @@
# Versity S3 Gateway — POSIX backend over Docker volumes.
# https://github.com/versity/versitygw
services:
versitygw:
image: versity/versitygw:v1.3.1
container_name: versitygw
restart: unless-stopped
environment:
- ROOT_ACCESS_KEY=${ROOT_ACCESS_KEY}
- ROOT_SECRET_KEY=${ROOT_SECRET_KEY}
# Matches Helm chart default; enables `/_/health` for probes.
- VGW_HEALTH=/_/health
ports:
- "${VERSITYGW_PORT:-10000}:10000"
volumes:
- s3_data:/data/s3
- iam:/data/iam
- versions:/data/versions
command:
- "--port"
- ":10000"
- "--iam-dir"
- "/data/iam"
- "posix"
- "--versioning-dir"
- "/data/versions"
- "/data/s3"
healthcheck:
test:
[
"CMD",
"wget",
"-qO-",
"http://127.0.0.1:10000/_/health",
]
interval: 30s
timeout: 5s
retries: 3
start_period: 10s
volumes:
s3_data:
iam:
versions: