From 354756a7c2c71b291dfb975afa6d169daed9e4b2 Mon Sep 17 00:00:00 2001 From: Robert Dailey Date: Mon, 23 May 2022 18:32:22 -0500 Subject: [PATCH] docs: Update docs regarding new default YAML location --- README.md | 10 ++++++---- wiki/Command-Line-Reference.md | 4 ++-- wiki/Configuration-Reference.md | 2 +- wiki/File-Structure.md | 10 ++++++++-- 4 files changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 90731e2e..ab790d52 100644 --- a/README.md +++ b/README.md @@ -111,8 +111,8 @@ linux, I think you can handle what needs to be done :-)* Recyclarr requires a YAML configuration file in order to work. Run the steps below if you want to get started with a minimal configuration file. -- Run `recyclarr create-config` to create a starter `recyclarr.yml` file in the same directory as the - executable. You can also use `--path` to customize the filename and location. +- Run `recyclarr create-config` to create a starter `recyclarr.yml` file in the [application data + directory][appdata]. You can also use `--path` to customize the filename and location. - Open the generated YAML file from the previous step. At a minimum you must update the `base_url` and `api_key` settings for each service that you want to use. Change/delete other parts of the file as you see fit. @@ -122,11 +122,13 @@ The last step above will do a "basic" sync from the guides to Sonarr and/or Rada config is very minimal. See the next section for further reading and links to the wiki for additional topics and more advanced customization. -Lastly, each subcommand supports printing help on the command line. Simply run `recyclarr --help` for -the main help output and a list of subcommands. You can then see the help for each subcommand by +Lastly, each subcommand supports printing help on the command line. Simply run `recyclarr --help` +for the main help output and a list of subcommands. You can then see the help for each subcommand by running `recyclarr [subcommand] --help`, where `[subcommand]` is one of those subcommands (e.g. `sonarr`) +[appdata]: https://github.com/recyclarr/recyclarr/wiki/File-Structure + ### Read the Documentation Main documentation is located in [the wiki](https://github.com/recyclarr/recyclarr/wiki). Links diff --git a/wiki/Command-Line-Reference.md b/wiki/Command-Line-Reference.md index fbd783f7..66848251 100644 --- a/wiki/Command-Line-Reference.md +++ b/wiki/Command-Line-Reference.md @@ -18,8 +18,8 @@ These are optional arguments shared by *all* subcommands. 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 -default configuration file named `recyclarr.yml` will be used. It must be in the same directory as the -`recyclarr` executable. +default configuration file named `recyclarr.yml` will be used. It must be in the [[application data +directory|File-Structure]]. **Command Line Examples**: diff --git a/wiki/Configuration-Reference.md b/wiki/Configuration-Reference.md index a8307c8d..65615019 100644 --- a/wiki/Configuration-Reference.md +++ b/wiki/Configuration-Reference.md @@ -17,7 +17,7 @@ multiple ways, offering a lot of flexibility: present). > **Remember**: If you do not specify the `--config` argument, the program will look for -> `recyclarr.yml` in the same directory where the executable lives. +> `recyclarr.yml` in the [[application data directory|File-Structure]]. # YAML Reference diff --git a/wiki/File-Structure.md b/wiki/File-Structure.md index d54d1bda..41f87586 100644 --- a/wiki/File-Structure.md +++ b/wiki/File-Structure.md @@ -15,5 +15,11 @@ path. ## Default YAML Configuration File -The default YAML configuration file is `recyclarr.yml` and it is always located next to the -Recyclarr executable. +The default YAML configuration file is named `recyclarr.yml` and it is always located in the +application data directory (listed above, listed for your platform). + +For backward compatibility, if the `recyclarr.yml` file is located adjacent to your `recyclarr` +executable, that will be loaded *first* and a warning is printed to the console. In this scenario, +even if a `recyclarr.yml` file exists in your application data directory, *it will not be loaded!* + +The solution is to delete or move the `recyclarr.yml` sitting next to the executable.