Zynthian Software

From ZynthianWiki
Revision as of 16:40, 28 May 2021 by Ie51 (talk | contribs) (Give some basic instructions for non v3 or v4 kits)
Jump to navigation Jump to search

Official ZynthianOS SD-Images

This is the last official Zynthian SD-Image, based on Raspberry Pi OS:

Last Stable ZynthianOS (MD5-sum)


This SD-image is pre-configured for official kits v4 & v3. If you are using a different hardware, your first step should be accessing the webconf and configuring your hardware.


  • For accessing to the webconf tool, see here
  • Once logged in go to Hardware -> Kit and select "Custom" then click on save button
  • Then, stil in the Hardware menu, configure each device: Audio, Display, Wiring (use "Dummies" if you do not use any encoder/switch). Don't forget to save your configuration after each step.
  • When everything is configured, you can reboot Zynthian using the System -> Reboot menu item

Nightly Build SD-Images

If you like to be in the cutting edge, test the latest features and find the bugs, try the nightly builds:

ZynthianOS Nightly Builds

Our nightly build system is based on the fantastic work of @guysoft, the CustomPiOS system:

CustomPiOS is a Raspberry Pi and other ARM devices distribution builder. CustomPiOS opens an already existing image, modifies it and repackages the image ready to ship.

@guysoft has largely contributed to the project by configuring and setting up the ZynthianOS build server. Really big thanks!!

Preparing the SD-card

Current images are 8 GB compressed image file compiled for Raspberry Pi 3. These SD card images include all the Zynthian software, properly configured for working with the official kits. Completely ready to use. Plug and play!

After downloading the SD-image, you have to write it to a SD-card. You need a SD card with a minimum size of 16GB, although you can use a bigger one if you want.

Use Etcher (free software works on Mac, Windows or Linux) to write the image onto the SDcard. Or do it manually! There is a really good manual for this at this link.


RBPi2 is not currently supported by the latest official zynthian SD images, so if you want to use a RBPi2, you may need to build your own SD image.

Build your own image

If you like, you can build your own SD image following these instructions:

Building the SD Image using the Setup Script

Also, you would like to try the new docker-builder (thanks @guysoft!!):

Building Zynthian with Docker