docs: Rename project & links

pull/64/head
Robert Dailey 3 years ago
parent a43e40a090
commit 139336eb60

@ -1,5 +1,5 @@
Special notes about behavior of Trash Updater with regards to the various services it supports will Special notes about behavior of Recyclarr with regards to the various services it supports will be
be documented here. documented here.
# Sonarr # Sonarr
@ -15,8 +15,8 @@ The script procedurally generates a name for release profiles it creates. For th
The name is generated as follows: The name is generated as follows:
- `[Trash]` is added by Trash Updater to indicate that this Release Profile is created and managed - `[Trash]` is added by Recyclarr to indicate that this Release Profile is created and managed by
by it. This prefix exists to separate it from any Release Profiles the user may have manually it. This prefix exists to separate it from any Release Profiles the user may have manually
created (which Trash Updater will not touch). created (which Recyclarr will not touch).
- `Anime - First Release Profile` is the name of the Release Profile (taken from the `name` property - `Anime - First Release Profile` is the name of the Release Profile (taken from the `name` property
of its corresponding JSON file). of its corresponding JSON file).

@ -1,4 +1,4 @@
Command line interface documentation for the `Trash` executable. Command line interface documentation for the `recyclarr` executable.
## Subcommands ## Subcommands
@ -18,20 +18,20 @@ These are optional arguments shared by *all* subcommands.
One or more paths to YAML configuration files. Only the relevant configuration section for the One or more paths to YAML configuration files. Only the relevant configuration section for the
specified subcommand will be read from each file. If this argument is not specified, a single specified subcommand will be read from each file. If this argument is not specified, a single
default configuration file named `trash.yml` will be used. It must be in the same directory as the default configuration file named `recyclarr.yml` will be used. It must be in the same directory as the
`trash` executable. `recyclarr` executable.
**Command Line Examples**: **Command Line Examples**:
```bash ```bash
# Default Config (trash.yml) # Default Config (recyclarr.yml)
trash sonarr recyclarr sonarr
# Single Config # Single Config
trash sonarr --config ../myconfig.yml recyclarr sonarr --config ../myconfig.yml
# Multiple Config # Multiple Config
trash sonarr --config ../myconfig1.yml "files/my config 2.yml" recyclarr sonarr --config ../myconfig1.yml "files/my config 2.yml"
``` ```
### `--preview` ### `--preview`

