Skip to content

Commit

Permalink
docs: Update documentation for UI port change
Browse files Browse the repository at this point in the history
  • Loading branch information
jorenn92 committed Feb 2, 2024
1 parent 8dc7c99 commit 6f98bfc
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 15 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ docker run -d \
-e TZ=Europe/Brussels \
-v ./data:/opt/data \
-u 1000:1000 \
-p 8154:80 \
-p 6246:6246 \
--restart unless-stopped \
jorenn92/maintainerr
ghcr.io/jorenn92/maintainerr:latest
```

Docker-compose:
Expand All @@ -91,7 +91,7 @@ services:
- TZ=Europe/Brussels
# - DEBUG=true # uncomment to enable debug logs
ports:
- 8154:80
- 6246:6246
restart: unless-stopped
```
Expand Down
25 changes: 13 additions & 12 deletions docs/2-getting-started/1-installation/Installation.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,26 @@
The easiest way to start Maintainerr is with Docker.
Docker is the easiest way to start 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.

Make sure the data volume is read/writeable by the user specified in the 'user' instruction. If no 'user' instruction is configured, the volume should be accessible by PID:GID 1000:1000.

> Starting with 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 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.
> 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 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.
>
> **Make sure your data volume is read/writeable by this UID:GID!**


# Run
Before running this command, create the ./data directory and make sure it's read/writeable by the user specified in the 'user' instruction.

```bash
docker run -d \
--name maintainerr \
-e TZ=Europe/Brussels \
-v ./data:/opt/data \
-u 1000:1000 \
-p 8154:80 \
-p 6246:6246 \
--restart unless-stopped \
jorenn92/maintainerr
ghcr.io/jorenn92/maintainerr:latest
```

## Updating
Expand All @@ -32,7 +34,7 @@ docker rm -f maintainerr
Pull the latest image:

```bash
docker pull jorenn92/maintainerr
docker pull ghcr.io/jorenn92/maintainerr:latest
```

Finally, run the container with the same parameters originally used to create the container.
Expand All @@ -42,7 +44,6 @@ You may alternatively use a third-party updating mechanism, such as Watchtower o
# Compose

Define the Maintainerr service in your docker-compose.yml as follows.
Create the ./data directory and make sure it's read/writeable by the user specified in the 'user' instruction.

```Yaml
version: '3'
Expand All @@ -60,26 +61,26 @@ services:
- TZ=Europe/Brussels
# - DEBUG=true # uncomment to enable debug logs
ports:
- 8154:80
- 6246:6246
restart: unless-stopped
```
Then, start all services defined in your Compose file:
```bash
docker-compose up -d
docker compose up -d
```

## Updating

Pull the latest image:

```bash
docker-compose pull
docker compose pull
```

Then, restart all services defined in the Compose file:

```bash
docker-compose up -d
docker compose up -d
```

0 comments on commit 6f98bfc

Please sign in to comment.