Create your own off-grid library https://wrolpi.org
Find a file
lrnselfreliance 38885990f6
The old sync engine is removed (#998)
* The old sync engine is removed

Part 4 of replacing the sync.  Since the previous part a secondary copies its primary with rsync, run by the
Controller, so nothing used the HTTP engine any more:

- the manifest (/api/sync/manifest), the download of a FileGroup's files over HTTP, the copy and import of each
  synced config, the moving of a replaced file's links, the request, cancel and tick of the old sync;
- the API lock that answered 503 SYNCING while that engine ran, its Event, the sync_running flag, the old status
  record in /api/status and its schema, and the frontend's handling of 503 SYNCING;
- their tests.

What a primary says about itself (/api/sync/info), the secondary's settings (its primary, the folders it does not
copy, Test Connection, the folder chooser), taking the primary's library settings when the API starts, and the
daily window of the backup drive stay.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* The primary's sync info no longer reports the largest FileGroup id

Only the old engine read it.  Review also found a docstring that still spoke of a manifest.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* A sync is announced again

Since the Controller runs a sync, nothing sent its events: the old engine did, and the Controller cannot send the
API's events (the API is stopped for most of a sync).  The API's loop now reads the Controller's record of the last
sync and sends one event per finished sync: "Synced N files from the primary" (with the files moved to the trash,
or a warning) or "Sync from the primary failed".  As before, a sync that changed nothing is not announced (within
the window that is every 15 minutes), nor one that was stopped on purpose.  What was announced is kept in
config/.sync, which a sync never touches, so the restart every sync makes neither repeats nor loses one.