@ -11,7 +11,7 @@ Various scenarios supported using flexible configuration structure:
## Update as much as possible in both Sonarr and Radarr with a single config ## Update as much as possible in both Sonarr and Radarr with a single config
Create a single configuration file (use the default `trash.yml` if you want to simplify your CLI Create a single configuration file (use the default `recyclarr.yml` if you want to simplify your CLI
usage by not being required to specify `--config`) and put all of the configuration in there, like usage by not being required to specify `--config`) and put all of the configuration in there, like
this: this:
@ -36,11 +36,11 @@ radarr:
preferred_ratio: 0.5 preferred_ratio: 0.5
``` ```
Even though it's all in one file, Radarr settings are ignored when you run `trash sonarr` and vice Even though it's all in one file, Radarr settings are ignored when you run `recyclarr sonarr` and
versa. To update both, just chain them together in your terminal, like so: vice versa. To update both, just chain them together in your terminal, like so:
```bash ```bash
trash sonarr && trash radarr recyclarr sonarr && recyclarr radarr
``` ```
This scenario is pretty ideal for a cron job you have running regularly and you want it to update This scenario is pretty ideal for a cron job you have running regularly and you want it to update
@ -78,7 +78,7 @@ sonarr:
Then run the following command: Then run the following command:
```bash ```bash
trash sonarr --config sonarr-release-profiles.yml recyclarr sonarr --config sonarr-release-profiles.yml
``` ```
This will only update release profiles since you have essentially moved the `quality_definition` This will only update release profiles since you have essentially moved the `quality_definition`
@ -86,7 +86,7 @@ property to its own file. When you want to update both, you just specify both fi
you run the program: you run the program:
```bash ```bash
trash sonarr --config sonarr-release-profiles.yml sonarr-quality-definition.yml recyclarr sonarr --config sonarr-release-profiles.yml sonarr-quality-definition.yml
``` ```
## Update multiple Sonarr instances in a single YAML config ## Update multiple Sonarr instances in a single YAML config
@ -117,8 +117,8 @@ In the example above, two separate instances, each with its own API key, will be
instance is for Anime only. The other is for Series (TV) only. And since I'm using two instances, I instance is for Anime only. The other is for Series (TV) only. And since I'm using two instances, I
don't bother with tags, so I am able to leave those elements out. don't bother with tags, so I am able to leave those elements out.
When you run `trash sonarr` (specify `--config` if you aren't using the default `trash.yml`) it will When you run `recyclarr sonarr` (specify `--config` if you aren't using the default `recyclarr.yml`)
update both instances. it will update both instances.
You can also split theses two instances across different YAML files if you do not want both to You can also split theses two instances across different YAML files if you do not want both to
update at the same time. There's an example of how to do that in a different section of this page. update at the same time. There's an example of how to do that in a different section of this page.
@ -260,11 +260,11 @@ radarr:
``` ```
However, especially in the case of DoVi, there are actually two custom formats with this name in the However, especially in the case of DoVi, there are actually two custom formats with this name in the
guide. You'll get a warning from Trash Updater stating that it couldn't pick which one you wanted, guide. You'll get a warning from Recyclarr stating that it couldn't pick which one you wanted, so it
so it was skipped. To fix this, simply use `trash_ids` and refer to it by an ID. IDs are never was skipped. To fix this, simply use `trash_ids` and refer to it by an ID. IDs are never duplicated
duplicated in the guide and also never change, so it's a robust and effective way to identify custom in the guide and also never change, so it's a robust and effective way to identify custom formats.
formats. The downside is that they are less readable than a name, but using comments can help with The downside is that they are less readable than a name, but using comments can help with that. The
that. The example below demonstrates how to do this. example below demonstrates how to do this.
```yml ```yml
radarr: radarr:
@ -283,7 +283,7 @@ custom format in the guide.
## Scores in a quality profile should be set to zero if it wasn't listed in config ## Scores in a quality profile should be set to zero if it wasn't listed in config
Scenario: *"I completely rely on Trash Updater to set scores on my quality profiles. I never plan to Scenario: *"I completely rely on Recyclarr to set scores on my quality profiles. I never plan to
manually set scores on those profiles. If I alter which custom format scores get assigned to a manually set scores on those profiles. If I alter which custom format scores get assigned to a
quality profile, the old scores should be set back to 0 automatically for me."* quality profile, the old scores should be set back to 0 automatically for me."*
@ -313,9 +313,9 @@ be different:
The `reset_unmatched_scores` setting basically determines how scores are handled for custom formats The `reset_unmatched_scores` setting basically determines how scores are handled for custom formats
that exist in Radarr but are not in the list of `names` in config. As shown in the example above, that exist in Radarr but are not in the list of `names` in config. As shown in the example above,
you set it to `true` which results in unmatched scores being set to `0`, or you can set it to you set it to `true` which results in unmatched scores being set to `0`, or you can set it to
`false` (or leave it omitted) in which case Trash Updater will not alter the value. `false` (or leave it omitted) in which case Recyclarr will not alter the value.
Which one should you use? That depends on how much control you want Trash Updater to have. If you Which one should you use? That depends on how much control you want Recyclarr to have. If you use
use Trash Updater to supplement manual changes to your profiles, you probably want it set to `false` Recyclarr to supplement manual changes to your profiles, you probably want it set to `false` so it
so it doesn't clobber your manual edits. Otherwise, set it to `true` so that scores aren't left over doesn't clobber your manual edits. Otherwise, set it to `true` so that scores aren't left over when
when you add/remove custom formats from a profile. you add/remove custom formats from a profile.

