Skip to content

Commit

Permalink
Add Docker Compose example to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Hamuko committed Jul 12, 2024
1 parent 0b2b8fc commit 881a92b
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ It's also possible to exclude prior episodes from the matching logic by giving a
### Example configuration

```yaml
source: /home/hamuko/Downloads
library: /mnt/Media/Anime
source: /src
library: /library
trash: false

# Matching rules:
Expand Down Expand Up @@ -74,4 +74,20 @@ docker run \
ghcr.io/hamuko/yurizaki:latest
```

Docker Compose:

```yaml
version: '3.7'
services:
yurizaki:
image: ghcr.io/hamuko/yurizaki:latest
container_name: yurizaki
user: "<user ID>:<group ID>"
volumes:
- /path/to/config.yml:/config.yml
- /path/to/src/directory:/src
- /path/to/library/directory:/library
restart: on-failure
```

Remember to use the paths used inside the container (`/src` and `/library` in the above example) and not the ones used on the host machine when writing the configuration file.

0 comments on commit 881a92b

Please sign in to comment.