mirror of
https://github.com/MeshCore-Beacon/beacon-docs.git
synced 2026-10-23 20:22:36 +00:00
MrAlders0n
f2728b059b
* docs: move design and API contract into docs/ * docs: add releases and versioning page * docs: add configuration reference for server and web * docs: add reverse proxy page * docs: add upgrading page * docs: add operations page and move backup and profiling docs * docs: add getting packets in and security pages * docs: add troubleshooting page * docs(api): fold admin, activity, route and summary notes into the contract * docs(deploy): add type 2 split deployment, finish the beacon rename, ignore secrets * docs: rewrite README as the front door and share the contributor workflow * docs: remove em dashes from prose and config comments * docs: apply review fixes to type 2, upgrading, troubleshooting and first-run notes * docs: fix upgrade order, restore steps, type 2 setup and contract details from review * docs: keep the gitignore to deployment secrets and runtime state
32 lines
1.3 KiB
YAML
32 lines
1.3 KiB
YAML
services:
|
|
caddy:
|
|
image: caddy:2-alpine
|
|
ports:
|
|
- "80:80"
|
|
- "443:443"
|
|
environment:
|
|
- DOMAIN=${DOMAIN:?DOMAIN environment variable is required}
|
|
volumes:
|
|
- ./data/Caddy/CaddyFile/Caddyfile.proxy:/etc/caddy/Caddyfile
|
|
- ./data/Caddy/data:/data/caddy/
|
|
- ./data/Caddy/config:/config/caddy/
|
|
restart: unless-stopped
|
|
|
|
beacon-web:
|
|
image: ${BEACON_WEB_IMAGE:?Set BEACON_WEB_IMAGE to a reviewed release tag or digest}
|
|
environment:
|
|
- VITE_API_BASE=${VITE_API_BASE:?VITE_API_BASE environment variable is required}
|
|
- VITE_WS_URL=${VITE_WS_URL:?VITE_WS_URL environment variable is required}
|
|
# Optional "All" map view; unset = world overview
|
|
- VITE_MAP_CENTER=${VITE_MAP_CENTER:-}
|
|
- VITE_MAP_ZOOM=${VITE_MAP_ZOOM:-}
|
|
# Optional branding/customization; unset = all tabs, hidden themes hidden, name "BEACON"
|
|
- VITE_DISABLED_TABS=${VITE_DISABLED_TABS:-}
|
|
- VITE_ENABLED_THEMES=${VITE_ENABLED_THEMES:-}
|
|
- VITE_APP_NAME=${VITE_APP_NAME:-BEACON}
|
|
# Skip the once-per-session load splash; unset = shown
|
|
- VITE_SKIP_SPLASH=${VITE_SKIP_SPLASH:-}
|
|
# Notice above the header, e.g. on a dev instance; unset = none
|
|
- VITE_BANNER=${VITE_BANNER:-}
|
|
restart: unless-stopped
|