Create your own off-grid library https://wrolpi.org
Find a file
2026-06-24 15:23:32 -06:00
.circleci Creating browser extension to facilitate starting downloads. Chrome/Brave and Firefox supported. 2026-05-03 11:48:50 -06:00
.github Splitting dependabot PRs to avoid massive breaking PRs. 2026-05-03 12:18:39 -06:00
.run Video downloads have many more options. Downloads are migrated. 2024-11-28 09:48:57 -07:00
alembic Rebuild Inventory as a config-only system with food catalog and calculators 2026-06-14 17:14:54 -06:00
app Fixing error where focusing on an empty Directory search would throw an error. 2026-06-24 15:23:32 -06:00
controller Warn in the navbar when a hard drive runs hot (#470) 2026-06-11 19:46:33 -06:00
debian-live-config Single file deno (#478) 2026-06-12 17:07:28 -06:00
docker Bumping deno version for latest yt-dlp. 2026-06-24 15:12:27 -06:00
etc Merging wrolpi-portable into debian-live-config; unifying Postgres on /media/wrolpi/config/postgresql. 2026-05-24 12:44:05 -06:00
modules Add manual import + backup Restore/Merge/Overwrite for inventory configs 2026-06-19 16:28:11 -06:00
pi-gen Single file deno (#478) 2026-06-12 17:07:28 -06:00
release Retrying build image uploads multiple times before failing release attempt. 2026-06-11 19:46:31 -06:00
scripts Single file deno (#478) 2026-06-12 17:07:28 -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 Bump version to 0.25.0-beta 2026-06-19 17:09:12 -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 Automating build and upload of WROLPi release images. 2026-05-30 14:23: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 add Gitpod support (#157) 2023-02-02 16:02:19 -07:00
.mcp.json.example Removing WROLPi admin functionality that is now in Controller. 2025-12-19 18:41:27 -07:00
alembic.ini A new start 2021-11-01 16:43:09 -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 Checking if postgres is ready faster to speed up docker container startup. 2026-05-03 12:09:12 -06:00
help.sh Migrating Controller from port 8087 to 80 so that it is more discoverable. Reformatting Controller dashboard to make header at the top. Reformatting navigation bar to handle the new links which prevented Admin from being visible in some screens. 2026-04-09 15:01:05 -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 Documenting WROLPi Portable USB, splitting install docs into INSTALL.md. 2026-05-28 21:33:22 -06:00
install.sh Many fixes split out from the feature/unified-query branch. Installing diagnostic tools in the built images. Displaying video comment statistics. Echoing error when install.sh fails. 2024-04-14 13:13:30 -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 Displaying warning when no drive is mounted. 2026-05-14 16:16:18 -06:00
pytest.ini FileGroups in Collections can be reorganized in the Collection's directory. 2026-01-31 18:08:41 -07:00
README.md Documenting WROLPi Portable USB, splitting install docs into INSTALL.md. 2026-05-28 21:33:22 -06:00
repair.sh Moving WROLPi-managed mounts off /etc/fstab onto a drive-resident fstab.yaml. 2026-05-24 12:44:05 -06:00
requirements.txt Rebuild Inventory as a config-only system with food catalog and calculators 2026-06-14 17:14:54 -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 Force checkout in upgrade.sh so a dirty working tree can't abort the upgrade 2026-05-29 13:22:56 -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. Start the database.
    • docker-compose up -d db
  8. Initialize the database.
    • docker-compose run --rm api db upgrade
  9. Start the docker containers.
    • docker-compose up
  10. 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