File tree Expand file tree Collapse file tree 3 files changed +30
-15
lines changed Expand file tree Collapse file tree 3 files changed +30
-15
lines changed Original file line number Diff line number Diff line change
1
+ ---
2
+ id : getting-started
3
+ sidebar_position : 4
4
+ title : Getting Started
5
+ ---
6
+
7
+ Recyclarr requires a YAML configuration file in order to work. By default, this file is named
8
+ ` recyclarr.yml ` and lives in your [ application data directory] [ appdata ] . Run the steps below if you
9
+ want to get started with a minimal configuration file.
10
+
11
+ 1 . Run ` recyclarr create-config ` to create a starter ` recyclarr.yml ` file in the [ application data
12
+ directory] [ appdata ] .
13
+ 1 . Open the generated YAML file from the previous step. At a minimum you must update the ` base_url `
14
+ and ` api_key ` properties for each service that you want to use. Use the configuration [ reference]
15
+ and [ examples] pages to assist you in understanding an editing other parts of the file as you see
16
+ fit.
17
+ 1 . Run ` recyclarr sonarr ` and/or ` recyclarr radarr ` as needed to update those instances using the
18
+ configuration provided in the previous step.
19
+
20
+ Lastly, each subcommand supports printing help on the command line. Simply run ` recyclarr --help `
21
+ for the main help output and a list of subcommands. You can then see the help for each subcommand by
22
+ running ` recyclarr [subcommand] --help ` , where ` [subcommand] ` is one of those subcommands (e.g.
23
+ ` sonarr ` ). You can also visit the [ CLI Reference] ( /reference/cli-reference.md ) page for detailed
24
+ documentation as well.
25
+
26
+ [ appdata ] : /file-structure.md#appdata-directory
27
+ [ reference ] : /reference/config-yml-reference.md
28
+ [ examples ] : /reference/configuration-examples.md
Original file line number Diff line number Diff line change 1
- position : 50
1
+ position : 3
Original file line number Diff line number Diff line change 14
14
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig } */
15
15
const sidebars = {
16
16
// By default, Docusaurus generates a sidebar from the docs folder structure
17
- tutorialSidebar : [ { type : 'autogenerated' , dirName : '.' } ] ,
18
-
19
- // But you can create a sidebar manually
20
- /*
21
- tutorialSidebar: [
22
- 'intro',
23
- 'hello',
24
- {
25
- type: 'category',
26
- label: 'Tutorial',
27
- items: ['tutorial-basics/create-a-document'],
28
- },
29
- ],
30
- */
17
+ wikiSidebar : [ { type : 'autogenerated' , dirName : '.' } ] ,
31
18
} ;
32
19
33
20
module . exports = sidebars ;
You can’t perform that action at this time.
0 commit comments