Guides
Raspberry Pi + ImmortalWrt
Raspberry Pi ImmortalWrt Docs Hub
From firmware flashing and network onboarding to OpenClash, backup/restore, and storage expansion, now rewritten around the `opkg` / `apk` split.
- Covers the full path from flashing to network and plugin setup.
- Includes backup, restore, maintenance, and troubleshooting workflows.
- Chinese and English views are separated for clean reading.
Scripts
1
Automation and backup tooling docsChangelog Items
8
Tracks docs/scripts/frontend updatesOpenWrt Version Split
Identify your OpenWrt branch first
Many older tutorials break not because the feature changed, but because the package manager changed. The updated docs now split the workflow before showing commands.
Open the new OpenClash guide24.10 and earlier stable releases
Still use `opkg`. Most older tutorials assume this path.
25.12 and newer
Use `apk`. Do not keep copying old `opkg install` commands.
Recommended reading paths
Jump straight to the problem you are solving instead of reading everything linearly.
First-Time Setup
Raspberry Pi OpenWrt Software Router Configuration Guide
Start from firmware, connection mode, and basic network onboarding.README_EN.mdProxy and Routing
OpenClash Network Access Configuration
Updated OpenClash guide with `opkg` / `apk` split.docs/en/Openclash_Config.mdBackup and Restore
Backup and Restore
Read this before migration, card swap, or recovery.docs/en/OpenWrt_Backup_Resotre.mdStorage and Expansion
ImmortalWrt Storage Expansion and Partitioning Guide
Choose between `ext4`, `squashfs`, data partition, and extroot.docs/en/Storage_Expansion_Guide.mdFirmware Version Description
ImmortalWrt-Raspberry Pi 4B/400/CM4 (64bit) Latest
EXT4 Version
Complete installation that erases existing configurations. Best for first-time installation or full reset. Supports larger storage and better recovery, but requires reconfiguration after flashing.
SQUASHFS Version
Incremental update that keeps user configurations. Ideal for users who only need firmware upgrades. Smaller footprint and faster boot, but limited writable storage.
Document Catalog
Browse by category and open the full document with one click.
Getting Started
Project overview and firmware flashing
Network and Proxy
LAN/PPPoE setup and OpenClash configuration
- LAN Connection (Upstream Router LAN Uplink)
This guide is for the common setup where your Raspberry Pi running ImmortalWrt gets internet from an upstream router, and devices connected to the Pi Wi-Fi can also access the internet.
docs/en/Lan_Connectioin.md - PPPoE Dial-Up Configuration
This guide is for two common cases:
docs/en/PPPoE_Connection.md - OpenClash Network Access Configuration
You can read this guide in the following order:
docs/en/Openclash_Config.md
Backup and Maintenance
Backup strategy, restore flow, and maintenance
- Backup and Restore
Since the author's SD card is 128GB, all mounted to the OpenWrt system, but the entire system only consumes 287MB of resources, which is a bit overkill. Therefore, the plan is to backup and switch to a 4GB memory card.
docs/en/OpenWrt_Backup_Resotre.md - OpenWrt System Maintenance and Troubleshooting
Document Scope : Daily maintenance, monitoring setup, and troubleshooting practices for Raspberry Pi + ImmortalWrt.
docs/en/System_Maintenance.md - ImmortalWrt Storage Expansion and Partitioning Guide
This guide answers the three questions that usually get mixed together:
docs/en/Storage_Expansion_Guide.md - ImmortalWrt Overlay and Extroot Expansion (Advanced)
This guide only applies when:
docs/en/ExtendOverlaySize.md - ImmortalWrt GitHub Auto Backup (Legacy Reference)
Note: this page is kept as a legacy reference for the older SSH + configs/ snapshot workflow.
docs/en/OpenWrt_AutoBackup.md
Scripts and Updates
Script usage and changelog index
Others
Additional documents