Merge pull request 'docs: LOCAL_BIND_URL in README (constitution IV) + tea label behavior in tracker docs' (#150) from docs/local-bind-url into master

Reviewed-on: #150
This commit was merged in pull request #150.
This commit is contained in:
cameron committed 2026-09-30 00:44:41 +00:00
commit 810db329ab
3 files changed
+16 -3

No files matched your search

+3
View File
@@ -11,6 +11,9 @@ VIDEO_PATH=/path/to/video/hls
GIFS_DIRECTORY=/path/to/gifs
PREVIEW_CLIPS_DIRECTORY=/path/to/preview-clips
BIND_URL=0.0.0.0:8080
# Secondary loopback listener (default localhost:8088). Empty = don't bind it
# (e.g. a second instance next to one that already owns 8088).
# LOCAL_BIND_URL=localhost:8088
CORS_ALLOWED_ORIGINS=http://localhost:3000
SECRET_KEY=replace-me-with-a-long-random-secret
RUST_LOG=info
+1
View File
@@ -71,6 +71,7 @@ They should be defined where the binary is located or above it in an `.env` file
- `VIDEO_PATH` is a path where HLS playlists and video parts should be stored
- `GIFS_DIRECTORY` is a path where generated video GIF thumbnails should be stored
- `BIND_URL` is the url and port to bind to (typically your own IP address)
- `LOCAL_BIND_URL` (optional) is a second, loopback listener [default: `localhost:8088`]. Set it to an empty string to skip it, e.g. to run a second instance such as the `dev/e2e` harness alongside one that already owns 8088
- `SECRET_KEY` is the *hopefully* random string to sign Tokens with
- `RUST_LOG` is one of `off, error, warn, info, debug, trace`, from least to most noisy [default: `info` for spans, `error` for dev console logs]. It also gates tracing-span export, so keep it at `info` or `debug`
- `OTLP_OTLS_ENDPOINT` (optional) is an OTLP/gRPC collector URL (e.g. SigNoz, Jaeger) for span export, in any build [default: unset, no export]
+12 -3
View File
@@ -7,7 +7,8 @@ Issues and specs for this repo live as issues on Gitea
- **Create an issue**: `tea issues create --title "..." --description-file -`
(read the body from a heredoc on stdin), or `--description "..."` for a
one-liner. Add labels at creation with `--labels "..."`.
one-liner. Add labels at creation with `--labels "..."` (the labels
must already exist — see below).
- **Read an issue**: `tea issues <index> --comments`. Use
`tea issues list -f index,title,body,labels,comments -o json` for
machine-readable output.
@@ -16,8 +17,16 @@ Issues and specs for this repo live as issues on Gitea
- **Comment on an issue**: `tea comments add <index> "..."` (alias:
`tea comments <index> "..."`).
- **Apply / remove labels**: `tea issues edit <index> --add-labels "..."` /
`--remove-labels "..."`. Labels that don't exist yet are created by the
server on first use.
`--remove-labels "..."`.
- **Labels must exist first.** Neither `issues create --labels` nor
`issues edit --add-labels` creates a missing label: an unknown name is
**silently dropped** — the command succeeds and the issue ends up
unlabelled (verified against this server, tea 0.16). Check with
`tea labels list`; create with
`tea labels create --name "..." --color "#rrggbb" --description "..."`,
then apply. After labelling, confirm it stuck (`tea issues <index>`).
The triage labels (`triage-labels.md`) exist; the `wayfinder:*` labels
below must be created before first use.
- **Close**: `tea issues close <index>`. It does not accept a closing
comment, so post the explanation first with
`tea comments add <index> "..."`, then close.