Offline Lab¶

A battery-powered platform for life without internet.

Start here¶

New to the project? Read About to understand what we're building and why.

Where to go next¶

Learn¶

Start here if you want to understand the platform:

• Getting Started: set up your first device
• Hardware: supported devices, storage, power, networking
• Operating System: Offline Lab OS design principles

Build¶

Step-by-step guides for working with the platform:

• Install Offline Lab OS: write a pre-built image
• Build the OS image: build Offline Lab OS from source

Look things up¶

Reference material for the platform and companion projects:

• Configuration: WiFi, SSH, and runtime config
• Boot: boot chain, partition layout, A/B mechanics
• Packages: OS packages and the provisioning pattern
• Service model: portable service model
• App filesystem: required files inside a portable service image
• Disco: service discovery and name resolution
• offline-lab.com/docs/framework: bash library and boxctl CLI reference
• offline-lab.com/docs/appctl: on-device app management CLI reference
• offline-lab.com/docs/buildctl: package build and publishing CLI reference
• offline-lab.com/docs/disco: service discovery protocol and CLI reference
• offline-lab.com/docs/bootconf: boot-time configuration reference

Contribute¶

• How to contribute: issues, PRs, code of conduct
• Development guide: gotchas, coding conventions, adding packages