Skip to content

Commit

Permalink
Merge pull request #130 from raydak-labs/docs/trash
Browse files Browse the repository at this point in the history
  • Loading branch information
BlackDark authored Dec 28, 2024
2 parents f2c84ed + 9cf281a commit ca58bc0
Show file tree
Hide file tree
Showing 9 changed files with 251 additions and 118 deletions.
6 changes: 3 additions & 3 deletions docs/docs/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,15 @@ Quality profiles define what types of releases you want for your media. They com

Release groups are teams or individuals who release media content. Different groups often have different standards and specialties for their releases.

### TRaSH Guides
### TRaSH-Guides

[TRaSH Guides](https://trash-guides.info/) is a comprehensive collection of guides and configurations for various media management tools. It provides recommended settings, custom formats, and quality profiles that represent community best practices.
[TRaSH-Guides](https://trash-guides.info/) is a comprehensive collection of guides and configurations for various media management tools. It provides recommended settings, custom formats, and quality profiles that represent community best practices.

## How They Work Together

- **Quality Profiles** use **Custom Formats** to score and select releases
- **Sonarr/Radarr** use these profiles to make download decisions
- **TRaSH Guides** provides optimized configurations for both
- **TRaSH-Guides** provides optimized configurations for both
- **Configarr** helps manage and synchronize all these components

:::tip
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/configuration/config-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ Configarr supports two types of templates:
- Documentation: [Recyclarr Templates Wiki](https://github.com/recyclarr/recyclarr/wiki/Templates)
- Location: Place template files in the directory specified by `localConfigTemplatesPath`

2. **TRaSH Guide Templates**: Standard templates from TRaSH Guides
- These are automatically pulled from the TRaSH Guide repository
2. **TRaSH-Guides Templates**: Standard templates from TRaSH-Guides
- These are automatically pulled from the TRaSH-Guides repository
- Can be overridden using `trashGuideUrl` in config.yml
- See [Trash Radarr](https://github.com/TRaSH-Guides/Guides/tree/master/docs/json/radarr/quality-profiles) and [Trash Sonarr](https://github.com/TRaSH-Guides/Guides/tree/master/docs/json/sonarr/quality-profiles) for more information
- See [TRaSH-Guides Radarr](https://github.com/TRaSH-Guides/Guides/tree/master/docs/json/radarr/quality-profiles) and [TRaSH-Guides Sonarr](https://github.com/TRaSH-Guides/Guides/tree/master/docs/json/sonarr/quality-profiles) for more information

## Custom Formats Definitions

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/configuration/experimental-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Following things are currently not supported or tested:
type: movies # not checked yet
```
- initial language of quality profiles is not correct -> `0`
- no available presets because nothings provided in trash guide or recyclarr -> needs to be done manually with local templates and custom formats
- no available presets because nothings provided in TRaSH-Guides or recyclarr -> needs to be done manually with local templates and custom formats

### Configuration File

Expand Down Expand Up @@ -96,7 +96,7 @@ Following things are currently not supported or tested:
type: movies # not checked yet
```
- metadata profiles are not supported. This is a specific thing to readarr and requires custom implementation and breaking out of some abstraction layer we have in the code
- no available presets because nothings provided in trash guide or recyclarr -> needs to be done manually with local templates and custom formats
- no available presets because nothings provided in TRaSH-Guides or recyclarr -> needs to be done manually with local templates and custom formats

### Configuration File

Expand Down
14 changes: 7 additions & 7 deletions docs/docs/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ To remove all containers and volumes:
docker-compose down -v
```

## Adjusting provided templates by TrashGuide/Recyclarr
## Adjusting provided templates by TRaSH-Guides/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.
It is a common use case to use existing templates from TRaSH-Guides 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
Expand Down Expand Up @@ -86,7 +86,7 @@ sonarr:
- 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
# HINT: if you want to use TRaSH-Guides guides own templates you can use them too
#- template: d1498e7d189fbe6c7110ceaabb7473e6
# source: TRASH # RECYCLARR (default) or TRASH

Expand All @@ -95,18 +95,18 @@ sonarr:
- trash_ids:
- example-in-config-cf
quality_profiles:
- name: WEB-1080p # name must match with given profiles (found in recyclarr or trashguide)
- name: WEB-1080p # name must match with given profiles (found in recyclarr or TRaSH-Guides)
# 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)
- name: WEB-1080p # name must match with given profiles (found in recyclarr or TRaSH-Guides)
score: 123
```
## Using templates from TrashGuide/Recyclarr but different names
## Using templates from TRaSH-Guides/Recyclarr but different names
This is currently not possible.
What you can do is copy those templates and paste it locally mounted folder.
Expand All @@ -132,7 +132,7 @@ sonarr:
- 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
# HINT: if you want to use TRaSH-Guides own templates you can use them too
#- template: d1498e7d189fbe6c7110ceaabb7473e6
# source: TRASH # RECYCLARR (default) or TRASH

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/installation/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Increase the log level with the `LOG_LEVEL` environment variable to get more det

- Ensure user matches your required user
- Check folder permissions on the config directory
- after changing the user, adjust the user in the git repos (trash guide, recyclarr) to match
- after changing the user, adjust the user in the git repos (TRaSH-Guides, recyclarr) to match

2. **Connection Issues**

Expand Down
33 changes: 23 additions & 10 deletions docs/docs/intro.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,29 @@
---
sidebar_position: 1
description: "Configarr - A powerful synchronization tool for Sonarr, Radarr and other *Arr tools that helps manage custom formats and quality profiles using TRaSH Guides and custom configurations"
keywords: [configarr, sonarr, radarr, trash guides, custom formats, media management, automation, recyclarr, quality profiles, whisparr]
description: "Configarr - A powerful synchronization tool for Sonarr, Radarr and other *Arr tools that helps manage custom formats and quality profiles using TRaSH-Guides and custom configurations"
keywords:
[
configarr,
sonarr,
radarr,
trash guides,
TRaSH-Guides,
custom formats,
media management,
automation,
recyclarr,
quality profiles,
whisparr,
]
---

# Introduction

Welcome to Configarr - your all-in-one solution for managing Sonarr and Radarr (and other \*Arr tools) configurations with seamless integration of TRaSH Guides and custom formats.
Welcome to Configarr - your all-in-one solution for managing Sonarr and Radarr (and other \*Arr tools) configurations with seamless integration of TRaSH-Guides and custom formats.

## What is Configarr?

Configarr is a powerful configuration and synchronization tool designed specifically for Sonarr v4 and Radarr v5. It streamlines the process of managing custom formats and quality profiles by automatically synchronizing settings from TRaSH Guides while supporting additional customizations.
Configarr is a powerful configuration and synchronization tool designed specifically for Sonarr v4 and Radarr v5. It streamlines the process of managing custom formats and quality profiles by automatically synchronizing settings from TRaSH-Guides while supporting additional customizations.

### Experimental support

Expand All @@ -21,25 +34,25 @@ Experimental support also available for [(check experimental support)](./configu

### Key Features

- 🔄 **TRaSH Guides Integration**: Directly sync custom formats and quality profiles from TRaSH Guides
- 🔄 **TRaSH-Guides Integration**: Directly sync custom formats and quality profiles from TRaSH-Guides
- 🔗 **Recyclarr Template Compatibility**: Works with existing Recyclarr templates
- 🎯 **Custom Format Support**: Create and manage your own custom formats
- 🌍 **Multi-language Support**: Includes specialized formats for different languages/countries
- 🔧 **Flexible Configuration**: Multiple ways to provide custom formats:
- Sync from TRaSH Guides
- Sync from TRaSH-Guides
- Sync from local files
- Direct configuration in YAML
- Smart merging (TRaSH Guide → Local Files → Config)
- Smart merging (TRaSH-Guide → Local Files → Config)

### Why Choose Configarr?

If you're managing a media server with Sonarr and Radarr (or other \*Arr tools), Configarr helps you:

- Save time by automating configuration management
- Maintain consistency across your media servers
- Easily implement best practices from TRaSH Guides
- Easily implement best practices from TRaSH-Guides
- Customize settings for your specific needs
- We provide custom formats for different languages/countries as long as TrashGuide does not include them
- We provide custom formats for different languages/countries as long as TRaSH-Guides does not include them

## Requirements

Expand All @@ -56,7 +69,7 @@ Ready to streamline your media server configuration? Let's get started with the

### Related/Inspired Projects

- [TRaSH Guides](https://trash-guides.info/)
- [TRaSH-Guides](https://trash-guides.info/)
- [Recyclarr](https://github.com/recyclarr/recyclarr)
- [Notifiarr](https://notifiarr.com/)
- [Profilarr](https://github.com/Dictionarry-Hub/profilarr)
Expand Down
Loading

0 comments on commit ca58bc0

Please sign in to comment.