rt/wrolpi
1
0
Fork 0
mirror of https://github.com/lrnselfreliance/wrolpi.git synced 2026-10-26 19:01:39 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
Create your own off-grid library https://wrolpi.org
570 commits 6 branches 98 tags 53 MiB
Find a file
Roland 6fcb992540
Storing example ebooks for testing. 
Special handling of json mimetype for json files.

Moving types up to avoid overwriting mime.types.

Adding custom types to nginx to server ebooks better.

Displaying EBookCard correctly when ebook was not indexed correctly.

Global search can search for all ebooks (mobi/epub).

Testing when mimetype suffix is searched.

Adding eBook to global search filter list.  Opening mimetype search to match mimetypes that may not end with expected suffix.

Adding log warning to explain refresh speed.

Generating ebook covers after refresh.

Testing that another nearby book removes the cover.

Calibre covers can be discovered and associated with an ebook.

Handling if ebooklib is not yet installed.

Adding ebook table and modeler to allow searching the contents of epub files.

Marking all PDFs as un-indexed, so they will be indexed.

Replacing null characters in PDF text.

Testing PDFIndexer against example PDF file.

Installing PyPDF2 to extract text for PDFIndexer.
2022-12-11 12:36:53 -07:00
.circleci Removing Latex as dependency. Using browser to convert OTP pads into printable documents. 2022-06-26 16:27:56 -06:00
.github/workflows Delete pylint.yml 2021-12-20 16:03:40 -07:00
alembic Storing example ebooks for testing. 2022-12-11 12:36:53 -07:00
app Storing example ebooks for testing. 2022-12-11 12:36:53 -07:00
docker Wrapping URL in archive download commands. 2022-10-25 15:07:17 -06:00
etc Stopping renderd when reseting map db. 2022-10-21 15:21:57 -06:00
modules Info JSON epoch is time of download, not time of upload. 2022-12-08 13:45:46 -07:00
scripts Bumping version for new feature. 2022-12-07 18:15:28 -07:00
test Storing example ebooks for testing. 2022-12-11 12:36:53 -07:00
wrolpi Storing example ebooks for testing. 2022-12-11 12:36:53 -07:00
.dockerignore A new start 2021-11-01 16:43:09 -06:00
.gitignore Ignoring test map files. 2022-03-12 09:50:43 -07:00
.travis.yml A new start 2021-11-01 16:43:09 -06:00
50x.html Adding helpful log notes to 50x.html. Suggesting changing media directory permissions after install. 2022-05-19 21:33:42 -06:00
alembic.ini A new start 2021-11-01 16:43:09 -06:00
conftest.py Arbitrary videos can be downloaded. (#63) 2021-12-20 16:09:11 -07:00
demo_link.jpg Using smaller custom image for demo link. 2022-01-21 10:30:41 -07:00
docker-compose.yml Passing .env file to app in docker-compose. 2022-10-26 11:21:03 -06:00
icon.ico A new start 2021-11-01 16:43:09 -06:00
icon.png A new start 2021-11-01 16:43:09 -06:00
install.sh Adding wrolpi directory to global safe directory. 2022-05-18 08:20:05 -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 Downloads are saved to the download manager config. They are imported on startup. 2022-11-04 19:59:42 -06:00
nginx.conf Storing example ebooks for testing. 2022-12-11 12:36:53 -07:00
nginx.dev.conf Storing example ebooks for testing. 2022-12-11 12:36:53 -07:00
pytest.ini Fixing JS warnings. 2022-09-23 11:25:55 -06:00
README.md Rewording readme to shorten first paragraph. 2022-11-13 14:36:13 -07:00
requirements.txt Storing example ebooks for testing. 2022-12-11 12:36:53 -07:00
UPGRADE.md Including map volumes in upgrade instructions. 2022-05-03 11:07:48 -06:00

README.md

WROLPi

Build Status License: GPL v3 Discord

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.

WARNING WROLPi is under active development!

  • WROLPi is in Beta!
  • Expect things to change!

Table of Contents

Features

  • Video player & downloader
  • Web archiver
  • Map viewer
  • Wi-Fi Hotspot
  • Universal search
  • Food Inventory management
  • One-Time pad generator, encrypter/decrypter
  • eBook viewer
  • Wiki viewer & downloader
  • Synchronizer and/or duplicator
  • Food storage calculator
  • Podcast player & downloader

Demo

YouTube Demo Video

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. Build the containers
    • docker-compose build --parallel
  5. Create volumes
    • docker volume create --name=openstreetmap-data
    • docker volume create --name=openstreetmap-rendered-tiles
  6. Start the database.
    • docker-compose up -d db
  7. Initialize the database
    • docker-compose run --rm api db upgrade
  8. Start the docker containers
    • docker-compose up
  9. Browse to WROLPi

Debian 11 Install

Install WROLPi onto a fresh Debian 11 system.

Warning: this will clobber anything else on the system! Do not run this installation script elsewhere!

  1. Install Debian 11 onto a laptop or other computer.
  2. Login to the new system.
  3. Get the WROLPi installation script
    • wget https://raw.githubusercontent.com/lrnselfreliance/wrolpi/release/install.sh -O /tmp/install.sh
  4. Run the installation script
    • sudo /bin/bash /tmp/install.sh
  5. Start WROLPi
    • sudo systemctl start wrolpi.target
  6. Browse to the IP address of your WROLPi!

RaspberryPi Install

Install WROLPi onto a fresh Raspberry Pi.

Warning: this will clobber anything else on the Raspberry Pi! Do not run this installation script elsewhere!

  1. Install Ubuntu Server 20.04 onto a RaspberryPi.
  2. Login to the new RaspberryPi.
  3. Get the WROLPi installation script
    • wget https://raw.githubusercontent.com/lrnselfreliance/wrolpi/release/install.sh -O /tmp/install.sh
  4. Run the installation script
    • sudo /bin/bash /tmp/install.sh
  5. Start WROLPi
    • sudo systemctl start wrolpi.target
  6. Join the Hotspot or browse to the IP address of your WROLPi!

Charter

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