Create your own off-grid library https://wrolpi.org
Find a file
Roland e58f7e2ef1
Upgrade to SQLAlchemy 2.0 (synchronous)
SQLAlchemy 1.3 has been end-of-life since 2021, and alembic was held at 1.10
because newer releases need SQLAlchemy 2.  This is a mechanical port; the code
stays synchronous.

- SQLAlchemy[asyncio]==2.0.54, alembic==1.20.0.
- Model annotations use Mapped[...] (2.0 rejects bare annotations on mapped
  attributes); declarative_base moves to sqlalchemy.orm.
- Plain SQL strings go through text() or exec_driver_sql; schema_ddl.execute_sql
  accepts a SQLAlchemy Connection or a raw sqlite3 connection, so rebuild_fts
  works from the baseline migration again.
- Session.get replaces Query.get; session.in_transaction() replaces
  session.transaction; cache_ok on MediaPathType and FancyJSON.
- The tag-directory sync query joins through TagFile's relationships instead of
  the legacy two-entity outerjoin.
- Section-hint rows use attribute access (2.0 rows are tuples).
- Migrations run on an AUTOCOMMIT connection, matching 1.3, where each
  statement committed on its own.  2.0 autobegins, so the unique-stem
  migration's read snapshot could not become a writer after its helpers wrote
  on another connection ("database is locked").  The begin listener emits no
  BEGIN for AUTOCOMMIT connections.
- Newer alembic compares column types: WrolpiKV now describes the TEXT table
  its migration created.
- The test database installs its DDL inside engine.begin(); 2.0 connections
  no longer autocommit, so the FTS tables were rolled back.
- Dependabot now holds SQLAlchemy at 2.0 instead of 1.3.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-09 13:31:52 -06:00
.github Upgrade to SQLAlchemy 2.0 (synchronous) 2026-10-09 13:31:52 -06:00
.run Video downloads have many more options. Downloads are migrated. 2024-11-28 09:48:57 -07:00
alembic Upgrade to SQLAlchemy 2.0 (synchronous) 2026-10-09 13:31:52 -06:00
app Resume EPUBs and comic books where the reader left off (#798) 2026-10-08 18:19:51 -06:00
controller build(deps): update fastapi requirement in /controller (#748) 2026-10-03 10:19:52 -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 Help: document resuming where you left off (#799) 2026-10-08 18:25:29 -06:00
etc perpetual: clear in-progress flags after a crash, downloads only in the perpetual process, KillMode=mixed (#726) 2026-09-26 11:22:58 -06:00
modules Upgrade to SQLAlchemy 2.0 (synchronous) 2026-10-09 13:31:52 -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 Add a Solar calculator (#778) 2026-10-04 18:36:45 -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 Upgrade to SQLAlchemy 2.0 (synchronous) 2026-10-09 13:31:52 -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 Add a Solar calculator (#778) 2026-10-04 18:36:45 -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 Add a Repos module that mirrors git repositories (#783) 2026-10-07 15:16:58 -06:00
demo_link.jpg Replacing demo image. 2023-01-30 13:27:26 -07:00
docker-compose.yml docker: web container reaps zombies; zim and help healthchecks can pass (#744) 2026-10-02 15:49:34 -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 db: request-path library functions use the request's connection (#774) 2026-10-04 11:05:20 -06:00
pytest.ini Remove CircleCI (#796) 2026-10-08 17:19:38 -06:00
README.md Remove CircleCI (#796) 2026-10-08 17:19:38 -06:00
repair.sh Hotspot captive portal: welcome page with the WROLPi's address (#709) 2026-09-13 20:10:02 -06:00
requirements.txt Upgrade to SQLAlchemy 2.0 (synchronous) 2026-10-09 13:31:52 -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

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 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