From 6f98bfcd54ff5df3885bd9ec78b237557d424683 Mon Sep 17 00:00:00 2001 From: Jorenn92 Date: Thu, 1 Feb 2024 18:41:57 +0100 Subject: [PATCH] docs: Update documentation for UI port change --- README.md | 6 ++--- .../1-installation/Installation.md | 25 ++++++++++--------- 2 files changed, 16 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 8538a3d0..5a32145c 100644 --- a/README.md +++ b/README.md @@ -68,9 +68,9 @@ docker run -d \ -e TZ=Europe/Brussels \ -v ./data:/opt/data \ -u 1000:1000 \ --p 8154:80 \ +-p 6246:6246 \ --restart unless-stopped \ -jorenn92/maintainerr +ghcr.io/jorenn92/maintainerr:latest ``` Docker-compose: @@ -91,7 +91,7 @@ services: - TZ=Europe/Brussels # - DEBUG=true # uncomment to enable debug logs ports: - - 8154:80 + - 6246:6246 restart: unless-stopped ``` diff --git a/docs/2-getting-started/1-installation/Installation.md b/docs/2-getting-started/1-installation/Installation.md index bc0d4fb9..f156394f 100644 --- a/docs/2-getting-started/1-installation/Installation.md +++ b/docs/2-getting-started/1-installation/Installation.md @@ -1,14 +1,16 @@ -The easiest way to start Maintainerr is with Docker. +Docker is the easiest way to start 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. -Make sure the data volume is read/writeable by the user specified in the 'user' instruction. If no 'user' instruction is configured, the volume should be accessible by PID:GID 1000:1000. -> Starting with 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 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. +> 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 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. +> +> **Make sure your data volume is read/writeable by this UID:GID!** + + # Run -Before running this command, create the ./data directory and make sure it's read/writeable by the user specified in the 'user' instruction. ```bash docker run -d \ @@ -16,9 +18,9 @@ docker run -d \ -e TZ=Europe/Brussels \ -v ./data:/opt/data \ -u 1000:1000 \ --p 8154:80 \ +-p 6246:6246 \ --restart unless-stopped \ -jorenn92/maintainerr +ghcr.io/jorenn92/maintainerr:latest ``` ## Updating @@ -32,7 +34,7 @@ docker rm -f maintainerr Pull the latest image: ```bash -docker pull jorenn92/maintainerr +docker pull ghcr.io/jorenn92/maintainerr:latest ``` Finally, run the container with the same parameters originally used to create the container. @@ -42,7 +44,6 @@ You may alternatively use a third-party updating mechanism, such as Watchtower o # Compose Define the Maintainerr service in your docker-compose.yml as follows. -Create the ./data directory and make sure it's read/writeable by the user specified in the 'user' instruction. ```Yaml version: '3' @@ -60,14 +61,14 @@ services: - TZ=Europe/Brussels # - DEBUG=true # uncomment to enable debug logs ports: - - 8154:80 + - 6246:6246 restart: unless-stopped ``` Then, start all services defined in your Compose file: ```bash -docker-compose up -d +docker compose up -d ``` ## Updating @@ -75,11 +76,11 @@ docker-compose up -d Pull the latest image: ```bash -docker-compose pull +docker compose pull ``` Then, restart all services defined in the Compose file: ```bash -docker-compose up -d +docker compose up -d ```