@ -3,7 +3,7 @@ Examples]] page.
# Summary # Summary
The Trash Updater program utilizes YAML for its configuration files. The configuration can be set up The Recyclarr program utilizes YAML for its configuration files. The configuration can be set up
multiple ways, offering a lot of flexibility: multiple ways, offering a lot of flexibility:
- You may use one or more YAML files simultaneously, allowing you to divide your configuration - You may use one or more YAML files simultaneously, allowing you to divide your configuration
@ -13,10 +13,11 @@ multiple ways, offering a lot of flexibility:
- Each YAML file may have one or more service configurations. This means you can have one file - Each YAML file may have one or more service configurations. This means you can have one file
define settings for just Sonarr, Radarr, or both services. The program will only read the define settings for just Sonarr, Radarr, or both services. The program will only read the
configuration from the file relevant for the specific service subcommand you specified (e.g. configuration from the file relevant for the specific service subcommand you specified (e.g.
`trash sonarr` will only read the Sonarr config in the file, even if Radarr config is present) `recyclarr sonarr` will only read the Sonarr config in the file, even if Radarr config is
present).
> **Remember**: If you do not specify the `--config` argument, the program will look for `trash.yml` > **Remember**: If you do not specify the `--config` argument, the program will look for
> in the same directory where the executable lives. > `recyclarr.yml` in the same directory where the executable lives.
# YAML Reference # YAML Reference
@ -69,7 +70,7 @@ sonarr:
page. page.
- `api_key` **(Required)**<br> - `api_key` **(Required)**<br>
The API key that Trash Updater should use to synchronize settings to your instance. You can obtain The API key that Recyclarr should use to synchronize settings to your instance. You can obtain
your API key by going to `Sonarr > Settings > General` and copy & paste the "API Key" under the your API key by going to `Sonarr > Settings > General` and copy & paste the "API Key" under the
"Security" group/header. "Security" group/header.
@ -169,7 +170,7 @@ radarr:
page. page.
- `api_key` **(Required)**<br> - `api_key` **(Required)**<br>
The API key that Trash Updater should use to synchronize settings to your instance. You can obtain The API key that Recyclarr should use to synchronize settings to your instance. You can obtain
your API key by going to `Radarr > Settings > General` and copy & paste the "API Key" under the your API key by going to `Radarr > Settings > General` and copy & paste the "API Key" under the
"Security" group/header. "Security" group/header.
@ -205,8 +206,8 @@ Synchronization]] page.
- `delete_old_custom_formats` (Optional; *Default: `false`*)<br> - `delete_old_custom_formats` (Optional; *Default: `false`*)<br>
If enabled, custom formats that you remove from your YAML configuration OR that are removed from If enabled, custom formats that you remove from your YAML configuration OR that are removed from
the guide will be deleted from your Radarr instance. Note that this *only* applies to custom the guide will be deleted from your Radarr instance. Note that this *only* applies to custom
formats that Trash Updater has synchronized to Radarr. Custom formats that you have added manually formats that Recyclarr has synchronized to Radarr. Custom formats that you have added manually in
in Radarr **will not be deleted** if you enable this setting. Radarr **will not be deleted** if you enable this setting.
- `custom_formats` (Optional; *Default: No custom formats are synced*)<br> - `custom_formats` (Optional; *Default: No custom formats are synced*)<br>
A list of one or more sets of custom formats (by name and/or trash_id), each with an optional set A list of one or more sets of custom formats (by name and/or trash_id), each with an optional set
@ -244,7 +245,7 @@ Synchronization]] page.
> >
> - If `delete_old_custom_formats` is set to true, custom formats are **deleted** in Radarr if > - If `delete_old_custom_formats` is set to true, custom formats are **deleted** in Radarr if
> you remove them from this list. > you remove them from this list.
> - It's OK for the same custom format to exist in multiple lists of `names`. Trash Updater will > - It's OK for the same custom format to exist in multiple lists of `names`. Recyclarr will
> only ever synchronize it once. Allowing it to be specified multiple times allows you to > only ever synchronize it once. Allowing it to be specified multiple times allows you to
> assign it to different profiles with different scores. > assign it to different profiles with different scores.
@ -263,12 +264,12 @@ Synchronization]] page.
rare cases where you might prefer (or need) to use the ID instead: rare cases where you might prefer (or need) to use the ID instead:
- Sometimes there are custom formats in the guide with the same name, such as "DoVi". In this - Sometimes there are custom formats in the guide with the same name, such as "DoVi". In this
case, Trash Updater will issue you a warning instructing you to use the Trash ID instead of case, Recyclarr will issue you a warning instructing you to use the Trash ID instead of the
the name to resolve the ambiguity. name to resolve the ambiguity.
- Trash IDs never change. Custom format names can change. Trash Updater keeps an internal cache - Trash IDs never change. Custom format names can change. Recyclarr keeps an internal cache of
of every custom format its seen to reduce the need for your config names to be updated. But every custom format its seen to reduce the need for your config names to be updated. But it's
it's not 100% fool proof. Using the ID could mean less config maintenance for you in the long not 100% fool proof. Using the ID could mean less config maintenance for you in the long run
run at the expense of readability. at the expense of readability.
Most of the rules and semantics are identical to the `names` property, which is documented Most of the rules and semantics are identical to the `names` property, which is documented
above. Just apply that logic to the ID instead of the name. above. Just apply that logic to the ID instead of the name.

