diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/404.html b/404.html new file mode 100644 index 00000000..febcff3f --- /dev/null +++ b/404.html @@ -0,0 +1,1130 @@ + + + +
+ + + + + + + + + + + + + + + + + + +We gathered some info from people that use Bazarr on a low powered device like a RaspberryPi or when you have your media stored in the cloud. +And when you got allot of missing Subtitles.
+Settings
=> Subtitles
=> Automatic Subtitles Synchronization
+To synchronize subtitles, Bazarr may need to extract audio track to detect speech fragments and align subtitles accordingly. It may result in massive network and CPU usage.
+Settings
=> Scheduler
=> Disk Indexing
+Change the settings to Manually to Disable it.
+This means that Bazarr won't scan your drive for existing subtitles and only knows about subtitles that Bazarr added !!!
+Settings
=> Scheduler
=> Search and Upgrade Subtitles
+If you got allot of missing/wanted subtitles change the search frequency to a bigger interval.
+6 - 12/24 Hours could give better results.
++Change this option also if you often see in the logs something like: +
+Execution of job "Update movies list from Radarr (trigger: interval[0:05:00], next run at: 2019-08-04 11:23:44 CEST)" skipped: maximum number of running instances reached (1)
+Settings
=> Subtitles
=> Performance / Optimization
+Enable Adaptive Searching
This setting reduces the searching frequency of specific media files after some time. This prevents searching every x hours for subtitles that may not exist at all for now. Adaptive searching should be (Always) enabled when you have many missing subtitles.
+Settings
=> Subtitles
=> Performance / Optimization
+Disable Use Embedded Subtitles
+Embedded subtitles are subtitles that are in the video container (mkv, mp4, etc)
+Bazarr needs to look inside the video container to know which subtitles are in it this can be resource intensive for some low powered devices and also give you issues with API Limits if you store your media on the cloud.
++This does mean it will ignore the embedded subtitles and will search for matching subtitles but that uses less resources.
+
Disable this option if you use a low performance device. +Example a RaspberryPi.
+Starting with v1.1.5-beta.8, Bazarr can be configured to use Postgres as database engine
+First, we need a Postgres instance. This guide is written for usage of the postgres:14 Docker image, but earlier version can be used if it's version >= 9.
+Do not even think about using the latest tag!
+docker create --name=postgres14 \
+ -e POSTGRES_PASSWORD=_<postgres_password>_ \
+ -e POSTGRES_USER=_<postgres_username>_ \
+ -e POSTGRES_DB=bazarr \
+ -p 5432:5432/tcp \
+ -v /path/to/appdata/postgres14:/var/lib/postgresql/data \
+ postgres:14
+
Bazarr needs one database. For example: bazarr
You can give the databases any name you want but make sure config.ini file has the correct names.
+Bazarr will not create the databases for you. Make sure you create it with your favourite tool before trying to start Bazarr.
+We need to tell Bazarr to use Postgres. The config.ini should already be populated with the entries we need:
+[postgresql]
+enabled = True
+host = localhost
+port = 5432
+database = bazarr
+username = _<postgres_username>_
+password = _<postgres_password>_
+
Alternatively you may use the environment variables POSTGRES_ENABLED
, POSTGRES_HOST
, POSTGRES_PORT
, POSTGRES_DATABASE
, POSTGRES_USERNAME
and POSTGRES_PASSWORD
. These take precedence over the config.ini
settings.
If you do not want to migrate an existing SQLite database to Postgres then you have already reached the end of this guide and you can simply start Bazarr!
+Once the database has been created, you can start the Bazarr migration from SQLite to Postgres. Make sure that your SQLite database has been used with Bazarr 1.1.5 or greater prior to migration.
+To migrate data we can use PGLoader. It does, however, have some gotchas:
+Before starting a migration please ensure that you have run Bazarr against the previously created Postgres databases at least once successfully.
+Begin the migration by doing the following:
+DELETE FROM "system" WHERE 1=1;
+DELETE FROM "table_settings_languages" WHERE 1=1;
+DELETE FROM "table_settings_notifier" WHERE 1=1;
+
Start the migration by using either of these options:
+with docker:
+docker run --rm -v /absolute/path/to/bazarr.db:/bazarr.db --network=host ghcr.io/roxedus/pgloader --with "quote identifiers" --with "data only" --cast "column table_blacklist.timestamp to timestamp" --cast "column table_blacklist_movie.timestamp to timestamp" --cast "column table_history.timestamp to timestamp" --cast "column table_history_movie.timestamp to timestamp" /bazarr.db "postgresql://_<postgres_username>_:_<postgres_password>_@hostname:5432/bazarr"
+
without docker:
+pgloader --with "quote identifiers" --with "data only" --cast "column table_blacklist.timestamp to timestamp" --cast "column table_blacklist_movie.timestamp to timestamp" --cast "column table_history.timestamp to timestamp" --cast "column table_history_movie.timestamp to timestamp" /bazarr.db "postgresql://_<postgres_username>_:_<postgres_password>_@hostname:5432/bazarr"
+
You can now start Bazarr with Postgres support without losing anything in the process!
+ + + + + + + + + + + + + + + + + + + + + + +server {
+ # other code here
+
+ # Increase http2 max sizes
+ large_client_header_buffers 4 16k;
+}
+
location /bazarr/ {
+ proxy_pass http://127.0.0.1:6767/bazarr/;
+ proxy_set_header X-Real-IP $remote_addr;
+ proxy_set_header Host $http_host;
+ proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+ proxy_set_header X-Forwarded-Proto $scheme;
+ proxy_http_version 1.1;
+ proxy_set_header Upgrade $http_upgrade;
+ proxy_set_header Connection "Upgrade";
+ proxy_redirect off;
+ # Allow the Bazarr API through if you enable Auth on the block above
+ location /bazarr/api {
+ auth_request off;
+ proxy_pass http://127.0.0.1:6767/bazarr/api;
+ }
+}
+
++Apache 2.3.12 or greater is required to support
+AllowEncodedSlashes NoDecode
which is required for Sonarr/Radarr config testing.
<IfModule mod_ssl.c
+<VirtualHost *:443
+ ServerAdmin webmaster@localhost
+ ServerName localhost
+ AllowEncodedSlashes NoDecode
+
+
+ <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
+
++Note: The default buffer_size is 4096, double that seems to fix any loading issues with Bazarr.
+
access_control:
+ default_policy:
+ rules:
+ - domain:
+ - bazarr.<domain>.com
+ resources:
+ - '^/api/.*$'
+ policy: bypass
+
+server:
+ read_buffer_size: 8192
+ write_buffer_size: 8192
+ path: authelia
+
Use the LinuxServer SWAG container, it has already pre-configured .conf
files for subfolder and subdomain to make is easy.
THIS SECTION IS OUTDATED AND STILL NEEDS TO GET UPDATED !!!
+ +Valid IP4 address or '0.0.0.0' for all interfaces
+++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.
Should be an available TCP port on the computer running Bazarr. Default is 6767 and it is the recommended value.
+This option gives you 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/
Mainly 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!!!
+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 conjunction with SSL (using a reverse proxy).
+Enter here the username to access Bazarr.
+Enter here the password to access Bazarr.
+Your API Key.
+Select the desired proxy type from HTTP(S), Socks4 or Socks5.
+Enter here the hostname of your proxy.
+Enter here the TCP port of your proxy.
+Enter here the username (if required) to authenticate to your proxy.
+Enter here the password (if required) to authenticate to your proxy.
+Enter here (if required), a list of comma separated hostname or IPv4 addresses to be excluded from going through the proxy.
+Self explanatory.
+This option enables debug logging and should be enabled for a short period to facilitate debugging process.
+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.
+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 or localhost). Loopback address refer to the Bazarr Docker container, not the Docker host.
+
Enter the TCP port of your Sonarr instance. Default is 8989.
+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. Mainly 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 this if your Sonarr instance is exposed trough SSL.
+++Not needed if you reach it with a local IP address.
+
Enter your Sonarr API key here.
+++Click the
+Test
button after filling in all the fields. Make sure the test is successful before you proceed.
Select the minimal score (in percentage) required for a subtitles file to be downloaded. Are your subs often out of sync? Raise the score!
+Automatic download of Subtitles will only happen for monitored shows/episodes in Sonarr.
+Episodes from series with those tags (case sensitive) in Sonarr will be excluded from automatic download of Subtitles.
+In Sonarr you add a custom made tag to a show, in this case the shows with these tags will be ignored by Bazarr. examples: dutch
, anime
Episodes from series with those types in Sonarr will be excluded from automatic download of Subtitles. +Options: Standard, Anime, Daily
+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 Docker.)
++ ++IF YOU GOT THE SAME VALUES ON BOTH SIDES THEN YOU DON'T NEED IT !!! +IT SHOULD ALSO BE REMOVED OR ELSE YOU WILL GET A ERROR.
+ +
Click on Add
and you will get a popup window
+
Ex.:
+/media/tv_shows/seriesX/
The common part of both path can be discarded and you should use those values:
+/media/tv_shows/
\\nas\tv\
++If everything runs on Docker you normally don't need to use this. Except if you have messed up path mappings and then it would be smarter to fix those first to have consistency and well planned paths.
+
The same setup as you did for Sonarr except for the default Port Number: 7878
+Choose the location where you want your subtitles to be stored, Alongside Media File
is the recommended value.
Schedule a task to upgrade Subtitles previously downloaded by Bazarr.
+Number of days to go back in history to upgrade Subtitles (up to 30).
+Enable or disable the upgrade of manually searched and downloaded subtitles.
+Some providers require a Anti-Captcha when using their API.
+ +Choose the Anti-Captcha provider you want to use. and add the necessary credentials.
+++We recommend Anti-Captcha.com.
+
When enabled, Bazarr will search less frequently to limit API calls to providers. +This option enables search on a weekly basis for episodes or movies that are unsuccessful after 4 weeks.
+Search multiple providers at once (Don't choose this on low powered devices)
+When disabled, this option forces Bazarr to not take care of embedded subtitles when deciding if a language is missing.
+When enabled you several extra options
+ +When enabled it Ignores PGS Subtitles in Embedded Subtitles
detection. Only relevant if Use embedded Subtitles
is enabled.
When enabled it hides embedded subtitles for languages that are not wanted.
+Re-encode downloaded Subtitles to UTF8. Should be left enabled in most cases.
+This option,it is only available on *nix based operating systems, gives the possibility to set permissions on subtitle files created by Bazarr.
+Enable the subtitles synchronization after downloading a subtitles.
+Only synchronize the subtitles if the score is below your chosen score.
+Only synchronize the subtitles if the score is below your chosen score.
+Enable the post-processing execution after downloading a subtitles.
+Only runs Post-processing if the score is below your chosen score.
+Only runs Post-processing if the score is below your chosen score.
+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.
+Be aware that your command cannot start or end with quote/double-quote. You must append something like 2>&1
to the end of your command.
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
+
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.
+Enable the automatic selection of desired languages for new series added after the activation of this option.
+Select the languages to be added to required languages for new series.
+Enable this to require hearing-impaired subtitles instead of standard one.
+Forced subtitles are the subtitles appearing on screen when the characters speak a foreign or alien language, or there is a sign, location, or other text in the scene.
+Values:
+Same as for series.
+Select the subtitles providers you would like to enable. It is best to select multiple providers and create/use a account with them especially when you have a lot of wanted subtitles. +Some subtitle providers requires a extra paid Anti-Captcha Service.
+++If possible don't forget to support them for their free service
+
For each notification provider, you need to enable (if desired) and, in the corresponding input field, provide a valid config string as described in Apprise wiki.
+How often to sync with Sonarr for new Series
+How often to sync with Sonarr for new Episodes
+How often to sync with Radarr for new Movies
+How often should Bazarr Update all Episodes Subtitles from disk
+Which day of the week
+Which hour of the day
+Same as series
+How often should Bazarr Search for Missing Series Subtitles
+How often should Bazarr Search for Missing Movies Subtitles
+How often should Bazarr upgrade previously downloaded Subtitles
+ + + + + + + + + + + + + + + + + + + + + + +Webhooks can be configured to POST a JSON payload to the specified URL on multiple events.
+You can find your Bazarr API KEY in Settings
=> General
=> Security
Note
+Keep in mind Plex Webhooks is a Plex Pass perk
+The URL provided will filter out events and if it got a media.play
or media.resume
event, it will search for missing subtitles for the episode or movie being played. you'll have to stop it and resume it for Plex to update the available subtitles.
Windows => http://localhost:6767/api/webhooks/plex?apikey=YOUR_BAZARR_API_KEY
+Docker => http://bazarr:6767/api/webhooks/plex?apikey=YOUR_BAZARR_API_KEY
Settings
=> Webhooks
=> click on ADD WEBHOOK
On the top right click on the Settings
icon, and on the left sidebar select Webhooks
+Click on the middle of the screen on and add the following info.
SAVE CHANGES
Note: Whisper is capable of transcribing many languages, but can only translate a language into English. It does not support translating to other languages.
+Whisper (based on OpenAI Whisper) uses a neural network powered by your CPU or NVIDIA graphics card to generate subtitles for your media.
+Whisper supports transcribing in many languages as well as translating from a language to English. The provider works best when it knows the audio language ahead of time. Make sure the 'Deep analyze media file to get audio tracks language' option is enabled to ensure the best results.
+Minimum score must be lowered if you want whisper generated subtitles to be automatically "downloaded" because they have a fixed score which is 241/360 (~67%) for episodes and 61/120 (~51%) for movies.
+Bazarr's Whisper provider communicates with ahmetoner/whisper-asr-webservice. Refer to its documentation for more assistance in setting it up.
+Larger models are more accurate but take longer to run. Choose the largest model you are comfortable with and your CPU/GPU is capable of running.
+Available ASR_MODELs are tiny
, base
, small
, medium
, large
(only OpenAI Whisper), large-v1
, large-v2
and large-v3
(only OpenAI Whisper for now).
whisper-asr-webservice supports multiple backends. Currently, there are two available options:
+Change ASR_MODEL to use the model you like, and change ASR_ENGINE to select the backend.
+docker run -d -p 9000:9000 -e ASR_MODEL=small -e ASR_ENGINE=faster_whisper onerahmet/openai-whisper-asr-webservice:latest
+
---
+version: "2.1"
+services:
+ whisperasr:
+ image: onerahmet/openai-whisper-asr-webservice:latest
+ environment:
+ - ASR_MODEL=small
+ - ASR_ENGINE=faster_whisper
+ ports:
+ - 9000:9000
+ restart: unless-stopped
+
docker run -d --gpus all -p 9000:9000 -e ASR_MODEL=small -e ASR_ENGINE=faster_whisper onerahmet/openai-whisper-asr-webservice:latest-gpu
+
---
+version: "2.1"
+services:
+ whisperasr:
+ image: onerahmet/openai-whisper-asr-webservice:latest-gpu
+ environment:
+ - ASR_MODEL=small
+ - ASR_ENGINE=faster_whisper
+ ports:
+ - 9000:9000
+ deploy:
+ resources:
+ reservations:
+ devices:
+ - driver: nvidia
+ count: 1
+ capabilities: [gpu]
+ restart: unless-stopped
+
You can run the ASR container on your Windows PC. This is especially useful if its your only way to get access to a powerful GPU. Follow these instructions for more information.
+Change the endpoint to the server you are hosting the Whisper container on (127.0.0.1 if on the same machine), and adjust the timeout if you find it keeps timing out on long movies or TV shows. The endpoint must start with http://
+ +When Bazarr doesn't know the language of the media you're trying to get subtitles for, Whisper must guess. It only uses the first 30 seconds of audio in order to detect the language. To ensure best results, use media which has the audio language specified in the file, and make sure the deep analyze option is turned on.
+Bazarr's implementation of Whisper is still in early stages. If you have any issues, follow these instructions:
+Attention
+In any case, the user must have a home directory!!!
+Note
+Be aware that this is provided as-is without any support from the team.
+This is a systemd service file created by users of Bazarr. It assumes you've installed Bazarr in: /opt/bazarr
.
You have to create a bazarr.service
file in /etc/systemd/system
:
sudo nano /etc/systemd/system/bazarr.service
+
Copy and paste the following text to the service file:
+[Unit]
+Description=Bazarr Daemon
+After=syslog.target network.target
+
+# After=syslog.target network.target sonarr.service radarr.service
+
+[Service]
+WorkingDirectory=/opt/bazarr/
+User=your_user(username of your choice)
+Group=your_group(group of your choice)
+UMask=0002
+Restart=on-failure
+RestartSec=5
+Type=simple
+ExecStart=/usr/bin/python3 /opt/bazarr/bazarr.py
+KillSignal=SIGINT
+TimeoutStopSec=20
+SyslogIdentifier=bazarr
+ExecStartPre=/bin/sleep 30
+
+[Install]
+WantedBy=multi-user.target
+
Start the service:
+sudo systemctl start bazarr
+
Check if the service is running:
+sudo systemctl status bazarr
+
If it's running without errors then you need to enable the service:
+sudo systemctl enable bazarr
+
This is an init upstart file. It assumes you've installed Bazarr in: /opt/bazarr
You have to create a bazarr.conf
file in /etc/init/
(sudo nano /etc/init/bazarr.conf
) that would contain the following text:
description "Upstart Script to run Bazarr as a service on Ubuntu/Debian based systems, as well as others"
+author "A Bazarr User"
+
+#Set user and group for the process if desired
+#setuid myUserID
+#setgid myGroupID
+
+#start after all services come up
+start on runlevel [2345]
+stop on runlevel [016]
+
+# Automatically restart process if crashed
+
+respawn
+
+# Make sure script is started with system locale
+
+script
+ if [ -r /etc/default/locale ]; then
+ . /etc/default/locale
+ export LANG
+ fi
+ exec python /opt/bazarr/bazarr.py
+end script
+
Install Bazarr following the instructions
+From terminal:
+cd /Users/<user name>/Library/LaunchAgents
+nano com.github.morpheus65535.bazarr.plist
+
Paste the following into the document and change the location of the logs to /Users/<user_name>/
:
<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+ <dict>
+ <key>Label</key>
+ <string>com.github.morpheus65535.bazarr</string>
+ <key>ProgramArguments</key>
+ <array>
+ <string>/usr/local/bin/python3.8</string>
+ <string>/Applications/bazarr/bazarr.py</string>
+ </array>
+ <key>RunAtLoad</key>
+ <true/>
+ <key>KeepAlive</key>
+ <true/>
+ <key>StandardErrorPath</key>
+ <string>/usr/local/var/log/bazarr.log</string>
+ <key>StandardOutPath</key>
+ <string>/usr/local/var/log/bazarr.log</string>
+ </dict>
+</plist>
+
Save the document. You should receive a notification that “_Software from ‘Ned Daily’ added items that can run in the background”. This is totally normal.
+To verify everything works, run to start Bazarr: launchctl load /Users/<user name>/Library/LaunchAgents/com.github.morpheus65535.bazarr.plist
+Run to stop Bazarr: launchctl unload /Users/<user name>/Library/LaunchAgents/com.github.morpheus65535.bazarr.plist
No more terminal work!
+launchctl load /Users/<user name>/Library/LaunchAgents/com.github.morpheus65535.bazarr.plist
http://localhost:6767
in your browser to testInfo
+If you used the installer then it's already set to autostart.
+If you installed it in another way in windows you can use the following.
+Download the latest NSSM from https://nssm.cc/download. It is recommended to grab the prerelease due to a slight issue with the Windows 10 Creators Update.
+Either place the downloaded NSSM binary in C:\Windows\System32
, or add it to your PATH
. This is to allow you to use NSSM from any location.
Run cmd
as an Administrator and use the command nssm install bazarr
A GUI should pop up. Use the following configuration
+C:\Python38\python.exe
Python38
folder. Example: C:\Python38
bazarr.py
file. Example: C:\bazarr\bazarr.py
Warning
+Please note that running Bazarr from the Program Files
or Program Files (x86)
directories may cause issues.
Under Process Tab
, make sure to uncheck Console Windows
.
Click the Install Service
button
Use the command nssm start bazarr
to initiate bazarr. It should autostart going forward.
nssm edit bazarr
will open up the GUI for further edits.nssm restart bazarr
will restart bazarr.nssm stop bazarr
will stop bazarr.nssm remove bazarr
will remove the Windows Service.Note
+This guide will work in essence for any Python script, and you can use NSSM to run most things as Windows Services through some tweaking of this overall config.
+After you've installed everything it's best to check all of your settings,
+Attention
+Bazarr only searches for subs for Episodes and Movies that are added after the install.
+So you will need to set the preferred languages for your existing Shows and Movies.
+In this example I will show you how to do that with the series.
+ +click on Mass Edit
Save
.Then go back to your Movies home screen and do the same for your Movies. +If you've done it correctly you will get something that looks like the following screenshot with your preferred languages.
+ + + + + + + + + + + + + + + + + + + + + + + +Warning
+You CANNOT store your config directory over an NFS share as it is unsupported by SQLITE. You'll face a locked database error.
+Feel free to use any of the following well maintained images, in no particular order:
+latest
(=stable
), nightly
stable-0.8.3.4
, nightly-0.9.4-beta.18
every 30 minutes for apps and every hour for upstream image updates
/config
.hotio/bazarr:latest
+
latest
and development
v0.8.3.4-ls59
and 600ef3ab-ls62
Updates: regular and timely application updates
Configuration files for Bazarr are stored in /config
.
Info
+For more info on how to configure the images, info about their used tags and their correlation to bazarr branches, visit their respective Docker pages.
+linuxserver/bazarr
+
Make sure you use /latest pkg repository
+/latest
and not /quarterly
/usr/local/etc/pkg/repos/FreeBSD.conf
/etc/pkg/FreeBSD.conf
to that location, open it, and replace quarterly
with latest
Install the required software:
+pkg update && pkg install bazarr
+
Enable bazarr during startup
+echo 'bazarr_enable="YES"' >> /etc/rc.conf
+
Start bazarr
+/usr/local/etc/rc.d/bazarr start
+
Please see the autostart page for rc configuration instructions.
+ + + + + + + + + + + + + + + + + + + + + + +Before 24.04:
+apt-get install 7zip python3-dev python3-pip python3-distutils unrar unzip
+
Since 24.04:
+apt-get install 7zip python3-dev python3-pip python3-setuptools unrar unzip
+
yum install python3-devel python3-pip python3-distutils
+
thnx to @inquilino for the fixes/updates
+sudo apt-get update
+sudo apt-get install libxml2-dev libxslt1-dev python3-dev python3-libxml2 python3-lxml unrar-free ffmpeg libatlas-base-dev
+
Download latest release of Bazarr here
+wget https://github.com/morpheus65535/bazarr/releases/latest/download/bazarr.zip
+
Create the bazarr
directory
sudo mkdir /opt/bazarr
+
Extract the content of the zipped release to the previously created bazarr
directory
sudo unzip bazarr.zip -d /opt/bazarr
+
cd into /opt/bazarr
+cd /opt/bazarr
+
Install the Python requirements:
+python3 -m pip install -r requirements.txt
+
If you run into an error like this one:
+error: externally-managed-environment
+
+× This environment is externally managed
+╰─> To install Python packages system-wide, try apt install
+ python3-xyz, where xyz is the package you are trying to
+ install.
+
+ If you wish to install a non-Debian-packaged Python package,
+ create a virtual environment using python3 -m venv path/to/venv.
+ Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make
+ sure you have python3-full installed.
+
+ If you wish to install a non-Debian packaged Python application,
+ it may be easiest to use pipx install xyz, which will manage a
+ virtual environment for you. Make sure you have pipx installed.
+
+ See /usr/share/doc/python3.12/README.venv for more information.
+
+note: If you believe this is a mistake, please contact your Python
+installation or OS distribution provider. You can override this, at
+the risk of breaking your Python installation or OS, by passing
+--break-system-packages.
+hint: See PEP 668 for the detailed specification.
+
Disable EXTERNALLY-MANAGED flag using this command before retrying Python requirements installation or consider using venv instead:
+find / -type f -name EXTERNALLY-MANAGED -execdir mv {} EXTERNALLY-MANAGED.bkp \;
+
Note
+(Raspbian) Don't worry about lxml
not being installed at this step, you have installed the module through apt-get
anyway.
Older Raspberry Pi (ARMv6)
+On ARMv6 devices (e.g. older Raspberry Pis, find out with uname -m
), numpy
installed from pip might contain instruction set that is not compatible with the architecture (Ref). The solution is to replace it with the version from apt repository:
python3 -m pip uninstall numpy
+sudo apt-get install python3-numpy
+
Change ownership to your preferred user for running programs (replace both instances of $USER
, or leave it to change ownership to current user)
sudo chown -R $USER:$USER /opt/bazarr
+
You can now start bazarr using the following command:
+python3 bazarr.py
+
Open your browser and go to http://localhost:6767/
+Please see the autostart page for systemd/upstart configuration instructions.
+ + + + + + + + + + + + + + + + + + + + + + +bazarr requires Python 3.8 or greater and can be run from source.
+bazarr
directory in your /Applications directoryOpen Terminal and change directory to /Applications/bazarr
:
cd /Applications/bazarr
+
Install bazarr requirements:
+python3.8 -m pip install -r requirements.txt
+
Run bazarr:
+python3.8 bazarr.py
+
bazarr will run in this Terminal session. Closing the session will stop bazarr. You can start it up again using steps 5 and 7.
+Access bazarr via browser at http://localhost:6767/
+Please see the autostart page for launch agents configuration instructions.
+ + + + + + + + + + + + + + + + + + + + + + +It is recommended to run Bazarr with docker when your NAS supports it. A package is also available from SynoCommunity: https://synocommunity.com/package/bazarr.
+We will try to explain the basics how to setup Bazarr on Synology with Docker.
+Tip
+Depending if you're smart and decide switch everything to Docker then you're done after this guide.
+If you decide to mix packages with docker you will need to mess with Path Mappings.
+In order for the Docker container to access the shares on the Synology, +we need to give it the same permissions as your main user who has access to those shares. +For this we need to figure out the PUID and the PGID of the user having access to your shares.
+You will need to SSH into your Synology. +If you didn't already enable it you need to do that first +
+Then use a program like Putty and SSH to your Synology.
+Login if you get a popup asking if you want to trust the key,
+Just press OK
or ACCEPT
Enter the login information of your main Synology user account.
+ +Once logged in type:
+id
+
This will show your UID (aka PUID).
+Which in this screenshot is 1026
and the GID (aka PGID) which is 101
for the administrator.
Remember these values for later use.
+Info
+yes we know it's not recommended to use the admin account but if you already know this then you wouldn't need to read this ;)
+Install(if you didn't do that already) and open docker.
+ +Select Registry
and type bazarr
in the search bar.
+We recommend to use one of the following 2 images.
+linuxserver/bazarr
or hotio/bazarr
.
+For this example I will use the hotio/bazarr
.
+Then you will get a popup asking which Tag you want to use.
+select latest
for the stable build.
+
or select nightly
if you want to use the dev version.
+
In this example I will use the dev build.
+Then on the left select Image
and wait till it's loaded you can see when it's done where the arrow is pointed and it stops building.
+
Then double click on the created image.
+bazarr
).Advanced Setttings
Select Enable auto-restart
if you want Bazarr to autostarts.
Click on Add Folder
Create a folder named config
and create in that folder a folder called bazarr
.
+This will be used for the database, config and log files.
Also add your tv
and your movies
folder locations,
+In this Guide we used the preferred path setup that's why we used /data/media
.
Change the local port
from automatic
to the official port 6767
.
Now we need to add the PUID
and PGID
that we wrote down earlier.
+If you don't have the PUID
and PGID
option as variable then add it yourself.
Then click Apply
and Next
.
Recheck your setting and click on Apply
.
Select on the left Container
and you can see if it's running.
Now you can access the Bazarr docker container by typing in your browser +http://your_synology_ip_or_your_synology_hostname:6767 +and then follow the Setup-Guide.
+First create a config
folder in your docker
folder and create a bazarr
folder in it.
+Then you ssh into your Synology and you type one of the the following depending which image you want to use.
hotio/bazarr
+sudo docker run -d --name bazarr -v /volume1/docker/config/bazarr:/config -v /volume1/data/media:/data/media -e PUID=1026 -e PGID=101 -p 6767:6767 hotio/bazarr:latest
+
linuxserver/bazarr
+sudo docker run -d --name bazarr -v /volume1/docker/config/bazarr:/config -v /volume1/data/media:/data/media -e PUID=1026 -e PGID=101 -p 6767:6767 linuxserver/bazarr:latest
+
hotio/bazarr
+sudo docker run -d --name bazarr -v /volume1/docker/config/bazarr:/config -v /volume1/data/media:/data/media -e PUID=1026 -e PGID=101 -p 6767:6767 hotio/bazarr:nightly
+
linuxserver/bazarr
+sudo docker run -d --name bazarr -v /volume1/docker/config/bazarr:/config -v /volume1/data/media:/data/media -e PUID=1026 -e PGID=101 -p 6767:6767 linuxserver/bazarr:nightly
+
Extra info:
+--name bazarr
= Container name.-v /volume1/docker/config/bazarr:/config
= Your path to your config location.-v /volume1/data/media:/data/media
= Your path to your tv shows/series and movies.-e PUID=1026
= Your PUID (that we found earlier).-e PGID=101
= Your PGID (that we found earlier).-p 6767:6767
= The ports Bazarr is going to use.hotio/bazarr:xxx
= Which image and build is going to be used.For his Wiki/Guide I used the following sources being that I don't have a Synology myself.
+ + + +Docker Guide (thnx to @fryfrog)
+Help from some Synology users on the Discord Server.
+ + + + + + + + + + + + + + + + + + + + + + +To install Bazarr on Windows 8 or greater, just use our automated installer: Bazarr installer
+Attention
+Please keep in mind that, by default, the 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 or nssm edit
. Once that's done, delete %PROGRAMDATA\Bazarr
and restart the service (via the console or nssm restart
.
Warning
+Bazarr is running as a Windows service. Microsoft Windows doesn't support using mapped network drives for process running as a service. You must either switch to UNC path for your Sonarr/Radarr root folders or use Bazarr path mapping to circumvent that.
+Info
+If you install Bazarr in the Program Files
directory, the account under which it runs must have administrative privileges for Bazarr to be able to update itself.
Bazarr settings, logs and db are stored in C:\ProgramData\Bazarr
. Keep in mind you'll need to change permission on this directory if you change Bazarr service account to something else than System.
The start menu shortcut (it opens the web UI) won't work anymore if you change Bazarr listening port or IP address.
+ + + + + + + + + + + + + + + + + + + + + + +bazarr requires Python 3.8 or greater and can be run from source.
+Open up CMD and go to the folder you want to install bazarr.
+Attention
+Do not use C:\Program Files
or C:\Program Files (x86)
as you could run into strange issues. Something like C:\bazarr
is a better choice.
Download the latest release of Bazarr here
+bazarr
directoryGo to the bazarr folder:
+cd bazarr
+
Install Python requirements using:
+pip install -r requirements.txt
+
You can now start bazarr with the following command:
+python bazarr.py
+
Open your browser and go to http://localhost:6767/
+Please see the autostart page for service installation instructions.
+ + + + + + + + + + + + + + + + + + + + + + +Here you will find a collection of Installation Guides.
+Choose on the left your Operating System.
+ + + + + + + + + + + + + + + + + + + + + + +Note
+In this guide we will try to explain the basic setup you need to do to get started with Bazarr. +For a more detailed few of all the setting check the following [LINK].
+Before Bazarr works we need to setup and configure a few settings.
+After installation and starting up, you open a browser and go to http://ip_where_installed:6767.
+First we're going to setup Sonarr.
+Settings
=> Sonarr
Click on Enabled
Enter the hostname or the IP address of the computer running your Sonarr instance.
+Info
+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 or localhost). Loopback address refer to the Bazarr Docker container, not the Docker host.
+Enter the TCP port of your Sonarr instance. Default is 8989.
+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. Mainly used when you use a reverse proxy.
+Info
+If you don't use a reverse proxy or don't know what it is leave this empty !!!
+Enter your Sonarr API key here.
+Enable this if your Sonarr instance is exposed trough SSL.
+Info
+Not needed if you reach it with a local IP address.
+Click the Test
button after filling in all the fields. Make sure the test is successful before you proceed.
Select the minimum score (in percentage) required for a subtitles file to be downloaded.
+Info
+Are your subs often out of sync or just bad? Raise the score!
+Episodes from series with those tags (case sensitive) in Sonarr will be excluded from automatic download of Subtitles. In Sonarr you add a custom tag to a show, in this case the shows with these tags will be ignored by Bazarr.
+Episodes from series with these types in Sonarr will be excluded from automatic download of Subtitles.
+Options: Standard
, Anime
, Daily
Automatic download of Subtitles will only happen for monitored shows/episodes in Sonarr.
+Note
+You should only use this section if Sonarr and Bazarr use a different path to access the same files.
+(for example if you run Sonarr on a different device then Bazarr or have a Synology and mix packages with Docker.)
+Click on Add
and you will get a extra option
Attention
+IF YOU GOT THE SAME VALUES ON BOTH SIDES THEN YOU DON'T NEED IT !!!
+IT SHOULD ALSO BE REMOVED OR ELSE YOU WILL GET A ERROR.
+Info
+If everything runs on Docker you normally don't need to use this except if you got messed up paths and then it would be smarter to fix those first to have consistent and well planned paths.
+Please take a look at TRaSH's Hardlink Tutorial https://trash-guides.info/hardlinks
+Next we're going to setup Radarr.
+Settings
=> Radarr
Click on Enabled
Enter the hostname or the IP address of the computer running your Radarr instance.
+Info
+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 or localhost). Loopback address refer to the Bazarr Docker container, not the Docker host.
+Enter the TCP port of your Radarr instance. Default is 7878.
+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.
+Info
+If you don't use a reverse proxy or don't know what it is leave this empty !!!
+Enter your Radarr API key here.
+Enable this if your Radarr instance is exposed trough SSL.
+Info
+Not needed if you reach it with a local IP address.
+Click the Test
button after filling in all the fields. Make sure the test is successful before you proceed.
Select the minimum score (in percentage) required for a subtitles file to be downloaded.
+Info
+Are your subs often out of sync or just bad? Raise the score!
+Movies with those tags (case sensitive) in Radarr will be excluded from automatic download of Subtitles, In Radarr you add a custom tag to a movie.
+Automatic download of Subtitles will only happen for monitored movies in Radarr.
+Note
+You should only use this section if Radarr and Bazarr use a different path to access the same files.
+(for example if you run Radarr on a different device then Bazarr or have a Synology and mix packages with Docker.)
+Click on Add
and you will get a extra option
Attention
+IF YOU GOT THE SAME VALUES ON BOTH SIDES THEN YOU DON'T NEED IT !!!
+IT SHOULD ALSO BE REMOVED OR ELSE YOU WILL GET A ERROR.
+Info
+If everything runs on Docker you normally don't need to use this except if you got messed up paths and then it would be smarter to fix those first to have consistent and well planned paths.
+Please take a look at TRaSH's Hardlink Tutorial https://trash-guides.info/hardlinks
+Here we're going to configure which subtitle languages you prefer/want.
+Settings
=> Languages
Warning
+**We don't recommend enabling Single Language
option unless absolutely required (ie: media player not supporting language code in subtitles filename). Results may vary.
Be aware the language code (ex.: en) is not going to be included in the subtitles file name when enabling this.**
+Here you select which languages you want for your subtitles, you can just start typing your language name and it will show you what's available.
+These languages are the subtitle languages you later use for the Languages Profiles
In this example I selected Dutch
and English
.
Select Add New Profile
Add
to add the languages you enabled earlier in Subtitle Language.So you can have a profile that states: English, Dutch, German, French +With cutoff Dutch, if it finds Dutch, it will download it and call it a day. +If no Dutch is found it will continue searching the other languages till Dutch is found.
+Automatic applied Languages Profiles
to Series and Movies added to Bazarr after enabling this option.
Here we're going to select which Subtitle Providers you want to use.
+Settings
=> Providers
Tip
+If possible don't forget to support them for their free service
+Here we will configure some extra settings for your subtitles
+Settings
=> Subtitles
AlongSide Media File
.Here you can select which Anti-Captcha provider you want to use.
+Why (or) do I need the Anti-Captcha ?
+Tip
+We Recommend the following provider => https://anti-captcha.com/
+Enable this option for automatic subtitles synchronization.
+ + +Now wait till Bazarr gets all the info needed from Sonarr/Radarr.
+Important
+Don't forget [First time installation configuration] !!!
+If you still have questions please check the [Troubleshooting] section in the wiki. +For more info about the other settings check the [Settings] wiki.
+ + + + + + + + + + + + + + + + + + + + + + +Do you need help or want to report a problem or a bug? You can do that several ways.
+bazarr.log
in the channel, Nobody wants to download logs and open them in notepad!Simply uninstall Bazarr (you won't lose your actual config and DB), download the latest installer from our website and install it.
+Make sure to adjust the service logon username and password if you did it previously.
+You can find the location for your database and log file in the following location depending where and how you installed it.
+Windows Installation: %programdata%\Bazarr
Dockers: /config/db
and /config/log
Source and other Installation: data directory inside bazarr root directory
If you're getting a error that looks like this:
+ +This can be for various reasons we've collected the the most common ones depending on the used OS.
+Bazarr service runs under Local System account that won't be able to access network shares.
+Run Bazarr's service as another user that has access to that share. You need to change the account used for Bazarr service in services.msc
console.
You're using a mapped network drive (not a UNC path).
+Change your paths to UNC paths (\\server\share
) both in Sonarr, Radarr and Bazarr will be able to access those files.
Your docker containers volume paths don't match with Sonarr/Radarr
+make sure Bazarr uses the identical volume paths as Sonarr and Radarr.
+Note
+If you're using docker and get this warning and need help with it provide us with the docker compose or docker build command of Bazarr and Sonarr/Radarr !!!
+If you're using a system with a GUI(Synology, unRAID, OMV, etc.) to configure docker use one of the following from terminal(puTTy) to get the docker compose or docker build command.`
+sudo docker run --rm -v /var/run/docker.sock:/var/run/docker.sock red5d/docker-autocompose CONTAINER_NAME
And yes this even works on a Synology +if you don't know how you probably didn't read the [Installation-Synology]
+Some providers require a Anti-Captcha when using their API.
+ +Choose the Anti-Captcha provider you want to use, and add the needed credentials.
+We recommend Anti-Captcha.com.
+Please check if you've configured the following settings.
+ +We've collected a few Tips & Tweaks that could help, you can find them in [Performance-Tuning]
+Forced subtitles 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 the scene.
+Embedded subtitles are subtitles that are in the video container (mkv, mp4, etc)
+they can be different formats in the container ex. .srt, PGS, etc
+Edit your config.ini and change your auth type to None and restart Bazarr.
+ +Your config.ini can be found in your in the same location where your logs or database are
+Bazarr recognizes the following external subtitles during a disk scan to match which language subtitles you already got.
+.srt
, .sub
, .smi
, .txt
, .ssa
, .ass
, .mpl
, .vtt
You're missing a subtitle provider or want one added to Bazarr ? +Well you got several ways to do that.
+The fastest:
+Learn Python and create a provider script for Bazarr.
+You can can look in the source code which providers we got and working on.
+If you need to write one then you can use the 2 following templates depending what the provider supports.
+Tip
+If API is supported it is preferred.
+Why ?
+Easier Error management and Scrapping the site is more resource intensive.
+The slowest:
+Bazarr Feature Request +First check if no one else already requested it of no one requested it you can create a new Feature Request, make sure to use a clear topic and use a good description and why etc.
+Note
+Keep in mind it doesn't mean it will happen, created or added !!!
+We highly discourage you from requesting providers in the Discord/Github.
+It will be ignored or forgotten !!!
+Go to Bazarr Feature Request
+First check if no one else already requested it of no one requested it you can create a new Feature Request, make sure to use a clear topic and use a good description and why etc.
+Note
+Keep in mind it doesn't mean it will happen, created or added !!!
+If you have left over *.synced.*
files or if you get the following error or similar:
Synchronization failed; consider passing --max-offset-seconds with a number larger than 600
This Should be reported to smacke ffsubsync Github by providing the subtitles synchronization debug log that is created by enabling Subtitles synchronization debugging
in Settings-->Subtitles.
Note
+This isn't a issue we can fix or do anything about it ourselves, So no need to report to us
+If you need help with Bazarr or want to report a problem it's best to start with a Debug log.
+Settings
=> General
You can find the location for your database and log file in the following location depending where and how you installed it.
+Windows Installation: %programdata%\Bazarr
Dockers: /config/db
and /config/log
Source and other Installation: data directory inside bazarr root directory
In order to use www.opensubtitles.com when you have working account on www.opensubtitles.org, please follow these steps:
+You should receive email with further instructions to follow.
+The accounts on www.opensubtitles.org and www.opensubtitles.com are separated and using different technology, that's why you need to do this.
+If you have further questions, don't hesitate to contact us.
+Welcome to www.OpenSubtitles.com
+ + + + + + + + + + + + + + + + + + + + + + +