You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Tzahi12345 9c0a77cb6e
Merge pull request #705 from weblate/weblate-youtubedl-material-ytdl-material
2 months ago
.github Fixed missing latest tag on docker-release 3 months ago
.vscode Updated npm in auto build to v12 1 year ago
backend Reverted #696 and updated node version to avoid 243 error 2 months ago
chart Updated version to 4.3 3 months ago
chrome-extension Updated Chrome and Firefox extension zips 1 year ago
e2e chore: initial commit from @angular/cli 4 years ago
src Translated using Weblate (Indonesian) 2 months ago
.browserslistrc Updated Angular to version 11 1 year ago
.dockerignore using more recent ffmpeg + code cleanup 5 months ago
.editorconfig chore: initial commit from @angular/cli 4 years ago
.eslintrc.json Logger is now separated into its own module 1 year ago
.gitignore Updated angular to v13 5 months ago
Dockerfile Reverted #696 and updated node version to avoid 243 error 2 months ago
Dockerfile.heroku Removed pm2 global install in favor of local node_modules (#662) 3 months ago
LICENSE.md Create LICENSE.md 4 years ago
Public API v1.yaml UI & logs now use proper fork name rather than just youtube-dl 3 months ago
README.md Added rpi 4 as a "special case" in the readme 3 months ago
SECURITY.md Removed recommendation of nightly, updated language in README, and updated SECURITY.md 3 months ago
angular.json Updated local font/bootstrap setup to be more Angular compatible 3 months ago
app.json Added back stack field in app.json 1 year ago
docker-compose.yml fix: remove exposed ports for mongo 3 months ago
ffmpeg-fetch.sh revert script 4 months ago
heroku.yml Updated heroku dockerfile 4 months ago
karma.conf.js Migrated to angular 8 2 years ago
main.js added skeleton code for future electron.js support 2 years ago
package-lock.json Removed pm2 global install in favor of local node_modules (#662) 3 months ago
package.json Updated mangled translations 3 months ago
protractor.conf.js chore: initial commit from @angular/cli 4 years ago
tsconfig.json Updated ES to 2019/2020 and local default.json is ignored for reloads when in dev mode 1 year ago
tslint.json Updated Angular to version 11 1 year ago

README.md

YoutubeDL-Material

Docker pulls badge Docker image size badge Heroku deploy badge GitHub issues badge License badge

YoutubeDL-Material is a Material Design frontend for youtube-dl. It’s coded using Angular 13 for the frontend, and Node.js on the backend.

Now with Docker support!


Getting Started

Check out the prerequisites, and go to the installation section. Easy as pie!

Here’s an image of what it’ll look like once you’re done:

Dark mode:

Prerequisites

NOTE: If you would like to use Docker, you can skip down to the Docker section for a setup guide.

Debian/Ubuntu:

sudo apt-get install nodejs youtube-dl ffmpeg unzip python npm

CentOS 7:

sudo yum install epel-release
sudo yum localinstall --nogpgcheck https://download1.rpmfusion.org/free/el/rpmfusion-free-release-7.noarch.rpm
sudo yum install centos-release-scl-rh
sudo yum install rh-nodejs12
scl enable rh-nodejs12 bash
sudo yum install nodejs youtube-dl ffmpeg ffmpeg-devel

Optional dependencies:

  • AtomicParsley (for embedding thumbnails, package name atomicparsley)
  • tcd (for downloading Twitch VOD chats)

Installing

  1. First, download the latest release!

  2. Drag the youtubedl-material directory to an easily accessible directory. Navigate to the appdata folder and edit the default.json file.

NOTE: If you are intending to use a reverse proxy, this next step is not necessary

  1. Port forward the port listed in default.json, which defaults to 17442.

  2. Once the configuration is done, run npm install to install all the backend dependencies. Once that is finished, type npm start. This will run the backend server, which serves the frontend as well. On your browser, navigate to to the server (url with the specified port). Try putting in a youtube link to see if it works. If it does, viola! YoutubeDL-Material is now up and running.

If you experience problems, know that it’s usually caused by a configuration problem. The first thing you should do is check the console. To get there, right click anywhere on the page and click “Inspect element.” Then on the menu that pops up, click console. Look at the error there, and try to investigate.

Build it yourself

If you’d like to install YoutubeDL-Material, go to the Installation section. If you want to build it yourself and/or develop the repository, then this section is for you.

To deploy, simply clone the repository, and go into the youtubedl-material directory. Type npm install and all the dependencies will install. Then type cd backend and again type npm install to install the dependencies for the backend.

Once you do that, you’re almost up and running. All you need to do is edit the configuration in youtubedl-material/appdata, go back into the youtubedl-material directory, and type npm build. This will build the app, and put the output files in the youtubedl-material/backend/public folder.

The frontend is now complete. The backend is much easier. Just go into the backend folder, and type npm start.

Finally, if you want your instance to be available from outside your network, you can set up a reverse proxy.

Alternatively, you can port forward the port specified in the config (defaults to 17442) and point it to the server’s IP address. Make sure the port is also allowed through the server’s firewall.

Docker

Host-specific instructions

If you’re on a Synology NAS, unRAID, Raspberry Pi 4 or any other possible special case you can check if there’s known issues or instructions both in the issue tracker and in the Wiki!

Setup

If you are looking to setup YoutubeDL-Material with Docker, this section is for you. And you’re in luck! Docker setup is quite simple.

  1. Run curl -L https://github.com/Tzahi12345/YoutubeDL-Material/releases/latest/download/docker-compose.yml -o docker-compose.yml to download the latest Docker Compose, or go to the releases page to grab the version you’d like.
  2. Run docker-compose pull. This will download the official YoutubeDL-Material docker image.
  3. Run docker-compose up to start it up. If successful, it should say “HTTP(S): Started on port 17443” or something similar. This tells you the container-internal port of the application. Please check your docker-compose.yml file for the external port. If you downloaded the file as described above, it defaults to 8998.
  4. Make sure you can connect to the specified URL + external port, and if so, you are done!

Custom UID/GID

By default, the Docker container runs as non-root with UID=1000 and GID=1000. To set this to your own UID/GID, simply update the environment section in your docker-compose.yml like so:

environment:
    UID: YOUR_UID
    GID: YOUR_GID

MongoDB

For much better scaling with large datasets please run your YoutubeDL-Material instance with MongoDB backend rather than the json file-based default. It will fix a lot of performance problems (especially with datasets in the tens of thousands videos/audios)!

Tutorial.

API

API Docs

To get started, go to the settings menu and enable the public API from the Extra tab. You can generate an API key if one is missing.

Once you have enabled the API and have the key, you can start sending requests by adding the query param apiKey=API_KEY. Replace API_KEY with your actual API key, and you should be good to go! Nearly all of the backend should be at your disposal. View available endpoints in the link above.

iOS Shortcut

If you are using iOS, try YoutubeDL-Material more conveniently with a Shortcut. With this Shorcut, you can easily start downloading YouTube video with just two taps! (Or maybe three?)

You can download Shortcut here.

Contributing

If you’re interested in contributing, first: awesome! Second, please refer to the guidelines/setup information located in the Contributing wiki page, it’s a helpful way to get you on your feet and coding away.

Pull requests are always appreciated! If you’re a bit rusty with coding, that’s no problem: we can always help you learn. And if that’s too scary, that’s OK too! You can create issues for features you’d like to see or bugs you encounter, it all helps this project grow.

If you’re interested in translating the app into a new language, check out the Translate wiki page.

Authors

  • Isaac Grynsztein (me!) - Initial work

Official translators:

  • Spanish - tzahi12345
  • German - UnlimitedCookies
  • Chinese - TyRoyal

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

This project is in no way affiliated with Google LLC, Alphabet Inc. or YouTube (or their subsidiaries) nor endorsed by them.

Acknowledgments

  • youtube-dl
  • AllTube (for the inspiration)