mirror of
https://github.com/MeshCore-Beacon/beacon-docs.git
synced 2026-10-23 04:11:20 +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
35 lines
1.3 KiB
Bash
35 lines
1.3 KiB
Bash
# Domain for Caddy TLS
|
|
DOMAIN=web.example.com
|
|
|
|
# Image to run. :latest follows releases, like the server half's compose file. To pin, use the
|
|
# same release line on both halves (e.g. :2.0 here and beacon-server:2.0 on the server host).
|
|
BEACON_WEB_IMAGE=ghcr.io/meshcore-beacon/beacon-web:latest
|
|
|
|
# BEACON REST API base URL
|
|
VITE_API_BASE=https://api.example.com/api/v1
|
|
|
|
# WebSocket endpoint for live packets
|
|
VITE_WS_URL=wss://api.example.com/ws
|
|
|
|
# Default map view for the "All" tab (leave both unset for a world view). VITE_MAP_CENTER is
|
|
# decimal "lat,lon", VITE_MAP_ZOOM is 0-22. The example below is a Canada-wide view.
|
|
VITE_MAP_CENTER=52.5,-96.8
|
|
VITE_MAP_ZOOM=3.2
|
|
|
|
# Hide tabs completely (comma list, case-insensitive). Leave empty to show all.
|
|
# Options: Packets,Channels,Map,Nodes,Observers,Routes,Traces,Analytics
|
|
VITE_DISABLED_TABS=
|
|
|
|
# Only offer these themes in the picker (comma list of theme ids). Leave empty for the default set.
|
|
# Listing a hidden theme (meshmapper_dark, meshmapper_light) is the only way to enable it.
|
|
VITE_ENABLED_THEMES=
|
|
|
|
# Custom app name shown in the top-left wordmark. Default: BEACON.
|
|
VITE_APP_NAME=
|
|
|
|
# Skip the once-per-session load splash. Set to true to skip; leave empty to show it.
|
|
VITE_SKIP_SPLASH=
|
|
|
|
# Notice above the header (e.g. on a dev instance); [label](url) and bare URLs become links. Blank = none.
|
|
VITE_BANNER=
|