README
¶
Device Gateway Satellite Server
The satellite server is an open source system for managing Foundries.io update agents. There are two primary use cases for the satellite server:
- Offline (air-gapped) environments where devices can't reach the Foundries.io backend
- Users who want to manage their own device management solution
This project handles both use cases by implementing all the APIs used by Foundries.io update agents. The project also includes a user-facing REST API and Web UI for managing devices and updates.
Quick start
Follow the Quick Start guide to get a server running in development mode.
Adding updates
The satellite server uses content from Offline Updates to serve devices their TUF, OSTree, and Container data. Follow the updates guide for setting this up.
API access
Follow the API to learn how to access and use the REST API.
Configuring authentication options
Follow the configuring authentication guide for chosing the method that meets your requirements.
Running in production
The production guide covers considerations when deploying the satellite server for production use.
Developing
The project is a single Golang binary that can be built with:
go build -o dg-sat github.com/foundriesio/dg-satellite/cmd/server
A "devshell" is also included that can be used for local development:
./contrib/dev-shell
NOTE: This repository uses Git-LFS. You'll need this installed to use the web UI.
License
dg-satellite is under the BSD 3-Clause Clear license.
Directories