Tag image as v1, update README with Synology Container Manager GUI instructions
Some checks failed
/ build (push) Failing after 44s

This commit is contained in:
vndangkhoa 2026-04-04 17:14:11 +07:00
parent db7dacf64a
commit 1dab610bb6
2 changed files with 46 additions and 54 deletions

View file

@ -32,6 +32,49 @@ The Docker image is available from the Forgejo container registry:
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
@ -39,58 +82,6 @@ docker build -t git.khoavo.myds.me/vndangkhoa/kv-download:v1 --platform linux/am
docker push git.khoavo.myds.me/vndangkhoa/kv-download:v1
```
## Deploy on Synology NAS
### Method 1: Docker Compose (Recommended)
1. SSH into your Synology NAS
2. Create a project directory and copy the `docker-compose.yml` there
3. Run:
```bash
cd /path/to/project
docker compose up -d
```
### Method 2: Synology Container Manager (Docker GUI)
1. Open **Container Manager** in DSM
2. Go to **Registry****Add** → enter:
- Server: `git.khoavo.myds.me`
- Username: `vndangkhoa`
- Password: `Thieugia19`
3. Search for `vndangkhoa/kv-download` and download the `v1` tag
4. Go to **Image** → select `kv-download` → **Create Container**
5. Configure the container:
- **Container Name**: `kv-download`
- **Port Settings**: Local `9292` → Container `9292`
- **Volume Settings**:
- Add folder: `/volume2/docker/kv-download/download` → Mount path `/download`
- **Environment Variables**:
- `MR_DOWNLOAD_DIR` = `/download`
- `TZ` = `Asia/Ho_Chi_Minh`
- **Restart Policy**: `Always restart the container`
6. Click **Done** to start the container
### Method 3: Docker CLI
```bash
docker run -d \
--name kv-download \
--restart unless-stopped \
-p 9292:9292 \
-v ./download:/download \
-e MR_DOWNLOAD_DIR=/download \
-e TZ=Asia/Ho_Chi_Minh \
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
@ -99,7 +90,7 @@ docker run -d \
After downloading videos, files are organized as follows:
```
download/
/download/
├── <hash>/
│ └── <video-id>.mp4 # Video files
└── json/

View file

@ -1,12 +1,13 @@
services:
kv-download:
image: git.khoavo.myds.me/vndangkhoa/kv-download:v1
pull_policy: always
container_name: kv-download
restart: unless-stopped
ports:
- "9292:9292"
volumes:
- ./download:/download
- ./downloads:/download
environment:
- MR_DOWNLOAD_DIR=/download
- TZ=Asia/Ho_Chi_Minh