Updated the Settings wiki

Updated the Settings wiki

Home.md

@@ -30,7 +30,7 @@
   * [General](/morpheus65535/bazarr/wiki/Settings-General)
   * [Sonarr](/morpheus65535/bazarr/wiki/Settings-Sonarr)
   * [Radarr](/morpheus65535/bazarr/wiki/Settings-Radarr)
-  * [Subtitles](/morpheus65535/bazarr/wiki/Settings-Subliminal)
+  * [Subtitles](/morpheus65535/bazarr/wiki/Settings-Subtitles)
   * [Notifications](/morpheus65535/bazarr/wiki/Settings-Notifications)
 * FAQ's & More
 

Settings-General.md

@@ -1,65 +1,115 @@
-![Settings - General](https://github.com/morpheus65535/bazarr/blob/master/screenshot/5-settings/settings-1-general.png?raw=true)
 ## Start-Up
-### Listening IP address:
-Should be the local IPv4 address of the computer running Bazarr. Leave it as `0.0.0.0` if you want to listen on every available IP address (recommended). If you are running inside a docker container, that's the recommended value.
-### Listening port:
-Should be an available TCP port on the computer running Bazarr. Default is 6767 and is the recommended value.
-### Base URL:
-This option give your the opportunity to serve Bazarr in a sub-directory. Ex.: `http://127.0.0.1:6767/bazarr/` instead of the default `http://127.0.0.1:6767/`
-### Enable debug logging:
-This option enable debug logging and should be enabled for a short period to facilitate debugging process.
-### Enable chmod:
-This option, only available on *nix based operating system, give the possibility to set permission on subtitles file created by Bazarr.
-### Set subtitle file permissions to:
-This field is used to specify the desired permission to be applied on subtitles file. You can take a look at Plex [Linux Permissions Guide](https://support.plex.tv/articles/200288596-linux-permissions-guide/) for reference.
-### Page size:
-Give the opportunity to select how many items are showed on each page.
-## Proxy settings
-### Proxy type:
-Select the desired proxy type from HTTP(S), Socks4 or Socks5.
-### Hostname
-Enter here the hostname of your proxy.
-### Port
-Enter here the TCP port of your proxy.
-### Username
-Enter here the username (if required) to authenticate to your proxy.
-### Password
-Enter here the password (if required) to authenticate to your proxy.
-### Ignored addresses
-Enter here (if required), a list of comma separated hostname or IPv4 addresses to be excluded from going through the proxy.
-## Security settings
-### Authentication:
-Select the type of authentication process desired from basic (browser popup) or forms login. Be aware that basic auth is not secure if not used in conjonction with SSL (using a reverse proxy).
-### Username:
-Enter here the username to access Bazarr.
-### Password:
-Enter here the password to access Bazarr.
-## Integration settings
-### Use Sonarr:
-Enable this option to synchronize series and episodes from Sonarr.
-### Use Radarr:
-Enable this option to synchronize movies from Radarr.
-## Path Mappings for shows:
-You should only use this section if Sonarr and Bazarr use a different path to access the same episode file (.mkv).
+![image-20191224215909111](images/image-20191224215909111.png)
 
-Ex.:
-* Sonarr path to an episode: `/media/tv/seriesX/seasonX/episodeX.mkv`
+#### Listening IP address:
+Should be the local IPv4 address of the computer running Bazarr.
+>**Leave it as `0.0.0.0` if you want to listen on every available IP address (recommended). If you are running inside a docker container, that's the recommended value.**
+
+#### Listening port:
+Should be an available TCP port on the computer running Bazarr. Default is 6767 and is the recommended value.
+
+#### Base URL:
+This option give your the opportunity to serve Bazarr in a sub-directory. Ex.: `http://127.0.0.1:6767/bazarr/` instead of the default `http://127.0.0.1:6767/`
+>Meanly used when you use a reverse proxy, if you don't use a reverse proxy or don't know what it is leave this empty !!!
+
+#### Enable debug logging:
+This option enable debug logging and should be enabled for a short period to facilitate debugging process.
+
+#### Enable chmod:
+This option, only available on *nix based operating system, give the possibility to set permission on subtitles file created by Bazarr.
+
+#### Set subtitle file permissions to:
+This field is used to specify the desired permission to be applied on subtitles file. You can take a look at Plex [Linux Permissions Guide](https://support.plex.tv/articles/200288596-linux-permissions-guide/) for reference or you can use the [Unix Permissions Calculator](http://permissions-calculator.org/).
+
+#### Page size:
+Give the opportunity to select how many items are showed on each page.
+
+## Proxy settings
+![image-20191224221102238](images/image-20191224221102238.png)
+
+#### Proxy type:
+Select the desired proxy type from HTTP(S), Socks4 or Socks5.
+
+#### Hostname:
+Enter here the hostname of your proxy.
+
+#### Port:
+Enter here the TCP port of your proxy.
+
+#### Username:
+Enter here the username (if required) to authenticate to your proxy.
+
+#### Password:
+Enter here the password (if required) to authenticate to your proxy.
+
+#### Ignored addresses:
+Enter here (if required), a list of comma separated hostname or IPv4 addresses to be excluded from going through the proxy.
+
+## Security settings
+![image-20191224221317419](images/image-20191224221317419.png)
+
+#### Authentication:
+Select the type of authentication process desired from basic (browser popup) or forms login. Be aware that basic auth is not secure if not used in conjonction with SSL (using a reverse proxy).
+
+#### Username:
+Enter here the username to access Bazarr.
+
+#### Password:
+Enter here the password to access Bazarr.
+
+#### API Key:
+Your API Key.
+
+## Integration settings
+![image-20191224221436309](images/image-20191224221436309.png)
+
+#### Use Sonarr:
+Enable this option to synchronize series and episodes from Sonarr.
+
+#### Use Radarr:
+Enable this option to synchronize movies from Radarr.
+
+## Path Mappings for shows:
+![](images/image-20191221151155713.png)
+
+>**You should only use this section if Sonarr and Bazarr use a different path to access the same episode file (.mkv).**
+**(for example if you run Sonarr on a different device then Bazarr or have a Synology and mix packages with dockers.)**
+
+Examples:
+* Sonarr path to an episode: `/media/tv_shows/seriesX/seasonX/episodeX.mkv`
 * Bazarr path for the same episode: `\\nas\tv\seriesX\seasonX\episodeX.mkv`
 
 The common part of both path can be discarded and you should use those values:
-### Path for Sonarr:
-`/media/tv/`
-### Path for Bazarr:
-`\\nas\tv\`
+* Path for Sonarr: `/media/tv_shows/`
+* Path for Bazarr: `\\nas\tv\`
+
 ## Path Mappings for movies:
+![image-20191221151339958](images/image-20191221151339958.png)
+
 Same as previous one but for Radarr vs Bazarr.
+
 ## Post-processing
-### Use post-processing:
+![image-20191224221856242](images/image-20191224221856242.png)
+
+#### Use post-processing:
 Enable the execution of a script or binary with arguments after the successful download of a subtitles file.
-### Post-processing command:
+
+#### Post-processing command:
 Enter in this field the script or binary path to execute with the desired arguments. Please be aware that double-quote could be necessary around arguments.
+
 ## Updates
-### Branch (only when running from source):
+> **NOT VISIBLE IN DOCKERS**
+
+![image-20191224222206202](images/image-20191224222206202.png)
+
+#### Branch (only when running from source):
 Select the desired branch from master or development. Be aware that running development branch could result in instabilities.
-### Automatic:
-Install automatically new update when available and display a restart required banner under the menu bar.
+
+#### Automatic:
+Install automatically new update when available and display a restart required banner under the menu bar.
+
+## Analytics
+![image-20191224222423074](images/image-20191224222423074.png)
+
+#### Analytics
+Send anonymous usage information, nothing that can identify you. This includes information on which providers you use, what languages you search for, Bazarr, Python, Sonarr, Radarr and what OS version you are using. We will use this information to prioritize features and bug fixes. Please, keep this enabled as this is the only way we have to better understand how you use Bazarr.

Settings-Notifications.md

@@ -1,3 +1,4 @@
 ![Settings - Notifications](https://github.com/morpheus65535/bazarr/blob/master/screenshot/5-settings/settings-5-notifications.png?raw=true)
 ## Notification settings:
-For each provider, you need to enable it (if desired) and, in the corresponding input field, provide a valid config string as described in Apprise [wiki](https://github.com/caronc/apprise/wiki).
+For each provider, you need to enable it (if desired) and, in the corresponding input field, provide a valid config string as described in Apprise [wiki](https://github.com/caronc/apprise/wiki).
+

Settings-Radarr.md

@@ -1,17 +1,33 @@
-![Settings - Radarr](https://github.com/morpheus65535/bazarr/blob/master/screenshot/5-settings/settings-3-radarr.png?raw=true)
+![image-20191224224330445](images/image-20191224224330445.png)
+
 ## Connection settings
-### Settings validation:
-You have to click the "Test" button after filling in the other fields. You can't save settings until the test is successful.
-### Hostname or IP address:
-Enter the hostname or the IP address of the computer running your Radarr instance. Be aware that when using Bazarr in docker, you cannot reach another container on the same Docker host using the loopback address (ex.: 127.0.0.1). Loopback address refer to the Bazarr Docker container, not the Docker host.
-### Listening port:
+#### Settings validation:
+You have to click the "Test" button after filling in the other fields. You can't go further until the test is successful.
+
+#### Use Radarr:
+Enable this to use Radarr integration. Required if you want to get subtitles for your movies.
+
+#### Hostname or IP address:
+Enter the hostname or the IP address of the computer running your Radarr instance.
+>**Be aware that when using Bazarr in docker, you cannot reach another container on the same Docker host using the loopback address (ex.: 127.0.0.1). Loopback address refer to the Bazarr Docker container, not the Docker host.**
+
+#### Listening port:
 Enter the TCP port of your Radarr instance. Default is 8989.
-### Base URL:
+
+#### Base URL:
 Mainly used by those who expose Radarr behind a reverse proxy (ex.: /radarr). Don't forget the leading slash. In fact, it should look exactly the same as in Radarr settings.
-### SSL enabled:
+Meanly used when you use a reverse proxy, if you don't use a reverse proxy or don't know what it is leave this empty !!!
+
+#### SSL enabled:
 Enable this if your Radarr instance is exposed trough SSL.
-### API key:
+Not needed if you reach it with a local address.
+
+#### API key:
 Enter your Radarr API key here.
+
+#### Download Only Monitored:
+Automatic download of Subtitles will only happen for monitored episodes in Radarr.
+
 ## Synchronization
-### Full sync frequency:
-Choose the frequency used for full refresh of subtitles available on disk.
+#### Full sync frequency:
+Choose the frequency used for full refresh of subtitles available on disk.

Settings-Sonarr.md

@@ -1,17 +1,33 @@
-![Settings - Sonarr](https://github.com/morpheus65535/bazarr/blob/master/screenshot/5-settings/settings-2-sonarr.png?raw=true)
+![image-20191224222937365](images/image-20191224222937365.png)
+
 ## Connection settings
-### Settings validation:
-You have to click the "Test" button after filling in the other fields. You can't save settings until the test is successful.
-### Hostname or IP address:
-Enter the hostname or the IP address of the computer running your Sonarr instance. Be aware that when using Bazarr in docker, you cannot reach another container on the same Docker host using the loopback address (ex.: 127.0.0.1). Loopback address refer to the Bazarr Docker container, not the Docker host.
-### Listening port:
+#### Settings validation:
+You have to click the "Test" button after filling in the other fields. You can't go further until the test is successful.
+
+#### Use Sonarr:
+Enable this to use Sonarr integration. Required if you want to get subtitles for your series.
+
+#### Hostname or IP address:
+Enter the hostname or the IP address of the computer running your Sonarr instance.
+>**Be aware that when using Bazarr in docker, you cannot reach another container on the same Docker host using the loopback address (ex.: 127.0.0.1). Loopback address refer to the Bazarr Docker container, not the Docker host.**
+
+#### Listening port:
 Enter the TCP port of your Sonarr instance. Default is 8989.
-### Base URL:
+
+#### Base URL:
 Mainly used by those who expose Sonarr behind a reverse proxy (ex.: /sonarr). Don't forget the leading slash. In fact, it should look exactly the same as in Sonarr settings.
-### SSL enabled:
+Meanly used when you use a reverse proxy, if you don't use a reverse proxy or don't know what it is leave this empty !!!
+
+#### SSL enabled:
 Enable this if your Sonarr instance is exposed trough SSL.
-### API key:
+Not needed if you reach it with a local address.
+
+#### API key:
 Enter your Sonarr API key here.
+
+#### Download Only Monitored:
+Automatic download of Subtitles will only happen for monitored episodes in Sonarr.
+
 ## Synchronization
-### Full sync frequency:
+#### Full sync frequency:
 Choose the frequency used for full refresh of subtitles available on disk.

Settings-Subtitles.md

@@ -0,0 +1,109 @@
+## Subtitles options
+![image-20191224230002985](images/image-20191224230002985.png)
+
+#### Search for missing Subtitles frequency (in hours):
+Search interval.
+set it to a bigger interval if you got a big/huge library.
+
+#### Use scene name when available:
+Enable this if Sonarr or Radarr are renaming files for you. Scene name is the original filename before renaming. This is going to result in more accurate subtitles.
+
+#### Minimum score for episodes:
+Select the minimal score (in percentage) required for a subtitles file to be downloaded.
+*Are your subs often out of sync raise the score!*
+
+#### Minimum score for movies:
+Select the minimal score (in percentage) required for a subtitles file to be downloaded.
+*Are your subs often out of sync raise the score!*
+
+#### Subtitle Folder:
+Choose the location where you want that your subtitles will be stored, `Alongside Media File` is the recommended value.
+
+#### Upgrade Previously Downloaded Subtitles:
+Upgrade Previously Downloaded Subtitles.
+
+#### Upgrade Frequency (In Hours):
+Schedule a task to upgrade Subtitles previously downloaded by Bazarr.
+
+#### Number of days to go back in history to upgrade Subtitles (up to 30):
+Number of days to go back in history to upgrade Subtitles (up to 30).
+
+#### Upgrade Manually Downloaded Subtitles:
+Enable or disable upgrade of manually searched and downloaded Subtitles.
+
+#### Use embedded subtitles:
+When disabled, this option force Bazarr to not take care of embedded subtitles when deciding if a language is missing.
+
+#### Ignore Embedded PGS Subtitles:
+Ignores PGS Subtitles in Embedded Subtitles detection. Only relevant if 'Use embedded Subtitles' is enabled.
+
+#### Adaptive searching:
+When enabled, Bazarr will search less frequently to limit call to providers.
+this option enables search on a weekly basis for episodes or movies that are unsuccessful after 4 weeks.
+
+#### Search Enabled Providers Simultaneously:
+Search multiple providers at once (Don't choose this on low powered devices)
+
+#### Encode Subtitles To UTF8:
+Re-encode downloaded Subtitles to UTF8. Should be left enabled in most case.
+
+## Anti-Captcha Options
+>***Some providers require a Anti-Captcha when using their API.***
+
+![image-20191224233022948](images/image-20191224233022948.png)
+
+Choose the Anti-Captcha provider you want to use. and add the needed credentials.
+>We recommend Anti-Captcha.
+
+## Subtitles providers
+![image-20191221155333060](images/image-20191221155333060.png)
+
+Select the subtitles providers you would like to enable.
+Hover over the question mark to see which language they support. it's best to select multiple providers and create/use a account with them especially when you got allot of wanted subtitles.
+
+If possible don't forget to support them for their free service*
+
+#### Enabled providers:
+Select the subtitles providers you would like to enable.
+
+#### Subtitles languages
+![image-20191221155809565](images/image-20191221155809565.png)
+
+#### Single Language:
+We don't recommend enabling this option unless absolutely required (ie: media player not supporting language code in subtitles filename).
+Be aware the language code (ex.: en) is not going to be included in the subtitles file name when enabling this.
+**Recommended value is off**
+
+#### Enabled languages:
+Select the languages you want to be able to use in Bazarr. This doesn't add any required languages to series or movies, it just filter out the language list everywhere in the UI to have a more readable drop-down.
+
+## Series default settings
+![image-20191221160456756](images/image-20191221160456756.png)
+
+#### Default enabled:
+Enable the automatic selection of desired languages for new series added **after** the activation of this option.
+
+#### Languages:
+Select the languages to be added to required languages for new series.
+
+#### Hearing-impaired:
+Enable this to require hearing-impaired subtitles instead of standard one.
+
+#### Forced:
+Forced subtitle is the subtitle appearing on screen when the characters speak a foreign or alien language, or there is a sign, location, or other text in a scene.
+
+- Like Drakhari in Game of Thrones.
+- Star Trek when some speaks Klingon.
+
+Values:
+
+- False: Disabled.
+- True: Search for only forced subtitles. (keep in mind that forced sub isn't available in many languages and hard to find).
+- Both: Search for normal subtitles and for forced subtitles. 
+
+Both: Search for normal subtitles and for forced subtitles. 
+
+## Movies default settings
+![image-20191221160533134](images/image-20191221160533134.png)
+
+Same as the one for series.

_Sidebar.md

@@ -31,7 +31,7 @@
   * [General](/morpheus65535/bazarr/wiki/Settings-General)
   * [Sonarr](/morpheus65535/bazarr/wiki/Settings-Sonarr)
   * [Radarr](/morpheus65535/bazarr/wiki/Settings-Radarr)
-  * [Subtitles](/morpheus65535/bazarr/wiki/Settings-Subliminal)
+  * [Subtitles](/morpheus65535/bazarr/wiki/Settings-Subtitles)
   * [Notifications](/morpheus65535/bazarr/wiki/Settings-Notifications)
 
 * FAQ's & More