From b6428a51efabf4ccda4739e782e8c1fc6b2ed147 Mon Sep 17 00:00:00 2001 From: daniele Date: Sat, 25 Mar 2023 11:58:55 +0200 Subject: [PATCH] chore: Update documentation to reflect image changes --- README.md | 3 +++ docs/docs/quick-start.md | 8 +++++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 611a530..e3d64bf 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,9 @@ [Configuration & Docker Compose](https://hay-kot.github.io/homebox/quick-start) ```bash +# Ensure data folder has correct permissions +mkdir -p /path/to/data/folder +chown 65532:65532 -R /path/to/data/folder docker run -d \ --name homebox \ --restart unless-stopped \ diff --git a/docs/docs/quick-start.md b/docs/docs/quick-start.md index e0ad87b..b4a59ad 100644 --- a/docs/docs/quick-start.md +++ b/docs/docs/quick-start.md @@ -5,7 +5,10 @@ Great for testing out the application, but not recommended for stable use. Checkout the docker-compose for the recommended deployment. ```sh -docker run -d \ +# Ensure data folder has correct permissions +$ mkdir -p /path/to/data/folder +$ chown 65532:65532 -R /path/to/data/folder +$ docker run -d \ --name homebox \ --restart unless-stopped \ --publish 3100:7745 \ @@ -38,6 +41,9 @@ volumes: driver: local ``` +!!! 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). + ## Env Variables & Configuration | Variable | Default | Description |