docs: Modify Balena-related documentation.

This commit is contained in:
nicomiguelino
2024-04-04 13:40:34 -07:00
parent bb86fdc6be
commit 181013cbaa
5 changed files with 42 additions and 9 deletions

View File

@@ -27,19 +27,45 @@ Should you encounter any issues, please file an issue either in this repository
[![Star History Chart](https://api.star-history.com/svg?repos=Screenly/Anthias&type=Date)](https://star-history.com/#Screenly/Anthias&Date)
## Installation options
## Balena disk images
### Using the image from the Raspberry Pi Imager
The quickest way to get started is to use [Raspberry Pi Imager](https://www.screenly.io/blog/2022/12/13/anthias-and-screenly-now-in-rpi-imager/), where you can find Anthias under `Other specific-purpose OS`. Alternatively, you can find our pre-built disk images (powered by [Balena Hub](https://hub.balena.io/)) [here](https://github.com/Screenly/Anthias/releases/latest/).
The quickest way to get started is to use [Raspberry Pi Imager](https://www.screenly.io/blog/2022/12/13/anthias-and-screenly-now-in-rpi-imager/), where you can find Anthias under `Other specific-purpose OS`.
Do however note that we are still in the process of knocking out some bugs. You can track the known issues [here](https://github.com/Screenly/Anthias/issues). You can also check the discussions in the [Anthias forums](https://forums.screenly.io).
![imager-01](./docs/img/imager-01.png)
If you'd like more control over your digital signage instance, try installing it on
[Raspberry Pi OS Lite](#installing-on-raspberry-pi-os-lite).
![imager-02](./docs/img/imager-02.png)
## Installing on Raspberry Pi OS Lite
![imager-03](./docs/img/imager-03.png)
The tl;dr for on [Raspberry Pi OS](https://www.raspberrypi.com/software/) Bullseye Lite is:
### Using the images from balenaHub
Balena made a [big update to their IoT marketplace](https://blog.balena.io/creating-an-iot-marketplace/). Included in that change is the launch of
[Fleets for Good](https://hub.balena.io/fleets-for-good). With that, you may find it hard to find the Anthias images on the marketplace. In the meantime,
here are the links to the images:
* [Raspberry Pi 1](https://hub.balena.io/fleets-for-good/1971378/anthias-pi1)
* [Raspberry Pi 2](https://hub.balena.io/fleets-for-good/1971385/anthias-pi2)
* [Raspberry Pi 3](https://hub.balena.io/fleets-for-good/1971388/anthias-pi3)
* [Raspberry Pi 4](https://hub.balena.io/fleets-for-good/1971389/anthias-pi4)
Go to one of the links above and click the *Join* button, then select either *Ethernet only* or *Wifi + Ethernet* for Network options.
You can either click the *Flash* button to open balenaEthcher (make sure that it's installed) or download the image file and flash it using your preferred imager.
Flash the SD card and boot up your Raspberry Pi. It will take a few minutes to boot up and start the services.
Alternatively, you can [download our pre-built Balena disk images from the releases](#using-the-images-from-the-releases).
### Using the images from the releases
You can find the latest release [here](https://github.com/Screenly/Anthias/releases/latest). From there, you can download the disk image that you need and flash it to your SD card.
The image file looks something like `<yyyy>-<mm>-<dd>-raspberry<version>.zip`. Take note that the `.img` file is compressed in a `.zip` file.
### Installing on Raspberry Pi OS Lite
If you'd like more control over your digital signage instance, try installing it on Raspberry Pi OS Lite.
The tl;dr for on [Raspberry Pi OS](https://www.raspberrypi.com/software/) is:
```
$ bash <(curl -sL https://install-anthias.srly.io)
@@ -66,10 +92,14 @@ it's still recommended to do a reboot.
During ideal conditions (Raspberry Pi 3 Model B+, class 10 SD card and fast internet connection), the installation normally takes 15-30 minutes. On a Raspberry Pi Zero or Raspberry Pi Model B with a class 4 SD card, the installation will take hours.
## Installing with Balena
### Installing with Balena
Go through the steps in [this documentation](/docs/balena-fleet-deployment.md)
to deploy Anthias on your Balena fleet.
to deploy Anthias on your own Balena fleet.
## Issues and bugs
Do however note that we are still in the process of knocking out some bugs. You can track the known issues [here](https://github.com/Screenly/Anthias/issues). You can also check the discussions in the [Anthias forums](https://forums.screenly.io).
## Quick links

View File

@@ -11,8 +11,11 @@ post-provisioning: >-
With Anthias, a monitor/TV and a Raspberry Pi, you can create a remotely managed screen that can display:
* Images
* Video
* Web pages
* Video feeds (RTSP)
Thanks to Balena [OpenFleets](https://hub.balena.io/organizations/screenly_ose/fleets), you benefit from having automatic updates. As soon as updates are shipped, they will be deployed to your device.

BIN
docs/images/imager-01.png Normal file
View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 103 KiB

BIN
docs/images/imager-02.png Normal file
View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 146 KiB

BIN
docs/images/imager-03.png Normal file
View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 113 KiB