mirror of
https://github.com/jorenn92/Maintainerr.git
synced 2026-07-16 16:47:04 +02:00
Document health probes and LOG_LEVEL override (#3210)
This commit is contained in:
committed by
GitHub
parent
6f79d4b74a
commit
df20214d58
@@ -176,6 +176,11 @@ yarn turbo test
|
||||
The development Docker workflow builds the multi-stage `Dockerfile` for
|
||||
`linux/amd64` and `linux/arm64`.
|
||||
|
||||
The built Docker image includes `/opt/app/healthcheck.sh` as its
|
||||
`HEALTHCHECK`. It probes `/api/health/ready` on `UI_PORT` and preserves
|
||||
`BASE_PATH`; use `/api/health/live` for process-only liveness checks and
|
||||
`/api/health/ready` for database readiness checks.
|
||||
|
||||
### Workspace MCP Servers
|
||||
|
||||
Project MCP server config lives in `.codex/config.toml` for Codex, `.mcp.json`
|
||||
|
||||
@@ -178,8 +178,15 @@ Important runtime environment variables include:
|
||||
- `BASE_PATH`: optional subdirectory mount path for both API and UI serving.
|
||||
- `GITHUB_TOKEN`: optional token for higher GitHub API rate limits.
|
||||
- `VERSION_TAG` and `GIT_SHA`: release metadata surfaced by the app.
|
||||
- `LOG_LEVEL`: optional process-local log level override; recognised values
|
||||
take precedence over the saved setting without writing the database.
|
||||
- `DEBUG`: influences default log level during migration seeding.
|
||||
|
||||
The server exposes health probes under `/api/health`: `/live` is process-only,
|
||||
`/ready` checks database readiness, and `/api/health` mirrors readiness. The
|
||||
Docker image runs `/opt/app/healthcheck.sh`, normalises `BASE_PATH`, and probes
|
||||
`/api/health/ready` on the local `UI_PORT`.
|
||||
|
||||
## Security Notes
|
||||
|
||||
- Treat configured integration tokens and API keys as secrets.
|
||||
|
||||
Reference in New Issue
Block a user