Skip to content

Commit

Permalink
docs: Update docs to reflect config-file name change
Browse files Browse the repository at this point in the history
  • Loading branch information
maxnatamo committed Jul 29, 2024
1 parent d2825e2 commit 763385e
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -480,4 +480,4 @@ $RECYCLE.BIN/
*.lnk

# Configuration files for Fetcharr
/config.yaml
/fetcharr.yaml
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ services:
restart: unless-stopped
```
Copy the [`config.example.yaml`](./config.example.yaml)-file to your configuration folder as `config.yaml` and edit it to your liking.
Copy the [`fetcharr.example.yaml`](./fetcharr.example.yaml)-file to your configuration folder as `fetcharr.yaml` and edit it to your liking.
When you've changed the config-file, remember to restart Fetcharr for it to take effect.

## 📝 Contributing
Expand Down
4 changes: 2 additions & 2 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ services:
- 8080:8080
volumes:
- type: bind
source: ./config.yaml
target: /config/config.yaml
source: ./fetcharr.yaml
target: /config/fetcharr.yaml
read_only: true
restart: unless-stopped
2 changes: 1 addition & 1 deletion docs/docs/configuration/basic-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ You can read their page on [getting your Plex token here](https://support.plex.t
This means that whether you're configuring a Radarr or Sonarr instance in Fetcharr, these configuration values will work for both.
```yaml title="config.yaml"
```yaml title="fetcharr.yaml"
service_type:
instance_name:
enabled: true
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/configuration/config_examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This page lists various scenarios supported by Fetcharr, which might come in han

This method functions on both Radarr and Sonarr instances. It separates anime content from other content and sends them to different instances. This can help prevent clutter in your Sonarr and/or Radarr instances.

```yaml title="config.yaml"
```yaml title="fetcharr.yaml"
sonarr:
default:
base_url: http://localhost:8989
Expand Down Expand Up @@ -40,7 +40,7 @@ Fetcharr will prefer the instance *explicitly* allows anime, as opposed to the i
This method functions on both Radarr and Sonarr instances. It separates content for children into a separate instance, allowing for less clutter. It functions very similar to [anime-only instances](#limit-an-instance-to-anime-only).
```yaml title="config.yaml"
```yaml title="fetcharr.yaml"
sonarr:
default:
base_url: http://localhost:8989
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/configuration/filters.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Fetcharr then picks the instance with the highest score.

Given three Sonarr instances with the given filters:

```yaml title="config.yaml"
```yaml title="fetcharr.yaml"
sonarr:
default:
[...]
Expand Down
File renamed without changes.

0 comments on commit 763385e

Please sign in to comment.