Difference between revisions of "Settings General"

From Servarr
 
(2 intermediate revisions by the same user not shown)
Line 181: Line 181:
  
 
* Branch - This is the branch of Radarr that you are running on. Please see [[Radarr_FAQ#How_do_I_update_Radarr.3F|the FAQ]] for available branches and version information
 
* Branch - This is the branch of Radarr that you are running on. Please see [[Radarr_FAQ#How_do_I_update_Radarr.3F|the FAQ]] for available branches and version information
−
* Automatic - Automatically download and install updates. You will still be able to install from System: Updates
+
* Automatic - Automatically download and install updates. You will still be able to install from System: Updates.  Note: Windows Users are always automatically updated.
 
* Mechanism - Use Radarr's built-in updater or a script
 
* Mechanism - Use Radarr's built-in updater or a script
 +
** Built-In - Use Radarr's own updater
 
** Docker - Do not update Radarr from inside the Docker, instead pull a brand new image with the new update
 
** Docker - Do not update Radarr from inside the Docker, instead pull a brand new image with the new update
 
** Script - Have Radarr run the update script
 
** Script - Have Radarr run the update script
Line 189: Line 190:
 
<section begin=sonarr_settings_general_updates />
 
<section begin=sonarr_settings_general_updates />
 
* Branch - This is the branch of Sonarr that you are running on. Please see [https://github.com/Sonarr/Sonarr Github] for available branches and version information. These branches only apply to V3.
 
* Branch - This is the branch of Sonarr that you are running on. Please see [https://github.com/Sonarr/Sonarr Github] for available branches and version information. These branches only apply to V3.
−
** main (Stable): This has been tested by users on nightly branch and it's not known to have any major issues. This branch should be userd by the majority of users.  
+
** main (Stable): This has been tested by users on nightly branch and it's not known to have any major issues. This branch should be used by the majority of users.  
 
** develop (Nightly) : This is the bleeding edge. It is released as soon as code is committed and passes all automated tests. This build may have not been used by us or other users yet. There is no guarantee that it will even run in some cases. This branch is only recommended for advanced users. Issues and self investigation are expected in this branch.
 
** develop (Nightly) : This is the bleeding edge. It is released as soon as code is committed and passes all automated tests. This build may have not been used by us or other users yet. There is no guarantee that it will even run in some cases. This branch is only recommended for advanced users. Issues and self investigation are expected in this branch.
 
** phantom-develop (v3-preview): This is EOL and the built-in updater will automatically update to main.
 
** phantom-develop (v3-preview): This is EOL and the built-in updater will automatically update to main.
−
* Automatic - Automatically download and install updates. You will still be able to install from System: Updates
+
** Automatic - Automatically download and install updates. You will still be able to install from System: Updates.  Note: Windows Users are always automatically updated.
 
* Mechanism - Use Sonarr built-in updater or a script
 
* Mechanism - Use Sonarr built-in updater or a script
 
** Built-in - Use Sonarr's own updater
 
** Built-in - Use Sonarr's own updater
Line 208: Line 209:
 
=== Lidarr ===
 
=== Lidarr ===
 
<section begin=lidarr_settings_general_updates />
 
<section begin=lidarr_settings_general_updates />
−
* If your using a docker container to run your Lidarr instance. Do not update Lidarr while inside the container. This has a bad tendancy to break things. Instead update the actual docker image which has the most current build.
+
* Branch - This is the branch of Lidarr that you are running on.
 +
* Automatic - Automatically download and install updates. You will still be able to install from System: Updates.  Note: Windows Users are always automatically updated.
 +
 
 +
* Mechanism - Use Lidarr's built-in updater or a script
 +
** Built-In - Use Lidarr's own updater
 +
** Docker - Do not update Lidarr from inside the Docker, instead pull a brand new image with the new update
 +
** Script - Have Lidarr run the update script
 
<section end=lidarr_settings_general_updates />
 
<section end=lidarr_settings_general_updates />
 
=== Readarr ===
 
=== Readarr ===
 
<section begin=readarr_settings_general_updates />
 
<section begin=readarr_settings_general_updates />
−
* If your using a docker container to run your Lidarr instance. Do not update Lidarr while inside the container. This has a bad tendancy to break things. Instead update the actual docker image which has the most current build.
+
* Branch - This is the branch of Readarr that you are running on.
 +
* Automatic - Automatically download and install updates. You will still be able to install from System: Updates.  Note: Windows Users are always automatically updated.
 +
 
 +
* Mechanism - Use Readarr's built-in updater or a script
 +
** Built-In - Use Readarr's own updater
 +
** Docker - Do not update Readarr from inside the Docker, instead pull a brand new image with the new update
 +
** Script - Have Readarr run the update script
 
<section end=readarr_settings_general_updates />
 
<section end=readarr_settings_general_updates />
  
Line 221: Line 234:
 
* Folder - This allows you to select the backup location
 
* Folder - This allows you to select the backup location
 
** In docker you will be limited to what you allow the container to see
 
** In docker you will be limited to what you allow the container to see
 +
** Paths are relative to the appdata folder; if necessary, you can set an absolute path to backup outside of the appdata folder
 
* Interval - How often would you like Radarr to make a backup
 
* Interval - How often would you like Radarr to make a backup
 
* Retention - How long would you like Radarr to hold on to each backup. After a new backup is made the oldest backup will be removed
 
* Retention - How long would you like Radarr to hold on to each backup. After a new backup is made the oldest backup will be removed
Line 229: Line 243:
 
* Folder - This allows you to select the backup location
 
* Folder - This allows you to select the backup location
 
** In docker you will be limited to what you allow the container to see
 
** In docker you will be limited to what you allow the container to see
 +
** Paths are relative to the appdata folder; if necessary, you can set an absolute path to backup outside of the appdata folder
 
* Interval - How often would you like Sonarr to make a backup
 
* Interval - How often would you like Sonarr to make a backup
 
* Retention - How long would you like Sonarr to hold on to each backup. After a new backup is made the oldest backup will be removed
 
* Retention - How long would you like Sonarr to hold on to each backup. After a new backup is made the oldest backup will be removed
Line 237: Line 252:
 
* Folder - This allows you to select the backup location
 
* Folder - This allows you to select the backup location
 
** In docker you will be limited to what you allow the container to see
 
** In docker you will be limited to what you allow the container to see
 +
** Paths are relative to the appdata folder; if necessary, you can set an absolute path to backup outside of the appdata folder
 
* Interval - How often would you like Lidarr to make a backup
 
* Interval - How often would you like Lidarr to make a backup
 
* Retention - How long would you like Lidarr to hold on to each backup. After a new backup is made the oldest backup will be removed
 
* Retention - How long would you like Lidarr to hold on to each backup. After a new backup is made the oldest backup will be removed
Line 245: Line 261:
 
* Folder - This allows you to select the backup location
 
* Folder - This allows you to select the backup location
 
** In docker you will be limited to what you allow the container to see
 
** In docker you will be limited to what you allow the container to see
 +
** Paths are relative to the appdata folder; if necessary, you can set an absolute path to backup outside of the appdata folder
 
* Interval - How often would you like Readarr to make a backup
 
* Interval - How often would you like Readarr to make a backup
 
* Retention - How long would you like Readarr to hold on to each backup. After a new backup is made the oldest backup will be removed
 
* Retention - How long would you like Readarr to hold on to each backup. After a new backup is made the oldest backup will be removed

Latest revision as of 22:00, 6 May 2021

General

Host

Radarr

  • Binding Address - Valid IP4 address or '*' for all interfaces
    • 0.0.0.0 or * - any address can connect
    • 127.0.0.1 or localhost - only localhost applications can connect
    • Any other IP (e.g. 1.2.3.4) - only that IP (1.2.3.4) can connect
  • Port Number - The port number that you are wanting to use to access the webUI for Radarr
    • Note: If using Docker do not touch
  • URL Base - For reverse proxy support, default is empty
    • Note: If using a reverse proxy (example: mydomain.com/radarr) you would enter '/radarr' for URL Base.
  • Enable SSL - If you have SSL credentials and would like to secure communication to and from your Radarr enable this option.
    • Note: do not mess with unless you know what you're doing

Sonarr

  • Binding Address - Valid IP4 address or '*' for all interfaces
    • 0.0.0.0 or * - any address can connect
    • 127.0.0.1 or localhost - only localhost applications can connect
    • Any other IP (e.g. 1.2.3.4) - only that IP (1.2.3.4) can connect
  • Port Number - The port number that you are wanting to use to access the webUI for Sonarr
    • Note: If using Docker do not touch
  • URL Base - For reverse proxy support, default is empty
    • Note: If using a reverse proxy (example: mydomain.com/sonarr) you would enter '/sonarr' for URL Base.
  • Enable SSL - If you have SSL credentials and would like to secure communication to and from your Sonarr enable this option.
    • Note: do not mess with unless you know what you're doing

Lidarr

  • Binding Address - Valid IP4 address or '*' for all interfaces
    • 0.0.0.0 or * - any address can connect
    • 127.0.0.1 or localhost - only localhost applications can connect
    • Any other IP (e.g. 1.2.3.4) - only that IP (1.2.3.4) can connect
  • Port Number - The port number that you are wanting to use to access the webUI for Lidarr
    • Note: If using Docker do not touch
  • URL Base - For reverse proxy support, default is empty
    • Note: If using a reverse proxy (example: mydomain.com/lidarr) you would enter '/lidarr' for URL Base.
  • Enable SSL - If you have SSL credentials and would like to secure communication to and from your Lidarr enable this option.
    • Note: do not mess with unless you know what you're doing

Readarr

  • Binding Address - Valid IP4 address or '*' for all interfaces
    • 0.0.0.0 or * - any address can connect
    • 127.0.0.1 or localhost - only localhost applications can connect
    • Any other IP (e.g. 1.2.3.4) - only that IP (1.2.3.4) can connect
  • Port Number - The port number that you are wanting to use to access the webUI for Readarr
    • Note: If using Docker do not touch
  • URL Base - For reverse proxy support, default is empty
    • Note: If using a reverse proxy (example: mydomain.com/readarr) you would enter '/readarr' for URL Base.
  • Enable SSL - If you have SSL credentials and would like to secure communication to and from your Readarr enable this option.
    • Note: do not mess with unless you know what you're doing


Security

Radarr

  • Authentication - How would you like to authenticate to access your Radarr instance
    • None - You have no authentication to access your Radarr
      • Typically if you're the only user of your network, do not have anybody on your network that would care to access your Radarr or your Radarr is not exposed to the web
    • Basic (Browser pop-up) - This option when accessing your Radarr will show a small pop-up allowing you to input a Username and Password
    • Forms (Login Page) - This option will have a familiar looking login screen much like other websites have to allow you to log onto your Radarr
  • API Key - This is how other programs would communicate or have Radarr communicate to other programs. This key if given to the wrong person with access could do all kinds of things to your library. This is why in the logs the API key is redacted
  • Certificate Validation - Change how strict HTTPS certification validation is

Sonarr

  • Authentication - How would you like to authenticate to access your Sonarr instance
    • None - You have no authentication to access your Sonarr
      • Typically if you're the only user of your network, do not have anybody on your network that would care to access your Sonarr or your Sonarr is not exposed to the web
    • Basic (Browser pop-up) - This option when accessing your Sonarr will show a small pop-up allowing you to input a Username and Password
    • Forms (Login Page) - This option will have a familiar looking login screen much like other websites have to allow you to log onto your Sonarr
  • API Key - This is how other programs would communicate or have Sonarr communicate to other programs. This key if given to the wrong person with access could do all kinds of things to your library. This is why in the logs the API key is redacted
  • Certificate Validation - Change how strict HTTPS certification validation is

Lidarr

  • Authentication - How would you like to authenticate to access your Lidarr instance
    • None - You have no authentication to access your Lidarr
      • Typically if you're the only user of your network, do not have anybody on your network that would care to access Lidarr or your Lidarr is not exposed to the web
    • Basic (Browser pop-up) - This option when accessing your Lidarr will show a small pop-up allowing you to input a Username and Password
    • Forms (Login Page) - This option will have a familiar looking login screen much like other websites have to allow you to log onto your Lidarr
  • API Key - This is how other programs would communicate or have Lidarr communicate to other programs. This key if given to the wrong person with access could do all kinds of things to your library. This is why in the logs the API key is redacted
  • Certificate Validation - Change how strict HTTPS certification validation is

Readarr

  • Authentication - How would you like to authenticate to access your Readarrinstance
    • None - You have no authentication to access your Readarr
      • Typically if you're the only user of your network, do not have anybody on your network that would care to access Readarr or your Readarr is not exposed to the web
    • Basic (Browser pop-up) - This option when accessing your Readarr will show a small pop-up allowing you to input a Username and Password
    • Forms (Login Page) - This option will have a familiar looking login screen much like other websites have to allow you to log onto your Readarr
  • API Key - This is how other programs would communicate or have Readarr communicate to other programs. This key if given to the wrong person with access could do all kinds of things to your library. This is why in the logs the API key is redacted
  • Certificate Validation - Change how strict HTTPS certification validation is


Proxy

Radarr

  • Proxy - This option allows you to run the information your Radarr pulls and searches for through a proxy. This can be useful if you're in a country that does not allow the downloading of Torrent files

Sonarr

  • Proxy - This option allows you to run the information your Sonarr pulls and searches for through a proxy. This can be useful if you're in a country that does not allow the downloading of Torrent files

Lidarr

  • Proxy - This option allows you to run the information your Lidarr pulls and searches for through a proxy. This can be useful if you're in a country that does not allow the downloading of Torrent files

Readarr

  • Proxy - This option allows you to run the information your Readarr pulls and searches for through a proxy. This can be useful if you're in a country that does not allow the downloading of Torrent files


Logging

Radarr

  • Log level - Probably one of the most useful troubleshooting tools
    • Info - This is the most basic way that Radarr gathers information this will include very minimal amount of information in the logs.
      • This log file contains fatal, error, warn and info entries.
    • Debug - Debug will include all the information that Info includes plus more information that can be useful.
      • This log files contains fatal, error, warn, info and debug entries
    • Trace - The most advance and detailed logging on Radarr, Trace will include all the information gathered by Info and Debug and more. This is the most common type of log that is going to be asked for when troubleshooting on Discord or Reddit. If you're needing help please select your log to Trace and redo the task that was giving you problems to capture the log.
      • This log files contains fatal, error, warn, info, debug and trace entries.

Sonarr

  • Log level - Probably one of the most useful troubleshooting tools
    • Info - This is the most basic way that Sonarr gathers information this will include very minimal amount of information in the logs.
      • This log file contains fatal, error, warn and info entries.
    • Debug - Debug will include all the information that Info includes plus more information that can be useful.
      • This log files contains fatal, error, warn, info and debug entries
    • Trace - The most advance and detailed logging on Sonarr, Trace will include all the information gathered by Info and Debug and more. This is the most common type of log that is going to be asked for when troubleshooting on Discord or Reddit. If you're needing help please select your log to Trace and redo the task that was giving you problems to capture the log.
      • This log files contains fatal, error, warn, info, debug and trace entries.

Lidarr

  • Log level - Probably one of the most useful troubleshooting tools
    • Info - This is the most basic way that Lidarr gathers information this will include very minimal amount of information in the logs.
      • This log file contains fatal, error, warn and info entries.
    • Debug - Debug will include all the information that Info includes plus more information that can be useful.
      • This log files contains fatal, error, warn, info and debug entries
    • Trace - The most advance and detailed logging on Lidarr, Trace will include all the information gathered by Info and Debug and more. This is the most common type of log that is going to be asked for when troubleshooting on Discord or Reddit. If you're needing help please select your log to Trace and redo the task that was giving you problems to capture the log.
      • This log files contains fatal, error, warn, info, debug and trace entries.

Readarr

  • Log level - Probably one of the most useful troubleshooting tools
    • Info - This is the most basic way that Readarr gathers information this will include very minimal amount of information in the logs.
      • This log file contains fatal, error, warn and info entries.
    • Debug - Debug will include all the information that Info includes plus more information that can be useful.
      • This log files contains fatal, error, warn, info and debug entries
    • Trace - The most advance and detailed logging on Readarr, Trace will include all the information gathered by Info and Debug and more. This is the most common type of log that is going to be asked for when troubleshooting on Discord or Reddit. If you're needing help please select your log to Trace and redo the task that was giving you problems to capture the log.
      • This log files contains fatal, error, warn, info, debug and trace entries.


Analytics

Radarr

  • Analytics - Send anonymous usage and error information to Radarr's servers (Servarr). This includes information on your browser, which Radarr WebUI pages you use, error reporting as well as OS and runtime version. We will use this information to prioritize features and bug fixes.

Sonarr

  • Analytics - Send anonymous usage and error information to Sonarr's servers (SkyHook). This includes information on your browser, which Sonarr WebUI pages you use, error reporting as well as OS and runtime version. We will use this information to prioritize features and bug fixes.

Lidarr

  • Analytics - Send anonymous usage and error information to Lidarr's servers (Servarr). This includes information on your browser, which Lidarr WebUI pages you use, error reporting as well as OS and runtime version. We will use this information to prioritize features and bug fixes.

Readarr

  • Analytics - Send anonymous usage and error information to Readarr's servers (Servarr). This includes information on your browser, which Readarr WebUI pages you use, error reporting as well as OS and runtime version. We will use this information to prioritize features and bug fixes.


Updates

Radarr

See Also: FAQ: How do I update Radarr?

  • Branch - This is the branch of Radarr that you are running on. Please see the FAQ for available branches and version information
  • Automatic - Automatically download and install updates. You will still be able to install from System: Updates. Note: Windows Users are always automatically updated.
  • Mechanism - Use Radarr's built-in updater or a script
    • Built-In - Use Radarr's own updater
    • Docker - Do not update Radarr from inside the Docker, instead pull a brand new image with the new update
    • Script - Have Radarr run the update script

Sonarr

  • Branch - This is the branch of Sonarr that you are running on. Please see Github for available branches and version information. These branches only apply to V3.
    • main (Stable): This has been tested by users on nightly branch and it's not known to have any major issues. This branch should be used by the majority of users.
    • develop (Nightly) : This is the bleeding edge. It is released as soon as code is committed and passes all automated tests. This build may have not been used by us or other users yet. There is no guarantee that it will even run in some cases. This branch is only recommended for advanced users. Issues and self investigation are expected in this branch.
    • phantom-develop (v3-preview): This is EOL and the built-in updater will automatically update to main.
    • Automatic - Automatically download and install updates. You will still be able to install from System: Updates. Note: Windows Users are always automatically updated.
  • Mechanism - Use Sonarr built-in updater or a script
    • Built-in - Use Sonarr's own updater
    • Script - Have Sonarr run the update script
    • Docker - Do not update Sonarr from inside the Docker, instead pull a brand new image with the new update
    • Apt - Set by the Debian/Ubuntu package when updating is managed exclusively via Apt
  • Script - Visible only when Mechanism is set to Script - Path to update script
  • Update Process - Sonarr will download the update file, verify its integrity and extract it to a temporary location and call the chosen method. The update process will be be run under the same user that Sonarr is run under, it will need permissions to update the Sonarr files as well as stop/start Sonarr.
    • Built-in - The built-in method will backup Sonarr files and settings, stop Sonarr, update the installation and Start Sonarr, if your system will not handle the stopping of Sonarr and will attempt to restart it automatically it may be best to use a script instead. In the event of failure the previous version of Sonarr will be restarted.
    • Script - The script should handle the the same as the built-in updater, if you need to handle stopping and starting services (upstart/launchd/etc) you will need to do that here.


Lidarr

  • Branch - This is the branch of Lidarr that you are running on.
  • Automatic - Automatically download and install updates. You will still be able to install from System: Updates. Note: Windows Users are always automatically updated.
  • Mechanism - Use Lidarr's built-in updater or a script
    • Built-In - Use Lidarr's own updater
    • Docker - Do not update Lidarr from inside the Docker, instead pull a brand new image with the new update
    • Script - Have Lidarr run the update script

Readarr

  • Branch - This is the branch of Readarr that you are running on.
  • Automatic - Automatically download and install updates. You will still be able to install from System: Updates. Note: Windows Users are always automatically updated.
  • Mechanism - Use Readarr's built-in updater or a script
    • Built-In - Use Readarr's own updater
    • Docker - Do not update Readarr from inside the Docker, instead pull a brand new image with the new update
    • Script - Have Readarr run the update script


Backups

Radarr

The backup section allows you to tell Radarr how you would like for it to handle backups

  • Folder - This allows you to select the backup location
    • In docker you will be limited to what you allow the container to see
    • Paths are relative to the appdata folder; if necessary, you can set an absolute path to backup outside of the appdata folder
  • Interval - How often would you like Radarr to make a backup
  • Retention - How long would you like Radarr to hold on to each backup. After a new backup is made the oldest backup will be removed

Sonarr

The backup section allows you to tell Sonarr how you would like for it to handle backups

  • Folder - This allows you to select the backup location
    • In docker you will be limited to what you allow the container to see
    • Paths are relative to the appdata folder; if necessary, you can set an absolute path to backup outside of the appdata folder
  • Interval - How often would you like Sonarr to make a backup
  • Retention - How long would you like Sonarr to hold on to each backup. After a new backup is made the oldest backup will be removed

Lidarr

The backup section allows you to tell Lidarr how you would like for it to handle backups

  • Folder - This allows you to select the backup location
    • In docker you will be limited to what you allow the container to see
    • Paths are relative to the appdata folder; if necessary, you can set an absolute path to backup outside of the appdata folder
  • Interval - How often would you like Lidarr to make a backup
  • Retention - How long would you like Lidarr to hold on to each backup. After a new backup is made the oldest backup will be removed

Readarr

The backup section allows you to tell Readarr how you would like for it to handle backups

  • Folder - This allows you to select the backup location
    • In docker you will be limited to what you allow the container to see
    • Paths are relative to the appdata folder; if necessary, you can set an absolute path to backup outside of the appdata folder
  • Interval - How often would you like Readarr to make a backup
  • Retention - How long would you like Readarr to hold on to each backup. After a new backup is made the oldest backup will be removed


Templates

Retrieved from "https://wikiold.servarr.com/index.php?title=Settings_General&oldid=3502"