Skip to content

Commit

Permalink
docs - Add ghcr.io image to documentation & improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jorenn92 committed Jan 8, 2024
1 parent 093585f commit 931398d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ Currently, <b>Maintainerr</b> supports rule parameters from these apps :

# Installation

Docker images for amd64 & arm64 are available under jorenn92/maintainerr. <br />
Docker images for amd64 & arm64 are available under jorenn92/maintainerr and ghcri.io/jorenn92/maintainerr. <br />

Data is saved within the container under /opt/data, it is recommended to tie a persistent volume to this location in your docker command/compose file.

For more information, visit the [installation guide](docs/2-getting-started/1-installation/Installation.md) or navigate to \<maintainerr_url\>:\<port\>/docs after starting your <b>Maintainerr</b> container.
Expand All @@ -76,7 +77,7 @@ version: '3'

services:
maintainerr:
image: jorenn92/maintainerr:latest
image: jorenn92/maintainerr:latest # or ghcr.io/jorenn92/maintainerr:latest
container_name: maintainerr
# user: 1000:1000 # only use this with release 2.0 and up
volumes:
Expand Down
9 changes: 4 additions & 5 deletions docs/2-getting-started/1-installation/Installation.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
The easiest way to start Maintainerr is with Docker.

images for amd64 & arm64 are available under jorenn92/maintainerr.
images for amd64 & arm64 are available under jorenn92/maintainerr and ghcri.io/jorenn92/maintainerr.
Data is saved under /opt/data, a volume should be created to persist the configuration.

> 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.
# Run

```bash
Expand Down Expand Up @@ -37,15 +39,12 @@ You may alternatively use a third-party updating mechanism, such as Watchtower o

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

> 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'

services:
maintainerr:
image: jorenn92/maintainerr:latest
image: jorenn92/maintainerr:latest # or ghcr.io/jorenn92/maintainerr:latest
container_name: maintainerr
# user: 1000:1000 # only use this with release 2.0 and up
volumes:
Expand Down

0 comments on commit 931398d

Please sign in to comment.