Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Temporarily comment the user documentation. Undo after release… #717

Merged
merged 1 commit into from
Jan 7, 2024
Merged

chore: Temporarily comment the user documentation. Undo after release… #717

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ services:
maintainerr:
image: jorenn92/maintainerr:latest
container_name: maintainerr
user: 1000:1000
# user: 1000:1000 # only use this with release 2.0 and up
volumes:
- <persistent-local-volume>:/opt/data
environment:
Expand Down
5 changes: 3 additions & 2 deletions docs/2-getting-started/1-installation/Installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ You may alternatively use a third-party updating mechanism, such as Watchtower o

Define the Maintainerr service in your docker-compose.yml as follows.

> You have the option to define a User and Group ID for running the container. Maintainerr will operate using this specified UID:GID, and any files it generates within your data volume will also be associated with this designated user and group. If not explicitly specified, the default UID:GID is set to 1000:1000, representing the 'node' user inside the container.
> Starting from release 2.0, you have the option to define a User and Group ID for running the container. Maintainerr will operate using this specified UID:GID, and any files it generates within your data volume will also be associated with this designated user and group. If not explicitly specified, the default UID:GID is set to 1000:1000, representing the 'node' user inside the container. Don't use this with 1.x releases, the container will fail to start.


```Yaml
version: '3'
Expand All @@ -46,7 +47,7 @@ services:
maintainerr:
image: jorenn92/maintainerr:latest
container_name: maintainerr
user: 1000:1000
# user: 1000:1000 # only use this with release 2.0 and up
volumes:
- ./data:/opt/data
environment:
Expand Down