Compare commits
3
Commits
bf3048aaae
..
main
| Author | SHA1 | Date | |
|---|---|---|---|
 clawbot
|
194390b61f | ||
 sneak
|
09d839a4c5 | ||
|
clawbot
|
7319cf4158 |
@@ -191,17 +191,17 @@ 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 | 8080 |
|
| `PORT` | HTTP listen port | 8080 |
|
||||||
| `UPAAS_DATA_DIR` | Data directory for SQLite and keys | `./data` (local dev only — use absolute path for Docker) |
|
| `UPAAS_DATA_DIR` | Data directory for SQLite and keys | `./data` (local dev only — use absolute path for Docker) |
|
||||||
| `UPAAS_HOST_DATA_DIR` | Host path for DATA_DIR (when running in container) | _(none — must be set to an absolute path)_ |
|
| `UPAAS_HOST_DATA_DIR` | Host path for `UPAAS_DATA_DIR` (when running in container) | _(none — must be set to an absolute path)_ |
|
||||||
| `UPAAS_DOCKER_HOST` | Docker socket path | unix:///var/run/docker.sock |
|
| `UPAAS_DOCKER_HOST` | Docker socket path | 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 |
|
||||||
| `DEBUG` | Enable debug logging | false |
|
| `UPAAS_DEBUG` | Enable debug logging | false |
|
||||||
| `SENTRY_DSN` | Sentry error reporting DSN | "" |
|
| `UPAAS_SENTRY_DSN` | Sentry error reporting DSN | "" |
|
||||||
| `METRICS_USERNAME` | Basic auth for /metrics | "" |
|
| `UPAAS_METRICS_USERNAME` | Basic auth for /metrics | "" |
|
||||||
| `METRICS_PASSWORD` | Basic auth for /metrics | "" |
|
| `UPAAS_METRICS_PASSWORD` | Basic auth for /metrics | "" |
|
||||||
|
|
||||||
## Running with Docker
|
## Running with Docker
|
||||||
|
|
||||||
@@ -230,8 +230,9 @@ HOST_DATA_DIR=/srv/upaas/data
|
|||||||
```
|
```
|
||||||
|
|
||||||
Other settings from [Configuration](#configuration) go in the same file, except
|
Other settings from [Configuration](#configuration) go in the same file, except
|
||||||
`PORT`: the compose file sets it to 8080, overriding `.env`, to match its port
|
`PORT` and `UPAAS_DATA_DIR`: the compose file sets them to 8080 and
|
||||||
mapping and healthcheck. Then run `docker compose up -d` from the repo root;
|
`/var/lib/upaas`, overriding `.env`, to match its port mapping, healthcheck and
|
||||||
|
data directory mount. Then run `docker compose up -d` from the repo root;
|
||||||
`docker compose ps` shows the container as healthy once `/health` answers.
|
`docker compose ps` shows the container as healthy once `/health` answers.
|
||||||
|
|
||||||
**Important**: `HOST_DATA_DIR` **must** be an **absolute path** on the host. It
|
**Important**: `HOST_DATA_DIR` **must** be an **absolute path** on the host. It
|
||||||
|
|||||||
@@ -20,6 +20,11 @@ regress.
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-09-28: The README Configuration table now names `UPAAS_DEBUG`,
|
||||||
|
`UPAAS_SENTRY_DSN`, `UPAAS_METRICS_USERNAME` and `UPAAS_METRICS_PASSWORD`, the
|
||||||
|
names upaas actually reads (the unprefixed names it listed were ignored), and
|
||||||
|
the `UPAAS_HOST_DATA_DIR` row refers to `UPAAS_DATA_DIR` (#224).
|
||||||
|
|
||||||
- 2026-09-28: Added `docker-compose.yml` for deploying upaas: settings from
|
- 2026-09-28: Added `docker-compose.yml` for deploying upaas: settings from
|
||||||
`.env`, the port published on `127.0.0.1` only for a TLS proxy in front, and a
|
`.env`, the port published on `127.0.0.1` only for a TLS proxy in front, and a
|
||||||
healthcheck against `/health`; the README's plain-HTTP Compose example is
|
healthcheck against `/health`; the README's plain-HTTP Compose example is
|
||||||
|
|||||||
@@ -10,6 +10,9 @@ services:
|
|||||||
# Overrides any PORT in .env, so upaas listens where the port mapping
|
# Overrides any PORT in .env, so upaas listens where the port mapping
|
||||||
# and healthcheck below expect it.
|
# and healthcheck below expect it.
|
||||||
PORT: "8080"
|
PORT: "8080"
|
||||||
|
# Overrides any UPAAS_DATA_DIR in .env, so the database stays on the
|
||||||
|
# HOST_DATA_DIR mount below instead of inside the container.
|
||||||
|
UPAAS_DATA_DIR: /var/lib/upaas
|
||||||
# The Docker daemon resolves app bind mounts on the host, so upaas must
|
# The Docker daemon resolves app bind mounts on the host, so upaas must
|
||||||
# know the host path of its data directory.
|
# know the host path of its data directory.
|
||||||
UPAAS_HOST_DATA_DIR: ${HOST_DATA_DIR:?set HOST_DATA_DIR in .env to an absolute host path}
|
UPAAS_HOST_DATA_DIR: ${HOST_DATA_DIR:?set HOST_DATA_DIR in .env to an absolute host path}
|
||||||
|
|||||||
Reference in New Issue
Block a user