Pimeleon Documentation

Complete guides and reference documentation for deploying, configuring, and operating Pimeleon router on Raspberry Pi hardware.

Documentation Sections

Getting Started

New to Pimeleon? Start here for installation and initial setup.

• Installation Guide - Download and flash Pimeleon to SD card
• First Boot Setup - Initial configuration and network setup
• Quick Setup Guide - Fast-track network integration
• User Guide - Basic operations and maintenance
• FAQ - Frequently asked questions
• Backup & Restore - Configuration backup procedures

Architecture

Understand how Pimeleon works under the hood.

• Architecture Overview - System design and components
• Network Architecture - Network topology and interfaces
• Services - Core services and integrations
  • DNS Filtering - Network-wide ad blocking and DNSCrypt
  • HTTP Filtering - Privoxy and Squid proxy
  • Tor Anonymity - Optional Tor routing
  • DHCP Server - Dynamic IP allocation
  • DNS Architecture - DNS resolution

Deployment

Hardware selection and physical deployment.

• Deployment Overview - Deployment guide and scenarios
• Hardware Selection - Choose the right Raspberry Pi
• Flashing Guide - Write image to SD card
• Physical Setup - Connect hardware and boot
• Network Integration - Add to existing network

Deployment Scenarios:

• Home Network - Home router deployment
• Small Office - Office network setup
• Edge Location - Remote site deployment
• Development - Dev/test environment

Hardware

Raspberry Pi specifications and capabilities.

• Hardware Overview - Supported Raspberry Pi models
• Raspberry Pi 3B+ - Specifications and performance
• Raspberry Pi 4 - Enhanced capabilities

Troubleshooting

Common issues and solutions.

• Troubleshooting Guide - General troubleshooting
• Boot Issues - Boot failure recovery
• Network Connectivity - Network problems
• Performance - Performance optimization

Community & Downloads

Get involved and download the latest releases.

• Community - Contributing, support, and resources
• Downloads - Image downloads and releases

Quick Links

Common Tasks

• Install Pimeleon on new SD card
• Configure WiFi access point
• Set up port forwarding
• Backup your configuration
• Troubleshoot boot failures

Reference Documentation

• Network topology and IP addressing
• Service architecture and components
• Deployment scenarios and use cases
• Hardware specifications comparison

Documentation Structure

This documentation is organized into logical sections based on your needs:

• Getting Started - Installation and setup for new users
• Architecture - Technical design and implementation details
• Deployment - Hardware selection and physical deployment
• Operations - Day-to-day management and maintenance
• Hardware - Platform specifications and capabilities
• Troubleshooting - Problem solving and diagnostics
• Community - Contributing and support resources
• Downloads - Software downloads and releases

Need Help?

• Check the FAQ for common questions
• Review the Troubleshooting Guide for common issues
• Visit the Community page for support resources

Navigation: [Home//) | [Getting Started/getting-started/) | Architecture | Deployment | Troubleshooting