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
751 commits 6 branches 98 tags 53 MiB
Find a file
Roland 5615ce542d
Making example label a tag. 
Tags can be created and deleted in UI.

Adding tag_file using id to avoid session error.

Using UTC in test.

Matching tag_names style in test.

Tag icon is displayed on file rows.

Archives, Videos and Files can be filtered by their tags.

Tags can be added and removed from UI.

Tags are displayed in VideoPlayer.

The tags of a file are returned in it's JSON.

Video favorites are converted to Favorite tag on channel config import.

Updating tests to match frontend usage.

PDF creator and modification time are displayed.

Reworking file search to use Video.__json__ for complex video relations.

Archives can be viewed.

Removing ebook.title.

Reworking alembic migration to be an upgrade rather than a replace.

Skipping test on circleci.

Clearing out video caption index only if extract_subtitles if off.

Channel tests pass.

Some video tests pass.

Missing videos can be found.  A video can be downloaded.

Orphaned files can be found.

Videos can be tagged.

Videos can be searched.

Videos can be modeled.

Converting some tests to use FileGroup.primary_path.

Adding archive and domains to alembic migration.

Testing cascading Archive titles.

Archives now uses FileGroup.

archive.lib tests pass.

Archive is partially converted to FileGroup.

Calculating FileGroup.primary file on refresh, rather than on select.

wrolpi tests pass.

Using FilesType to convert between str/pathlib.Path for FileGroup.files.

Using list of files in FileGroup.files instead of dictionary.

Storing files in dedicated FileGroup.files to avoid overwriting them.

Adding comment explaining CASE.

Not overwriting FileGroup.data on refresh if no change has been detected.

Removing File model in favor of FileGroup.data.

Adding typing to Files methods.

Files are indexed using the primary mimetype of the FileGroup.

files test_lib tests pass.

Removing file_group_file in favor of simple one-to-many relationship.

PDF files are indexed during refresh.

Adding Tag and TagFile to tag files with specific tags.

Only iterating when full_stem_ids has contents.

Testing that FileGroups are related to their Files.

Files and file_groups are created and linked.

Bump webpack from 5.75.0 to 5.76.1 in /app (#160)

Bumps [webpack](https://github.com/webpack/webpack) from 5.75.0 to 5.76.1.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](https://github.com/webpack/webpack/compare/v5.75.0...v5.76.1)

---
updated-dependencies:
- dependency-name: webpack
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-03-25 17:54:41 -06:00
.circleci Testing Python 3.11. 2023-03-01 13:25:58 -07:00
.github/workflows Delete pylint.yml 2021-12-20 16:03:40 -07:00
alembic Making example label a tag. 2023-03-25 17:54:41 -06:00
app Making example label a tag. 2023-03-25 17:54:41 -06:00
docker Fixing changes before merge. 2023-02-08 21:18:51 -07:00
etc Checking for icesheet table as current user. 2023-02-24 16:16:13 -07:00
modules Making example label a tag. 2023-03-25 17:54:41 -06:00
pi-gen Checking for icesheet table as current user. 2023-02-24 16:16:13 -07:00
scripts Searching for wrolpi with colon to avoid catching non-wrolpi user. 2023-02-25 19:08:46 -07:00
test File.d_text is reformatted to break up long lines. 2022-12-27 15:41:55 -07:00
wrolpi Making example label a tag. 2023-03-25 17:54:41 -06:00
.dockerignore A new start 2021-11-01 16:43:09 -06:00
.gitignore Modifying CircleCI config to also test React App. Caching Python venv on CircleCI. 2023-01-07 20:05:25 -07:00
.gitpod.yml add Gitpod support (#157) 2023-02-02 16:02:19 -07: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 Replacing demo image. 2023-01-30 13:27:26 -07:00
docker-compose.yml Making example label a tag. 2023-03-25 17:54:41 -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 Checking for icesheet table as current user. 2023-02-24 16:16:13 -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 Making example label a tag. 2023-03-25 17:54:41 -06:00
nginx.conf Switching /download alias to correct directory for global nginx. 2023-02-25 18:36:03 -07:00
nginx.dev.conf Fixing changes before merge. 2023-02-08 21:18:51 -07:00
pytest.ini Fixing JS warnings. 2022-09-23 11:25:55 -06:00
README.md Checking for icesheet table as current user. 2023-02-24 16:16:13 -07:00
requirements.txt Making example label a tag. 2023-03-25 17:54:41 -06:00
UPGRADE.md Checking for icesheet table as current user. 2023-02-24 16:16:13 -07:00
upgrade.sh Calling second upgrade script so new upgrades can be pulled from git. 2023-02-24 17:31:08 -07:00

README.md

WROLPi

Build Status License: GPL v3 Discord Gitpod

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

  • Videos
  • Web Archive
  • Maps
  • File search
  • eBooks (EPUB / PDFs)
  • Wi-Fi Hotspot
  • Universal search
  • Food Inventory management
  • One-Time pad generator, encrypter/decrypter
  • Synchronizer and/or duplicator
  • Food storage calculator

Module features matrix

Module Search View Download
Videos yes yes yes
Web Archives yes yes yes
eBooks (EPUB/PDFs) yes yes planned
Map planned yes planned
Wikis planned planned planned
Podcasts/Audio planned planned planned

Demo

YouTube Demo Video

Download

Images are available on wrolpi.org

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. Get the WROLPi installation script
    • wget https://raw.githubusercontent.com/lrnselfreliance/wrolpi/release/install.sh -O /tmp/install.sh
  3. Run the installation script
    • sudo /bin/bash /tmp/install.sh
  4. Start WROLPi
    • sudo systemctl start wrolpi.target
  5. 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 Raspberry Pi OS onto a RaspberryPi.
  2. Get the WROLPi installation script
    • wget https://raw.githubusercontent.com/lrnselfreliance/wrolpi/release/install.sh -O /tmp/install.sh
  3. Run the installation script
    • sudo /bin/bash /tmp/install.sh
  4. Start WROLPi
    • sudo systemctl start wrolpi.target
  5. 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