christian/TechLibrary
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat(deploy): make Compose host port configurable

Browse source
This commit is contained in:
Christian Johannesen 2026-10-18 16:52:35 +02:00
parent b9a9c85e60
commit 093d489b13
4 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.env.example
View file

@ -1,7 +1,9 @@
NODE_ENV=development NODE_ENV=development
PORT=3001 PORT=3001
DATABASE_URL=./data/tech-library.db DATABASE_URL=./data/tech-library.db
WEB_ORIGIN=http://localhost:5173 # Docker Compose host binding. Change both values when using another port.
HOST_PORT=8144
WEB_ORIGIN=http://localhost:8144
ADMIN_USERNAME=admin ADMIN_USERNAME=admin
# Generate with: npm run password:hash -w @tech-library/api -- "your password" # Generate with: npm run password:hash -w @tech-library/api -- "your password"
ADMIN_PASSWORD_HASH= ADMIN_PASSWORD_HASH=

2
README.md
View file

@ -37,6 +37,8 @@ Open `http://localhost:5173`. The API runs on port 3001. Local content is stored
| `npm run db:seed` | Add the curated starter catalog | | `npm run db:seed` | Add the curated starter catalog |
| `docker compose up -d --build` | Build and run the production topology | | `docker compose up -d --build` | Build and run the production topology |
The Compose stack listens on host port `8144` by default. Copy `.env.example` to `.env` and change `HOST_PORT` plus `WEB_ORIGIN` when another port or public origin is required.
## Repository structure ## Repository structure
```text ```text

4
docker-compose.yml
View file

@ -4,7 +4,7 @@ services:
context: . context: .
target: web target: web
ports: ports:
- "8080:80" - "${HOST_PORT:-8144}:80"
depends_on: depends_on:
api: api:
condition: service_healthy condition: service_healthy
@ -18,7 +18,7 @@ services:
NODE_ENV: production NODE_ENV: production
PORT: 3001 PORT: 3001
DATABASE_URL: /data/tech-library.db DATABASE_URL: /data/tech-library.db
WEB_ORIGIN: ${WEB_ORIGIN:-http://localhost:8080} WEB_ORIGIN: ${WEB_ORIGIN:-http://localhost:8144}
ADMIN_USERNAME: ${ADMIN_USERNAME:-admin} ADMIN_USERNAME: ${ADMIN_USERNAME:-admin}
ADMIN_PASSWORD_HASH: ${ADMIN_PASSWORD_HASH:?Set ADMIN_PASSWORD_HASH} ADMIN_PASSWORD_HASH: ${ADMIN_PASSWORD_HASH:?Set ADMIN_PASSWORD_HASH}
SESSION_SECRET: ${SESSION_SECRET:?Set SESSION_SECRET} SESSION_SECRET: ${SESSION_SECRET:?Set SESSION_SECRET}

6
docs/operations.md
View file

@ -3,11 +3,11 @@
## Deployment ## Deployment
1. Generate an Argon2id hash with `npm run password:hash -w @tech-library/api -- "a strong password"`. 1. Generate an Argon2id hash with `npm run password:hash -w @tech-library/api -- "a strong password"`.
2. Copy `.env.example` to `.env`, set the hash, a random 32+ character session secret, and the public `WEB_ORIGIN`. 2. Copy `.env.example` to `.env`, set the hash, a random 32+ character session secret, `HOST_PORT` (default `8144`), and the matching public `WEB_ORIGIN`.
3. Run `docker compose up -d --build`. 3. Run `docker compose up -d --build`.
4. Verify `http://host:8080/healthz` and the API health check through Docker Compose. 4. Verify `http://host:8144/healthz` (or the configured `HOST_PORT`) and the API health check through Docker Compose.
Terminate TLS at a trusted reverse proxy and forward HTTPS to port 8080. Restrict filesystem access to the Docker volume and secrets file. Terminate TLS at a trusted reverse proxy and forward HTTPS to the configured host port. Restrict filesystem access to the Docker volume and secrets file.
## Backup and restore ## Backup and restore