rt/wrolpi
1
0
Fork 0
mirror of https://github.com/lrnselfreliance/wrolpi.git synced 2026-10-26 10:51:36 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
Create your own off-grid library https://wrolpi.org
15 commits 6 branches 98 tags 53 MiB
Find a file
Roland dc4ce0bda1
Adding more comments. Testing that the orphan file isn't deleted.
2019-10-14 17:18:20 -06:00
docker Adding and testing Channel.GET/DELETE. 2019-10-10 11:32:43 -06:00
test/example_videos/blender Initial commit. 2019-10-09 17:30:06 -06:00
wrolpi Adding more comments. Testing that the orphan file isn't deleted. 2019-10-14 17:18:20 -06:00
.gitignore Adding download button. Adding endpoint to stream statuses during download, not yet complete. 2019-10-14 12:34:38 -06:00
docker-compose.yml Initial commit. 2019-10-09 17:30:06 -06:00
main.py Adding and testing Channel.GET/DELETE. 2019-10-10 11:32:43 -06:00
README.md Statuses are sent during the refresh POST. 2019-10-14 11:58:25 -06:00
requirements.txt Initial commit. 2019-10-09 17:30:06 -06:00
TODO.md Initial commit. 2019-10-09 17:30:06 -06:00

README.md

WROLPi

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 wifi network so that any person with a laptop/tablet/phone can connect and use the data previously collected by the user.

Install

WROLPi runs in a couple Docker containers. Lets get the prerequisites installed...

  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. Build the docker containers
    • docker-compose build --parallel
  5. Start the docker containers
    • docker-compose up
  6. Navigate to 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. 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.