From 931398d4f508b9cd67406790211574b4a1d08423 Mon Sep 17 00:00:00 2001 From: jorenn92 Date: Mon, 8 Jan 2024 12:13:03 +0100 Subject: [PATCH] docs - Add ghcr.io image to documentation & improve docs --- README.md | 5 +++-- docs/2-getting-started/1-installation/Installation.md | 9 ++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 07700194..d63a8c83 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,8 @@ Currently, Maintainerr supports rule parameters from these apps : # Installation -Docker images for amd64 & arm64 are available under jorenn92/maintainerr.
+Docker images for amd64 & arm64 are available under jorenn92/maintainerr and ghcri.io/jorenn92/maintainerr.
+ Data is saved within the container under /opt/data, it is recommended to tie a persistent volume to this location in your docker command/compose file. For more information, visit the [installation guide](docs/2-getting-started/1-installation/Installation.md) or navigate to \:\/docs after starting your Maintainerr container. @@ -76,7 +77,7 @@ version: '3' services: maintainerr: - image: jorenn92/maintainerr:latest + image: jorenn92/maintainerr:latest # or ghcr.io/jorenn92/maintainerr:latest container_name: maintainerr # user: 1000:1000 # only use this with release 2.0 and up volumes: diff --git a/docs/2-getting-started/1-installation/Installation.md b/docs/2-getting-started/1-installation/Installation.md index 3b0139a0..8ab58dd7 100644 --- a/docs/2-getting-started/1-installation/Installation.md +++ b/docs/2-getting-started/1-installation/Installation.md @@ -1,8 +1,10 @@ The easiest way to start Maintainerr is with Docker. -images for amd64 & arm64 are available under jorenn92/maintainerr. +images for amd64 & arm64 are available under jorenn92/maintainerr and ghcri.io/jorenn92/maintainerr. Data is saved under /opt/data, a volume should be created to persist the configuration. +> Starting from release 2.0, you have the option to define a User and Group ID for running the container. Maintainerr will operate using this specified UID:GID, and any files it generates within your data volume will also be associated with this designated user and group. If not explicitly specified, the default UID:GID is set to 1000:1000, representing the 'node' user inside the container. Don't use this with 1.x releases, the container will fail to start. + # Run ```bash @@ -37,15 +39,12 @@ You may alternatively use a third-party updating mechanism, such as Watchtower o Define the Maintainerr service in your docker-compose.yml as follows. -> Starting from release 2.0, you have the option to define a User and Group ID for running the container. Maintainerr will operate using this specified UID:GID, and any files it generates within your data volume will also be associated with this designated user and group. If not explicitly specified, the default UID:GID is set to 1000:1000, representing the 'node' user inside the container. Don't use this with 1.x releases, the container will fail to start. - - ```Yaml version: '3' services: maintainerr: - image: jorenn92/maintainerr:latest + image: jorenn92/maintainerr:latest # or ghcr.io/jorenn92/maintainerr:latest container_name: maintainerr # user: 1000:1000 # only use this with release 2.0 and up volumes: