Difference between revisions of "Zynthian FAQ"

Latest revision as of 23:43, 25 June 2023

Please, add your questions to this FAQ. And of course, if you can add/improve an answer, do it! ;-)

1 LINUX Audio terminology is confusing

Understanding LINUX Audio Helps understand the acronyms mentioned in this Wiki

2 Which compute boards does Zynthian support?

The currently supported computing boards are:

RBPi2 is not longer supported by official zynthian SD images. RBPi3 is supported but may be not powerfull enough if you plan to use many sound engines at the same time. RBPi4 is the best choice.

3 I want to run Zynthian OS on another Single Board Computer

Not an easy task, but it's doable for advanced users. If you want to use a different computing board model, you have to build your own SD image using the setup scripts. You can start from here on top of minimal Debian Buster install. This script and the environment variables should be adapted to match your board.

4 Where can i buy a Zynthian Kit?

You can buy official kits in the Zynthian Shop.

5 How do I edit entries in the Wiki?

You need to be able to login into the Wiki. Registering in the wiki is currently disabled for security reasons, but you can ask on the forum to get access.

6 I have a license for Pianoteq, what would be the process to enter the license key ?

You have to access the webconf tool and follow carefully the instructions from the "Software->Pianoteq" section.

7 I see a red lightning on the display, I hear cracks when playing

You are suffering from underpower. You need a reliable Power Supply Unit and a strong USB cable. The official RaspberryPi PSU bundle is the one that works perfectly. And it's available in the Zynthian shop.

8 Loading engines or soundfonts is slow

Be sure that you're using a high quality SD card. Also, if you're running ZynthianOs on a RBPi3, consider upgrading to RBPi4.

9 Despite I have a good PSU, a good SD card and a RBPi4, my Zynthian hangs

Maybe you have let the VNC server running while playing. Forwarding the sound engines native gui over the network is resource consuming. You should consider disabling the VNC server.

10 Does the pre-built kit come with a Raspberry Pi ?

In the shop, you can choose to buy the kit with or without a Raspberry Pi 4.

11 I’m primarily a guitarist and thus, I’m interested in the MOD UI...

Currently, all official Zynthian Bundle-All Kits include "audio input". The new official sound card is the ZynADAC.

Zynthia UI allows to create up to 16 FX-chains for audio processing and, of course, you can also use the fantastic MOD-UI from MOD Devices.

12 Do you think Zynthian is for me?

It depends a lot. Building a recent official zynthian kit doesn't require soldering, only basic tinkering (plugging wires, screw-driving, etc.). The official zynthian software runs out-the-box and you shouldn't need to use the command line. That being said, being comfortable with Linux command line helps in solving problems. If you love tinkering and have specific needs, Zynthian is an excellent basis to taylor a unique piece of hardware.

13 About Zynthian Security

FYI, everything in Zynthian is executed as root user.

Anybody who wants to connect their Zynthians to a “not secure” network (any network not controlled by oneself should be considered “not secure”) SHOULD CHANGE the default zynthian password. You can do that from the webconf tool.

You also have to understand that:

Although the Webconf Tool ask for the password, it doesn’t use HTTPS by default, so your password could be sniffed by bad actors connected to the local network. That is especially true if you are using an ethernet cable or the old WEP Wifi protocol. If you are using WPA2 Wifi protocol on your 2 devices (Zynthian and your “computer”), then you should be protected against sniffers.

When a MOD-UI layer is created on zynthian, the MOD-UI server run completely open for everybody in the local network.

IMHO, these 2 are the main security holes in Zynthian. For solving it, we have to:

Use HTTPS for webconf tool. This is already implemented with a self-signed certificate.
Secure the MOD-UI server:
1. Fast and Easy Way: Set a flag for “secure” networks, so MOD-UI will be “open” in that networks only
2. Not so Easy Way: Use HTTPS and ask for the password. We should modify MOD-UI source code

14 How good can the latency be?

A forum post on Latency.

@@ Line 1: / Line 1: @@
 Please, add your questions to this FAQ. And of course, if you can add/improve an answer, do it! ;-)
