diff --git a/README.md b/README.md index 171a5d7..c7b7748 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ Minimalistic, portable and selfhosted Interface for the famous [youtube-dl](https://rg3.github.io/youtube-dl/) CLI tool. +![GIF](https://i.imgur.com/D5aPYhH.gif) + I made this because most public downloaders either: - Have adblock bypasses, coinhive scripts or PRO plans you have to buy, - Dont put thumbnails and meta data in the file, @@ -9,7 +11,7 @@ I made this because most public downloaders either: youtube-dl supports all this, but all the UIs I found werent really my taste. So I made my own. -# Ideology of this Project +# Idea of this Project This downloader is meant to be used as a selfhosted and private Service. It was designed with this in mind and DOES not scale well. Its not to be released publicly, as this will probably just flood your Harddrive. It was meant to be shared and used by you and some friends you trust. To explain further, its because of these functionalitys: @@ -20,6 +22,29 @@ Its not to be released publicly, as this will probably just flood your Harddrive So use with care! +# Features +- Make multiple users +- Log every (succesful) download in the log.php +- configuration variables are all stored in an config.php +- Download whole channels, playlists, trackstations etc. (And MANY other sites are supported as well for example soundcloud) +- Writes artists and Thumbnails to mp3s (when using default config parameter) +- Deletes all + # Installation -[... to be continued ...] +You need: +- Webserver with PHP +- The command ```popen ``` cant be blacklisted (Apache does this by default IIRC) + +1. Download the release +2. Unzip it and upload to your webdirectory +3. Make sure to make the owner of the folder to your webservers user (e.g. apache or www-data) and set permissions as 775 + - You can use either CHOWN and CHMOD [READ MORE HERE](https://www.cyberciti.biz/faq/how-to-use-chmod-and-chown-command/) + - Or use an FTP client such as winSCP [example](https://i.imgur.com/lbyK2Gy.png) +4. navigate to the config.php and configure to your likings. (For md5 hashes I use http://www.md5.cz/) + +# Questions? + +make an issue if you have any questions, improvemenets or critic. +have fun :) +