Skip to content

Commit

Permalink
chore: Temporarily comment the user documentation. Undo after release…
Browse files Browse the repository at this point in the history
… 2.0
jorenn92 committed Jan 7, 2024
1 parent 006fba1 commit 3b86745
Showing 2 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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:
5 changes: 3 additions & 2 deletions docs/2-getting-started/1-installation/Installation.md
Original file line number Diff line number Diff line change
@@ -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'
@@ -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:

0 comments on commit 3b86745

Please sign in to comment.