Deployment Guide

Automated Deployment

Use the deployment script for zero-downtime deployments:

./scripts/deploy.sh

This script will:

Create a database backup
Pull latest changes from git
Fetch all git tags (for version display)
Build the new Docker image
Restart the container with minimal downtime
Clean up old images

Manual Deployment

If you need to deploy manually:

# Pull latest changes
git pull

# Fetch tags (important for version display!)
git fetch --tags

# Build and restart
docker compose build
docker compose up -d

Version Display

The app displays the current version in the footer. The version is determined as follows:

During Docker build: The version is extracted from git tags using git describe --tags --always
At runtime: The version is read from /app/version.txt and exposed via the /api/version endpoint
Local development: The version is extracted directly from git on each request

Building with a specific version

You can override the version during build:

docker compose build --build-arg APP_VERSION=v1.2.3

Troubleshooting

If the version shows as "dev" or "unknown":

Make sure git tags are pushed to the remote repository:
```
git push --tags
```
On the deployment server, fetch the tags:
```
git fetch --tags
```
Verify tags are available:
```
git describe --tags --always
```

Rebuild the Docker image:

docker compose build --no-cache
docker compose up -d

Health Check

The container includes a health check that monitors the /api/daily endpoint. Check the health status:

docker ps

Look for the "healthy" status in the STATUS column.

1.7 KiB Raw Blame History