Redd-Archiver

⭐ If you find this project useful, please star the repo! It helps others discover the tool and motivates continued development.

Transform compressed data dumps into browsable HTML archives with flexible deployment options. Redd-Archiver supports offline browsing via sorted index pages OR full-text search with Docker deployment. Features mobile-first design, multi-platform support, and enterprise-grade performance with PostgreSQL full-text indexing.

Supported Platforms: | Platform | Format | Status | Available Posts | Data | |----------|--------|--------|----------------|------| | Reddit | .zst JSON Lines (Pushshift) | ✅ Full support | 2.38B posts (40,029 subreddits, through Dec 31 2025) | Download | | Voat | SQL dumps | ✅ Full support | 3.81M posts, 24.1M comments (22,637 subverses, complete archive) | Download | | Ruqqus | .7z JSON Lines | ✅ Full support | 500K posts (6,217 guilds, complete archive) | Download |

Tracked content: 2.384 billion posts across 68,883 communities (Reddit full Pushshift dataset through Dec 31 2025, Voat/Ruqqus complete archives)

Version 1.0 features multi-platform archiving, REST API with 30+ endpoints, MCP server for AI integration, and PostgreSQL-backed architecture for large-scale processing.

🚀 Quick Start

Archive internet history before it disappears - Deploy in 2 minutes, no domain required.

Try the live demo: Browse Example Archive →

→ QUICKSTART.md - Step-by-step deployment:

