Skip to content

Latest commit

 

History

History
107 lines (72 loc) · 6.53 KB

README.md

File metadata and controls

107 lines (72 loc) · 6.53 KB
Raw

youtube-dl-server

(A modified version of manbearwiz's youtube-dl-server. This project is still in the beta stages, so deploy it at your own risk.)

As of 2020/08/27, I will only be working on this project occasionally. I still want to update it, but the new school year brings new (educationally oriented) different projects that will take up more of my time. If you would like to help out, you can try to add code to this! Thanks! Updates will be coming out occasionally, and hopefully this will be done soon.

What is new in this version?

  • You can now specify where to download the videos on the server you are downloading to, which helps simplifiy adding videos to media servers such as Plex or Jellyfin.
  • Built in metadata tagging. The downloader will now apply the appropriate metadata to media you download (artist/author/title) so that you dont need to deal with tagging everything once its downloaded. This also helps simplify adding videos to media servers.
  • All of the files are hosted locally. Previously, youtube-dl-server reached out to CDNs on the internet for web assets, however this new version has everything included locally. This means that you don't need to be reliant on external CDNs and you are in full control of your files.
  • This new version has error pages. The old version had no error pages, which can lead to some user confusion in the instance of a server side error.
  • /q has been renamed to /queue so that users know what page they are at, instead of being confused by what "q" means.
  • A download progess page where you can view the status of pending, current, past, and failed downloads (the history page at /history). This page refreshes live, so the status of your downloads will update every 3 seconds.
  • Authentication by local user accounts, so that you can restrict who is using the application and prevent unauthorized people from using your bandwidth to download videos.
  • Specific error messages and better error handling.
  • Added the ability to "subscribe" to channels/playlists, where the subscription daemon that runs in the background every x hours will download new videos in the playlist/channel. The subscriptions can be added through the /subscriptions webpage and it can be configured to run every x hours by using crontab, or another scheduling program.
  • You can use proxies for downloading videos at the home page. Currently, you can add as many proxies as you want, however I haven't been able to test this feature out. This is an experimental feature.

What is coming?

In the works right now:

  • Transferring all the form inputs to ajax requests.

In the future:

  • Docker images (planning on supporting Raspis).
  • The ability to administrate the program via Systemctl.
  • Support for downloading videos with captions (currently having issues with this, help would be appreciated).
  • Support for (pleasant) mobile device viewing (currently the only mobile devices that this app works on are tablets).

How do I set this up?

Required Programs (the method of installation vaires by distro):

Install the required packages with apt-get:

sudo apt-get install ffmpeg python3 python3-pip

Install the requrired modules with pip:

python3 -m pip install -r requirements.txt

Non-Docker Install Instructions:

Pre setup-warning: The user this program is running under should have r/w access to EVERY directory that is being referenced. That means the current directory you are installing in, and any external server download directories you are downloading to.

  1. Run setup.py with Python>=3.6 (below 3.6 isn't tested yet). Make sure to use a strong password for your admin account, to ensure that nobody can log on without your permission.
  2. Once you have ran the setup program, without an error, run the Flask application by running gunicorn3 --workers 4 --threads 4 --bind 0.0.0.0:8080 wsgi:app. You can change the host to 127.0.0.1 if you only want the application to work on your computer, but running it as 0.0.0.0 allows others to access the app. You can also change the port from 8080 to something else; 8080 is just the default (warning: port 80 may already be taken by your Apache installation).

Docker Install Instructions:

Use the provided docker-compose.yml file (with your modifications or run directly from the command line).
Docker-compose absolutely sucks and is causing heaps of issues. You'll have to manually build the docker image and run that.

  1. docker build -t katznboyz1/youtube-dl-server:latest .
  2.  docker run -d -p 8080:8080 \
 -v /path/to/downloaded/vids:/app/downloads \
 -v /path/to/database:/app/db \
 -e APPNAME=YDS \
 -e ADMINUSER=admin \
 -e PASSWORD=youtube \
 -e TZ=Australia/Melbourne \
 katznboyz1/youtube-dl-server:latest

The environment variables are:

  • APPNAME - the name you want the application to have (default: YDS)
  • ADMINUSER - the name of the admin user (default: admin)
  • PASSWORD - the password for the admin user (default: youtube)
  • TZ - for the timezone. Not actually sure if this is going to work.

And the volumes are:
# Where downloaded videos should go
- /opt/youtubedownloads:/app/downloads
# Where the database is
- /opt/database:/app/db

The docker image exposes port 8080 for the webserver.

Having an issue?

Leave an issue on the official repo!

Known issues:

  • Downloading certain videos with the ultra high format will lead to a missing codec error if you play it on windows.

Want to contribute?

There are some things that still need to be added, and if you want to help out it would be appreciated! Here is a list of some of the needed bits:

  • A new favicon for the application
  • Known issue fixes
  • Unknown issue fixes

Disclaimers

  • I am not a network security professional. If you run this application exposed to the internet, then you run it at your own risk. Do not use common/reused passwords for this application. I am a singular person, and there may be bugs in this program. Do not allow it to fail badly by not following common sense.
  • I am not in charge of how people use this application. I created this application for people to use, however the way that people may use it does not reflect on my original intentions/beliefs.
  • Any damages caused by this application to any party are not the responsibility of me as the creator, and they are either the responsibility of the person hosting the app, or the user of the app.
  • READ THE LICENSE