122 lines
3.3 KiB
Markdown
122 lines
3.3 KiB
Markdown
# KV-Download (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, TikTok, Instagram, etc),
|
|
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 [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 should not be exposed to public traffic. There's no auth.
|
|
|
|
|
|
|
|
|
|
|
|
# Running
|
|
|
|
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
|
|
```
|
|
|
|
## Docker Image
|
|
|
|
The Docker image is available from the Forgejo container registry:
|
|
|
|
```bash
|
|
docker pull git.khoavo.myds.me/vndangkhoa/kv-download:v1
|
|
```
|
|
|
|
### Deploy on Synology NAS (CLI)
|
|
|
|
1. Login to the registry (one-time):
|
|
```bash
|
|
docker login git.khoavo.myds.me -u vndangkhoa -p Thieugia19
|
|
```
|
|
|
|
2. Run with docker-compose:
|
|
```bash
|
|
docker compose up -d
|
|
```
|
|
|
|
### Deploy on Synology NAS (Container Manager GUI)
|
|
|
|
1. Open **Container Manager** → **Registry** → **Add**
|
|
- Server: `git.khoavo.myds.me`
|
|
- Username: `vndangkhoa`
|
|
- Password: `Thieugia19`
|
|
|
|
2. Search for `vndangkhoa/kv-download` and download the `v1` tag
|
|
|
|
3. Go to **Container Manager** → **Project** → **Create**
|
|
- Project name: `kv-download`
|
|
- Paste this `docker-compose.yml`:
|
|
```yaml
|
|
services:
|
|
kv-download:
|
|
image: git.khoavo.myds.me/vndangkhoa/kv-download:v1
|
|
container_name: kv-download
|
|
restart: unless-stopped
|
|
ports:
|
|
- "9292:9292"
|
|
volumes:
|
|
- ./downloads:/download
|
|
environment:
|
|
- MR_DOWNLOAD_DIR=/download
|
|
- TZ=Asia/Ho_Chi_Minh
|
|
```
|
|
|
|
4. Click **Next** → **Done** to start the container
|
|
|
|
5. Access the app at `http://<NAS-IP>:9292`
|
|
|
|
### Build Your Own Image
|
|
|
|
```bash
|
|
docker build -t git.khoavo.myds.me/vndangkhoa/kv-download:v1 --platform linux/amd64 .
|
|
docker push git.khoavo.myds.me/vndangkhoa/kv-download:v1
|
|
```
|
|
|
|
## Docker Environment Variables
|
|
* `MR_DOWNLOAD_DIR` where videos are saved. Defaults to `/download`
|
|
* `MR_PROXY` will pass the value to yt-dlp with the `--proxy` argument. Defaults to empty
|
|
|
|
## File Structure
|
|
|
|
After downloading videos, files are organized as follows:
|
|
```
|
|
/download/
|
|
├── <hash>/
|
|
│ └── <video-id>.mp4 # Video files
|
|
└── json/
|
|
└── <video-id>.info.json # Metadata files (separate folder)
|
|
```
|
|
|
|
# API
|
|
|
|
To download a video directly, use the API endpoint:
|
|
|
|
```
|
|
/api/download?url=SOME_URL
|
|
```
|
|
|
|
Create a bookmarklet, allowing one click downloads (From a PC):
|
|
|
|
```
|
|
javascript:(location.href="http://127.0.0.1:9292/fetch?url="+encodeURIComponent(location.href));
|
|
```
|
|
|
|
# Integrating with mobile
|
|
|
|
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.
|