{"id":17888287,"url":"https://github.com/squat/onboard","last_synced_at":"2025-07-15T16:12:02.762Z","repository":{"id":65145983,"uuid":"364351620","full_name":"squat/onboard","owner":"squat","description":"Easily connect IoT devices to your fleet","archived":false,"fork":false,"pushed_at":"2023-03-02T22:10:57.000Z","size":2815,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-01T06:03:35.179Z","etag":null,"topics":["iot","kubernetes","raspberry-pi","sbc","wizard"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/squat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-04T18:35:14.000Z","updated_at":"2024-02-04T03:17:01.000Z","dependencies_parsed_at":"2024-06-20T12:59:24.483Z","dependency_job_id":"02fe6c5a-c5c1-4232-84d6-ae73ed64430a","html_url":"https://github.com/squat/onboard","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/squat/onboard","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squat%2Fonboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squat%2Fonboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squat%2Fonboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squat%2Fonboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/squat","download_url":"https://codeload.github.com/squat/onboard/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squat%2Fonboard/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265444938,"owners_count":23766438,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["iot","kubernetes","raspberry-pi","sbc","wizard"],"created_at":"2024-10-28T13:37:01.093Z","updated_at":"2025-07-15T16:12:02.714Z","avatar_url":"https://github.com/squat.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Onboard\n\n`onboard` is a tool designed to help you connect single board computers (SBCs), such as Raspberry Pis, to your fleet of IoT devices.\nIt provides a configurable wizard via a webapp to collect all of the information needed to configure the device, such as connecting to a wireless network and starting the services you need.\n\n[![Go Report Card](https://goreportcard.com/badge/github.com/squat/onboard)](https://goreportcard.com/report/github.com/squat/onboard)\n\n## Overview\n\n`onboard` provides two main pieces of functionality to connect your IoT devices to your fleet:\n1. a programmable and extensible service for configuring the IoT device; this service:\n    1. runs a webapp that guides the user through a wizard in order to provide any necessary inputs;\n    2. executes the requested operations on the host, such as provisioning files and running systemd units;\n    3. verifies the proper operation of the host by running a series of configured checks; and\n    4. surfaces the status and progress of the configuration process to the user through the webapp.\n\n2. a minimalist base OS for the IoT device built on [Arch Linux Arm](https://archlinuxarm.org/) that can be installed using the [`install.sh`](https://github.com/squat/onboard/blob/master/install.sh) script; this base OS:\n    1. starts a wireless access point with an open wireless network named `onboard`;\n    2. runs the `onboard` configuration wizard webapp at [http://onboard.local/](http://onboard.local/);\n    3. configures the IoT device using the collected inputs to connect to a desired wireless network;\n    4. runs any other actions specified via the `onboard` configuration files, such as starting additional systemd services;\n    5. disables the wireless access point once the network connection has been successfully established; and\n    5. periodically checks if the network is inaccessible, in which case it re-enables the wireless access point so that the device can be reconfigured.\n\n## Getting Started\n\nFirst, flash the `onboard` filesystem onto an SD card using the [`install.sh`](https://github.com/squat/onboard/blob/master/install.sh) script, or with the following snippet:\n\n```shell\ncurl -sfL https://raw.githubusercontent.com/squat/onboard/master/install.sh | sh -\n```\n\nThis will install a complete Linux distribution onto the SD card.\n\n_Note_: the script is currently compatible with the following IoT devices:\n* Raspberry PI 4;\n* Raspberry PI 3;\n* Raspberry PI Zero W; and\n* Banana PI M2 Zero.\n\nNext, insert the SD card into the IoT device and power it on.\nThe device will take ~10 seconds to boot, after which `onboard` will start a wireless access point with the name `onboard`.\nTo access the `onboard` webapp, connect your computer to the `onboard` wireless network and point a browser to [http://onboard.local/](http://onboard.local/).\nThe `onboard` webapp will ask for some information so that it can connect to your local wireless network and to any services specified in its configuration file.\n\n## Usage\n\n[embedmd]:# (tmp/help.txt)\n```txt\nUsage of bin/amd64/onboard:\n  -c, --config stringArray            The path to the configuration file for Onboard. Can be specified multiple times to concatenate mutiple configuration files. Can be a glob, e.g. /path/to/configs/*.yaml. Files are processed in lexicographic order.\n      --debug.name string             A name to add as a prefix to log lines. (default \"onboard\")\n      --id string                     The ID for this device.\n      --ip-address string             The IP address of the device running this process. (default \"10.0.0.1\")\n      --log.format string             The log format to use. Options: 'logfmt', 'json'. (default \"logfmt\")\n      --log.level string              The log filtering level. Options: 'error', 'warn', 'info', 'debug'. (default \"info\")\n      --web.healthchecks.url string   The URL against which to run healthchecks. (default \"http://localhost:8080\")\n      --web.internal.listen string    The address on which the internal server listens. (default \":8081\")\n      --web.listen string             The address on which the public server listens. (default \":8080\")\n      --wlan-interface string         The name of the WLAN interface to configure. (default \"wlan0\")\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsquat%2Fonboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsquat%2Fonboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsquat%2Fonboard/lists"}