Skip to content

Commit

Permalink
Merge branch 'develop' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
ptr727 authored Aug 29, 2024
2 parents 646d5b0 + ee9579f commit 6cc966d
Showing 1 changed file with 29 additions and 5 deletions.
34 changes: 29 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Alternatively, install directly on [Windows](#windows), [Linux](#linux), or [Mac

Example, run in an interactive shell:

```console
```bash
# The host "/data/media" directory is mapped to the container "/media" directory
# Replace the volume mappings to suit your needs

Expand Down Expand Up @@ -165,9 +165,9 @@ docker run \
exit
```

Example, run in a screen session:
Example, run `monitor` command in a screen session:

```console
```bash
# Start a new screen session
screen
# Or attach to the existing screen session
Expand All @@ -194,9 +194,9 @@ docker run \
--mediafiles /media/Series
```

Example, run as a command:
Example, run `process` command:

```console
```bash
# Run the process command
docker run \
--rm \
Expand All @@ -215,6 +215,30 @@ docker run \
--mediafiles /media/Series
```

Example, run `monitor` command as a docker compose stack:

```yaml
services:

plexcleaner:
image: docker.io/ptr727/plexcleaner:latest
container_name: PlexCleaner
restart: unless-stopped
user: nonroot:users
command:
- /PlexCleaner/PlexCleaner
- monitor
- --settingsfile=/media/PlexCleaner/PlexCleaner.json
- --logfile=/media/PlexCleaner/PlexCleaner.log
- --preprocess
- --mediafiles=/media/Series
- --mediafiles=/media/Movies
environment:
- TZ=America/Los_Angeles
volumes:
- /data/media:/media
```
### Windows
- Install the [.NET Runtime](https://docs.microsoft.com/en-us/dotnet/core/install/windows).
Expand Down

0 comments on commit 6cc966d

Please sign in to comment.