Skip to content
Open Prison Education project - Code and scripts to enable offline docker services and offline laptop syncing for inmate education
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
PortableGit
admin_app - Update admin app version Jan 1, 2019
bin
build_tools - Work on rebuild smc w web2py include Nov 19, 2018
client_tools - Update admin app version Jan 1, 2019
docker_build_files - SMC Update to v1.9.1 Jan 2, 2019
laptop_credential - enhancements to credential app Dec 24, 2018
libs
router_files - Get sync box gui working - can now update sync boxes in the sync app Dec 8, 2018
sync_tools - Update import_docker_images - recalculate app digest after import Jan 24, 2018
.gitattributes - Adjust sh script linefeed attributes - try to force sh files to hav… Sep 21, 2017
.gitignore - Work on rebuild smc w web2py include Nov 19, 2018
.ope_root - Added .ope_root file in the root OPE folder - used by scripts to lo… Jul 3, 2017
LICENSE
OfflineUpdate.cmd - syncapp - add auto param to up.sh and rebuild_compose.py files - su… Jan 15, 2018
OnlineUpdate.cmd
README.md
Scratch.txt - Get sync box gui working - can now update sync boxes in the sync app Dec 8, 2018
TODO - Work on not credentialed screen for lms app Nov 15, 2018

README.md

Overview - OPE (Open Prison Education)

It is a struggle to install and manage online services in an offline world. Simple things like updates or installing new packages becomes a hassle. We work in highly secure prison environments where internet is not available.

The goal here is to create a tool where we can package apps that can be easily copied to a USB drive, then pushed to a server in the offline environment.

This project consists of building and staging of apps, easy deployment into facilities, and offline laptops that students can take back to their unit to continue their school work.

Project Goals

  1. Create a place for skilled IT personnel to stage and place apps that are ready to deploy

  2. Limit the need for skilled IT personnel to deal with the actual deployment process

  3. Provide laptop images that can sync to a learning management system, credential for an individual student, and apply security settings to keep the system secure during use

Project Members

Deployment Steps

  1. Skilled IT personnel create docker apps and setup code to sync these apps and app data to a device (e.g. USB drive or Laptop)

  2. Sync USB drive in online or offline mode with a few button clicks - Goal is to have non IT personnel do this

  3. Image laptops and credential them for individual students - Goal is non IT personnel or local IT personnel to be able to do this easily

  4. Student brings laptop to docking station to sync with learning management system - download materials, upload completed work

Tech Details

Micro Service Architecture

We utilize Docker containers for micro services. You will need a machine that can run docker containers on the outside to build and setup your services, and a docker machine on the inside to transfer images and data to.

  +----------------------------------------------------------------------+
  | Online Server                                                        |
  |                                                                      |
  | you need a linux machine running docker                              |
  |  - can host this on campus (recommended)                             |
  |  - or on your desktop in virtual box/hyper-v/vmware/etc...           |
  |                                                                      |
  | Pre built Linux with Docker Available Here:                          |
  | - https://susestudio.com/a/P08rUy/ope-docker                         |
  |                                                                      |
  +------------------^---------------------------------------------------+
                     |
                     |
                +----V--------------------------------------------------+
                | USB Drive (or laptop)                                 |
                |                                                       |
                | Use a GUI based app to sync between servers           |
                | - Pulls apps/data from the online server              |
                | - Pushes apps/data to the offline server              |
                | - Clickable buttons - made for NON IT personnel       |
                +------------------------^------------------------------+
                                         |
                                         |
                                    +----V-------------------------------------------------------+
                                    | Offline Server                                             |
                                    |                                                            |
                                    | identical to the online server, but apps/data will         |
                                    | be pushed into this system                                 |
                                    |                                                            |
                                    | Use the same docker system as the online system:           |
                                    | - https://susestudio.com/a/P08rUy/ope-docker               |
                                    +--^----------------------------------------------------------+
                                       |
                                       |
                +----------------------V------------------------------------+
                | Inmate Laptop                                             |
                |                                                           |
                | Credentialed with the LMS app installed                   |
                | Will pull course work from offline LMS server and         |
                | push completed work back to the server for grading        |
                +-----------------------------------------------------------+

