AdguardTeam/AdGuardHome

Allow user and group mapping

Open

#1237 opened on Dec 6, 2019

View on GitHub
 (0 comments) (17 reactions) (0 assignees)Go (34,000 stars) (2,333 forks)batch import
P3: Mediumfeature requesthelp wanted

Description

  • I am running the latest version
  • I checked the documentation and found no answer
  • I checked to make sure that this issue has not already been filed

Problem Description

I'm running the AdguardHome docker image, with the conf and work dirs mapped to local folders. Adguard creates files within these folders as root. I would like the option to map to another user, the way linuxserver.io images do: https://docs.linuxserver.io/general/understanding-puid-and-pgid

Proposed Solution

Allow for PUID and PGID environment variables to be set, so that files written by AdguardHome will map to the user I specify, so that I don't run into permission issues.

Alternatives Considered

Another option would be for me to use docker's built in --user flag:

https://docs.docker.com/engine/reference/run/

But for that to work the processes within the container would have to be able to cope with running as a different user, and not as root. I'm not sure if that's currently the case, and did not see anything in the documentation about that.

edit: By the way, my compliments on the project, really nice to use and works like a charm!

Contributor guide

Tech stack
godocker
Domain
devops
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Dockershell scriptingGo basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the current Docker entrypoint script in the repository (likely a shell script that starts AdGuardHome). The implementation should parse PUID and PGID environment variables and use the `usermod` and `groupmod` commands (or similar) to change the user/group ID of the user running the process before starting it. Look at linuxserver.io images for reference. Ensure the entrypoint handles cases where the variables are not set (default to root). Test by running the container with non root user and verifying file ownership.