From 43c14bd996766679d8823add4b6504adb2cdd6c5 Mon Sep 17 00:00:00 2001 From: daniele Date: Mon, 8 May 2023 22:36:30 +0300 Subject: [PATCH] feat: update documentation about double tags --- docs/docs/quick-start.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/docs/quick-start.md b/docs/docs/quick-start.md index b4a59ad..8081ea5 100644 --- a/docs/docs/quick-start.md +++ b/docs/docs/quick-start.md @@ -4,10 +4,15 @@ Great for testing out the application, but not recommended for stable use. Checkout the docker-compose for the recommended deployment. +For each image there are two tags, respectively the regular tag and $TAG-rootless, which uses a non-root image. + ```sh -# Ensure data folder has correct permissions +# If using the rootless image, ensure data +# folder has correct permissions $ mkdir -p /path/to/data/folder $ chown 65532:65532 -R /path/to/data/folder +# --------------------------------------- +# Run the image $ docker run -d \ --name homebox \ --restart unless-stopped \ @@ -15,6 +20,8 @@ $ docker run -d \ --env TZ=Europe/Bucharest \ --volume /path/to/data/folder/:/data \ ghcr.io/hay-kot/homebox:latest +# ghcr.io/hay-kot/homebox:latest-rootless + ``` ## Docker-Compose @@ -25,6 +32,7 @@ version: "3.4" services: homebox: image: ghcr.io/hay-kot/homebox:latest +# image: ghcr.io/hay-kot/homebox:latest-rootless container_name: homebox restart: always environment: @@ -42,7 +50,7 @@ volumes: ``` !!! note - If instead of using named volumes you would prefer using a hostMount directly (e.g., `volumes: [ /path/to/data/folder:/data ]`) you need to `chown` the chosen directory in advance to the `65532` user (as shown in the Docker example above). + If you use the `rootless` image, and instead of using named volumes you would prefer using a hostMount directly (e.g., `volumes: [ /path/to/data/folder:/data ]`) you need to `chown` the chosen directory in advance to the `65532` user (as shown in the Docker example above). ## Env Variables & Configuration