feat: update documentation about double tags

This commit is contained in:
daniele 2023-05-08 22:36:30 +03:00
parent 56b0931b6c
commit 43c14bd996

View file

@ -4,10 +4,15 @@
Great for testing out the application, but not recommended for stable use. Checkout the docker-compose for the recommended deployment. 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 ```sh
# Ensure data folder has correct permissions # If using the rootless image, ensure data
# folder has correct permissions
$ mkdir -p /path/to/data/folder $ mkdir -p /path/to/data/folder
$ chown 65532:65532 -R /path/to/data/folder $ chown 65532:65532 -R /path/to/data/folder
# ---------------------------------------
# Run the image
$ docker run -d \ $ docker run -d \
--name homebox \ --name homebox \
--restart unless-stopped \ --restart unless-stopped \
@ -15,6 +20,8 @@ $ docker run -d \
--env TZ=Europe/Bucharest \ --env TZ=Europe/Bucharest \
--volume /path/to/data/folder/:/data \ --volume /path/to/data/folder/:/data \
ghcr.io/hay-kot/homebox:latest ghcr.io/hay-kot/homebox:latest
# ghcr.io/hay-kot/homebox:latest-rootless
``` ```
## Docker-Compose ## Docker-Compose
@ -25,6 +32,7 @@ version: "3.4"
services: services:
homebox: homebox:
image: ghcr.io/hay-kot/homebox:latest image: ghcr.io/hay-kot/homebox:latest
# image: ghcr.io/hay-kot/homebox:latest-rootless
container_name: homebox container_name: homebox
restart: always restart: always
environment: environment:
@ -42,7 +50,7 @@ volumes:
``` ```
!!! note !!! 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 ## Env Variables & Configuration