Create your own off-grid library https://wrolpi.org
Find a file
lrnselfreliance 9278103554
Some checks are pending
CodeQL / Analyze (push) Waiting to run
Controller Tests / controller-tests (push) Waiting to run
Jest Tests / jest-tests (push) Waiting to run
e2e: exercise the FileBrowser footer buttons against real files (#670)
* e2e: exercise the FileBrowser footer buttons against real files

Sixteen Cypress tests covering Rename, Move, Delete (including the
tagged-file force-delete flow), Ignore/Unignore, Upload, and scoped
Refresh, with no API mocking: fb:* tasks seed a cypress-fb/ sandbox
inside the media directory, the UI mutates it through the real API, and
assertions check the disk as well as the table.  Skipped in CI, which
runs only the React dev server.

Background jobs (move, refresh) only queue work and worker_status reads
idle while jobs wait, so cy.refreshFiles / cy.waitForEvent poll the
events feed for completion events newer than the server's clock, and
fail loudly when one never arrives.  Every suite cleans up
unconditionally: sandbox files, DB rows via a final refresh, test tags
and their tags/ directories, and any leaked ignored-directory config.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* e2e: act on review — drain stragglers, teardown that cannot be skipped

Events carry no job id, so waitForEvent cannot prove WHICH job finished.
The rename tests now drain the parent-directory refresh their rename
queues before ending, so the next test's refresh wait cannot be
satisfied by a straggler while the DB still reflects the old tree; move
waits match the destination in the completion message.

Teardown must always reach the disk wipe: a failed command aborts the
rest of its hook, so the tag cleanup and the DB-purge refresh are now
best-effort (failOnStatusCode: false, no assertions), and the unignore
runs after every test instead of once per spec.  History and
forward-looking product notes trimmed from comments.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-08-19 20:27:29 -06:00
.circleci test: the component suite has not run since cypress 15, on any machine (#661) 2026-08-12 21:57:07 -06:00
.github ci: raise the test timeout to 120s, and run controller tests on pull requests 2026-08-08 18:05:44 -06:00
.run Video downloads have many more options. Downloads are migrated. 2024-11-28 09:48:57 -07:00
alembic SQLite: make the browse pages index-only. 2026-07-14 07:46:29 -06:00
app e2e: exercise the FileBrowser footer buttons against real files (#670) 2026-08-19 20:27:29 -06:00
controller build(deps): bump aiohttp from 3.14.1 to 3.14.3 (#633) 2026-08-08 16:33:19 -06:00
debian-live-config zim: ship a default fallback Zim and honor the configured Zim directory 2026-07-20 19:09:57 -06:00
docker Map previews that never drew, and a Docker map with no world under it (#658) 2026-08-11 20:37:23 -06:00
etc install: always install serve; resolve it via PATH in wrolpi-app 2026-07-23 18:21:58 -06:00
modules Map previews that never drew, and a Docker map with no world under it (#658) 2026-08-11 20:37:23 -06:00
pi-gen zim: ship a default fallback Zim and honor the configured Zim directory 2026-07-20 19:09:57 -06:00
release Retrying build image uploads multiple times before failing release attempt. 2026-06-11 19:46:31 -06:00
scripts install: always install serve; resolve it via PATH in wrolpi-app 2026-07-23 18:21:58 -06: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 test: the watchdog test must not inherit a sibling's shutdown state 2026-08-19 19:09:16 -06: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 Remove stale Postgres references after SQLite cutover. 2026-07-18 13:28:54 -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 Zim/Kiwix (Wikipedia) feature 2023-07-10 21:30:40 -06:00
demo_link.jpg Replacing demo image. 2023-01-30 13:27:26 -07:00
docker-compose.yml Map previews that never drew, and a Docker map with no world under it (#658) 2026-08-11 20:37:23 -06:00
help.sh help.sh: move DB integrity scan out of startup diagnostics 2026-07-22 19:47:35 -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 Docs: recommend Raspberry Pi Imager instead of Etcher. 2026-07-03 18:58:54 -06:00
install.sh Disambiguate 'git checkout release' in install.sh 2026-06-27 13:57:27 -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 files: a failed directory rename that hung for five minutes 2026-08-19 18:57:17 -06:00
pytest.ini ci: raise the test timeout to 120s, and run controller tests on pull requests 2026-08-08 18:05:44 -06:00
README.md Postgres -> SQLite hard cutover: the database moves into the media directory. 2026-07-12 14:09:37 -06:00
repair.sh repair: copy wrolpi/blobs into /opt/wrolpi-blobs on install and upgrade 2026-07-20 19:09:57 -06:00
requirements.txt build: require pytest-timeout, so a hung test fails instead of hanging CI 2026-08-08 18:05:08 -06: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 Documenting WROLPi Portable USB, splitting install docs into INSTALL.md. 2026-05-28 21:33:22 -06:00
upgrade.sh upgrade: restart services when the upgrade fails before code changes (#669) 2026-08-19 18:52:53 -06:00

WROLPi

Build Status 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 12 — 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