Found by review, and by the dead-code check, which saw the two event methods unused.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 15:37:44 -07:00
.github Python packages install from hash-locked requirements; yt-dlp still floats (#913) 2026-11-01 12:00:39 -07:00
.run Video downloads have many more options. Downloads are migrated. 2024-11-28 09:48:57 -07:00
alembic The modelers and indexers find unindexed FileGroups through an index (#905) 2026-10-30 19:40:46 -06:00
app The old sync engine is removed (#998) 2026-11-19 15:37:44 -07:00
controller A secondary syncs by rsync: the Controller runs it on its schedule, and both pages follow it (#995) 2026-11-19 15:06:25 -07:00
debian-live-config A WROLPi serves its library over rsync, and makes a database snapshot on request (#988) 2026-11-18 16:47:02 -07:00
docker A WROLPi serves its library over rsync, and makes a database snapshot on request (#988) 2026-11-18 16:47:02 -07:00
etc A WROLPi serves its library over rsync, and makes a database snapshot on request (#988) 2026-11-18 16:47:02 -07:00
modules An overlay's layers which the basemap already draws start hidden (#969) 2026-11-14 11:17:31 -07:00
npm-tools serve, single-file and readability-extractor install from a committed lockfile (#912) 2026-10-31 10:39:08 -06:00
pi-gen A WROLPi serves its library over rsync, and makes a database snapshot on request (#988) 2026-11-18 16:47:02 -07:00
release Retrying build image uploads multiple times before failing release attempt. 2026-06-11 19:46:31 -06:00
scripts Sync and backup: a secondary WROLPi and a backup drive copy the library (#957) 2026-11-11 10:53:45 -07:00
test Modifying Video/Channel/RSS Downloaders so that they can download videos, but audio only. These audio files are grouped under their channel directories. 2026-04-14 15:33:01 -06:00
wrolpi The old sync engine is removed (#998) 2026-11-19 15:37:44 -07:00
.coveragerc Adding coverage config which ignores non-API directories. 2024-10-16 18:56:03 -06:00
.dockerignore A new start 2021-11-01 16:43:09 -06:00
.gitignore serve, single-file and readability-extractor install from a committed lockfile (#912) 2026-10-31 10:39:08 -06:00
.gitmodules Adding FileGroup.published_date/author/etc. Creating script which converts a Singlefile to an Archive FileGroup files. 2023-10-23 18:09:08 -06:00
.gitpod.yml Postgres -> SQLite hard cutover: the database moves into the media directory. 2026-07-12 14:09:37 -06:00
.mcp.json.example Removing WROLPi admin functionality that is now in Controller. 2025-12-19 18:41:27 -07:00
alembic.ini Postgres -> SQLite hard cutover: the database moves into the media directory. 2026-07-12 14:09:37 -06:00
conftest.py The map draws any PMTiles file as an overlay, in any sub-directory (#962) 2026-11-13 15:11:01 -07:00
demo_link.jpg Replacing demo image. 2023-01-30 13:27:26 -07:00
docker-compose.yml Archive container reaps its zombie processes (#837) 2026-10-15 18:10:17 -06:00
help.sh install.sh installs on Debian 13 (#830) 2026-10-14 15:51:40 -06:00
icon.ico A new start 2021-11-01 16:43:09 -06:00
icon.png Zim/Kiwix (Wikipedia) feature 2023-07-10 21:30:40 -06:00
INSTALL.md Live USB: allow password SSH (#845) 2026-10-20 16:29:40 -06:00
install.sh install.sh and both image builds run WROLPi only from a signed checkout (#909) 2026-10-30 21:27:41 -06:00
join_discord.png A new start 2021-11-01 16:43:09 -06:00
LICENSE A new start 2021-11-01 16:43:09 -06:00
main.py The Controller can make a secondary a copy of its primary with rsync (#992) 2026-11-18 20:21:55 -07:00
pytest.ini Tests fail when a request writes outside request.ctx.db.write() (#864) 2026-10-23 17:09:39 -06:00
README.md INSTALL.md points to the Controller drive wizard (#825) 2026-10-13 15:57:10 -06:00
repair.sh A WROLPi serves its library over rsync, and makes a database snapshot on request (#988) 2026-11-18 16:47:02 -07:00
requirements.lock Python packages install from hash-locked requirements; yt-dlp still floats (#913) 2026-11-01 12:00:39 -07:00
requirements.txt build(deps): update certifi requirement (#919) 2026-11-02 11:52:18 -07:00
test_all.sh Creating test_all.sh script to run all frontend and backend tests. 2025-12-17 15:11:57 -07:00
UPGRADE.md An upgrade refuses to roll back to an older commit of the current branch (#910) 2026-10-31 09:33:25 -06:00
upgrade.sh An upgrade refuses to roll back to an older commit of the current branch (#910) 2026-10-31 09:33:25 -06:00

WROLPi

Backend Tests License: GPL v3 Discord Gitpod

Create your own off-grid library.

WROLPi Logo

WROLPi is a self-contained collection of software to help you survive the world Without Rule of Law.

WROLPi is intended to be run on a Raspberry Pi with an optional external drive attached. It serves up it's own Wi-Fi network so that any user with a laptop/tablet/phone can connect and use the library created by the maintainer.

Table of Contents

Features

  • Videos
  • Web Archives
  • Maps
  • Wikipedia
  • File search
  • eBooks (EPUB / PDFs)
  • Wi-Fi Hotspot
  • Universal search
  • Food Inventory management
  • One-Time pad generator, encrypter/decrypter
  • Synchronizer/duplicator
  • Food storage calculator

Module features matrix

Module View Search Download Project
Videos yes yes yes yt-dlp
Web Archives yes yes yes Singlefile
Wikipedia yes yes yes Kiwix
eBooks yes yes planned EPUB/PDF
Map yes yes yes Protomaps
Podcasts/Audio yes planned planned

Demo

YouTube Demo Video

Download

Images are available at wrolpi.org

Try WROLPi!

You can try out WROLPi by running the docker containers.

  1. Install docker-ce and docker-compose
  2. Copy the latest WROLPi code.
    • git clone https://github.com/lrnselfreliance/wrolpi.git
  3. Change directory into the code base.
    • cd wrolpi
  4. Initialize git submodules
    • git submodule update --init
  5. Build the containers.
    • docker-compose build --parallel
  6. Create volumes.
    • docker volume create --name=openstreetmap-data
    • docker volume create --name=openstreetmap-rendered-tiles
  7. Initialize the database (SQLite in the media directory).
    • docker-compose run --rm api db upgrade
  8. Start the docker containers.
    • docker-compose up
  9. Browse to WROLPi.

More Docker documentation is available in docker/README.md

Install WROLPi

Full installation instructions are in INSTALL.md. Pick the option that matches your hardware:

  • WROLPi Portable (Live USB) — boot a complete WROLPi from a USB stick on any x86 PC or laptop. Nothing is installed to the computer; the first boot creates a persistence partition on the USB so your library, database, and configuration survive reboots.
  • Debian 13 — install WROLPi onto an x86 PC or laptop.
  • Raspberry Pi — install WROLPi onto a Raspberry Pi with an external drive.
  • Docker — run the WROLPi containers on an existing Linux host.

Charter

Guiding Principals

  1. Storage is cheaper than power.
  2. Two is one, one is none.
  3. Run silently.
  4. Primary, secondary, tertiary.
  5. Secure as a bookshelf in your home.

Physical properties

  1. A WROLPi instance should be capable of running with a minimal of hardware:
    • Raspberry Pi
    • SD card
    • External USB hard drive
    • Power supply and cables
    • Wi-Fi USER device such as a phone, tablet, or laptop.
  2. A WROLPi instance should consume a minimal amount of electricity during WROL event. It is expected power will be scarce when WROLPi is needed most.

User expectations

  1. A WROLPi instance should be run and maintained by a person (MAINTAINER) with a moderate amount of Linux and Raspberry Pi experience. It is expected that they should be able to do this using only the documentation on their WROLPi.

Software properties and capabilities

  1. A WROLPi instance should be able to "factory-reset" itself without any outside services.
  2. WROLPi should function completely without any internet services.
  3. A user should have easy access to their data if WROLPi fails:
    • For example, a user can watch their videos by navigating a short and intuitive directory structure and opening the video in their preferred video player.
  4. WROLPi should be self-documented. The UI should contain a tutorial for USERS as well as the MAINTAINER.
    • If the UI isn't functional, the code should be documented such that a user can restore functionality.
  5. WROLPi should favor pre-processing, rather than processing during a WROL event. Such as re-encoding a video, or processing captions. This is to ensure that when a user adds content during non-WROL time, the processing for optimum performance is already done for a WROL event.

Join!

Discord QR Code

Join our Discord