Skip to content

v0.1.9

Choose a tag to compare

@andprov andprov released this 28 Sep 21:02
· 26 commits to main since this release
65d9f04

What's Changed

TimeGrip now ships as ready-made Docker images. A server needs three files from the release and one command. The repository is no longer needed to deploy, and HTTPS certificates are issued without manual steps.

Deployment

  • Published images for amd64 and arm64. timegrip-backend, timegrip-frontend, timegrip-nginx and timegrip-certbot are published to GitHub Container Registry for linux/amd64 and linux/arm64, so TimeGrip also runs on a Raspberry Pi with a 64-bit OS.
  • Deploy with docker compose up -d. Each release carries docker-compose.yml, env.example and seo.config.example.json. Put your .env and seo.config.json next to the compose file and start the stack. The compose file runs the images of its release.
  • Automatic HTTPS. certbot requests the Let's Encrypt certificate on the first start and retries every 15 minutes if the request fails. nginx switches to HTTPS within a minute after the certificate appears and picks up renewed certificates by itself. Running docker compose run --rm certbot obtain and restarting nginx are no longer needed. After changing DOMAIN_ALIASES or turning off CERTBOT_STAGING, docker compose up -d reissues the certificate.
  • SEO is applied when the frontend starts. seo.config.json is mounted into the frontend container instead of being built into it, so one image serves any instance. The file now lives next to docker-compose.yml, and its format is unchanged. After editing it, run docker compose restart frontend.
  • Postgres is no longer published on the host, so the stack starts on servers that already run their own Postgres. To reach the database from the host, see Database in docs/DEPLOY.md.

Documentation

  • Quick start in the README now deploys from the release files. Building from source moved to Try it locally and is marked as for evaluation and development only.
  • docs/DEPLOY.md is rewritten for image-based deployment: server requirements, configuration, updates, certificates, database access and backups.

Upgrade notes

No application changes and no database migrations. To update an instance that runs from a repository clone:

  1. Move frontend/seo.config.json to seo.config.json in the repository root, or set SEO_CONFIG_FILE in .env. Without the file, docker compose up stops with an error. Set SEO_CONFIG_FILE=/dev/null to run without SEO tags.
  2. The Compose project name is now fixed to timegrip. If your checkout directory has a different name, add COMPOSE_PROJECT_NAME=<directory name> to .env, so the existing database and certificate volumes are reused.
  3. If anything on the host connected to Postgres on 127.0.0.1:5432, publish the port again in docker-compose.override.yml (see Database in docs/DEPLOY.md).
  4. Update and restart:
    git pull
    docker compose up -d