@roomi-fields/notebooklm-mcp 1.5.3 → 1.5.7

package/deployment/docs/08-DOCKER.md

@@ -26,26 +26,68 @@ docker build -t notebooklm-mcp .
 # Run container
 docker run -d \
   --name notebooklm-mcp \
+  --restart unless-stopped \
   -p 3000:3000 \
+  -p 6080:6080 \
   -v notebooklm-data:/data \
+  -e HEADLESS=true \
+  -e STEALTH_ENABLED=true \
+  -e NOTEBOOKLM_UI_LOCALE=fr \
   notebooklm-mcp
 ```
 
-## First-Time Setup
+## Ports
 
-After starting the container, you need to authenticate with Google:
+| Port | Description                              |
+| ---- | ---------------------------------------- |
+| 3000 | HTTP REST API                            |
+| 6080 | noVNC web interface (for authentication) |
+
+## First-Time Authentication via noVNC
+
+Docker includes a **noVNC server** for visual browser access, required for initial Google authentication.
+
+### Step 1: Open noVNC
+
+Open in your browser:
+
+```
+http://localhost:6080/vnc.html
+```
+
+### Step 2: Trigger Authentication
 
 ```bash
-# Option 1: Use the setup-auth endpoint
 curl -X POST http://localhost:3000/setup-auth \
   -H "Content-Type: application/json" \
   -d '{"show_browser": true}'
+```
 
-# Option 2: Copy existing credentials into the container
-docker cp ~/.local/share/notebooklm-mcp/. notebooklm-mcp:/data/
+### Step 3: Login in noVNC
+
+1. The Chromium browser appears in the noVNC window
+2. Complete Google login
+3. Authentication is saved automatically
+4. Browser closes when done
+
+### Verify Authentication
+
+```bash
+curl http://localhost:3000/health
+# → {"success":true,"data":{"authenticated":true,...}}
 ```
 
-**Note:** For initial authentication, you may need to run in non-headless mode or use pre-authenticated credentials.
+## Alternative: Copy Existing Credentials
+
+If you've already authenticated locally:
+
+```bash
+# Copy from local machine to container
+docker cp ~/.local/share/notebooklm-mcp/. notebooklm-mcp:/data/
+
+# Restart container
+docker restart notebooklm-mcp
+```
 
 ## Configuration
 
@@ -60,6 +102,8 @@ docker cp ~/.local/share/notebooklm-mcp/. notebooklm-mcp:/data/
 | `NOTEBOOKLM_DATA_DIR`  | `/data`   | Data directory path   |
 | `NOTEBOOKLM_UI_LOCALE` | `fr`      | UI language (fr/en)   |
 | `AUTO_LOGIN_ENABLED`   | `false`   | Enable auto-login     |
+| `ENABLE_VNC`           | `true`    | Enable noVNC server   |
+| `NOVNC_PORT`           | `6080`    | noVNC web port        |
 
 ### Custom Configuration
 
@@ -79,15 +123,15 @@ All data is stored in the `/data` volume:
 ```
 /data/
 ├── library.json          # Notebook library
+├── chrome_profile/       # Chrome profile (Google session)
+├── browser_state/        # Browser state backup
 ├── accounts.json         # Account configuration
 ├── accounts/             # Per-account data
 │   └── account-xxx/
 │       ├── credentials.enc.json
 │       ├── quota.json
 │       └── state.json
-├── browser_state/        # Browser cookies/state
-│   └── state.json
-└── chrome_profile/       # Chrome profile data
+└── encryption.key        # Encryption key
 ```
 
 ### Backup
@@ -106,6 +150,46 @@ docker run --rm \
   alpine tar xzf /backup/notebooklm-backup.tar.gz -C /data
 ```
 