-----------------------------------
+===LINUX Audio terminology is confusing===
-===What RaspberryPi does Zynthian support?===
+[[Understanding LINUX Audio]] Helps understand the acronyms mentioned in this Wiki
-You need a '''RBPi3'''.
-RBPi2 is not longer supported by official zynthian SD images. If you want to use a different RBPi version, you should rebuild your own SD image. Also, you can try with the experimental ZynthianOS images from here:
+===Which compute boards does Zynthian support?===
+The currently supported computing boards are:
- https://os.zynthian.org
+* [https://www.raspberrypi.org/products/raspberry-pi-4-model-b Raspberry Pi 4 Model B]
+* [https://www.raspberrypi.org/products/raspberry-pi-3-model-b-plus Raspberry Pi 3 Model B+]
+* [https://www.raspberrypi.org/products/raspberry-pi-3-model-b Raspberry Pi 3 Model B]
-===Where can i buy a Zynthian Kit?===
+RBPi2 is not longer supported by official zynthian SD images.
-Currently you can buy the official Zynthian Kits in the [http://shop.zynthian.org Zynthian Shop].
+RBPi3 is supported but may be not powerfull enough if you plan to use many sound engines at the same time.
+RBPi4 is the best choice.
+=== I want to run Zynthian OS on another Single Board Computer ===
-=== How do I edit entries in the wiki? ===
+Not an easy task, but it's doable for advanced users.
-You need to be able to login to the wiki with a username. Simply register...
+If you want to use a different computing board model, you have to build your own SD image using the setup scripts. You can start from [https://github.com/zynthian/zynthian-sys/blob/master/scripts/setup_system_rbpi_raspbian_lite_buster.sh here] on top of minimal Debian Buster install. This script and the [https://github.com/zynthian/zynthian-sys/blob/master/scripts/zynthian_envars.sh environment variables] should be adapted to match your board.
-=== I just wrote my 16/32/64 GB SD card with a Zynthian image, but from Zynthian's console i only see a part of SD's total space and i've no free space left in the partition. How can i make available all the space on my SD Card? ===
+===Where can i buy a Zynthian Kit?===
+You can buy official kits in the '''[https://shop.zynthian.org Zynthian Shop]'''.
-'''UPDATE:''' From 2016-12-23, the Gorgona SD image solved this problem. Latest SD images will auto-expand the partition on the first boot, so you shouldn't have this problem never more, but if you have it ...
+=== How do I edit entries in the Wiki? ===
+You need to be able to login into the Wiki. Registering in the wiki is currently disabled for security reasons, but you can ask on the forum to get access.
-After writing the zynthian image into the SD card, you have to "expand" the partition to fill all the available space. Follow these steps:
+=== I have a license for Pianoteq, what would be the process to enter the license key ? ===
- + login into your zynthian box using ssh
+You have to access the webconf tool and follow ''carefully'' the instructions from the "Software->Pianoteq" section.
- + execute "df" command to see the size of your partition and the available space
- + run "raspi-config" and select the first option to expand your partition
- + reboot your zynthian box
- + login again and execute "df" command to see size of your partition and the available space. You should see the difference ;-)
-'''Important:''' If you don't expand your partition, you will have problems when updating zynthian software or library, as you will run out of space.
+=== I see a red lightning on the display, I hear cracks when playing ===
-=== I have a license for Pianoteq6, what would be the process to enter the license key ? ===
+You are suffering from underpower. You need a reliable Power Supply Unit and a strong USB cable. The official RaspberryPi PSU bundle is the one that works perfectly. And it's available in the [https://shop.zynthian.org/shop/product/raspberry-pi-15-3w-usb-c-power-supply-389 Zynthian shop].
-''Is the process easy ? Is it done via a graphical interface ?''
-You need a Ethernet connection (Wifi or cacble - Wifi has range problems when Zynthian is inside a metal case!)
+=== Loading engines or soundfonts is slow ===
- ssh to Zynthian:
+Be sure that you're using a high quality SD card.
-    ssh zynthian.local
+Also, if you're running ZynthianOs on a RBPi3, consider upgrading to RBPi4.
- Login (as root or pi)
- Start PT on the Zynthian. The Window of PT should be redirected via ssh.
- Add your license like “normal”
-Caveats: If using putty or anything else on Windows make sure that X11-Forwarding is activated.
+=== Despite I have a good PSU, a good SD card and a RBPi4, my Zynthian hangs ===
+Maybe you have let the VNC server running while playing. Forwarding the sound engines native gui over the network is resource consuming. You should consider disabling the VNC server.
-=== Does the pre-built kit come with a rpi3 or 3+ ? ===
+=== Does the pre-built kit come with a Raspberry Pi ? ===
-''If 3, is it possible to order the pre-built kit without it since I already have a rpi3 doing nothing here ?''
-The 3+ is highly recommended, especially with Pianoteq.
+[https://shop.zynthian.org/shop/product/zynthian-kit-v4-2-358?category=13 In the shop], you can choose to buy the kit with or without a Raspberry Pi 4.
-Full kits come with a Rpi 3+. Basic kits come without a Rpi  http://shop.zynthian.org/shop/category/zynthian-v2-basic-kits-4
+=== I’m primarily a guitarist and thus, I’m interested in the MOD UI... ===
-=== I’m primarily a guitarist and thus, I’m interested in the MOD UI. ===
+Currently, all official Zynthian Bundle-All Kits include "audio input". The new official sound card is the [https://blog.zynthian.org/2021/05/zynadac-v1-0-an-open-hardware-soundcard-for-zynthian/ ZynADAC].
-''I know some people have experimented with audio input and was wondering if this would be added to the “official” Zynthian kit at some point and if so, how hard would it be to “upgrade” to it ?
-There are no firm plans for including an audio input device in the kits at this time.
+Zynthia UI allows to create up to 16 FX-chains for audio processing and, of course, you can also use the fantastic MOD-UI from [https://mod.audio/ MOD Devices].
-=== Do you think Zynthian is for me ?===
+=== Do you think Zynthian is for me? ===
-''Knowing that I am comfortable with tinkering (basic soldering, basic command line in linux) and that the idea would be to use Zynthian in a professional environment (studio and on stage)''
-If you are comfortable with linux I think this is a great project and I do recommend it.
+It depends a lot. Building a recent official zynthian kit doesn't require soldering, only basic tinkering (plugging wires, screw-driving, etc.). The official zynthian software runs out-the-box and you shouldn't need to use the command line. That being said, being comfortable with Linux command line helps in solving problems.
+If you love tinkering and have specific needs, Zynthian is an excellent basis to taylor a unique piece of hardware.
 === About Zynthian Security===
-FYI, everything in Zynthian is executed as root user. The Pi user in the new PiOS images have sudo rights, so i don’t see a big security difference between the Gorgona and the PiOS images. PiOS is about automation and evolution, but currently it doesn’t improve security AFAIK.
+FYI, everything in Zynthian is executed as root user.
-Everybody wanting to connect his Zynthian to a “not secure” network (every network not controlled by himself should be considered “not secure” :wink: ) SHOULD CHANGE the default zynthian password. You can do that from the webconf tool.
+Anybody who wants to connect their Zynthians to a “not secure” network (any network not controlled by oneself should be considered “not secure”) '''SHOULD CHANGE the default zynthian password'''. You can do that from the webconf tool.
-Also, you have to understand that:
+You also have to understand that:
-* Although the Webconf Tool ask for the password, currently, it doesn’t use HTTPS, so your password could be sniffed by bad actors connected to the local network. That is specially true if you are using an ethernet cable or the old WEP Wifi protocol. If you are using WPA2 Wifi protocol in your 2 devices (Zynthian and your “computer”), then you should be protected against sniffers.
+* Although the Webconf Tool ask for the password, it doesn’t use HTTPS ''by default'', so your password could be sniffed by bad actors connected to the local network. That is especially true if you are using an ethernet cable or the old WEP Wifi protocol. If you are using WPA2 Wifi protocol on your 2 devices (Zynthian and your “computer”), then you should be protected against sniffers.
-* When a MOD-UI layer is created in zynthian, the MOD-UI server run completely open for everybody in the local network.
+* When a MOD-UI layer is created on zynthian, the MOD-UI server run completely open for everybody in the local network.
-* IMHO, these 2 are the main security holes in Zynthian. For solving it, we have to:
+IMHO, these 2 are the main security holes in Zynthian. For solving it, we have to:
-# Use HTTPS for webconf tool.
+# Use HTTPS for webconf tool. This is already implemented with a self-signed certificate.
 # Secure the MOD-UI server:
 ## Fast and Easy Way: Set a flag for “secure” networks, so MOD-UI will be “open” in that networks only
 ## Not so Easy Way: Use HTTPS and ask for the password. We should modify MOD-UI source code
+=== How good can the latency be? ===
+[https://discourse.zynthian.org/t/latency-on-the-new-hifiberry-stage-dac/5627/2?u=wyleu A forum post on Latency.]