<!-- 'README.md' is automatically generated by 'build.sh' using 'pandoc'. Edit 'README.rst' instead ! -->
Subtitle Downloader Service
Subtitle Download Web Service for Sonarr or Radarr. It uses Subliminal to search automatically for missing subtitles on download notification.
- Free software: MIT
- Source: https://github.com/Stibbons/subdlsrv
- Python 3. Python 2 is tested by Travis but local installation is not provided.
- Docker image based on Alpine Linux and S6-Overlay is provided (based on Linuxserver's images)
The best usage is through the docker image.
Use with Docker
Use my docker image:
docker create \ --name subdlsrv \ -p 8000:8000 \ -e PUID=<UID> \ -e PGID=<GID> \ -v <path/to/animes>:/animes \ -v <path/to/movies>:/movies \ -v <path/to/tvseries>:/tv \ stibbons31/subdlsrv
Mount your media directory in
/media. This directory exists in the docker image, so if you have several media directory (
/animes), mount them all in
/media and set the following environment variable:
It is a good practive to run Sonarr and Radarr in their own container, so they also "see" their media in path such as
/animes. Mount these volume with the same name in the subdlsrv container. They will all communicate with the same path.
Base directory (
SUBDLSRC_BASEDIR environment variable) can be used to put all these folder in same directory. If
SUBDLSRC_BASEDIR is not defined, subdlsrv will assume the path communicated by Sonarr or Radarr also exists locally. So mouth your series folder to
/series, TV show folder to
/tv, and animes to
/animes and so on.
The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.
-p 8086:8086- the port webinterface
-v /path/to/anime:/anime- location of Anime library on disk
-v /path/to/movies:/movies- location of Movies library on disk
-v /path/to/tv:/tv- location of TV library on disk
-e PGID=1000- for for GroupID. See below for explanation
-e PUID=100- for for UserID. See below for explanation
-e SUBDLSRC_LANGUAGES=fra,eng- set wanted subtitles languages (mandatory)
-e SUBDLSRC_BASEDIR=/app- set media base directory (optional)
-e SUBDLSRC_VERBOSE=1- set verbosity. 1=verbose, 0=silent (optional)
User / Group Identifiers
Sometimes when using data volumes (-v flags) permissions issues can arise between the host OS and the container. We avoid this issue by allowing you to specify the user PUID and group PGID. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" TM.
In this instance PUID=1001 and PGID=1001. To find yours use id user as below:
$ id <dockeruser> uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
Wanted subtitle languages
Use a comma-separated list of 3-letter language descriptors you want Subliminal to try to download them.
Descriptors are ISO-639-3 names of the language. See the official Babelfish table to find your prefered languages.
Create a dedicated virtual environment and install it properly with the following commands:
sudo ./bootstrap.sh ./install.sh prod
This will install subdlsrv in a local virtual environment will all its dependencies without messing with your system's Python environment.
Installing in your system
Do NOT install a Python application in your system. Always use a Virtualenv. Or let it be handled by your distribution's maintainer.
This method is used when building the docker image (and the travis build):
sudo ./bootstrap.sh sudo ./install.sh system
Go in Settings to configure a "Connect" webhook:
- Settings > Connect > add Webhook notification
- Select only On Download and On Upgrade
- URL: http://<ip address>:8086/notify
- Method: POST
Two READMEs ?
If you look at the source code, you would have seen that there are TWO readme files: README.md and README.rst. This has been done on purpose because:
- Docker Hub does not render README written in restructuredText
- Pypi does not render README written in Markdown
So, I have put both. Simple.
README.md is automatically generated from README.rst by build.sh if pandoc is installed on your system.
Bootstrap your system with
Setup your environment with
or run it live with
Activate the environment (to start your editor from, for example):
$ pipenv shell
(This part should be automatically done by Travis)
Build Wheel package:
pipenv run python setup.py bdist_wheel
Register and publish your package to Pypi:
pipenv run python setup.py sdist bdist bdist_wheel upload -r pypi
Create a release: create a tag with a semver syntax. Optionally you can tag code locally and push to GitHub.
git tag 1.2.3
On successful travis build on the Tag branch, your Pypi package will be automatically updated.