mirror of
https://github.com/lrnselfreliance/wrolpi.git
synced 2026-10-26 19:01:39 -04:00
43 lines
No EOL
2.1 KiB
Markdown
43 lines
No EOL
2.1 KiB
Markdown
# 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](https://docs.docker.com/install/linux/docker-ce/ubuntu/)
|
|
1. [Install docker-compose](https://docs.docker.com/compose/install/)
|
|
1. Copy the latest WROLPi code
|
|
* `git clone git@github.com:lrnselfreliance/wrolpi.git`
|
|
1. Change directory into the code base
|
|
* `cd wrolpi`
|
|
1. Build the docker containers
|
|
* `docker-compose build`
|
|
1. Start the docker containers
|
|
* `docker-compose up`
|
|
|
|
|
|
# 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.
|
|
1. 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.
|
|
1. WROLPi should function completely without any internet services.
|
|
1. 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.
|
|
1. 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. |