From 689c6aa2762f3bf285b8eacb187888b3fd94ee13 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rudolf=20Horv=C3=A1th?= Date: Thu, 21 Nov 2024 13:25:45 +0100 Subject: [PATCH] docs: add developer notes about rootless docker setup (#13250) --- docker/docker-compose.dev.yml | 2 ++ docs/docs/developer/setup.md | 5 ++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/docker/docker-compose.dev.yml b/docker/docker-compose.dev.yml index 7f4806a99d..0b14ea7d6a 100644 --- a/docker/docker-compose.dev.yml +++ b/docker/docker-compose.dev.yml @@ -57,6 +57,8 @@ services: immich-web: container_name: immich_web image: immich-web-dev:latest + # Needed for rootless docker setup, see https://github.com/moby/moby/issues/45919 + # user: 0:0 build: context: ../web command: ['/usr/src/app/bin/immich-web'] diff --git a/docs/docs/developer/setup.md b/docs/docs/developer/setup.md index 92f0ce0c28..9dbaf157b5 100644 --- a/docs/docs/developer/setup.md +++ b/docs/docs/developer/setup.md @@ -45,7 +45,10 @@ All the services will be started with hot-reloading enabled for a quick feedback You can access the web from `http://your-machine-ip:3000` or `http://localhost:3000` and access the server from the mobile app at `http://your-machine-ip:3000/api` -**Note:** the "web" development container runs with uid 1000. If that uid does not have read/write permissions on the mounted volumes, you may encounter errors +**Notes:** + +- The "web" development container runs with uid 1000. If that uid does not have read/write permissions on the mounted volumes, you may encounter errors +- In case of rootless docker setup, you need to use root within the container, otherwise you will encounter read/write permission related errors, see comments in `docker/docker-compose.dev.yml`. #### Connect web to a remote backend