Get Started
Required Hardware
- For the best experience, we recommend using a Raspberry Pi 3B+ or 4B.
- An SD Card. We recommend the Sandisk Extreme Pro series. 8GB should be plenty enough for this project.
- Power supply
Software required
- Software to flash an SD card (balenaEtcher)
- A free balenaCloud account
- (optional) A download of this project
- (optional) The balena CLI tools
Provision your device
Once your application has been created you'll need to add a device to it:
- Add a device to the application by clicking the
add device
button - Download the OS and flash it to your SD card with balenaEtcher
- Power up your device and check it's online in the dashboard!
CLI deploy
This is the traditional and more advanced approach for deploying applications to balena powered devices. Installing and setting up the balena CLI is definitely more involved than using the Deploy with balena
button, but it allows for more flexibility and customization when choosing what and when to deploy.
For example, if you don't plan on using the Spotify integration, you can edit the docker-compose.yml
file and remove the Spotify service before deploying the application.
Provision your device
- Sign up for or login to the balenaCloud dashboard
- Create an application, selecting the correct device type.
- Add a device to the application, enabling you to download the OS
- Flash the downloaded OS to your SD card with balenaEtcher
- Power up your device and check it's online in the dashboard
Deploy the application
- Install the balena CLI tools
- Login with
balena login
- Clone the project and from the project directory run
balena push <appName>
where<appName>
is the name you gave your balenaCloud application in the first step.
Having trouble?
If you are running into issues getting your application running, please try the following:
- Check the existing issues on GitHub.
- Post in the Balena forums for help from the Balena community.
- Create a new GitHub issue