Skip to content

docker.md

Latest commit

 

History

History
123 lines (85 loc) · 3.03 KB

docker.md

File metadata and controls

123 lines (85 loc) · 3.03 KB
Raw

Docker Deployment and Release

This document is the single Docker runbook for Reader Next.

File layout

Dockerfile                         # canonical image build entrypoint
deploy/
  compose.yml                      # simple user deployment
  compose.local.yml                # local always-on container bound to repo storage/
  Caddyfile                        # optional Caddy reverse proxy config
  compose.caddy.yml                # production sample with Caddy
  env.docker.example               # deploy/compose.yml environment template
  env.prod.example                 # VPS deployment environment template
.github/workflows/docker-publish.yml # multi-arch GHCR publishing

Deprecated root files were removed: Dockerfile.prod, Dockerfile.x86, docker-compose.prod.yml, DOCKER_RELEASE.md, and RELEASE_WORKFLOW.md.

Published image

Default image repo: ghcr.io/maple0517/reader-next.

Tags:

  • latest: newest tagged release.
  • vX.Y.Z: exact release tag.
  • X.Y.Z: exact release tag without the leading v.
  • X.Y: newest patch release in a minor line.

Architectures:

  • linux/amd64
  • linux/arm64

User deployment

Run from the repository root:

cp deploy/env.docker.example .env.docker
docker compose -f deploy/compose.yml up -d

Upgrade:

docker compose -f deploy/compose.yml pull
docker compose -f deploy/compose.yml up -d

Runtime contract:

  • Container port: 18080.
  • Persistent data: /app/storage.
  • Static frontend: /app/web/dist.
  • Default database URL: sqlite:/app/storage/reader.db?mode=rwc.
  • Secrets stay in .env.docker or .env.prod; never bake SECURE_KEY or INVITE_CODE into the image.

Local dual-db workflow

If you want an always-on local container for day-to-day reading while keeping development writes isolated, run:

docker compose -f deploy/compose.local.yml up -d

Contract:

  • Host port defaults to 28080.
  • Repo storage/ is bind-mounted into /app/storage.
  • The container uses the repo's current storage/reader.db.
  • Local development should use a separate db such as dev-storage/reader.db.

Recommended dev startup:

cp .env.dev.example .env.dev
./scripts/run-dev.sh

Production sample with Caddy

Run from the repository root:

cp deploy/env.prod.example .env.prod
docker compose -f deploy/compose.caddy.yml up -d

The deploy script uses the same compose file:

APP_DIR=/opt/reader/app scripts/deploy-do.sh

Release flow

  1. Verify changes locally.
  2. Bump versions and create a tag through the release helper:
./scripts/release.sh v1.0.10
  1. Pushing the vX.Y.Z tag triggers .github/workflows/docker-publish.yml.
  2. The workflow builds amd64 and arm64 natively, then creates a multi-arch manifest.

Verify a published image:

docker buildx imagetools inspect ghcr.io/maple0517/reader-next:v1.0.10

Manual image test

docker build -t reader-next:local .
docker run --rm -p 18080:18080 -v reader-storage-test:/app/storage reader-next:local

Open http://localhost:18080.