Formatting and MD cleanup

Formatting and MD cleanup
TRaSH 2020-11-07 16:27:58 +01:00
parent 6924891096
commit 4e3f3ba7d5
1 changed files with 50 additions and 59 deletions

109
FAQ.md

@ -1,19 +1,21 @@
- [Where can I find the logs or database](#where-can-i-find-the-logs-or-database)
- [This path doesn't seems to be valid](#this-path-doesnt-seems-to-be-valid)
- [Why (or) do I need the Anti-Captcha](#why-or-do-i-need-the-anti-captcha)
- [Why doesn't Bazarr find any subtitles](#why-doesnt-bazarr-find-any-subtitles)
- [How do I enable the debug log](#how-do-i-enable-the-debug-log)
- [How to report a problem](#how-to-report-a-problem)
- [I'm a cloud user or run on a low powered device](#im-a-cloud-user-or-run-on-a-low-powered-device)
- [What are Forced Subtitles](#what-are-forced-subtitles)
- [What are Embedded Subtitles](#what-are-embedded-subtitles)
- [How do I reset my password](#how-do-i-reset-my-password)
- [Which external subtitles does Bazarr recognize](#which-external-subtitles-does-bazarr-recognize)
- [I'm missing or want a subtitle provider added to Bazarr](#im-missing-or-want-a-subtitle-provider-added-to-bazarr)
- [I would like to see the following Feature in Bazarr](#i-would-like-to-see-the-following-feature-in-bazarr)
- [Synchronization failed...](#synchronization-failed)
# FAQ
### Where can I find the logs or database
- [Where can I find the logs or database](#where-can-i-find-the-logs-or-database)
- [This path doesn't seems to be valid](#this-path-doesnt-seems-to-be-valid)
- [Why (or) do I need the Anti-Captcha](#why-or-do-i-need-the-anti-captcha)
- [Why doesn't Bazarr find any subtitles](#why-doesnt-bazarr-find-any-subtitles)
- [How do I enable the debug log](#how-do-i-enable-the-debug-log)
- [How to report a problem](#how-to-report-a-problem)
- [I'm a cloud user or run on a low powered device](#im-a-cloud-user-or-run-on-a-low-powered-device)
- [What are Forced Subtitles](#what-are-forced-subtitles)
- [What are Embedded Subtitles](#what-are-embedded-subtitles)
- [How do I reset my password](#how-do-i-reset-my-password)
- [Which external subtitles does Bazarr recognize](#which-external-subtitles-does-bazarr-recognize)
- [I'm missing or want a subtitle provider added to Bazarr](#im-missing-or-want-a-subtitle-provider-added-to-bazarr)
- [I would like to see the following Feature in Bazarr](#i-would-like-to-see-the-following-feature-in-bazarr)
- [Synchronization failed...](#synchronization-failed)
## Where can I find the logs or database
You can find the location for your database and log file in the following location depending where and how you installed it.
@ -31,7 +33,7 @@ You can find the location for your database and log file in the following locati
------
### This path doesn't seems to be valid
## This path doesn't seems to be valid
If you're getting a error that looks like this:
@ -39,40 +41,36 @@ 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.
##### Windows:
### Windows
- **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.
##### Docker:
### Docker
- **Your docker containers volume paths don't match with Sonarr/Radarr**
make sure Bazarr uses the identical volume paths as Sonarr and Radarr.
##### Docker & Synology when mixing packages with dockers:
### Docker & Synology when mixing packages with dockers
- In worse case scenario you need to make use of [Paths Mapping](https://github.com/morpheus65535/bazarr/wiki/Settings#path-mappings)
#### NOTE:
#### 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 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.*`
> *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 assaflavie/runlike CONTAINER_NAME`
> `sudo docker run --rm -v /var/run/docker.sock:/var/run/docker.sock red5d/docker-autocompose CONTAINER_NAME`
>
> *or*
>
> `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]]*
> *And yes this even works on a Synology*
> *if you don't know how you probably didn't read the [[Installation-Synology]]*
------
### Why (or) do I need the Anti-Captcha
## Why (or) do I need the Anti-Captcha
***Some providers require a Anti-Captcha when using their API.***
@ -84,21 +82,21 @@ We recommend [Anti-Captcha.com](https://anti-captcha.com/).
------
### Why doesn't Bazarr find any subtitles
## Why doesn't Bazarr find any subtitles
Please check if you've configured the following settings.
[[First time installation configuration]]
------
### How do I enable the debug log
## How do I enable the debug log
`Settings` => `General`
![](images/image-20200519215100814.png)
![enable debug log](images/image-20200519215100814.png)
------
### How to report a problem
## How to report a problem
1. Start with enabling the debug log.
2. Clear your logs and then try to replicate your issue.
@ -110,13 +108,13 @@ Please check if you've configured the following settings.
------
### I'm a cloud user or run on a low powered device
## I'm a cloud user or run on a low powered device
We've collected a few Tips & Tweaks that could help, you can find them in [[Performance-Tuning]]
------
### What are Forced Subtitles
## What are Forced Subtitles
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.
@ -125,14 +123,14 @@ Forced subtitles is the subtitle appearing on screen when the characters speak a
------
### What are Embedded Subtitles
## What are Embedded Subtitles
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
------
### How do I reset my password
## How do I reset my password
Edit your config.ini and change your auth type to None and restart Bazarr.
@ -142,7 +140,7 @@ Your config.ini can be found in your [in the same location where your logs or da
------
### Which external subtitles does Bazarr recognize
## Which external subtitles does Bazarr recognize
Bazarr recognizes the following external subtitles during a disk scan to match which language subtitles you already got.
@ -150,40 +148,34 @@ Bazarr recognizes the following external subtitles during a disk scan to match w
------
### I'm missing or want a subtitle provider added to Bazarr
## I'm missing or want a subtitle provider added to Bazarr
You're missing a subtitle provider or want one added to Bazarr ?
Well you got several ways to do that.
1. The fastest:
Learn Python and create a provider script for Bazarr.
You can can look in the source code which [providers](https://github.com/morpheus65535/bazarr/tree/master/libs/subliminal_patch/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.
- [API-Template](https://github.com/morpheus65535/bazarr/blob/master/libs/subliminal_patch/providers/napisy24.py)
- [Page-Scrapping-Template](https://github.com/morpheus65535/bazarr/blob/master/libs/subliminal_patch/providers/soustitreseu.py)
> If API is supported it is preferred.
> Why ?
> Easier Error management and Scrapping the site is more resource intensive.
Learn Python and create a provider script for Bazarr.
You can can look in the source code which [providers](https://github.com/morpheus65535/bazarr/tree/master/libs/subliminal_patch/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.
- [API-Template](https://github.com/morpheus65535/bazarr/blob/master/libs/subliminal_patch/providers/napisy24.py)
- [Page-Scrapping-Template](https://github.com/morpheus65535/bazarr/blob/master/libs/subliminal_patch/providers/soustitreseu.py)
> If API is supported it is preferred.
> Why ?
> Easier Error management and Scrapping the site is more resource intensive.
2. The slowest:
[Bazarr Feature Request](https://bazarr.featureupvote.com/)
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.
[Bazarr Feature Request](https://bazarr.featureupvote.com/)
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.
> **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 !!!**
------
### I would like to see the following Feature in Bazarr
## I would like to see the following Feature in Bazarr
Go to [Bazarr Feature Request](https://bazarr.featureupvote.com/)
@ -193,7 +185,7 @@ First check if no one else already requested it of no one requested it you can c
------
### Synchronization failed...
## Synchronization failed...
If you get the following error or similar
@ -204,4 +196,3 @@ This Should be reported to [smacke ffsubsync Github](https://github.com/smacke/f
This isn't a issue we can fix or do anything about it ourselves, So no need to report to us
------