sneak/upaas
1
0
Fork 1
Code Issues 5 Pull Requests 2 Actions Packages Projects Releases 1 Wiki Activity

Compare commits

base: sneak/upaas:eb358e67d2d5cb4b7571ab432bed3f1c2af37bd6
Branches Tags
sneak/upaas:main sneak/upaas:issue-239-commit-hash-tags sneak/upaas:next sneak/upaas:docker-compose sneak/upaas:feature/prettierrc sneak/upaas:fix-gosec-g710 sneak/upaas:fix-noctx-lint sneak/upaas:feature/custom-healthcheck-command sneak/upaas:feature/observability-improvements sneak/upaas:feature/private-registry-auth sneak/upaas:feature/backup-restore-config sneak/upaas:fix/js-formatting sneak/upaas:fix/module-path sneak/upaas:feature/api-token-auth sneak/upaas:ci/add-check-action sneak/upaas:feature/deployment-rollback-tests sneak/upaas:feature/edit-entities
sneak/upaas:1.0.0
..
compare: sneak/upaas:dfa88eef2d40cf0f8659d02a1ef772f698c35b85
Branches Tags
sneak/upaas:issue-239-commit-hash-tags sneak/upaas:next sneak/upaas:main sneak/upaas:docker-compose sneak/upaas:feature/prettierrc sneak/upaas:fix-gosec-g710 sneak/upaas:fix-noctx-lint sneak/upaas:feature/custom-healthcheck-command sneak/upaas:feature/observability-improvements sneak/upaas:feature/private-registry-auth sneak/upaas:feature/backup-restore-config sneak/upaas:fix/js-formatting sneak/upaas:fix/module-path sneak/upaas:feature/api-token-auth sneak/upaas:ci/add-check-action sneak/upaas:feature/deployment-rollback-tests sneak/upaas:feature/edit-entities
sneak/upaas:1.0.0
1 Commits
eb358e67d2 .. dfa88eef2d
Author SHA1 Message Date
clawbot dfa88eef2d List every setting upaas reads in the README Configuration table (closes #229)
Check / check (pull_request) Skipped 
The table left out UPAAS_MAINTENANCE_MODE, UPAAS_SESSION_SECRET and
UPAAS_CORS_ORIGINS, and several rows gave the wrong default or effect.
Each row now matches internal/config/config.go and the code that uses
the value: UPAAS_PORT is also read and wins over PORT,
UPAAS_HOST_DATA_DIR falls back to UPAAS_DATA_DIR and must be absolute
when set, UPAAS_DEBUG also drops the session cookie's Secure flag,
UPAAS_SENTRY_DSN is not used, and /metrics exists only when
UPAAS_METRICS_USERNAME is set. A sentence under the table names the
standard Docker client variables. TODO.md records the step.

Model: opus-5-5
 2026-09-29 01:31:58 +00:00
1 changed files with 14 additions and 14 deletions
Expand all files Collapse all files
README.md
+14 -14
View File
@@ -191,20 +191,20 @@ This ensures the main branch always contains clean, tested, working code.
Environment variables: Environment variables:
| Variable | Description | Default | | Variable | Description | Default |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
| `PORT` | HTTP listen port. `UPAAS_PORT` is also read and wins when both are set. | 8080 | | `PORT` | HTTP listen port. `UPAAS_PORT` is also read and wins when both are set. | 8080 |
| `UPAAS_DATA_DIR` | Directory for the SQLite database, session key, builds and deployment logs | `./data` (the Docker image sets `/var/lib/upaas`) | | `UPAAS_DATA_DIR` | Directory for the SQLite database, session key, builds and deployment logs | `./data` (the Docker image sets `/var/lib/upaas`) |
| `UPAAS_HOST_DATA_DIR` | Host path of `UPAAS_DATA_DIR`, needed when upaas runs in a container so the bind mounts it passes to Docker point at the right host directory. Must be absolute, or upaas refuses to start. | the value of `UPAAS_DATA_DIR` | | `UPAAS_HOST_DATA_DIR` | Host path of `UPAAS_DATA_DIR`, needed when upaas runs in a container so the bind mounts it passes to Docker point at the right host directory. When set, it must be absolute, or upaas refuses to start. | the value of `UPAAS_DATA_DIR` |
| `UPAAS_DOCKER_HOST` | Docker daemon address | unix:///var/run/docker.sock | | `UPAAS_DOCKER_HOST` | Docker daemon address | unix:///var/run/docker.sock |
| `UPAAS_PLAINTEXT_HTTP` | Set when µPaaS is reached over plain HTTP (no TLS-terminating proxy in front) so CSRF origin checks use `http://`. Leave unset behind a TLS-terminating reverse proxy. | false | | `UPAAS_PLAINTEXT_HTTP` | Set when µPaaS is reached over plain HTTP (no TLS-terminating proxy in front) so CSRF origin checks use `http://`. Leave unset behind a TLS-terminating reverse proxy. | false |
| `UPAAS_DEBUG` | Enable debug logging. Also sends the session cookie without the `Secure` flag. | false | | `UPAAS_DEBUG` | Enable debug logging. Also sends the session cookie without the `Secure` flag. | false |
| `UPAAS_SENTRY_DSN` | Read but not used: upaas sends nothing to Sentry | "" | | `UPAAS_SENTRY_DSN` | Read but not used: upaas sends nothing to Sentry | "" |
| `UPAAS_METRICS_USERNAME` | When set, `/metrics` is served behind basic auth with this username. When unset, there is no `/metrics`. | "" | | `UPAAS_METRICS_USERNAME` | When set, `/metrics` is served behind basic auth with this username. When unset, there is no `/metrics`. | "" |
| `UPAAS_METRICS_PASSWORD` | Basic auth password for `/metrics` | "" | | `UPAAS_METRICS_PASSWORD` | Basic auth password for `/metrics` | "" |
| `UPAAS_MAINTENANCE_MODE` | Only shown as `maintenanceMode` in the `/health` response; it blocks nothing | false | | `UPAAS_MAINTENANCE_MODE` | Only shown as `maintenanceMode` in the `/health` response; it blocks nothing | false |
| `UPAAS_SESSION_SECRET` | Key that signs the session and CSRF cookies. When unset, a random key is generated once and kept in `$UPAAS_DATA_DIR/session.key`. | "" | | `UPAAS_SESSION_SECRET` | Key that signs the session and CSRF cookies. When unset, a random key is generated once and kept in `$UPAAS_DATA_DIR/session.key`. | "" |
| `UPAAS_CORS_ORIGINS` | Comma-separated origins allowed to make cross-origin requests with cookies. When unset, no CORS headers are sent. | "" | | `UPAAS_CORS_ORIGINS` | Comma-separated origins allowed to make cross-origin requests with cookies. When unset, no CORS headers are sent. | "" |
The Docker client also reads the standard `DOCKER_API_VERSION`, The Docker client also reads the standard `DOCKER_API_VERSION`,
`DOCKER_CERT_PATH` and `DOCKER_TLS_VERIFY` variables; `UPAAS_DOCKER_HOST`, which `DOCKER_CERT_PATH` and `DOCKER_TLS_VERIFY` variables; `UPAAS_DOCKER_HOST`, which