rt/wrolpi
1
0
Fork 0
mirror of https://github.com/lrnselfreliance/wrolpi.git synced 2026-10-26 02:48:38 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
wrolpi/README.md
Roland 0a6cc62ad6
Using release branch for install.
2022-01-15 19:00:26 -07:00

4.3 KiB
Raw Blame History

WROLPi

Build Status License: GPL v3

Take your internet, off-grid.

WROLPi Logo

WROLPi is a self-contained collection of software (on a Raspberry Pi) 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 wifi network so that any person with a laptop/tablet/phone can connect and use the data previously collected by the user.

WARNING WROLPi is under active development!

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

Features

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

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 git@github.com:lrnselfreliance/wrolpi.git
  3. Change directory into the code base
    • cd wrolpi
  4. Start the database.
    • docker-compose up -d db
  5. Initialize the database
    • docker-compose run --rm api db upgrade
  6. Start the docker containers
    • docker-compose up
  7. Navigate to 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