+## NAS Deployment (Synology, QNAP)
+
+### Build and Export
+
+```bash
+# On your local machine
+npm run build
+docker build -t notebooklm-mcp:latest .
+docker save notebooklm-mcp:latest | gzip > notebooklm-mcp.tar.gz
+```
+
+### Upload and Deploy
+
+```bash
+# Upload to NAS
+scp notebooklm-mcp.tar.gz user@nas:/volume1/docker/
+
+# SSH to NAS and load
+ssh user@nas
+docker load < /volume1/docker/notebooklm-mcp.tar.gz
+
+# Run container
+docker run -d \
+  --name notebooklm-mcp \
+  --restart unless-stopped \
+  -p 3000:3000 \
+  -p 6080:6080 \
+  -v /volume1/docker/notebooklm/data:/data \
+  -e HEADLESS=true \
+  -e STEALTH_ENABLED=true \
+  -e NOTEBOOKLM_UI_LOCALE=fr \
+  notebooklm-mcp:latest
+```
+
+### Authenticate via noVNC
+
+1. Open `http://nas-ip:6080/vnc.html`
+2. Run setup-auth command
+3. Complete Google login in VNC window
+
 ## Resource Requirements
 
 | Resource | Minimum | Recommended |
@@ -114,7 +198,7 @@ docker run --rm \
 | CPU      | 1 core  | 2 cores     |
 | Disk     | 500 MB  | 2 GB        |
 
-Chromium in headless mode uses significant memory. Adjust limits in `docker-compose.yml`:
+Chromium uses significant memory. Adjust limits in `docker-compose.yml`:
 
 ```yaml
 deploy:
@@ -131,13 +215,10 @@ deploy:
 
 ```bash
 # Check logs
-docker-compose logs notebooklm-mcp
+docker logs notebooklm-mcp
 
 # Check container status
 docker ps -a
-
-# Inspect container
-docker inspect notebooklm-mcp
 ```
 
 ### Browser issues
@@ -145,8 +226,14 @@ docker inspect notebooklm-mcp
 If Chromium fails to launch:
 
 1. Ensure sufficient memory (minimum 512MB)
-2. Check for missing dependencies in logs
-3. Try rebuilding: `docker-compose build --no-cache`
+2. Check logs for errors
+3. Try rebuilding: `docker build --no-cache -t notebooklm-mcp .`
+
+### noVNC not accessible
+
+1. Verify port 6080 is exposed
+2. Check firewall rules
+3. Verify container is running: `docker ps`
 
 ### Authentication issues
 
@@ -154,8 +241,7 @@ If Chromium fails to launch:
 # Check health endpoint
 curl http://localhost:3000/health
 
-# If not authenticated, run setup
-curl -X POST http://localhost:3000/setup-auth
+# If not authenticated, use noVNC method above
 ```
 
 ### Permission issues
@@ -183,51 +269,35 @@ server {
         proxy_set_header X-Real-IP $remote_addr;
         proxy_cache_bypass $http_upgrade;
     }
-}
-```
-
-### With Traefik
 
-```yaml
-services:
-  notebooklm-mcp:
-    labels:
-      - 'traefik.enable=true'
-      - 'traefik.http.routers.notebooklm.rule=Host(`notebooklm.example.com`)'
-      - 'traefik.http.services.notebooklm.loadbalancer.server.port=3000'
+    # noVNC (restrict access!)
+    location /vnc {
+        proxy_pass http://localhost:6080;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection 'upgrade';
+        # Add authentication here!
+    }
+}
 ```
 
 ### Security Considerations
 
-1. **Don't expose port 3000 publicly** - use a reverse proxy with authentication
-2. **Use secrets management** for credentials
+1. **Don't expose port 6080 publicly** - noVNC gives browser access
+2. **Use a reverse proxy with authentication** for production
 3. **Regular backups** of the data volume
 4. **Monitor container health** using the healthcheck endpoint
 
-## Building Custom Image
-
-```bash
-# Build with specific Node version
-docker build --build-arg NODE_VERSION=20 -t notebooklm-mcp:custom .
+## Architecture
 
