vndangkhoa/kv-download
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme

Browse source
This commit is contained in:
rroller 2024-10-20 09:50:51 -07:00
parent f51c8d1643
commit 03d58bfd1d
1 changed files with 10 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -1,11 +1,11 @@
# 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.
download the video file, and return a URL to directly download the video. The video will be transcoded 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).
This is built on [yt-dlp](https://github.com/yt-dlp/yt-dlp). yt-dlp will auto update every 12 hours to make sure it's running the latest nightly build.
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.
Note: This was written to run on a home network and should not be exposed to public traffic. There's no auth.
![Screenshot 1](https://i.imgur.com/lxwf1qU.png)
@ -13,10 +13,15 @@ Note: This was written to run on a home network and wasn't originally written to
# 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:
Make sure you have [yt-dlp](https://github.com/yt-dlp/yt-dlp) and [FFmpeg](https://github.com/FFmpeg/FFmpeg) installed then pull the repo and run:
```bash
./run.sh
```
Or for docker locally:
```bash
./docker-build.sh
./docker-run.sh
```
With Docker: `ronnieroller/media-roller:latest`.
See https://hub.docker.com/repository/docker/ronnieroller/media-roller
@ -36,15 +41,9 @@ javascript:(location.href="http://127.0.0.1:3000/fetch?url="+encodeURIComponent(
```
# 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.
After you have your server up, install this shortcut. Update the endpoint to your server address by editing the shortcut before running it.
https://www.icloud.com/shortcuts/d3b05b78eb434496ab28dd91e1c79615
# 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