kv-tube/README.md
2025-12-17 07:57:39 +07:00

2.1 KiB

KV-Tube

A modern, ad-free YouTube web client and video proxy designed for Synology NAS and personal home servers.

Features

  • Ad-Free Watching: Clean interface without distractions.
  • Smart Search: Directly search YouTube content.
  • Trending: Browse trending videos by category (Tech, Music, Gaming, etc.).
  • Auto-Captions: English subtitles automatically enabled if available.
  • AI Summary: (Optional) Extractive summarization of video content running locally.
  • PWA Ready: Installable on mobile devices with a responsive drawer layout.
  • Dark/Light Mode: User preference persisted in settings.
  • Privacy Focused: Everything runs on your server.

🚀 Deployment

This is the easiest way to run KV-Tube.

  1. Create a folder named kv-tube on your NAS/Server.
  2. Copy docker-compose.yml into that folder.
  3. Create a data folder inside kv-tube.
  4. Run the container.

docker-compose.yml

version: '3.8'

services:
  kv-tube:
    image: vndangkhoa/kvtube:latest
    container_name: kv-tube
    restart: unless-stopped
    ports:
      - "5011:5001"
    volumes:
      - ./data:/app/data
    environment:
      - PYTHONUNBUFFERED=1
      - FLASK_ENV=production

Run Command:

docker-compose up -d

Access the app at http://YOUR_NAS_IP:5011

Option B: Local Development (Python)

  1. Clone the repository:

    git clone https://github.com/vndangkhoa/kv-tube.git
    cd kv-tube
    
  2. Install Dependencies:

    python3 -m venv venv
    source venv/bin/activate
    pip install -r requirements.txt
    
  3. Run:

    python3 app.py
    

    Open http://127.0.0.1:5001 in your browser.

🛠️ Configuration

The app is zero-config by default.

  • Database: SQLite (stored in ./data/kvtube.db)
  • Port: 5001 (internal), mapped to 5011 in Docker compose example.

📝 License

Proprietary / Personal Use.