@ -8,26 +8,26 @@ Custom format synchronization is broken up into three categories:
> **Important** > **Important**
> >
> Trash Updater will *never* touch custom formats that you create by hand, unless they share a name > Recyclarr will *never* touch custom formats that you create by hand, unless they share a name with
> with a custom format in the guide. In general, Trash Updater must have been the one to create a > a custom format in the guide. In general, Recyclarr must have been the one to create a custom
> custom format in order to do anything to it (update or delete). > format in order to do anything to it (update or delete).
## Cache ## Cache
### Summary ### Summary
The synchronization cache in Trash Updater allows it to more accurately detect changes to custom The synchronization cache in Recyclarr allows it to more accurately detect changes to custom formats
formats in the TRaSH guides. This mainly helps cover changes like renames. in the TRaSH guides. This mainly helps cover changes like renames.
Once Trash Updater creates or updates a custom format in Radarr, it records information about it in Once Recyclarr creates or updates a custom format in Radarr, it records information about it in a
a cache file located on disk. The location varies depending on platform: cache file located on disk. The location varies depending on platform:
- Windows: `%APPDATA%/trash-updater/cache` - Windows: `%APPDATA%/recyclarr/cache`
- Linux: `~/.config/trash-updater/cache` - Linux: `~/.config/recyclarr/cache`
- MacOS: `~/Library/Application Support/trash-updater/cache` - MacOS: `~/Library/Application Support/recyclarr/cache`
The cache files are not meant to be edited by users. In general I recommend leaving them alone. The cache files are not meant to be edited by users. In general I recommend leaving them alone.
Trash Updater will manage it for you. However, sometimes a bug may cause an issue where deleting the Recyclarr will manage it for you. However, sometimes a bug may cause an issue where deleting the
cache directory will be a good way to recover. cache directory will be a good way to recover.
### Custom Format Identification Behavior ### Custom Format Identification Behavior

@ -13,4 +13,4 @@ This wiki is auto-generated from the main repository. If you want to contribute
here, please clone the main repo and edit files in the [wiki directory][1]. Pull request the changes here, please clone the main repo and edit files in the [wiki directory][1]. Pull request the changes
and when they are merged, a workflow will run that updates the wiki. and when they are merged, a workflow will run that updates the wiki.
[1]: https://github.com/rcdailey/trash-updater/tree/master/wiki [1]: https://github.com/rcdailey/recyclarr/tree/master/wiki

@ -1,20 +1,20 @@
This page contains the YAML reference for Trash Updater settings. Settings support was introduced in This page contains the YAML reference for Recyclarr settings. Settings support was introduced in
version `1.7.0`. version `1.7.0`.
The `settings.yml` file is located in the following locations depending on your platform: The `settings.yml` file is located in the following locations depending on your platform:
| Platform | Location | | Platform | Location |
| -------- | ---------------------------------------------------------- | | -------- | ------------------------------------------------------ |
| Windows | `%APPDATA%\trash-updater\settings.yml` | | Windows | `%APPDATA%\recyclarr\settings.yml` |
| Linux | `~/.config/trash-updater/settings.yml` | | Linux | `~/.config/recyclarr/settings.yml` |
| MacOS | `~/Library/Application Support/trash-updater/settings.yml` | | MacOS | `~/Library/Application Support/recyclarr/settings.yml` |
Settings in this file affect the behavior of Trash Updater regardless of instance-specific Settings in this file affect the behavior of Recyclarr regardless of instance-specific configuration
configuration for Radarr and Sonarr. for Radarr and Sonarr.
If this file does not exist, Trash Updater will create it for you. Starting out, this file will be If this file does not exist, Recyclarr will create it for you. Starting out, this file will be empty
empty and default behavior will be used. There is absolutely no need to touch this file unless you and default behavior will be used. There is absolutely no need to touch this file unless you have a
have a specific reason to. It is recommended that you only add the specific properties for the specific reason to. It is recommended that you only add the specific properties for the
customizations you need and leave the rest alone. customizations you need and leave the rest alone.
# Schema Validation # Schema Validation
@ -23,7 +23,7 @@ A schema file is provided for `settings.yml` to help assist in editing the file.
add the below snippet to the first line in your `settings.yml` file: add the below snippet to the first line in your `settings.yml` file:
```yml ```yml
# yaml-language-server: $schema=https://raw.githubusercontent.com/rcdailey/trash-updater/master/schemas/settings-schema.json # yaml-language-server: $schema=https://raw.githubusercontent.com/rcdailey/recyclarr/master/schemas/settings-schema.json
``` ```
If you use VS Code to edit your settings file and install the [YAML extension][yaml], it will If you use VS Code to edit your settings file and install the [YAML extension][yaml], it will
@ -60,6 +60,6 @@ repository:
- `clone_url`<br> - `clone_url`<br>
A URL compatible with `git clone` that is used to clone the [Trash Guides A URL compatible with `git clone` that is used to clone the [Trash Guides
repository][official_repo]. This setting exists for enthusiasts that may want to instead have repository][official_repo]. This setting exists for enthusiasts that may want to instead have
Trash Updater pull data from a fork instead of the official repository. Recyclarr pull data from a fork instead of the official repository.
[official_repo]: https://github.com/TRaSH-/Guides [official_repo]: https://github.com/TRaSH-/Guides

