davidedg/webgyb repository overview

⁠WebGYB - Web Interface for Gmail Backups

WebGYB provides a web interface for viewing GMail backups created by Got-Your-Back (GYB)⁠.

⁠Key Features

• 📧 Multi-Account Support: Switch between multiple Gmail accounts seamlessly
• 🏷️ Labels Management: Full support for GMail labels
• 🛡️ Safe Rendering: Protected email content display with HTML sanitization
• 📥 Email Management: View original email source and download in EML format
• 🖥️ Multi-Platform: Supports amd64, arm64, and armv7 architectures - for ARM, see this⁠

⁠Quick Start

docker run -d \
  -p 3000:3000 \
  -v "/path/to/gyb/accounts:/app/accounts" \
  davidedg/webgyb

Access the application at http://localhost:3000

⁠Required Directory Structure

accounts/
└── {account1}/
    ├── msg-db.sqlite
    └── {email_folders}/
└── {account2}/
    ├── msg-db.sqlite
    └── {email_folders}/

⁠Docker Compose Example

services:
  webgyb:
    image: davidedg/webgyb
    container_name: webgyb
    init: true
    user: "1000:1000"
    ports:
      - "3000:3000"
    volumes:
      - /path/to/gyb/accounts:/app/accounts:ro
    environment:
      - PUID=1000
      - PGID=1000
      - NODE_ENV=production
      - HOST=0.0.0.0
      - PORT=3000
      - GYB_ACCOUNTS_DIR=/app/accounts
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:3000/"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 10s

⁠Environment Variables

• PUID: User ID (default: 1000)
• PGID: Group ID (default: 1000)
• NODE_ENV: Node environment (default: production)
• HOST: Host to bind to (default: 0.0.0.0)
• PORT: Port to listen on (default: 3000)
• GYB_ACCOUNTS_DIR: Directory containing GYB accounts (default: /app/accounts)

⁠Support & Contributing

• GitHub Repository: davidedg/webgyb⁠
• Issues & Feature Requests: GitHub Issues⁠
• Support the project: GitHub Sponsors⁠