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
174 commits 6 branches 98 tags 53 MiB
Find a file
Roland dc888c6392
Squashed commit of the following: 
commit 54d06bf8045fceaa2684348d110792e6833b170c
Author: Roland <roland@learningselfreliance.com>
Date:   Sat Jan 29 16:46:14 2022 -0700

    Can't delete files when WROL Mode is enabled.

commit 2d91f1983aae47bdb3f6dc7fc2bd2ae642c1126a
Author: Roland <roland@learningselfreliance.com>
Date:   Sat Jan 29 16:37:42 2022 -0700

    Fixing bug where files could not be deleted in series.

commit eed818c50682b19de9f18da2d4daedc54408cc49
Author: Roland <roland@learningselfreliance.com>
Date:   Sat Jan 29 16:26:31 2022 -0700

    Fixing fake_now to reset now() when complete.

commit 183e98cbec25784720ebaeabfac8af4a3fc87da8
Author: Roland <roland@learningselfreliance.com>
Date:   Sat Jan 29 16:08:14 2022 -0700

    Files can be deleted and downloaded.

commit c5bcd25a3da041f42b9e11eae804aa359ab9e985
Author: Roland <roland@learningselfreliance.com>
Date:   Sat Jan 29 14:41:07 2022 -0700

    Files can be deleted or downloaded.

commit 690b332bb4f89aa4e97ce2590b35bd4a71fefd87
Author: Roland <roland@learningselfreliance.com>
Date:   Sat Jan 29 14:11:05 2022 -0700

    File is opened in new tab when file is selected.

commit ba8ead6f3185d0a398c4f89cecb5958f5e7731a3
Author: Roland <roland@learningselfreliance.com>
Date:   Sat Jan 29 13:32:32 2022 -0700

    Removing files sort because React FE sorts them itself.

commit 4e04753234b11d615c5992bc08e9dd9fb7226c05
Author: Roland <roland@learningselfreliance.com>
Date:   Sat Jan 29 13:29:52 2022 -0700

    Duplicate directories are ignored.

commit c2f7d7929f37655e5c2d11767a512571263b35ef
Author: Roland <roland@learningselfreliance.com>
Date:   Sat Jan 29 12:22:38 2022 -0700

    Multiple directories can be requested.

commit 31678139c0799d0034d564cc1f8ae448234df90c
Author: Roland <roland@learningselfreliance.com>
Date:   Fri Jan 28 17:21:33 2022 -0700

    Files are displayed with the correct modified time.  Files can be recursively viewed.

commit a2d10a1dd792e518c8c6ad8f699b5d416c3d07e4
Author: Roland <roland@learningselfreliance.com>
Date:   Thu Jan 27 22:37:19 2022 -0700

    Files can be viewed.  Folders display their children.
2022-01-29 16:50:22 -07:00
.github/workflows Delete pylint.yml 2021-12-20 16:03:40 -07:00
alembic Videos can be sorted by their modification date. 2022-01-25 08:51:55 -07:00
app Squashed commit of the following: 2022-01-29 16:50:22 -07:00
config Installing raspberry pi version of pyyaml. 2022-01-17 10:46:14 -07:00
docker Squashed commit of the following: 2022-01-29 16:50:22 -07:00
modules Squashed commit of the following: 2022-01-29 16:50:22 -07:00
scripts Adding more details to WROLPi install. 2021-11-02 10:53:12 -06:00
systemd Installing python packages globally because it will make it easier to troubleshoot and start the services. 2022-01-17 09:35:17 -07:00
test Arbitrary videos can be downloaded. (#63) 2021-12-20 16:09:11 -07:00
wrolpi Squashed commit of the following: 2022-01-29 16:50:22 -07:00
.dockerignore A new start 2021-11-01 16:43:09 -06:00
.gitignore A new start 2021-11-01 16:43:09 -06:00
.travis.yml A new start 2021-11-01 16:43:09 -06:00
50x.html Installing python packages globally because it will make it easier to troubleshoot and start the services. 2022-01-17 09:35:17 -07: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 Mounting test directory to api's /media/wrolpi. Updating Archive's Sanic to avoid depreciation error with uvloop. 2022-01-22 19:54:46 -07: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 Upgrade DB after API has been stopped. 2022-01-25 16:24:26 -07: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 Creating main.py argument which checks if the media directory is correct. 2022-01-24 18:04:23 -07:00
nginx.conf Customizing nginx error page to help user start wrolpi services. 2022-01-15 19:34:12 -07:00
nginx.dev.conf Using charset utf-8 and including mime.types so HTML files and images are displayed correctly. (#61) 2021-11-12 14:13:02 -07:00
README.md Using image from master. 2022-01-21 10:31:40 -07:00
requirements.txt Installing raspberry pi version of pyyaml. 2022-01-17 10:46:14 -07:00

README.md

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 Beta!
  • 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

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