Skip to content

Commit 7b3dcc1

Browse files
Update README to reflect support for MP4 streams and enhance user guidance
- Revised descriptions to include MP4 alongside M3U8 for video stream detection and downloading. - Added new images for overall system and backend architecture. - Updated key features and usage instructions to highlight the side panel interface and cookie/header forwarding for authenticated streams. - Bumped version to 1.4.0 and updated last modified date.
1 parent daa1e04 commit 7b3dcc1

File tree

3 files changed

+29
-14
lines changed

3 files changed

+29
-14
lines changed

README.md

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
[![Chrome Extension](https://img.shields.io/badge/Chrome-Extension-red.svg)](https://developer.chrome.com/docs/extensions/)
77
[![Release](https://img.shields.io/github/v/release/asdfghj1237890/chrome2nas-m3u8)](https://github.com/asdfghj1237890/chrome2nas-m3u8/releases/latest)
88

9-
> Seamlessly capture m3u8 video streams from Chrome and download them to your NAS
9+
> Seamlessly capture M3U8 and MP4 video streams from Chrome and download them to your NAS
1010
1111
## Overview
1212

1313
This system enables you to:
14-
1. 🔍 Detect m3u8 video stream URLs in Chrome
14+
1. 🔍 Detect M3U8 and MP4 video URLs in Chrome
1515
2. 📤 Send URLs to your NAS with one click
1616
3. ⬇️ Automatically download and convert to MP4
1717
4. 💾 Store videos on your NAS storage
@@ -22,6 +22,12 @@ This system enables you to:
2222
Chrome Extension → NAS Docker (API + Worker) → Video Storage
2323
```
2424

25+
![Overall System Architecture](pics/overall_system_architecture.png)
26+
27+
### Backend Architecture
28+
29+
![Backend Architecture](pics/backend_architecture.png)
30+
2531
## Quick Links
2632

2733
<img align="right" src="docs/extension-screenshot.png" alt="Chrome Extension Screenshot" width="300">
@@ -37,9 +43,11 @@ Chrome Extension → NAS Docker (API + Worker) → Video Storage
3743
## Key Features
3844

3945
### Chrome Extension
40-
- ✅ Automatic m3u8 URL detection
46+
- ✅ Automatic M3U8 and MP4 URL detection
4147
- ✅ One-click send to NAS
48+
- ✅ Side panel interface for easy access
4249
- ✅ Real-time download progress
50+
- ✅ Cookie & header forwarding for authenticated streams
4351
- ✅ Context menu integration
4452
- ✅ Configurable NAS endpoint
4553

@@ -88,9 +96,11 @@ Chrome Extension → NAS Docker (API + Worker) → Video Storage
8896
- Progress tracking
8997
- Retry mechanism
9098
- [x] Phase 3: Chrome extension (URL detection, UI) ✅
91-
- Automatic M3U8 detection
99+
- Automatic M3U8 and MP4 detection
92100
- One-click send to NAS
101+
- Side panel interface
93102
- Real-time progress monitoring
103+
- Cookie & header forwarding
94104
- Settings management
95105
- Context menu integration
96106
- Badge notifications
@@ -162,17 +172,19 @@ For detailed instructions including Synology NAS setup, see **[INSTALL.md](INSTA
162172
You can now:
163173
- ✅ Deploy Docker stack on Synology NAS or any Docker host
164174
- ✅ Download M3U8 video streams to MP4
165-
- ✅ Use Chrome extension for automatic detection
166-
- ✅ Monitor download progress in real-time
175+
- ✅ Download MP4 videos directly
176+
- ✅ Use Chrome extension for automatic detection (M3U8 & MP4)
177+
- ✅ Forward cookies & headers for authenticated streams
178+
- ✅ Monitor download progress in side panel
167179
- ✅ Manage downloads via REST API
168180

169181
## Usage
170182

171183
1. Browse to any video streaming site
172-
2. When m3u8 URL is detected, extension badge shows notification
173-
3. Click extension icon or right-click → "Send to NAS"
174-
4. Video downloads automatically to your NAS
175-
5. Monitor progress in extension popup
184+
2. When video URL (M3U8/MP4) is detected, extension badge shows notification
185+
3. Click extension icon to open side panel, or right-click → "Send to NAS"
186+
4. Video downloads automatically to your NAS (with cookies for authenticated streams)
187+
5. Monitor progress in the side panel
176188
6. Access completed videos in `/downloads/completed/`
177189

178190
## Configuration
@@ -197,9 +209,11 @@ The system runs **2 workers** by default for parallel processing:
197209
### Extension Settings
198210
- **NAS Endpoint**: `https://192.168.1.100:52052`
199211
- **API Key**: Your configured API key
200-
- **Auto Detect**: Enable automatic m3u8 detection
212+
- **Auto Detect**: Enable automatic M3U8/MP4 detection
201213
- **Notifications**: Enable completion notifications
202214

215+
> **Note**: Click the extension icon to open the side panel for managing detected videos and monitoring downloads.
216+
203217
## Security Notes
204218

205219
⚠️ **Important Security Considerations:**
@@ -225,8 +239,9 @@ The system runs **2 workers** by default for parallel processing:
225239

226240
### Download fails
227241
- Check logs: `docker-compose logs worker`
228-
- Verify m3u8 URL is accessible
242+
- Verify video URL is accessible
229243
- Check disk space on NAS
244+
- For authenticated streams, ensure cookies are being captured
230245

231246
### Slow downloads
232247
- Reduce concurrent downloads in .env
@@ -262,8 +277,8 @@ MIT License - See LICENSE file for details
262277
---
263278

264279
**Status**: Core Features Complete | Production Ready
265-
**Version**: 1.3.0
266-
**Last Updated**: 2025-10-17
280+
**Version**: 1.4.0
281+
**Last Updated**: 2025-12-04
267282
**Port**: 52052 (unified)
268283

269284
## Star History

pics/backend_architecture.png

189 KB
Loading
311 KB
Loading

0 commit comments

Comments
 (0)