docs: fix #12 - improve documentation about apiUrl

This commit is contained in:
psyko-gh
2024-08-26 18:10:56 +02:00
parent e9363f5a0e
commit 56d8df88b9
2 changed files with 24 additions and 11 deletions

View File

@@ -25,13 +25,19 @@ Once the user is created, you can fill these value in Overcrawlrr `settings.yaml
```yaml title="settings.yaml"
config:
overseerr:
apiUrl: xxx # required
user: xxx # required
password: xxx # required
dryRun: true # Optional - dryRun will not send requests to Overseerr
# required
apiUrl: http://localhost:5056/api/v1
user: xxx # required
password: xxx # required
# Optional - dryRun will not send requests to Overseerr
# allowing you to test your rules
dryRun: true
```
!!! note
The api URL should ends with `/api/v1`. Replace `http://localhost:5056` with your Overseerr URL
---
### Plex authentication
@@ -46,7 +52,7 @@ To read data from your Plex library, you have to specify your Plex URL and token
config:
# Only required when using Smart recommendations job
plex:
apiUrl: xxx
apiUrl: http://localhost:32400/
plexToken: xxx
```
@@ -59,9 +65,12 @@ You can refer to environment variables using the `{{ key }}` syntax.
```yaml title="settings.yaml"
config:
overseerr:
apiUrl: xxx
apiUrl: http://localhost:5056/api/v1
user: '{{ OVERSEERR_USER }}'
password: '{{ OVERSEERR_PASSWORD }}'
plex:
apiUrl: http://localhost:32400/
plexToken: '{{ PLEX_TOKEN }}'
```
These variables can be defined in the `docker-compose.yaml`
@@ -73,6 +82,7 @@ services:
environment:
- OVERSEERR_USER=
- OVERSEERR_PASSWORD=
- PLEX_TOKEN=
```
---