83 lines
2.5 KiB
Markdown
83 lines
2.5 KiB
Markdown
# KV-Tube v3.0
|
|
|
|
> A lightweight, privacy-focused YouTube frontend web application with AI-powered features.
|
|
|
|
KV-Tube removes distractions, tracking, and ads from the YouTube watching experience. It provides a clean interface to search, watch, and discover related content without needing a Google account.
|
|
|
|
## 🚀 Key Features (v3)
|
|
|
|
- **Privacy First**: No tracking, no ads.
|
|
- **Clean Interface**: Distraction-free watching experience.
|
|
- **Efficient Streaming**: Direct video stream extraction using `yt-dlp`.
|
|
- **AI Summary (Experimental)**: Generate concise summaries of videos (Currently disabled due to upstream rate limits).
|
|
- **Multi-Language**: Support for English and Vietnamese (UI & Content).
|
|
- **Auto-Update**: Includes `update_deps.py` to easily keep core fetching tools up-to-date.
|
|
|
|
## 🛠️ Architecture Data Flow
|
|
|
|
```mermaid
|
|
graph TD
|
|
User["User Browser"]
|
|
Server["KV-Tube Server (Flask)"]
|
|
YTDLP["yt-dlp Core"]
|
|
YTFetcher["YTFetcher Lib"]
|
|
YouTube["YouTube V3 API / HTML"]
|
|
|
|
User -- "1. Search / Watch Request" --> Server
|
|
Server -- "2. Extract Video Metadata" --> YTDLP
|
|
YTDLP -- "3. Network Requests (Cookies Optional)" --> YouTube
|
|
YouTube -- "4. Raw Video/Audio Streams" --> YTDLP
|
|
YTDLP -- "5. Stream URL / Metadata" --> Server
|
|
|
|
subgraph TranscriptSystem ["Transcript System (Deferred)"]
|
|
Server -.-> YTFetcher
|
|
YTFetcher -.-> YouTube
|
|
YTFetcher -- "No Transcript (429)" -.-> Server
|
|
end
|
|
|
|
Server -- "6. Render HTML / Stream Proxy" --> User
|
|
```
|
|
|
|
## 🔧 Installation & Usage
|
|
|
|
### Prerequisites
|
|
- Python 3.10+
|
|
- Git
|
|
- Valid `cookies.txt` (Optional, for bypassing age-restrictions or rate limits)
|
|
|
|
### Local Setup
|
|
1. Clone the repository:
|
|
```bash
|
|
git clone https://git.khoavo.myds.me/vndangkhoa/kv-tube.git
|
|
cd kv-tube
|
|
```
|
|
2. Install dependencies:
|
|
```bash
|
|
pip install -r requirements.txt
|
|
```
|
|
3. Run the application:
|
|
```bash
|
|
python wsgi.py
|
|
```
|
|
4. Access at `http://localhost:5002`
|
|
|
|
### Docker Deployment (Linux/AMD64)
|
|
|
|
Built for stability and ease of use.
|
|
|
|
```bash
|
|
docker pull vndangkhoa/kv-tube:latest
|
|
docker run -d -p 5002:5002 -v $(pwd)/cookies.txt:/app/cookies.txt vndangkhoa/kv-tube:latest
|
|
```
|
|
|
|
## 📦 Updates
|
|
|
|
- **v3.0**: Major release.
|
|
- Full modularization of backend routes.
|
|
- Integrated `ytfetcher` for specialized fetching.
|
|
- Added manual dependency update script (`update_deps.py`).
|
|
- Enhanced error handling for upstream rate limits.
|
|
- Docker `linux/amd64` support verified.
|
|
|
|
---
|
|
*Developed by Khoa Vo*
|