Update .env.sample and compose.yaml for Versity S3 Gateway to enhance WebUI and CORS configuration. Add comments clarifying the purpose of VGW_CORS_ALLOW_ORIGIN and correct usage of VGW_WEBUI_GATEWAYS, improving deployment instructions and user understanding.

This commit is contained in:
Nikholas Pcenicni
2026-03-28 18:28:52 -04:00
parent 11c62009a4
commit a4b9913b7e
2 changed files with 11 additions and 3 deletions

View File

@@ -21,10 +21,16 @@ VERSITYGW_PORT=10000
# WebUI (container listens on 8080). In Pangolin, create a *second* HTTP resource for this # WebUI (container listens on 8080). In Pangolin, create a *second* HTTP resource for this
# port — do not point the UI hostname at :10000 (that is S3 API only; `/` is not the SPA). # port — do not point the UI hostname at :10000 (that is S3 API only; `/` is not the SPA).
VERSITYGW_WEBUI_PORT=8080 VERSITYGW_WEBUI_PORT=8080
# HTTPS URL clients use for the S3 API (must match your Pangolin route to :10000), e.g.: # HTTPS URL of the *S3 API* (Pangolin resource → host :10000). **Not** the WebUI URL.
# No trailing slash. Wrong value → WebUI calls the wrong host and bucket create can 404.
# VGW_WEBUI_GATEWAYS=https://s3.example.com # VGW_WEBUI_GATEWAYS=https://s3.example.com
VGW_WEBUI_GATEWAYS= VGW_WEBUI_GATEWAYS=
# Public origin of the **WebUI** page (Pangolin → :8080), e.g. https://s3-ui.example.com
# Required when UI and API are on different hosts so the browser can call the API (CORS).
# VGW_CORS_ALLOW_ORIGIN=https://s3-ui.example.com
VGW_CORS_ALLOW_ORIGIN=
# NFS: object metadata defaults to xattrs; most NFS mounts need sidecar mode # NFS: object metadata defaults to xattrs; most NFS mounts need sidecar mode
# (compose.yaml uses --sidecar /data/sidecar). Create the host path, e.g. # (compose.yaml uses --sidecar /data/sidecar). Create the host path, e.g.
# mkdir -p /mnt/nfs/versity/sidecar # mkdir -p /mnt/nfs/versity/sidecar

View File

@@ -23,9 +23,11 @@ services:
VGW_HEALTH: /_/health VGW_HEALTH: /_/health
# WebUI (browser): separate listener; TLS terminates at Pangolin — serve HTTP in-container. # WebUI (browser): separate listener; TLS terminates at Pangolin — serve HTTP in-container.
VGW_WEBUI_NO_TLS: "true" VGW_WEBUI_NO_TLS: "true"
# Public base URL of the *S3 API* (same host you expose on port 10000 via Pangolin). # Public base URL of the *S3 API* only (Pangolin → :10000). Not the WebUI hostname.
# Required for the WebUI JS to call the gateway (see Versity wiki / chart notes). # No trailing slash. If this points at the UI URL, bucket ops return 404/wrong host.
VGW_WEBUI_GATEWAYS: ${VGW_WEBUI_GATEWAYS} VGW_WEBUI_GATEWAYS: ${VGW_WEBUI_GATEWAYS}
# Browser Origin when WebUI and API use different HTTPS hostnames (see wiki / WebGUI CORS).
VGW_CORS_ALLOW_ORIGIN: ${VGW_CORS_ALLOW_ORIGIN}
ports: ports:
- "${VERSITYGW_PORT:-10000}:10000" - "${VERSITYGW_PORT:-10000}:10000"
- "${VERSITYGW_WEBUI_PORT:-8080}:8080" - "${VERSITYGW_WEBUI_PORT:-8080}:8080"