Getting Started

  1. Get a linux distro with docker installed in both your online and offline servers:

  2. From online computer, download the OPE Git project at: https://github.com/operepo/ope

    • From the GREEN button, click and choose "Download Zip".
    • Unzip this onto your USB drive into a folder called ope (e.g. e:\ope )
  3. Run the SyncApp.exe app

    • In the ope folder, you should see a folder called SyncApp. Run the SyncApp.exe file from there
  4. Configure your settings

    • Make sure you put in the correct IP for each server as well as the password you set
  5. Run Online

    • Choose the online button, then click Run. This will start pulling in the selected apps and syncing them to the USB drive
  6. Unplug, take USB drive to offline server, the choose the Offline option and run it

    • This will push the apps/data on the USB drive to the offline server
  7. Repeat online/offline as often as needed

  8. Setup DNS forwarder to .ed domain name to the static IP of the server. This forwards all DNS queries for the .ed domain to the docker apps to resolve DNS automatically

    • For Active Directory DNS - add a conditional forwarder for the domain ed -> to the static IP (put in the correct IP for the online or offline server)
    • For Linux DNS users, a wildcard DNS should work too if you don't know how to do a conditional forwarder

Getting Started - Developers

Use this method to get everything ready to do development.

  1. Get a linux distro with docker installed in both your online and offline servers:

  2. Install Git

  3. Python 2.7.? and needed libraries (python.org - choose 2.7? MSI installer)

    • NOTE: On the options page of the install, make sure "Add Python to Path" is selected
    • Run the InstallPythonModules.cmd batch file as admin to install all the needed python modules
  4. Clone the OPE project into a folder on your computer.

  5. Use the SyncApp tool to push apps to your online linux server (see instructions above)

Manuall Starting Apps - On the online Linux Server

  1. SSH into your online server (putty is a great tool from windows)

  2. Move to the OPE folder: cd /ope

  3. Move to the folder with the docker files: cd docker_build_files

  4. Start the apps: ./up.sh (use ./up.sh b if you want to build the docker apps from here)

  5. From here you can also use docker-compose commands:

    • python ../build_tools/rebuild_compose.py --> rebuilds the docker-compose file based on activated apps
    • docker-compose up -d --> start up all enabled apps
    • docker-compose down --> stop all apps

NOTE - 6/7/17 - file structure rearranged on this date

Revising to use dockerhub to pull built images as well as include client tools/etc... This is currently in process and could mean breaking changes to the prev build process.

DHCP Settings - to allow FOG Server to do network imaging with PXE Boot

DHCP Settings for Endian Firewall

option space PXE;
option PXE.mtftp-ip    code 1 = ip-address;
option PXE.mtftp-cport code 2 = unsigned integer 16;
option PXE.mtftp-sport code 3 = unsigned integer 16;
option PXE.mtftp-tmout code 4 = unsigned integer 8;
option PXE.mtftp-delay code 5 = unsigned integer 8;
option arch code 93 = unsigned integer 16; # RFC4578
use-host-decl-names on;
ddns-update-style interim;
ignore client-updates;
authoritative;
allow booting;
allow bootp;
option option-128 code 128 = string;
option option-129 code 129 = text;
next-server fog.ed;
#filename "pxelinux.0";
#filename "snponly.efi";
#filename "ipxe.efi";
option tftp-server-name "fog.ed";
#option bootfile-name "pelinux.0";
#option bootfile-name "undionly.kpxe";  # works for vmplayer
#option bootfile-name "snponly.efi";
#option bootfile-name "ipxe.efi";
#range dynamic-bootp 192.168.10.25 192.168.10.28;

class "UEFI-32-1" {
    match if substring(option vendor-class-identifier, 0, 20) = "PXEClient:Arch:00006";
    filename "i386-efi/ipxe.efi";
    }

    class "UEFI-32-2" {
    match if substring(option vendor-class-identifier, 0, 20) = "PXEClient:Arch:00002";
     filename "i386-efi/ipxe.efi";
    }

    class "UEFI-64-1" {
    match if substring(option vendor-class-identifier, 0, 20) = "PXEClient:Arch:00007";
     #filename "ipxe.efi";
     filename "snp.efi";  # works for hyperv
    }

    class "UEFI-64-2" {
    match if substring(option vendor-class-identifier, 0, 20) = "PXEClient:Arch:00008";
     #filename "ipxe.efi";
     filename "snp.efi"; # Works for hyper v
    }

    class "UEFI-64-3" {
    match if substring(option vendor-class-identifier, 0, 20) = "PXEClient:Arch:00009";
     #filename "ipxe.efi";
     filename "snp.efi"; # Works for hyperv
    }

    class "Legacy" {
    match if substring(option vendor-class-identifier, 0, 20) = "PXEClient:Arch:00000";
    filename "undionly.kkpxe";
    }
You can’t perform that action at this time.