Difference between revisions of "Zynthian FAQ"

From ZynthianWiki
Jump to navigation Jump to search
(33 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
Please, add your questions to this FAQ. And of course, if you can add/improve an answer, do it! ;-)
 
Please, add your questions to this FAQ. And of course, if you can add/improve an answer, do it! ;-)
  
----------------------------------
+
===LINUX Audio terminology is confusing===
 +
[[Understanding LINUX Audio]] Helps understand the acronyms mentioned in this Wiki
 +
 
 +
===Which RaspberryPi does Zynthian support?===
 +
You need a '''RBPi3''' [https://www.raspberrypi.org/products/raspberry-pi-3-model-b Raspberry Pi 3 Model B] or [https://www.raspberrypi.org/products/raspberry-pi-3-model-b-plus Raspberry Pi 3 Model B+]
 +
 
 +
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. You can also try using the experimental ZynthianOS images from here:
 +
 
 +
https://os.zynthian.org
  
 
===Where can i buy a Zynthian Kit?===
 
===Where can i buy a Zynthian Kit?===
Currently you can buy the official Zynthian Kits in the [http://shop.zynthian.org Zynthian Shop].
+
You can buy the official Zynthian Kits in the [https://shop.zynthian.org Zynthian Shop].
  
=== 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? ===
+
=== 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.
  
'''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 ...'''
+
=== 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 the SD Cards total space. How can i make all the space on my SD Card availalbe? ===
  
  
After writing the Zynthian image in the SD card, you have to "expand" the partition to fill all the available space.
+
'''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 ...
  
Procedure:
+
After writing the zynthian image into the SD card, you have to "expand" the partition to fill all the available space. Follow these steps:
  
  + login into Zynthian by SSH
+
  + login into your zynthian box using ssh
 
  + execute "df" command to see the size of your partition and the available space
 
  + execute "df" command to see the size of your partition and the available space
  + run "sudo raspi-config" and select the first option to expand your partition
+
  + run "raspi-config" and select the first option to expand your partition
  + reboot Zynthian
+
  + reboot your zynthian box
  + login again and execute "df" command to see size of your partition and the available space
+
  + login again and execute "df" command to see size of your partition and the available space. You should see the difference.
  
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.
  
'''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 have a license for Pianoteq 6, 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.
 +
 
 +
For accessing the Pianoteq GUI, please read this: [[Accessing_Zynthian_from_your_computer#Opening_Synth_Engine_Native_GUIs_in_your_Computer|Opening Native GUIs from your Computer]]
 +
 
 +
=== Does the pre-built kit come with a RBPi3 or 3+ ? ===
 +
 
 +
All Bundle Kits come with a RBPi 3+. Check the shop's product descriptions:
 +
 
 +
  https://shop.zynthian.org/shop/product/zynthian-bundle-all-kit-v3-326?category=13
 +
 
 +
=== I’m primarily a guitarist and thus, I’m interested in the MOD UI. ===
 +
''I know some people have experimented with audio input and were 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 ?
 +
 
 +
All official Zynthian Bundle-All Kits have "audio input". The new official sound card is the [https://www.hifiberry.com/docs/data-sheets/datasheet-dac-adc HifiBerry DAC+ ADC].
 +
 
 +
=== Do you think Zynthian is for me? ===
 +
It depends a lot. Building an official zynthian kit doesn't require soldering, only basic tinkering (plugging wires, screw-driving, etc.). The official zynthian software should run 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
  
 +
''Knowing that I am comfortable with tinkering (basic command line in linux) and that the idea would be to use Zynthian in a professional environment (studio and stage)''
  
=== Can i play a MIDI track with Zynthian as a multi instrument expander (different instruments on different channels)? If I have such a setup: how can I store it? ===
+
''If you are comfortable with linux I think this is a great project and I do recommend it.''
  
You can create such a setup by using the channel list and configuring different presets on each channel. This will work with the next Synth Engines:
+
=== About Zynthian Security===
  
+ ZynAddSubFX
+
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.
+ LinuxSampler
 
+ FluidSynth
 
  
setBfree tries to emulate the original Hammond B3 configuration. It has a fixed setup of 2 manuals (upper and lower) and pedals, arranged in channels 1, 2 and 3.
+
Anybody who wants to connect their Zynthian to a “not secure” network (any network not controlled by themselves should be considered “not secure”) ) '''SHOULD CHANGE the default zynthian password'''. You can do that from the webconf tool.
  
While using MOD-UI, the channel list doesn't appears, but you can setup a MIDI splitter/router inside Carla and configure different plugins/effects in each channel or create more complex setups. No limits (well, CPU ;-).
+
You also have to understand that:
  
Remember that currently you can only work with one engine at a time, but using MOD-UI you can load all the engines as plugins, so you create complex multi-engine setups.
+
* Although the Webconf Tool ask for the password, it doesn’t use HTTPS, 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.
  
=== I try to put some GIG files inside the '''zynthian-my-data/soundfonts''' folder, but Zynthian GUI don't show my files. What am i doing wrong? ===
+
* When a MOD-UI layer is created in zynthian, the MOD-UI server run completely open for everybody in the local network.
  
The files dropped directly inside "gig" directory wont be shown. You must create some subfolder (category) inside the gig folder. The same is true for SFZs soundfonts.
+
IMHO, these 2 are the main security holes in Zynthian. For solving it, we have to:
  
=== How do I edit entries in the wiki? ===
+
# Use HTTPS for webconf tool.
You need to be able to login to the wiki with a username:
+
# Secure the MOD-UI server:
Simply register . .
+
## 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

Revision as of 12:37, 13 January 2020

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 RaspberryPi does Zynthian support?

You need a RBPi3 Raspberry Pi 3 Model B or Raspberry Pi 3 Model B+

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. You can also try using the experimental ZynthianOS images from here:

https://os.zynthian.org

3 Where can i buy a Zynthian Kit?

You can buy the official Zynthian Kits in the Zynthian Shop.

4 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.

5 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 the SD Cards total space. How can i make all the space on my SD Card availalbe?

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 ...

After writing the zynthian image into the SD card, you have to "expand" the partition to fill all the available space. Follow these steps:

+ login into your zynthian box using ssh
+ 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.

6 I have a license for Pianoteq 6, 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.

For accessing the Pianoteq GUI, please read this: Opening Native GUIs from your Computer

7 Does the pre-built kit come with a RBPi3 or 3+ ?

All Bundle Kits come with a RBPi 3+. Check the shop's product descriptions:

 https://shop.zynthian.org/shop/product/zynthian-bundle-all-kit-v3-326?category=13

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

I know some people have experimented with audio input and were 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 ?

All official Zynthian Bundle-All Kits have "audio input". The new official sound card is the HifiBerry DAC+ ADC.

9 Do you think Zynthian is for me?

It depends a lot. Building an official zynthian kit doesn't require soldering, only basic tinkering (plugging wires, screw-driving, etc.). The official zynthian software should run 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

Knowing that I am comfortable with tinkering (basic command line in linux) and that the idea would be to use Zynthian in a professional environment (studio and stage)
If you are comfortable with linux I think this is a great project and I do recommend it.

10 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.

Anybody who wants to connect their Zynthian to a “not secure” network (any network not controlled by themselves 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, 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.

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

  1. Use HTTPS for webconf tool.
  2. 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