@ -1,32 +1,32 @@
# Obtaining Debug Logs # Obtaining Debug Logs
Trash Updater always outputs logs as files in a directory on your filesystem. Each execution of Recyclarr always outputs logs as files in a directory on your filesystem. Each execution of
Trash Updater yields a new file and those files always contain verbose (debug) logs. When reporting Recyclarr yields a new file and those files always contain verbose (debug) logs. When reporting
issues, I ask that you always include logs from the file rather than the command line output since issues, I ask that you always include logs from the file rather than the command line output since
Trash Updater will not include debug logs by default in the console output. Recyclarr will not include debug logs by default in the console output.
Below is a list of locations where you can find the log directory depending on platform. Below is a list of locations where you can find the log directory depending on platform.
| Platform | Location | | Platform | Location |
| -------- | -------------------------------------------------- | | -------- | ---------------------------------------------- |
| Windows | `%APPDATA%\trash-updater\logs` | | Windows | `%APPDATA%\recyclarr\logs` |
| Linux | `~/.config/trash-updater/logs` | | Linux | `~/.config/recyclarr/logs` |
| MacOS | `~/Library/Application Support/trash-updater/logs` | | MacOS | `~/Library/Application Support/recyclarr/logs` |
# Errors & Solutions # Errors & Solutions
* On Mac or Linux OS, you may see the following error when you run `trash`: * On Mac or Linux OS, you may see the following error when you run `recyclarr`:
```txt ```txt
Failed to map file. open(/Users/foo/Downloads/trash) failed with error 13 Failed to map file. open(/Users/foo/Downloads/recyclarr) failed with error 13
Failure processing application bundle. Failure processing application bundle.
Couldn't memory map the bundle file for reading. Couldn't memory map the bundle file for reading.
A fatal error occurred while processing application bundle A fatal error occurred while processing application bundle
``` ```
This cryptic message is actually a permissions error, likely because your executable does not have This cryptic message is actually a permissions error, likely because your executable does not have
read permissions set. Simply run `chmod u+rx trash` to add read + execute permissions on the read permissions set. Simply run `chmod u+rx recyclarr` to add read + execute permissions on the
`trash` executable. `recyclarr` executable.
* When communicating with Radarr or Sonarr, you get the following exception message: * When communicating with Radarr or Sonarr, you get the following exception message:
@ -39,14 +39,14 @@ Below is a list of locations where you can find the log directory depending on p
This means your Base URL is missing from the URL you specified in the YAML. See issue [#42] for This means your Base URL is missing from the URL you specified in the YAML. See issue [#42] for
more details. more details.
* On Ubuntu 22.04 or derivatives when you run `./recyclarr radarr` you will get the following error: * On Ubuntu 22.04 or derivatives when you run `recyclarr radarr` you will get the following error:
```txt ```txt
[ERR] An exception occurred during git operations on path: /home/REDACTED/.config/trash-updater/repo [ERR] An exception occurred during git operations on path: /home/REDACTED/.config/recyclarr/repo
LibGit2Sharp.LibGit2SharpException: could not load ssl libraries LibGit2Sharp.LibGit2SharpException: could not load ssl libraries
------ ------
[INF] Deleting local git repo and retrying git operation... [INF] Deleting local git repo and retrying git operation...
[1] 257872 segmentation fault (core dumped) ./trash radarr [1] 257872 segmentation fault (core dumped) ./recyclarr radarr
``` ```
Ubuntu and Fedora moved from libssl 1.1 to libssl 3.0 in version 22.04 and 36 respectively. This Ubuntu and Fedora moved from libssl 1.1 to libssl 3.0 in version 22.04 and 36 respectively. This

Loading…
Cancel
Save