This is a preview release of TubeSync, it may contain bugs but should be usable
TubeSync is a PVR (personal video recorder) for YouTube. Or, like Sonarr but for YouTube (with a built-in download client). It is designed to synchronize channels and playlists from YouTube to local directories and update your media server once media is downloaded.
If you want to watch YouTube videos in particular quality or settings from your local media server, then TubeSync is for you. Internally, TubeSync is a web interface wrapper on
ffmpeg with a task scheduler.
There are several other web interfaces to YouTube and
youtube-dl all with varying features and implemenations. TubeSync's largest difference is full PVR experience of updating media servers and better selection of media formats. Additionally, to be as hands-free as possible, TubeSync has gradual retrying of failures with back-off timers so media which fails to download will be retried for an extended period making it, hopefully, quite reliable.
Latest container image
:latest tag does exist, but will contain in-development commits and may be broken. Use at your own risk.
For the easiest installation, you will need an environment to run containers such as Docker or Podman. You will also need as much space as you want to allocate to downloaded media and thumbnails. If you download a lot of media at high resolutions this can be very large.
What to expect
Once running, TubeSync will download media to a specified directory. Inside this directory will be a
audio subdirectories. All media which only has an audio stream (such as music) will download to the
audio directory. All media with a video stream will be downloaded to the
video directory. All administration of TubeSync is performed via a web interface. You can optionally add a media server, currently just Plex, to complete the PVR experience.
TubeSync is designed to be run in a container, such as via Docker or Podman. It also works in a Docker Compose stack. Only
amd64 is initially supported.
Example (with Docker on *nix):
First find your the user ID and group ID you want to run TubeSync as, if you're not sure what this is it's probably your current user ID and group ID:
$ id # Example output, in this example, user ID = 1000, group ID = 1000 # id uid=1000(username) gid=1000(username) groups=1000(username),129(docker)
You can find your local timezone name here:
TZ defaults to
Next, create the directories you're going to use for config data and downloads:
$ mkdir /some/directory/tubesync-config $ mkdir /some/directory/tubesync-downloads
Finally, download and run the container:
# Pull a versioned image $ docker pull ghcr.io/meeb/tubesync:v0.7 # Start the container using your user ID and group ID $ docker run \ -d \ --name tubesync \ -e PUID=1000 \ -e PGID=1000 \ -e TZ=Europe/London \ -v /some/directory/tubesync-config:/config \ -v /some/directory/tubesync-downloads:/downloads \ -p 4848:4848 \ ghcr.io/meeb/tubesync:v0.7
Once running, open
http://localhost:4848 in your browser and you should see the TubeSync dashboard. If you do, you can proceed to adding some sources (YouTube channels and playlists). If not, check
docker logs tubesync to see what errors might be occuring, typical ones are file permission issues.
Alternatively, for Docker Compose, you can use something like:
tubesync: image: ghcr.io/meeb/tubesync:v0.7 container_name: tubesync restart: unless-stopped ports: - 4848:4848 volumes: - /some/directory/tubesync-config:/config - /some/directory/tubesync-downloads:/downloads environment: - TZ=Europe/London - PUID=1000 - PGID=1000
To update, you can just pull a new version of the container image as they are released.
$ docker pull ghcr.io/meeb/tubesync:v[number]
Back-end updates such as database migrations should be automatic.
Moving, backing up, etc.
TubeSync, when running in its default container, stores thumbnails, cache and its SQLite database into the
/config directory and wherever you've mapped that to on your file system. Just copying or moving this directory and making sure the permissions are correct is sufficient to move, back up or migrate your TubeSync install.
1. Add some sources
Pick your favourite YouTube channels or playlists, pop over to the "sources" tab, click whichever add button suits you, enter the URL and validate it. This process extracts the key information from the URL and makes sure it's a valid URL. This is the channel name for YouTube channels and the playlist ID for YouTube playlists.
You will then be presented with the initial add a source form where you can select all the features you want, such as how often you want to index your source and the quality of the media you want to download. Once happy, click "add source".
That's about it. All other actions are automatic and performed on timers by scheduled tasks. You can see what your TubeSync instance is doing on the "tasks" tab.
As media is indexed and downloaded it will appear in the "media" tab.
3. Media Server updating
Currently TubeSync supports Plex as a media server. You can add your local Plex server under the "media servers" tab.
Logging and debugging
TubeSync outputs useful logs, errors and debugging information to the console. You can view these with:
$ docker logs --follow tubesync
1. Index frequency
It's a good idea to add sources with as long of an index frequency as possible. This is the duration between indexes of the source. An index is when TubeSync checks to see what videos available on a channel or playlist to find new media. Try and keep this as long as possible, up to 24 hours.
2. Indexing massive channels
If you add a massive (several thousand videos) channel to TubeSync and choose "index every hour" or similar short interval it's entirely possible your TubeSync install may spend its entire time just indexing the massive channel over and over again without downloading any media. Check your tasks for the status of your TubeSync install.
If you add a significant amount of "work" due to adding many large channels you may need to increase the number of background workers by setting the
TUBESYNC_WORKERS environment variable. Try around ~4 at most, although the absolute maximum allowed is 8.
Be nice. it's likely entirely possible your IP address could get throttled by the source if you try and crawl extremely large amounts very quickly. Try and be polite with the smallest amount of indexing and concurrent downloads possible for your needs.
Can I use TubeSync to download single videos?
No, TubeSync is designed to repeatedly scan and download new media from channels or playlists. If you want to download single videos the best suggestion would be to create your own playlist, add the playlist to TubeSync and then add single videos to your playlist as you browse about YouTube. Your "favourites" playlist of videos will download automatically.
Does TubeSync support any other video platforms?
At the moment, no. This is a pre-release. The library TubeSync uses that does most of the downloading work,
youtube-dl, supports many hundreds of video sources so it's likely more will be added to TubeSync if there is demand for it.
Is there a progress bar?
Are there alerts when a download is complete?
No, this feature is best served by existing services such as the execelent Tautulli which can monitor your Plex server and send alerts that way.
There's errors in my "tasks" tab!
You only really need to worry about these if there is a permanent failure. Some errors are temproary and will be retried for you automatically, such as a download got interrupted and will be tried again later. Sources with permanet errors (such as no media available because you got a channel name wrong) will be shown as errors on the "sources" tab.
What is TubeSync written in?
Python3 using Django, embedding youtube-dl. It's pretty much glue between other much larger libraries.
Notable libraries and software used:
- Django Background Tasks
- The container bundles with
See the Pipefile for a full list.
Can I get access to the full Django admin?
Yes, although pretty much all operations are available through the front end interface and you can probably break things by playing in the admin. If you still want to access it you can run:
$ docker exec -ti tubesync python3 /app/manage.py createsuperuser
And follow the instructions to create an initial Django superuser, once created, you can log in at http://localhost:4848/admin
Are there user accounts or multi-user support?
No not at the moment. This could be added later if there is demand for it.
Does TubeSync support HTTPS?
No, you should deploy it behind an HTTPS-capable proxy if you want this (nginx, caddy, etc.). Configuration of this is beyond the scope of this README.
What architectures does the container support?
amd64 for the moment. Others may be made available if there is demand.
There are a number of other environment variables you can set. These are, mostly, NOT required to be set in the default container installation, they are really only useful if you are manually installing TubeSync in some other environment. These are:
|TUBESYNC_WORKERS||Number of background workers, default is 2, max allowed is 8||2|
|GUNICORN_WORKERS||Number of gunicorn workers to spawn||3|
|LISTEN_HOST||IP address for gunicorn to listen on||127.0.0.1|
|LISTEN_PORT||Port number for gunicorn to listen on||8080|
Manual, non-containerised, installation
As a relatively normal Django app you can run TubeSync without the container. Beyond following this rough guide you are on your own and should be knowledgeable about installing and running WSGI-based Python web applications before attempting this.
- Clone or download this repo
- Make sure you're running a modern version of Python (>=3.6) and have Pipenv installed
- Set up the environment with
tubesync/tubesync/local_settings.pyand edit it as appropriate
- Run migrations with
- Collect static files with
- Set up your prefered WSGI server, such as
gunicornpoiting it to the application in
- Set up your proxy server such as
nginxand forward it to the WSGI server
- Check the web interface is working
./manage.py process_tasksas the background task worker to index and download media. This is a non-detaching process that will write logs to the console. For long term running you could use a terminal multiplexer such as
tmux, or create
systemdunit to run it.
There is a moderately comprehensive test suite focussing on the custom media format matching logic and that the front-end interface works. You can run it via Django:
$ ./manage.py test --verbosity=2
All properly formatted and sensible pull requests, issues and comments are welcome.