balena-io / Open Balena

OpenBalena is a platform to deploy and manage connected devices. Devices run balenaOS, a host operating system designed for running containers on IoT devices, and are managed via the balena CLI, which you can use to configure your application containers, push updates, check status, view logs, and so forth. OpenBalena’s backend services, composed of battle-tested components that we’ve run in production on balenaCloud for years, can store device information securely and reliably, allow remote management via a built-in VPN service, and efficiently distribute container images to your devices.

To learn more about openBalena, visit balena.io/open.

Features

• Simple provisioning: Adding devices to your fleet is a breeze
• Easy updates: Remotely update the software on your devices with a single command
• Container-based: Benefit from the power of virtualization, optimized for the edge
• Scalable: Deploy and manage one device, or one million
• Powerful API & SDK: Extend openBalena to fit your needs
• Built-in VPN: Access your devices regardless of their network environment

Getting Started

Our Getting Started guide is the most direct path to getting an openBalena installation up and running and successfully deploying your application to your device(s).

Compatibility

The current release of openBalena has the following minimum version requirements:

• balenaOS v2.58.3
• balena CLI v12.38.5

If you are updating from previous openBalena versions, ensure you update the balena CLI and reprovision any devices to at least the minimum required versions in order for them to be fully compatible with this release, as some features may not work.

Documentation

While we're still working on the project documentation, please refer to the balenaCloud documentation. BalenaCloud is built on top of openBalena, so the core concepts and functionality is identical. The following sections are of particular interest:

• Overview / A balena primer
• Overview / Core Concepts
• Overview / Going to production
• Develop / Define a container
• Develop / Multiple containers
• Develop / Runtime
• Develop / Interact with hardware
• Deploy / Optimize your builds
• Reference
• FAQ

Getting Help

You are welcome to submit any questions, participate in discussions and request help with any issue in openBalena forums. The balena team frequents these forums and will be happy to help. You can also ask other community members for help, or contribute by answering questions posted by fellow openBalena users. Please do not use the issue tracker for support-related questions.

Contributing

Everyone is welcome to contribute to openBalena. There are many different ways to get involved apart from submitting pull requests, including helping other users on the forums, reporting or triaging issues, reviewing and discussing pull requests, or just spreading the word.

All of openBalena is hosted on GitHub. Apart from its constituent components, which are the API, VPN, Registry, S3 storage service, and Database, contributions are also welcome to its client-side software such as the balena CLI, the balena SDK, balenaOS and balenaEngine.

Roadmap

OpenBalena is currently in beta. While fully functional, it lacks features we consider important before we can comfortably call it production-ready. During this phase, don’t be alarmed if things don’t work as expected just yet (and please let us know about any bugs or errors you encounter!). The following improvements and new functionality is planned:

• Full documentation
• Full test suite
• Simplified deployment
• Remote host OS updates
• Support for custom device types

Differences between openBalena and balenaCloud

Additionally, refer back to the roadmap above for planned but not yet implemented features.

License

OpenBalena is licensed under the terms of AGPL v3. See LICENSE for details.