diff --git a/README.md b/README.md index bfe9b6d..6fe6cdc 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ Data lives in the `sam_storage` volume. Set `FORCE_SSL=false` if you serve plain Other examples in the repository: -- [`docker-compose.image.yml`](docker-compose.image.yml): runs a published image (set the image name to yours) without cloning the source, with a health check and update steps. +- [`docker-compose.image.yml`](docker-compose.image.yml): runs the published image (`barrettefab/simple-aircraft-manager-rails` on Docker Hub) without cloning the source, with a health check and update steps. - [`docker-compose.traefik.yml`](docker-compose.traefik.yml): behind Traefik with HTTPS, with optional Authentik forward auth (see [Running behind Authentik](docs/authentik.md)). [`.env.example`](.env.example) lists every setting, grouped and commented. After starting or updating, `docker compose exec web bin/rails sam:doctor` checks the installation. diff --git a/docker-compose.image.yml b/docker-compose.image.yml index 0b51ab1..08470db 100644 --- a/docker-compose.image.yml +++ b/docker-compose.image.yml @@ -1,7 +1,8 @@ # Run a published image, without cloning the source. # # 1. Put this file and a .env (copied from .env.example) in a folder. -# 2. Set the image below to the one you use. To publish your own: +# 2. The image below is the project's published one (tags: latest, or a +# commit such as :1412470). To build and publish your own instead: # docker build -t your-registry/simple-aircraft-manager-rails:latest \ # --build-arg APP_REVISION=$(git rev-parse --short HEAD) --build-arg APP_BUILT_AT=$(date -u +%FT%TZ) . # docker push your-registry/simple-aircraft-manager-rails:latest @@ -12,7 +13,7 @@ # (database changes are applied when the container starts). Then: docker compose exec web bin/rails sam:doctor services: web: - image: your-registry/simple-aircraft-manager-rails:latest + image: barrettefab/simple-aircraft-manager-rails:latest restart: unless-stopped ports: - "3000:80" diff --git a/docker-compose.traefik.yml b/docker-compose.traefik.yml index ab2904a..734bc14 100644 --- a/docker-compose.traefik.yml +++ b/docker-compose.traefik.yml @@ -10,7 +10,7 @@ # to rely on the app's own sign-in (and optionally its single sign-on). services: web: - image: your-registry/simple-aircraft-manager-rails:latest # or: build: . + image: barrettefab/simple-aircraft-manager-rails:latest # or your own image, or: build: . restart: unless-stopped env_file: .env environment: