From 5d08647196f83cb4b3f46847e3ca84c130e0c725 Mon Sep 17 00:00:00 2001 From: boc-the-git <3479092+boc-the-git@users.noreply.github.com> Date: Sun, 21 Jan 2024 21:34:34 +1100 Subject: [PATCH] docs: Docker image versions (#3019) * fix: Add the need to change image tag * Minor tidying * Advice to use specific tag, not latest * Advice to use specific tag, not latest * Revert mistake * Reword Co-authored-by: Kuchenpirat <24235032+Kuchenpirat@users.noreply.github.com> --------- Co-authored-by: Kuchenpirat <24235032+Kuchenpirat@users.noreply.github.com> --- docs/docs/contributors/developers-guide/maintainers.md | 2 +- .../documentation/getting-started/installation/postgres.md | 7 ++++--- .../documentation/getting-started/installation/sqlite.md | 3 ++- docs/docs/documentation/getting-started/updating.md | 1 + 4 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/docs/contributors/developers-guide/maintainers.md b/docs/docs/contributors/developers-guide/maintainers.md index f62c940848af..aa128f9b1716 100644 --- a/docs/docs/contributors/developers-guide/maintainers.md +++ b/docs/docs/contributors/developers-guide/maintainers.md @@ -40,7 +40,7 @@ Mealie is published via GitHub actions to the GitHub container registry with the : published when a new GitHub Release is created - [Actions File](https://github.com/mealie-recipes/mealie/blob/mealie-next/.github/workflows/release.yml) !!! note - Both the latest, and {version} tags will be the same container on the release of a new version + Both the latest, and {version} tags will be the same image on the release of a new version ### Process diff --git a/docs/docs/documentation/getting-started/installation/postgres.md b/docs/docs/documentation/getting-started/installation/postgres.md index d28149a628c9..7c106a9d6171 100644 --- a/docs/docs/documentation/getting-started/installation/postgres.md +++ b/docs/docs/documentation/getting-started/installation/postgres.md @@ -9,14 +9,14 @@ PostgreSQL might be considered if you need to support many concurrent users. In version: "3.7" services: mealie: - image: ghcr.io/mealie-recipes/mealie:latest + image: ghcr.io/mealie-recipes/mealie:v1.0.0 # (3) container_name: mealie ports: - - "9925:9000" + - "9925:9000" # (1) deploy: resources: limits: - memory: 1000M # (1) + memory: 1000M # (2) depends_on: - postgres volumes: @@ -60,3 +60,4 @@ volumes: 1. To access the mealie interface you only need to expose port 9000 on the mealie container. Here we expose port 9925 on the host, but feel free to change this to any port you like. 2. Setting an explicit memory limit is recommended. Python can pre-allocate larger amounts of memory than is necessary if you have a machine with a lot of RAM. This can cause the container to idle at a high memory usage. Setting a memory limit will improve idle performance. +3. Whilst a 'latest' tag is available, the Mealie team advises specifying a specific version tag and consciously updating to newer versions when you have time to read the release notes and ensure you follow any manual actions required (which should be rare). diff --git a/docs/docs/documentation/getting-started/installation/sqlite.md b/docs/docs/documentation/getting-started/installation/sqlite.md index 125a47eb1c9e..10a054688c60 100644 --- a/docs/docs/documentation/getting-started/installation/sqlite.md +++ b/docs/docs/documentation/getting-started/installation/sqlite.md @@ -13,7 +13,7 @@ SQLite is a popular, open source, self-contained, zero-configuration database th version: "3.7" services: mealie: - image: ghcr.io/mealie-recipes/mealie:latest + image: ghcr.io/mealie-recipes/mealie:v1.0.0 # (3) container_name: mealie ports: - "9925:9000" # (1) @@ -43,3 +43,4 @@ volumes: 1. To access the mealie interface you only need to expose port 9000 on the container. Here we expose port 9925 on the host, but feel free to change this to any port you like. 2. Setting an explicit memory limit is recommended. Python can pre-allocate larger amounts of memory than is necessary if you have a machine with a lot of RAM. This can cause the container to idle at a high memory usage. Setting a memory limit will improve idle performance. +3. Whilst a 'latest' tag is available, the Mealie team advises specifying a specific version tag and consciously updating to newer versions when you have time to read the release notes and ensure you follow any manual actions required (which should be rare). diff --git a/docs/docs/documentation/getting-started/updating.md b/docs/docs/documentation/getting-started/updating.md index 0df5e7954cc9..6917bc35bb9c 100644 --- a/docs/docs/documentation/getting-started/updating.md +++ b/docs/docs/documentation/getting-started/updating.md @@ -20,5 +20,6 @@ If you are upgrading from pre-v1.0.0 to v1.0.0, make sure you read [Migrating to For all setups using Docker the updating process looks something like this - Stop the container using `docker compose down` +- If you are not using the latest tag, change the version (image tag) in your docker-compose file - Pull the latest image using `docker compose pull` - Start the container again using `docker compose up -d`