2 min: Tor hidden service (no domain, no port forwarding, works behind CGNAT)
5 min: Local testing (HTTP on localhost)
15 min: Production HTTPS (automated Let's Encrypt)

Why now? Communities get banned, platforms shut down, discussions vanish. Start preserving today.

Documentation

→ First time here? QUICKSTART.md - Deploy in 2-15 minutes

→ Quick answers? FAQ - Common questions answered in 30 seconds

→ Need help? Troubleshooting - Fix common issues

→ Using the API? API Reference - 30+ REST endpoints

→ How it works? Architecture - Technical deep-dive

→ Deployment guides:

Tor Hidden Service - .onion setup (2 min, no domain needed)
HTTPS Production - Let's Encrypt SSL (15 min)
Static Hosting - GitHub/Codeberg Pages (browse-only)
Docker Reference - Complete Docker guide

→ Advanced:

MCP Server - AI integration (Claude Desktop/Code)
Scanner Tools - Data discovery utilities
Registry Setup - Instance leaderboard

🎯 Key Features

🌐 Multi-Platform Support

Archive content from multiple link aggregator platforms in a single unified archive:

| Platform | Format | CLI Flag | URL Prefix | |----------|--------|----------|------------| | Reddit | .zst JSON Lines | --subreddit | /r/ | | Voat | SQL dumps | --subverse | /v/ | | Ruqqus | .7z JSON Lines | --guild | /g/ |

Automatic Detection: Platform auto-detected from file extensions
Unified Search: PostgreSQL FTS searches across all platforms
Mixed Archives: Combine Reddit, Voat, and Ruqqus in single archive

🤖 MCP Server (AI Integration)

29 MCP tools auto-generated from OpenAPI for AI assistants:

Full Archive Access: Query posts, comments, users, search via Claude Desktop or Claude Code
Token Overflow Prevention: Built-in LLM guidance with field selection and truncation
5 MCP Resources: Instant access to stats, top posts, subreddits, search help
Claude Code Ready: Copy-paste configuration for immediate use

{
  "mcpServers": {
    "reddarchiver": {
      "command": "uv",
      "args": ["--directory", "/path/to/mcp_server", "run", "python", "server.py"],
      "env": { "REDDARCHIVER_API_URL": "http://localhost:5000" }
    }
  }
}

See MCP Server Documentation for complete setup guide.

Core Functionality

📱 Mobile-First Design: Responsive layout optimized for all devices with touch-friendly navigation
🔍 Advanced Search System (Server Required): PostgreSQL full-text search optimized for Tor network. Search by keywords, subreddit, author, date, score. Requires Docker deployment - offline browsing uses sorted index pages.
⚡ JavaScript Free: Complete functionality without JS, pure CSS interactions
🎨 Theme Support: Built-in light/dark theme toggle with CSS-only implementation
♿ Accessibility: WCAG compliant with keyboard navigation and screen reader support
🚄 Performance: Optimized CSS (29KB), designed for low-bandwidth networks

Technical Excellence

🏗️ Modular Architecture: 18 specialized modules for maintainability and extensibility
🗄️ PostgreSQL Backend: Large-scale processing with constant memory usage regardless of dataset size
⚡ Lightning-Fast Search: PostgreSQL full-text search with GIN indexing
🌐 REST API v1: 30+ endpoints with MCP/AI optimization for programmatic access to posts, comments, users, statistics, search, aggregations, and exports
🧅 Tor-Optimized: Zero JavaScript, server-side search, no external dependencies
📊 Rich Statistics: Comprehensive analytics dashboard with file size tracking
🔗 SEO Optimized: Complete meta tags, XML sitemaps, and structured data
💾 Streaming Processing: Memory-efficient with automatic resume capability
📈 Progress Tracking: Real-time transfer rates, ETAs, and database metrics
🏆 Instance Registry: Leaderboard system with completeness-weighted scoring for distributed archives

Deployment Options

🏠 Local/Homelab: HTTP on localhost or LAN (2 commands)
🌐 Production HTTPS: Automated Let's Encrypt setup (5 minutes)
🧅 Tor Hidden Service: .onion access, zero networking config (2 minutes)
🔀 Dual-Mode: HTTPS + Tor simultaneously
📄 Static Hosting: GitHub/Codeberg Pages for small archives (browse-only, no search)

📸 Screenshots

Dashboard

Main landing page showing archive overview with statistics for 9,592 posts across Reddit, Voat, and Ruqqus. Features customizable branding (site name, project URL), responsive cards, activity metrics, and content statistics. (Works offline)

Subreddit Index

Post listing with sorting options (score, comments, date), pagination, and badge coloring. Includes navigation and theme toggle. (Works offline - sorted by score/comments/date)

Post Page with Comments

Post Page

Individual post displaying nested comment threads with collapsible UI, user flair, and timestamps. Comments include anchor links for direct navigation from user pages. (Works offline)

Mobile Responsive Design

Fully optimized for mobile devices with touch-friendly navigation and responsive layout.

Search Interface

PostgreSQL full-text search with Google-style operators. Supports filtering by subreddit, author, date range, and score. (Requires Docker deployment)

Search results with highlighted excerpts using PostgreSQL ts_headline(). Sub-second response times with GIN indexing. (Server-based, Tor-compatible)

Sample Archive: Multi-platform archive featuring programming and technology communities from Reddit, Voat, and Ruqqus · See all screenshots →

🛠️ Installation

Prerequisites: Python 3.7+, PostgreSQL 12+, 4GB+ RAM

Quick Install (Docker):

git clone https://github.com/19-84/redd-archiver.git
cd redd-archiver

# Create required directories
mkdir -p data output/.postgres-data logs tor-public

# Configure environment (IMPORTANT: change passwords!)
cp .env.example .env
nano .env  # Edit POSTGRES_PASSWORD and DATABASE_URL

# Start services
docker compose up -d

# Generate archive (after downloading .zst files to data/)
python reddarc.py data/ \
  --subreddit privacy \
  --comments-file data/privacy_comments.zst \
  --submissions-file data/privacy_submissions.zst \
  --output output/

Detailed installation procedures (Docker, Ubuntu/Debian, macOS, Windows WSL2):

Installation Guide - Platform-specific setup and troubleshooting

📊 Usage

Quick workflow: Download data → Run archive generator → Deploy

Basic Example

# Generate archive (assumes .zst files in data/ directory)
python reddarc.py data

redd-archiver

Related Skills