Updating the wiki

Updating the wiki with to make it more up to date with the latest changes.

First-time-installation-configuration.md

@@ -1,4 +1,8 @@
-## First time installation/configuration
+# First time installation/configuration.
+
+------
+
+
 
 After you installed everything it's best to check all your settings,
 

Home.md

@@ -22,7 +22,7 @@
 **Configuration**
 * Wizard
   * [General](/morpheus65535/bazarr/wiki/Wizard-General)
-  * [Subliminal](/morpheus65535/bazarr/wiki/Wizard-Subliminal)
+  * [Subtitles](/morpheus65535/bazarr/wiki/Wizard-Subtitles)
   * [Sonarr](/morpheus65535/bazarr/wiki/Wizard-Sonarr)
   * [Radarr](/morpheus65535/bazarr/wiki/Wizard-Radarr)
 
@@ -30,11 +30,11 @@
   * [General](/morpheus65535/bazarr/wiki/Settings-General)
   * [Sonarr](/morpheus65535/bazarr/wiki/Settings-Sonarr)
   * [Radarr](/morpheus65535/bazarr/wiki/Settings-Radarr)
-  * [Subliminal](/morpheus65535/bazarr/wiki/Settings-Subliminal)
+  * [Subtitles](/morpheus65535/bazarr/wiki/Settings-Subtitles)
   * [Notifications](/morpheus65535/bazarr/wiki/Settings-Notifications)
 * FAQ's & More
 
-  -  [First time installation/configuration](/morpheus65535/bazarr/wiki/First-time-installation-configuration)
+  *  [First time installation/configuration](/morpheus65535/bazarr/wiki/First-time-installation-configuration)
 ---
 
 **Usage**

Installation-Docker.md

@@ -1,3 +1,9 @@
+# Installation - Docker
+
+------
+
+
+
 >NOTE: I no longer support the official bazarr docker image.
 
 Feel free to use any of the following well maintained images, in no particular order:

Installation-FreeBSD.md

@@ -1,8 +1,15 @@
+# Installation - FreeBSD
+
+------
+
+
+
 Instruction as provided by @Derkades:
 
 Disclaimer: I don't know how rc.d works so the script is pretty crappy and doesn't have start/stop/status functionality. It only starts the program on startup, which was enough for me.
 
-# Installing Bazarr on FreeBSD
+## Installing Bazarr on FreeBSD
+
 * Install the required software `pkg update && pkg install git python27 py27-pip py27-libxml2 py27-libxslt py27-sqlite3`
 * `cd /usr/local`
 * Clone the repository using `git clone https://github.com/morpheus65535/bazarr.git` (this will download the files to `/usr/local/bazarr`)
@@ -12,6 +19,7 @@ Disclaimer: I don't know how rc.d works so the script is pretty crappy and doesn
 * Check if it works `python2.7 bazarr.py`. You should see `BAZARR is started and waiting for request on http://0.0.0.0:6767/`
 
 ## Starting on boot
+
 * `nano /usr/local/etc/rc.d/bazarr`
 * Enter this: 
 ```

Installation-MacOS.md

@@ -1,50 +1,54 @@
-## Running from Source on MacOS
+# Installation - MacOS (from source)
+
+------
+
+
 
 bazarr require Python 2.7.13 or greater (**system Python 2.7.10 or version 3.x not supported**) and can be run from source. This will use *git* as updater, so make sure that it's installed.
 
 How To Install Bazarr on Mac OS 10.14 in Terminal
- 
+
 1. Install Homebrew
 `ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" < /dev/null 2> /dev/null`
- 
+
 2. Install pyenv
 `brew install pyenv-virtualenv`
- 
+
 3. Add Homebrew Directory To Path
 `export PATH="/usr/local/bin:/usr/local/sbin:$PATH"`
- 
+
 4. Install Python 2.7
 `brew install python@2`
- 
+
 5. Add Python 2.7 Directory to Path
 `export PATH="/usr/local/opt/python@2/libexec/bin:$PATH"`
- 
+
 6. Install virtualenv
 `pip install virtualenv`
- 
+
 7. Create A Python 2.7 Virtual Environment
 `virtualenv -p /usr/local/bin/python venv`
- 
+
 8. Activate The Virtual Environment
 `source venv/bin/activate`
- 
+
 9. Change Directory To Applications
 `cd Applications`
- 
+
 10. Get Bazarr
 `git clone https://github.com/morpheus65535/bazarr.git`
