kv-download/README.md
2020-02-10 07:37:23 -08:00

44 lines
1.8 KiB
Markdown

# Media Roller
A mobile friendly tool for downloading videos from social media.
The backend is a Golang server that will take a URL (YouTube, Reddit, Twitter, etc),
download the video file, and return a URL to directly download the video. The video will be transcoced as needed to produce a single mp4 file.
This is built on [youtube-dl](https://github.com/ytdl-org/youtube-dl) which has a list of [supported sites](http://ytdl-org.github.io/youtube-dl/supportedsites.html).
Note: This was written to run on a home network and wasn't originally written to be exposed to public traffic. Currently there's no auth. This might change and feel free to send a pull request, but right now, keep this on your internal network and do not expose it.
![Screenshot 1](https://i.imgur.com/lxwf1qU.png)
![Screenshot 2](https://i.imgur.com/TWAtM7k.png)
# Running
Make sure you have [youtube-dl](https://github.com/ytdl-org/youtube-dl) and [FFmpeg](https://github.com/FFmpeg/FFmpeg) installed then pull the repo and run:
```bash
./run.sh
```
With Docker: `ronnieroller/media-roller:latest`.
See https://hub.docker.com/repository/docker/ronnieroller/media-roller
The files are saved to the /download directory which you can mount as needed.
# API
To download a video directly, use the API endpoint:
```
/api/download?url=SOME_URL
```
# Integrating with mobile
After you you have you server up, install this shortcut. Update the endpoint to your server address by editing the shortcut before running it.
https://www.icloud.com/shortcuts/2b9765fb5bf24509a4e83bc76c5c7409
# Unraid
media-roller is available in Unraid and can be found on the "Apps" tab by searching its name.
# Open Issues, missing features
* Conversions are slow, need to be sped up
* Needs to support auth
* Needs a better way to track downloaded media and manage it
* Add ablity to prefer certain quality or format