# Deployment

## Environments

- development
- test/CI
- production

## Docker Compose

Baseline services:
- frontend
- API
- worker
- PostgreSQL
- Redis
- reverse proxy

Persistent data:
- PostgreSQL data
- Redis data where needed
- image storage

## Production Compose

The repository includes `compose.production.yaml` with separate API, worker,
web, PostgreSQL, and Redis services. It exposes only the Nginx web service and
keeps database and Redis ports internal to the Compose network.

Before starting, create a production `.env` containing real values for
`POSTGRES_DB`, `POSTGRES_USER`, `POSTGRES_PASSWORD`, `DATABASE_URL`,
`REDIS_URL`, `SMTP_URL`, `SMTP_FROM`, and a stable base64-encoded 32-byte
`MFA_ENCRYPTION_KEY`. Do not use the fixture pricing provider in production.

Start the stack and apply migrations with:

```sh
docker compose -f compose.production.yaml up -d --build postgres redis
docker compose -f compose.production.yaml run --rm api npm run db:migrate
docker compose -f compose.production.yaml up -d --build api worker web
```

The default web port is `8080` and can be changed with `WEB_PORT`. The API and
worker images share the same Node workspace image; the web image builds the Vue
application and serves it through Nginx with SPA fallback and internal `/api`
proxying.

## Health Checks

Production Compose waits for healthy PostgreSQL, Redis, and API services before
starting the web service. The API health endpoint is `GET /health`; the web
container checks its `/health` response through Nginx.

## Backup And Restore

Create a PostgreSQL custom-format dump from the running production stack:

```sh
BACKUP_DIR=/secure/backups \
POSTGRES_DB=inventory \
POSTGRES_USER=inventory \
POSTGRES_PASSWORD='use-secret-storage' \
./scripts/backup-postgres.sh
```

Restore only during a planned maintenance window because `pg_restore` replaces
matching database objects:

```sh
BACKUP_FILE=/secure/backups/inventory-20260909T000000Z.dump \
POSTGRES_DB=inventory \
POSTGRES_USER=inventory \
POSTGRES_PASSWORD='use-secret-storage' \
./scripts/restore-postgres.sh
```

Back up image storage and the deployment `.env` through the NAS secret/backup
system as well. Never commit either one. Before upgrading, record the current
image tags and database migration state. To roll back, stop the application
services, restore the previous image tags, restore the database dump if the
schema changed, then start the stack and verify `/health` and a read-only
catalog request.

## Reverse proxy

Responsible for:
- HTTPS/TLS
- routing
- compression
- security headers
- rate limiting where appropriate

## Configuration

Environment variables/secrets:
- database connection
- Redis connection
- authentication/session secrets
- provider credentials
- email credentials
- storage credentials

Application settings such as pricing strategy and site settings belong in the database.

## Backups

Back up:
- PostgreSQL
- image storage
- required environment/configuration information

Retention policy and restore procedures must be documented for production.

Disaster recovery should allow reconstruction elsewhere from database backup, image backup, and deployment/environment configuration.

## Future hosting

Initial deployment targets a home server/NAS. The architecture should allow later movement to an online server or managed infrastructure without redesigning the domain model.