-# Multi-platform build
-docker buildx build --platform linux/amd64,linux/arm64 -t notebooklm-mcp:multi .
 ```
-
-## Development Mode
-
-For development with hot reload:
-
-```yaml
-# docker-compose.override.yml
-version: '3.8'
-services:
-  notebooklm-mcp:
-    build:
-      context: .
-      dockerfile: Dockerfile.dev
-    volumes:
-      - .:/app
-      - /app/node_modules
-    command: npm run dev:http
+Docker Container
+├── Node.js HTTP Server (port 3000)
+├── Xvfb (:99) - Virtual display
+├── x11vnc - VNC server
+├── websockify/noVNC (port 6080) - Web VNC
+└── Chromium browser
+
+User → noVNC (6080) → VNC → Xvfb → Chromium
+User → HTTP API (3000) → Node.js → Chromium
 ```

package/deployment/docs/README.md

@@ -23,6 +23,7 @@
 | [**05-TROUBLESHOOTING.md**](./05-TROUBLESHOOTING.md)   | Solutions to common problems                | Debugging, errors       |
 | [**06-NOTEBOOK-LIBRARY.md**](./06-NOTEBOOK-LIBRARY.md) | Multi-notebook library management           | Notebook management     |
 | [**07-AUTO-DISCOVERY.md**](./07-AUTO-DISCOVERY.md)     | Autonomous resource discovery pattern       | Auto-discovery feature  |
+| [**08-DOCKER.md**](./08-DOCKER.md)                     | Docker deployment with noVNC                | Docker, NAS users       |
 | [**11-MULTI-ACCOUNT.md**](./11-MULTI-ACCOUNT.md)       | Multi-account management and rotation       | Rate limit handling     |
 | [**Test Scripts**](../scripts/README.md)               | PowerShell validation scripts               | Testing, CI/CD          |
 
@@ -64,6 +65,12 @@
 2. [Automatic rotation](./11-MULTI-ACCOUNT.md#automatic-rotation-flow) — How rotation works
 3. [Quota management](./11-MULTI-ACCOUNT.md#troubleshooting) — Reset and monitor quotas
 
+### I want to deploy on Docker/NAS
+
+1. [Docker guide](./08-DOCKER.md) — Complete Docker deployment
+2. [noVNC authentication](./08-DOCKER.md#first-time-authentication-via-novnc) — Visual auth in browser
+3. [NAS deployment](./08-DOCKER.md#nas-deployment-synology-qnap) — Synology, QNAP setup
+
 ---
 
 ## 📖 Quick Reference
@@ -203,5 +210,5 @@ Or directly propose a PR to improve the documentation!
 
 ---
 
-**Documentation updated:** 2025-12-29
-**Version:** 1.4.2
+**Documentation updated:** 2026-01-05
+**Version:** 1.5.3

package/deployment/scripts/install.ps1

@@ -1,114 +1,114 @@
-# Automatic installation script - NotebookLM MCP HTTP Server
-# Version: 1.3.0
-# Description: Installs all dependencies and compiles the project
-
-Write-Host "╔══════════════════════════════════════════════════════════╗" -ForegroundColor Cyan
-Write-Host "║  NotebookLM MCP - Automatic Installation                 ║" -ForegroundColor Cyan
-Write-Host "╚══════════════════════════════════════════════════════════╝" -ForegroundColor Cyan
-Write-Host ""
-
-# Check Node.js
-Write-Host "🔍 Checking Node.js..." -ForegroundColor Yellow
-try {
-    $nodeVersion = node --version
-    $npmVersion = npm --version
-    Write-Host "✅ Node.js $nodeVersion found" -ForegroundColor Green
-    Write-Host "✅ npm $npmVersion found" -ForegroundColor Green
-} catch {
-    Write-Host "❌ Node.js is not installed!" -ForegroundColor Red
-    Write-Host ""
-    Write-Host "📥 Download Node.js from: https://nodejs.org/" -ForegroundColor Yellow
-    Write-Host "   Install the LTS version and run this script again." -ForegroundColor Yellow
-    exit 1
-}
-
-Write-Host ""
-
-# Check that we're in the right directory
-Write-Host "🔍 Checking directory..." -ForegroundColor Yellow
-if (-not (Test-Path "package.json")) {
-    Write-Host "❌ package.json file not found!" -ForegroundColor Red
-    Write-Host "   Make sure you are in the project root directory." -ForegroundColor Yellow
-    exit 1
-}
-
-$projectName = (Get-Content "package.json" -Raw | ConvertFrom-Json).name
-Write-Host "✅ Project detected: $projectName" -ForegroundColor Green
-Write-Host ""
-
-# Install dependencies
-Write-Host "📦 Installing npm dependencies..." -ForegroundColor Yellow
-Write-Host "   (This may take 2-5 minutes)" -ForegroundColor Gray
-Write-Host ""
-
-npm install
-
-if ($LASTEXITCODE -ne 0) {
-    Write-Host ""
-    Write-Host "❌ Error during dependency installation" -ForegroundColor Red
-    Write-Host "   Check your Internet connection and try again." -ForegroundColor Yellow
-    exit 1
-}
-
-Write-Host ""
-Write-Host "✅ Dependencies installed successfully!" -ForegroundColor Green
-Write-Host ""
-
-# TypeScript compilation
-Write-Host "🔨 Compiling project..." -ForegroundColor Yellow
-npm run build
-
-if ($LASTEXITCODE -ne 0) {
-    Write-Host ""
-    Write-Host "❌ Error during compilation" -ForegroundColor Red
-    exit 1
-}
-
-Write-Host ""
-Write-Host "✅ Compilation successful!" -ForegroundColor Green
-Write-Host ""
-
-# Final checks
-Write-Host "🔍 Final checks..." -ForegroundColor Yellow
-
-$checks = @(
-    @{File = "dist\http-wrapper.js"; Description = "HTTP Server"},
-    @{File = "dist\index.js"; Description = "MCP Server"},
-    @{File = "node_modules\express"; Description = "Express.js"}
-)
-
-$allOk = $true
-foreach ($check in $checks) {
-    if (Test-Path $check.File) {
-        Write-Host "  ✅ $($check.Description)" -ForegroundColor Green
-    } else {
-        Write-Host "  ❌ $($check.Description) - $($check.File) not found" -ForegroundColor Red
-        $allOk = $false
-    }
-}
-
-Write-Host ""
-
-if ($allOk) {
-    Write-Host "╔══════════════════════════════════════════════════════════╗" -ForegroundColor Green
-    Write-Host "║  ✅ INSTALLATION COMPLETED SUCCESSFULLY!                 ║" -ForegroundColor Green
-    Write-Host "╚══════════════════════════════════════════════════════════╝" -ForegroundColor Green
-    Write-Host ""
-    Write-Host "📋 Next steps:" -ForegroundColor Cyan
-    Write-Host ""
-    Write-Host "1️⃣  Configure Google authentication (one time only):" -ForegroundColor White
-    Write-Host "   .\deployment\scripts\setup-auth.ps1" -ForegroundColor Gray
-    Write-Host ""
-    Write-Host "2️⃣  Start the server:" -ForegroundColor White
-    Write-Host "   npm run start:http" -ForegroundColor Gray
-    Write-Host ""
-    Write-Host "3️⃣  Test the server:" -ForegroundColor White
-    Write-Host "   curl http://localhost:3000/health" -ForegroundColor Gray
-    Write-Host ""
-    Write-Host "📖 Complete documentation: .\deployment\docs\" -ForegroundColor Cyan
-    Write-Host ""
-} else {
-    Write-Host "❌ Installation encountered problems" -ForegroundColor Red
-    Write-Host "   See: .\deployment\docs\05-TROUBLESHOOTING.md" -ForegroundColor Yellow
-    exit 1
-}
+# Automatic installation script - NotebookLM MCP HTTP Server
+# Version: 1.3.0
+# Description: Installs all dependencies and compiles the project
+
+Write-Host "╔══════════════════════════════════════════════════════════╗" -ForegroundColor Cyan
+Write-Host "║  NotebookLM MCP - Automatic Installation                 ║" -ForegroundColor Cyan
+Write-Host "╚══════════════════════════════════════════════════════════╝" -ForegroundColor Cyan
+Write-Host ""
+
+# Check Node.js
+Write-Host "🔍 Checking Node.js..." -ForegroundColor Yellow
+try {
+    $nodeVersion = node --version
+    $npmVersion = npm --version
+    Write-Host "✅ Node.js $nodeVersion found" -ForegroundColor Green
+    Write-Host "✅ npm $npmVersion found" -ForegroundColor Green
+} catch {
+    Write-Host "❌ Node.js is not installed!" -ForegroundColor Red
+    Write-Host ""
+    Write-Host "📥 Download Node.js from: https://nodejs.org/" -ForegroundColor Yellow
+    Write-Host "   Install the LTS version and run this script again." -ForegroundColor Yellow
+    exit 1
+}
+
+Write-Host ""
+
+# Check that we're in the right directory
+Write-Host "🔍 Checking directory..." -ForegroundColor Yellow
+if (-not (Test-Path "package.json")) {
+    Write-Host "❌ package.json file not found!" -ForegroundColor Red
+    Write-Host "   Make sure you are in the project root directory." -ForegroundColor Yellow
+    exit 1
+}
+
+$projectName = (Get-Content "package.json" -Raw | ConvertFrom-Json).name
+Write-Host "✅ Project detected: $projectName" -ForegroundColor Green
+Write-Host ""
+
+# Install dependencies
+Write-Host "📦 Installing npm dependencies..." -ForegroundColor Yellow
+Write-Host "   (This may take 2-5 minutes)" -ForegroundColor Gray
+Write-Host ""
+
+npm install
+
+if ($LASTEXITCODE -ne 0) {
+    Write-Host ""
+    Write-Host "❌ Error during dependency installation" -ForegroundColor Red
+    Write-Host "   Check your Internet connection and try again." -ForegroundColor Yellow
+    exit 1
+}
+
+Write-Host ""
+Write-Host "✅ Dependencies installed successfully!" -ForegroundColor Green
+Write-Host ""
+
+# TypeScript compilation
+Write-Host "🔨 Compiling project..." -ForegroundColor Yellow
+npm run build
+
+if ($LASTEXITCODE -ne 0) {
+    Write-Host ""
+    Write-Host "❌ Error during compilation" -ForegroundColor Red
+    exit 1
+}
+
+Write-Host ""
+Write-Host "✅ Compilation successful!" -ForegroundColor Green
+Write-Host ""
+
+# Final checks
+Write-Host "🔍 Final checks..." -ForegroundColor Yellow
+
+$checks = @(
+    @{File = "dist\http-wrapper.js"; Description = "HTTP Server"},
+    @{File = "dist\index.js"; Description = "MCP Server"},
+    @{File = "node_modules\express"; Description = "Express.js"}
+)
+
+$allOk = $true
+foreach ($check in $checks) {
+    if (Test-Path $check.File) {
+        Write-Host "  ✅ $($check.Description)" -ForegroundColor Green
+    } else {
+        Write-Host "  ❌ $($check.Description) - $($check.File) not found" -ForegroundColor Red
+        $allOk = $false
+    }
+}
+
+Write-Host ""
+
+if ($allOk) {
+    Write-Host "╔══════════════════════════════════════════════════════════╗" -ForegroundColor Green
+    Write-Host "║  ✅ INSTALLATION COMPLETED SUCCESSFULLY!                 ║" -ForegroundColor Green
+    Write-Host "╚══════════════════════════════════════════════════════════╝" -ForegroundColor Green
+    Write-Host ""
+    Write-Host "📋 Next steps:" -ForegroundColor Cyan
+    Write-Host ""
+    Write-Host "1️⃣  Configure Google authentication (one time only):" -ForegroundColor White
+    Write-Host "   .\deployment\scripts\setup-auth.ps1" -ForegroundColor Gray
+    Write-Host ""
+    Write-Host "2️⃣  Start the server:" -ForegroundColor White
+    Write-Host "   npm run start:http" -ForegroundColor Gray
+    Write-Host ""
+    Write-Host "3️⃣  Test the server:" -ForegroundColor White
+    Write-Host "   curl http://localhost:3000/health" -ForegroundColor Gray
+    Write-Host ""
+    Write-Host "📖 Complete documentation: .\deployment\docs\" -ForegroundColor Cyan
+    Write-Host ""
+} else {
+    Write-Host "❌ Installation encountered problems" -ForegroundColor Red
+    Write-Host "   See: .\deployment\docs\05-TROUBLESHOOTING.md" -ForegroundColor Yellow
+    exit 1
+}