mirror of
https://github.com/balena-io/open-balena.git
synced 2024-12-24 07:46:39 +00:00
commit
6438da8498
106
README.md
106
README.md
@ -25,42 +25,23 @@ To learn more about openBalena, visit [balena.io/open][open-balena-website].
|
|||||||
- **Built-in VPN**: Access your devices regardless of their network environment
|
- **Built-in VPN**: Access your devices regardless of their network environment
|
||||||
|
|
||||||
|
|
||||||
## 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
|
|
||||||
|
|
||||||
|
|
||||||
## 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][forums], reporting or triaging [issues][issue-tracker],
|
|
||||||
reviewing and discussing [pull requests][pulls], or just spreading the word.
|
|
||||||
|
|
||||||
All of openBalena is hosted on GitHub. Apart from its constituent components,
|
|
||||||
which are the [API][open-balena-api], [VPN][open-balena-vpn], [Registry][open-balena-registry],
|
|
||||||
[S3 storage service][open-balena-s3], and [Database][open-balena-db], contributions
|
|
||||||
are also welcome to its client-side software such as the [balena CLI][balena-cli],
|
|
||||||
the [balena SDK][balena-sdk], [balenaOS][balena-os] and [balenaEngine][balena-engine].
|
|
||||||
|
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
Our [Getting Started][getting-started] guide is the most direct path to getting
|
Our [Getting Started guide][getting-started] is the most direct path to getting
|
||||||
an openBalena installation up and running and successfully deploying your
|
an openBalena installation up and running and successfully deploying your
|
||||||
application to your device(s).
|
application to your device(s).
|
||||||
|
|
||||||
> **IMPORTANT:** Due to changes in [balenaOS][balena-os], only versions up to and including `2.49.0` are currently supported. Additionally, only [balenaCLI](balena-cli) versions `<v12.2.2` are fully supported at the moment.
|
|
||||||
|
## Compatibility
|
||||||
|
|
||||||
|
The current release of openBalena has the following minimum version requirements:
|
||||||
|
|
||||||
|
- balenaOS v2.58.3
|
||||||
|
- balena CLI v12.23.4
|
||||||
|
|
||||||
|
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
|
## Documentation
|
||||||
@ -81,22 +62,6 @@ sections are of particular interest:
|
|||||||
- [Reference](https://balena.io/docs/reference)
|
- [Reference](https://balena.io/docs/reference)
|
||||||
- [FAQ](https://balena.io/docs/faq/troubleshooting/faq)
|
- [FAQ](https://balena.io/docs/faq/troubleshooting/faq)
|
||||||
|
|
||||||
## Differences between openBalena and balenaCloud
|
|
||||||
|
|
||||||
| openBalena | balenaCloud |
|
|
||||||
| ----- | ---- |
|
|
||||||
| Device updates using full images | Device updates using [delta images](https://www.balena.io/docs/learn/deploy/delta/) |
|
|
||||||
| Support for a single user | Support for [multiple users](https://www.balena.io/docs/learn/manage/account/#application-members) |
|
|
||||||
| Self-hosted deployment and scaling | balena-managed scaling and deployment |
|
|
||||||
| Community support via [forums](https://forums.balena.io/c/open-balena) | Private support on [paid plans](https://www.balena.io/pricing/) |
|
|
||||||
| Deploy via `balena deploy` only | Build remotely with native builders using [`balena push`](https://www.balena.io/docs/learn/deploy/deployment/#balena-push) or [`git push`](https://www.balena.io/docs/learn/deploy/deployment/#git-push) |
|
|
||||||
| No support for building via `git push` | Use the same CI workflow with [`git push`](https://www.balena.io/docs/learn/deploy/deployment/#git-push) |
|
|
||||||
| No public URL support | Serve websites directly from device with [public device URLs](https://www.balena.io/docs/learn/manage/actions/#enable-public-device-url) |
|
|
||||||
| Management via `balena-cli` only | Cloud-based device management dashboard |
|
|
||||||
| Download images from https://www.balena.io/os/ | Download preconfigured images directly from the dashboard |
|
|
||||||
| No supported remote diagnostics | Remote device diagnostics |
|
|
||||||
|
|
||||||
Additionally, refer back to the [roadmap](#roadmap) above for planned but not yet implemented features.
|
|
||||||
|
|
||||||
## Getting Help
|
## Getting Help
|
||||||
|
|
||||||
@ -107,6 +72,53 @@ for help, or contribute by answering questions posted by fellow openBalena users
|
|||||||
Please do not use the issue tracker for support-related questions.
|
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][forums], reporting or triaging [issues][issue-tracker],
|
||||||
|
reviewing and discussing [pull requests][pulls], or just spreading the word.
|
||||||
|
|
||||||
|
All of openBalena is hosted on GitHub. Apart from its constituent components,
|
||||||
|
which are the [API][open-balena-api], [VPN][open-balena-vpn], [Registry][open-balena-registry],
|
||||||
|
[S3 storage service][open-balena-s3], and [Database][open-balena-db], contributions
|
||||||
|
are also welcome to its client-side software such as the [balena CLI][balena-cli],
|
||||||
|
the [balena SDK][balena-sdk], [balenaOS][balena-os] and [balenaEngine][balena-engine].
|
||||||
|
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
| openBalena | balenaCloud |
|
||||||
|
| ----- | ---- |
|
||||||
|
| Device updates using full images | Device updates using [delta images](https://www.balena.io/docs/learn/deploy/delta/) |
|
||||||
|
| Support for a single user | Support for [multiple users](https://www.balena.io/docs/learn/manage/account/#application-members) |
|
||||||
|
| Self-hosted deployment and scaling | balena-managed scaling and deployment |
|
||||||
|
| Community support via [forums][forums] | Private support on [paid plans](https://www.balena.io/pricing/) |
|
||||||
|
| Deploy via `balena deploy` only | Build remotely with native builders using [`balena push`](https://www.balena.io/docs/learn/deploy/deployment/#balena-push) or [`git push`](https://www.balena.io/docs/learn/deploy/deployment/#git-push) |
|
||||||
|
| No support for building via `git push` | Use the same CI workflow with [`git push`](https://www.balena.io/docs/learn/deploy/deployment/#git-push) |
|
||||||
|
| No public URL support | Serve websites directly from device with [public device URLs](https://www.balena.io/docs/learn/manage/actions/#enable-public-device-url) |
|
||||||
|
| Management via `balena-cli` only | Cloud-based device management dashboard |
|
||||||
|
| Download images from [balena.io][balena-os-website] | Download preconfigured images directly from the dashboard |
|
||||||
|
| No supported remote diagnostics | Remote device diagnostics |
|
||||||
|
|
||||||
|
Additionally, refer back to the [roadmap](#roadmap) above for planned but not yet implemented features.
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
OpenBalena is licensed under the terms of AGPL v3. See [LICENSE](LICENSE) for details.
|
OpenBalena is licensed under the terms of AGPL v3. See [LICENSE](LICENSE) for details.
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
export OPENBALENA_API_VERSION_TAG=v0.19.5
|
export OPENBALENA_API_VERSION_TAG=v0.105.0
|
||||||
export OPENBALENA_DB_VERSION_TAG=v2.0.3
|
export OPENBALENA_DB_VERSION_TAG=v4.1.0
|
||||||
export OPENBALENA_MDNS_PUBLISHER_VERSION_TAG=v1.6.2
|
export OPENBALENA_MDNS_PUBLISHER_VERSION_TAG=v1.7.9
|
||||||
export OPENBALENA_REGISTRY_VERSION_TAG=v2.11.1
|
export OPENBALENA_REGISTRY_VERSION_TAG=v2.13.11
|
||||||
export OPENBALENA_S3_VERSION_TAG=v2.8.5
|
export OPENBALENA_S3_VERSION_TAG=v2.9.9
|
||||||
export OPENBALENA_VPN_VERSION_TAG=v8.10.0
|
export OPENBALENA_VPN_VERSION_TAG=v9.16.1
|
||||||
|
Loading…
Reference in New Issue
Block a user