ef89113877
A fresh reader given only the README and the HOWTO reached the Studio and a plugin's /__leaf page with nothing else needed, but one step. After "port 8090 is already in use ... set DX_PB_PORT", neither doc said the setting is read when bun run dev starts, so the new port only applies after a restart. The README copies .env.example before starting the server, and the port message appears only once it runs, so the steps looped with no stated way out. All three places that mention DX_PB_PORT now say to pick a free port and restart.
43 lines
3.3 KiB
Text
43 lines
3.3 KiB
Text
# .env.example — every local setting, each shown with its DEFAULT.
|
|
# A fresh clone needs NONE of this: `bun run dev` works with no .env at all. To change something, copy
|
|
# this file to .env (or .env.local, which wins; both are gitignored) and edit only the lines you need.
|
|
# An empty value means "use the default".
|
|
|
|
# ── Maps ─────────────────────────────────────────────────────────────────────────────────────────
|
|
# A Mapbox public token (starts with pk.), used by maps that choose Mapbox ("provider": "mapbox", or
|
|
# ?provider=mapbox on a page). Empty is fine: maps draw with MapLibre by default, with no key.
|
|
# Production hosts pass the token through profile-config.tk; never bake it into a bundle.
|
|
VITE_MAPBOX_TOKEN=
|
|
# The data API the maps read when a plugin's profile does not name one (profile apiBaseUrl and a host
|
|
# page's window.MAP_APP_API_URL come first). This is the value the maps are built against.
|
|
VITE_API_BASE_URL=https://pray.doxa.life
|
|
|
|
# ── Hot reload from a shared branch (internal/dev-sync-plugin.mjs) ───────────────────────────────
|
|
# Empty = OFF: the dev server hot-reloads YOUR local edits only (the default).
|
|
# Set to a remote name (origin) or a repo URL (https://…/repo.git) and `bun run dev` fetches every few
|
|
# seconds and fast-forwards when this checkout is on that branch with no local edits or commits; otherwise
|
|
# it only reports "development is N commits ahead" (in the log and at /api/dev-sync). It never merges over your work.
|
|
# Following needs read access to the repo (a git credential helper, or an SSH remote); without it the log says so.
|
|
DX_SYNC_REMOTE=
|
|
# The branch to follow. Empty = development (the shared table; main is production).
|
|
DX_SYNC_BRANCH=
|
|
# Seconds between checks. Empty = 5 (minimum 2).
|
|
DX_SYNC_INTERVAL=
|
|
|
|
# ── PocketBase, the backend for plugins (internal/backend-dev-plugin.mjs) ────────────────────────
|
|
# Empty = a LOCAL PocketBase: `bun run dev` downloads the pinned binary once (checksum-verified) and
|
|
# serves it at /api/pb, admin UI /api/pb/_/, data in .pb/dev (gitignored). Nothing leaves this computer.
|
|
# Set to a PocketBase root (e.g. https://<your team's dev server>/pb) to use a shared team one instead.
|
|
DX_PB_URL=
|
|
# The local PocketBase's port. Empty = 8090 (change it only if the log says the port is in use, then restart
|
|
# `bun run dev`: settings are read when it starts).
|
|
DX_PB_PORT=
|
|
|
|
# ── Rudder, voice to text (backend/rudder-engine) ────────────────────────────────────────────────
|
|
# These are read from the SHELL ENVIRONMENT, not from this file (e.g. `RUDDER_PORT=6193 bun run dev`).
|
|
# Rudder runs when its engine is built: install Go 1.22+ and run `bash backend/rudder-engine/setup-runtime.sh`.
|
|
# RUDDER_ENGINE 0 = never start the engine here (default: start it if it is built)
|
|
# RUDDER_PORT the engine's port (default 5193)
|
|
# RUDDER_NEMO_PORT the speech server's port (default 5194)
|
|
# RUDDER_HOME where the runtime and model live (default ~/.local/share/rudder)
|
|
# RUDDER_LANG the default language (default en-US)
|