- 
+
 11. Change Directory To bazarr
 `cd bazarr`
- 
+
 12. Install bazarr requirements
 `python -m pip install -r requirements.txt`
 
 13. Run bazarr
 `Python bazarr.py`
- 
+
 To Run bazarr in future, open Terminal, Repeat steps 8, 9, 11, 13.
- 
+
 bazarr will run in this Terminal session. Closing session will stop bazarr.
- 
+
 Access bazarr via browser at https://localhost:6767/

Installation-Running-from-Source.md

@@ -1,8 +1,12 @@
-## Running from Source
+# Installation - Running from Source
 
-bazarr require Python 2.7.13 or greater (**version 3.x not supported**) and can be run from source. This will use *git* as updater, so make sure that it's installed.
+------
 
-Windows:
+
+
+bazarr require Python 2.7.13 or greater (**version 3.x not yet supported**) and can be run from source. This will use *git* as updater, so make sure that it's installed.
+
+### Windows:
 
 * Install [GIT](http://git-scm.com/)
 * Install Python 2.7.13 or greater (latest is good) from [this link](https://www.python.org/downloads/release/python-2716/) and make sure to check the box to have Python directory added to the system path variable.
@@ -13,11 +17,11 @@ Windows:
 * You can now start bazarr via `python bazarr.py` to start bazarr.
 * Open your browser and go to `http://localhost:6767/`
 
-OS X:
+### OS X:
 
 * See https://github.com/morpheus65535/bazarr/wiki/Installation-MacOS
 
-Linux:
+### Linux:
 
 * (Ubuntu / Debian) Install [GIT](http://git-scm.com/) with `apt-get install git-core python-pip`
 * (Fedora / CentOS) Install [GIT](http://git-scm.com/) with `yum install git python-pip`

Installation-Windows.md

@@ -1,3 +1,9 @@
+# Installation - Windows
+
+------
+
+
+
 To install Bazarr on Windows 7 or greater, just use our automated installer: [Bazarr installer](https://github.com/bazarr/bazarr.github.io/releases/latest/download/bazarr.zip)
 
 **Please keep in mind that, by default, Bazarr service will run under Local System account that won't be able to access network shares. You need to change the account used for Bazarr service in `services.msc` console.**

LaunchAgent-on-MacOS.md

@@ -1,3 +1,7 @@
+# LaunchAgent on MacOS
+
+------
+
 As-is, the LaunchAgent expects bazarr to be cloned or installed at `/Applications/bazarr`. If this is counter to other documentation I recommend amending the file contents.
 
 You have to be running Python installed through Brew.

Reverse-proxy-Apache.md

@@ -1,10 +1,29 @@
-# Using Apache 2.3.12 or greater and /bazarr/ base url:
-Apache 2.3.12or greater is required to support `AllowEncodedSlashes NoDecode` which is required for Sonarr/Radarr config testing.
+# Reverse Proxy - Apache
 
-    <IfModule mod_ssl.c>
-    <VirtualHost *:443>
+------
+
+
+
+### Using Apache 2.3.12 or greater and /bazarr/ base url:
+
+*Apache 2.3.12 or greater is required to support `AllowEncodedSlashes NoDecode` which is required for Sonarr/Radarr config testing.*
+
+```php
+<IfModule mod_ssl.c>
+<VirtualHost *:443>
+        ServerAdmin webmaster@localhost
         ServerName localhost
-        ProxyPass "/bazarr/ "http://127.0.0.1:6767/bazarr/"
-        ProxyPassReverse "/bazarr/" "http://127.0.0.1:6767/bazarr/"
         AllowEncodedSlashes NoDecode
-        ServerAdmin webmaster@localhost
+
+        <Proxy *>
+                Order deny,allow
+                Allow from all
+                Satisfy Any
+        </Proxy>
+
+    ProxyPass "/bazarr/ "http://127.0.0.1:6767/bazarr/"
+    ProxyPassReverse "/bazarr/" "http://127.0.0.1:6767/bazarr/"
+
+</VirtualHost>
+```
+

Reverse-proxy-Nginx.md

@@ -1,4 +1,10 @@
-# Using Nginx and /bazarr/ base url:
+# Reverse Proxy - Nginx
+
+------
+
+
+
+### Using Nginx and /bazarr/ base url:
 
     location /bazarr/ {
             proxy_pass              http://127.0.0.1:6767/bazarr/;
@@ -10,4 +16,4 @@
             proxy_set_header        Upgrade                 $http_upgrade;
             proxy_set_header        Connection              "Upgrade";
             proxy_redirect off;
-    }
+    }

Wizard-General.md

@@ -1,14 +1,28 @@
-![Wizard - General](https://github.com/morpheus65535/bazarr/blob/master/screenshot/0-wizard/wizard-1-%20general.png?raw=true)
+# Wizzard - General (General Settings)
+
+------
+
 ## 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:
+
+![](images/image-20191221150220886.png)
+
+### 1 - 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.**
+### 2 - Listening port:
+
 Should be an available TCP port on the computer running Bazarr. Default is 6767 and is the recommended value.
-### Base URL:
+### 3 - 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 !!!
+
 ## 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).
-(for example if you run Sonarr on a different device then Bazarr or have a Synology and mix packages with dockers.)
+
+![](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.)**
 
 Ex.:
 * Sonarr path to an episode: `/media/tv_shows/seriesX/seasonX/episodeX.mkv`
@@ -17,5 +31,10 @@ Ex.:
 The common part of both path can be discarded and you should use those values:
 * Path for Sonarr: `/media/tv_shows/`
 * Path for Bazarr: `\\nas\tv\`
+
 ## Path Mappings for movies:
-Same as previous one but for Radarr vs Bazarr.
+
+![image-20191221151339958](images/image-20191221151339958.png)
+
+Same as previous one but for Radarr vs Bazarr.
+

Wizard-Radarr.md

@@ -1,16 +1,26 @@
-![Wizard - Radarr](https://github.com/morpheus65535/bazarr/blob/master/screenshot/0-wizard/wizard-4-radarr.png?raw=true)
+# Wizard - Radarr
+
+------
+
+![image-20191222162338384](images/image-20191222162338384.png)
+
 ## Connection settings
 ### 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.
+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:
 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.
+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.
+Not needed if you reach it with a local address.
+
 ### API key:
 Enter your Radarr API key here.

Wizard-Sonarr.md

@@ -1,16 +1,29 @@
-![Wizard - Sonarr](https://github.com/morpheus65535/bazarr/blob/master/screenshot/0-wizard/wizard-3-sonarr.png?raw=true)
+# Wizard - Sonarr
+
+------
+
+![image-20191222161617957](images/image-20191222161617957.png)
+
 ## Connection settings
+
 ### 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.
+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:
 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.
+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.
+Not needed if you reach it with a local address.
+
 ### API key:
 Enter your Sonarr API key here.

Wizard-Subtitles.md

@@ -0,0 +1,72 @@
+## Wizzard - Subtitles (Subtitles settings)
+
+------
+
+### Subtitles options
+
+![image-20191221153726487](images/image-20191221153726487.png)
+
+#### Subtitle Folder:
+
+Choose the location where you want that your subtitles will be stored, `Alongside Media File` is the recommended value.
+
+##### Use Embendded Subtitles:
+
+Use Embedded Subtitles in media files when determining missing ones.
+
+### 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*
+
+## 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

@@ -23,7 +23,7 @@
 **Configuration**
 * Wizard
   * [General](/morpheus65535/bazarr/wiki/Wizard-General)
-  * [Subliminal](/morpheus65535/bazarr/wiki/Wizard-Subliminal)
+  * [Subtitles](/morpheus65535/bazarr/wiki/Wizard-Subtitles)
   * [Sonarr](/morpheus65535/bazarr/wiki/Wizard-Sonarr)
   * [Radarr](/morpheus65535/bazarr/wiki/Wizard-Radarr)
 
@@ -31,12 +31,12 @@
   * [General](/morpheus65535/bazarr/wiki/Settings-General)
   * [Sonarr](/morpheus65535/bazarr/wiki/Settings-Sonarr)
   * [Radarr](/morpheus65535/bazarr/wiki/Settings-Radarr)
-  * [Subliminal](/morpheus65535/bazarr/wiki/Settings-Subliminal)
+  * [Subtitles](/morpheus65535/bazarr/wiki/Settings-Subtitles)
   * [Notifications](/morpheus65535/bazarr/wiki/Settings-Notifications)
 
 * FAQ's & More
 
-  -  [First time installation
+  *  [First time installation
    and configuration](/morpheus65535/bazarr/wiki/First-time-installation-configuration)