Repository navigation
v0.1.9
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-nginxandtimegrip-certbotare published to GitHub Container Registry forlinux/amd64andlinux/arm64, so TimeGrip also runs on a Raspberry Pi with a 64-bit OS. - Deploy with
docker compose up -d. Each release carriesdocker-compose.yml,env.exampleandseo.config.example.json. Put your.envandseo.config.jsonnext 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 obtainand restarting nginx are no longer needed. After changingDOMAIN_ALIASESor turning offCERTBOT_STAGING,docker compose up -dreissues the certificate. - SEO is applied when the frontend starts.
seo.config.jsonis mounted into the frontend container instead of being built into it, so one image serves any instance. The file now lives next todocker-compose.yml, and its format is unchanged. After editing it, rundocker 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.mdis 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:
- Move
frontend/seo.config.jsontoseo.config.jsonin the repository root, or setSEO_CONFIG_FILEin.env. Without the file,docker compose upstops with an error. SetSEO_CONFIG_FILE=/dev/nullto run without SEO tags. - The Compose project name is now fixed to
timegrip. If your checkout directory has a different name, addCOMPOSE_PROJECT_NAME=<directory name>to.env, so the existing database and certificate volumes are reused. - If anything on the host connected to Postgres on
127.0.0.1:5432, publish the port again indocker-compose.override.yml(see Database indocs/DEPLOY.md). - Update and restart:
git pull docker compose up -d