Skip to content

Commit

Permalink
docs: update examples
Browse files Browse the repository at this point in the history
  • Loading branch information
BlackDark committed Nov 23, 2024
1 parent 1221c6b commit 73c6ca5
Showing 1 changed file with 93 additions and 0 deletions.
93 changes: 93 additions & 0 deletions docs/docs/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,96 @@ To remove all containers and volumes:
```bash
docker-compose down -v
```

## Adjusting provided templates by TrashGuide/Recyclarr

It is a common use case to use existing templates from TrashGuide or Recyclarr and modify them with either own scores or own additional custom formats.
We can easily do this with Configarr because we support both use cases and can add own custom formats when needed.

```yaml
# We define a new custom format we need (can also be done via file)
customFormatDefinitions:
- trash_id: example-in-config-cf
trash_scores:
default: 10000
trash_description: "Language: German Only"
name: "Language: Not German"
includeCustomFormatWhenRenaming: false
specifications:
- name: Not German Language
implementation: LanguageSpecification
negate: true
required: false
fields:
value: 4

sonarr:
instance1:
base_url: !secret sonarr_url
api_key: !secret sonarr_apikey

include:
# We use existing templates from recyclarr as base
- template: sonarr-quality-definition-series
- template: sonarr-v4-quality-profile-web-1080p
- template: sonarr-v4-custom-formats-web-1080p

# HINT: if you want to use trash guides own templates you can use them too
#- template: d1498e7d189fbe6c7110ceaabb7473e6
# source: TRASH # RECYCLARR (default) or TRASH

# Now you can adjust the custom formats as wanted per profile
custom_formats:
- trash_ids:
- example-in-config-cf
quality_profiles:
- name: WEB-1080p # name must match with given profiles (found in recyclarr or trashguide)
# score: 0 # Uncomment this line to add custom scoring

# Overwrite existing scores
- trash_ids:
- e6258996055b9fbab7e9cb2f75819294 # WEB Tier 01
quality_profiles:
- name: WEB-1080p # name must match with given profiles (found in recyclarr or trashguide)
score: 123
```
## Using templates from TrashGuide/Recyclarr but different names
This is currently not possible.
What you can do is copy those templates and paste it locally mounted folder.
Than you can rename those in the templates as required.
Possible feature request. Those are currently in evualition if usable and suitable:
- rename [#114](https://github.com/raydak-labs/configarr/issues/114)
- clone [#115](https://github.com/raydak-labs/configarr/issues/115).
```yaml
# The path in the container for your templates for copy&paste templates with slight modifications in the files.
localConfigTemplatesPath: /app/templates

sonarr:
instance1:
base_url: !secret sonarr_url
api_key: !secret sonarr_apikey

include:
# assuming we copied 3 templates for quality defintion, profile and formats to those files names (file ending .yml)
- template: my-local-quality-definition-series
- template: my-local-quality-profile
- template: my-local-custom-formats

# HINT: if you want to use trash guides own templates you can use them too
#- template: d1498e7d189fbe6c7110ceaabb7473e6
# source: TRASH # RECYCLARR (default) or TRASH

# Now you can adjust the custom formats as wanted per profile
custom_formats:
# Overwrite existing scores
- trash_ids:
- e6258996055b9fbab7e9cb2f75819294 # WEB Tier 01
quality_profiles:
- name: MyLocalProfile # name must match with given profiles (found in recyclarr or trashguide)
score: 123
```

0 comments on commit 73c6ca5

Please sign in to comment.