Line 1: |
Line 1: |
− | The '''WebConf Tool''' is the ''Zynthian Web Configuration Tool'', a website hosted inside your Zynthian device that allows you to configure and inspect the settings and attributes of your Zynthian. | + | The '''WebConf Tool''' is the ''Zynthian Web Configuration Tool'', a website hosted inside your Zynthian device that allows you to configure and inspect the settings and attributes of your Zynthian. Note: if you can't access the WebConf tool, see '''Configuration by ssh''' at the bottom of this page. |
| | | |
| ==Login== | | ==Login== |
| | | |
− | [[File:zynthian_webconf_login.png|right]] | + | [[File:zynthian_webconf_login.png|600px|right]] |
| | | |
| You can access the Webconf tool from any computer using a web browser. Your Zynthian Box must be connected to your local network, or directly to your computer with an Ethernet cable (link local, point to point). | | You can access the Webconf tool from any computer using a web browser. Your Zynthian Box must be connected to your local network, or directly to your computer with an Ethernet cable (link local, point to point). |
Line 11: |
Line 11: |
| To access your Zynthian box from your browser, you can use either of these 2 methods: | | To access your Zynthian box from your browser, you can use either of these 2 methods: |
| | | |
− | * Browse to '''http://zynthian.local'''. This doesn't work in all devices. Many Windows-PCs and mobile devices don't fully support the [https://en.wikipedia.org/wiki/Multicast_DNS mDNS] protocol that enable the use of named addresses on a local network. | + | * Browse to '''http://zynthian.local''' or '''http://zynthian.lan'''. This doesn't work in all devices. Many Windows-PCs and mobile devices don't fully support the [https://en.wikipedia.org/wiki/Multicast_DNS mDNS] protocol that enable the use of named addresses on a local network. |
| | | |
| * If you your browser can’t find the '''zynthian.local''' address, you will then need to figure out what IP address has been assigned to your Zynthian Box. For more details, see [[Finding your IP address]]. Once you have your Zynthian's IP address (xxx.xxx.xxx.xxx), you can browse to '''http://xxx.xxx.xxx.xxx'''. | | * If you your browser can’t find the '''zynthian.local''' address, you will then need to figure out what IP address has been assigned to your Zynthian Box. For more details, see [[Finding your IP address]]. Once you have your Zynthian's IP address (xxx.xxx.xxx.xxx), you can browse to '''http://xxx.xxx.xxx.xxx'''. |
| | | |
| <br clear=all> | | <br clear=all> |
| + | |
| + | {{NoteBox| Default password is '''raspberry''' }} |
| | | |
| ==Dashboard== | | ==Dashboard== |
− | [[File:zynthian_webconf_dashboard.png|right]] | + | [[File:zynthian_webconf_dashboard.png|600px|right]] |
| | | |
| The Dashboard displays basic configuration information about your Zynthian. | | The Dashboard displays basic configuration information about your Zynthian. |
Line 28: |
Line 30: |
| | | |
| ===Snapshots=== | | ===Snapshots=== |
− | [[File:WebLibrarySnapshots.png|right]] | + | [[File:WebLibrarySnapshots.png|600px|right]] |
| The Snapshots is where you can manage your snapshots (a stored configuration of instruments and settings.) | | The Snapshots is where you can manage your snapshots (a stored configuration of instruments and settings.) |
| | | |
Line 45: |
Line 47: |
| | | |
| ===Audio=== | | ===Audio=== |
− | [[File:zynthian_webconf_hardware_audio.png|right]] | + | [[File:zynthian_webconf_hardware_audio.png|600px|right]] |
| | | |
| This page lets you configure your sound cards and audio adapters. | | This page lets you configure your sound cards and audio adapters. |
Line 60: |
Line 62: |
| | | |
| ===Display=== | | ===Display=== |
− | [[File:zynthian_webconf_hardware_display.png|right]] | + | [[File:zynthian_webconf_hardware_display.png|600px|right]] |
| | | |
| This is where you can configure the touchscreen display. | | This is where you can configure the touchscreen display. |
Line 68: |
Line 70: |
| <br clear=all> | | <br clear=all> |
| | | |
− | ===Wiring Layouts=== | + | ===Wiring Layout=== |
− | [[File:zynthian_webconf_hardware_wiring.png|right]] | + | [[File:zynthian_webconf_hardware_wiring.png|600px|right]] |
− | Configure wiring for the encoders/knobs and switches. | + | Configure the "wiring" for your encoders/knobs and switches. Select "dummies" if your zynthian has none. |
− | | |
− | Select dummies for the encoders if you have none. | |
| | | |
| + | You can also configure the V4's customizable switches (S1, S2, S3 & S4), the zynaptik's analog & digital inputs and 2 TOF distance sensors that can be assigned to MIDI actions. Take a look to [https://wiki.zynthian.org/index.php/Adding_Extra_I/O_with_the_Zynaptik_Module this section]. |
| <br clear=all> | | <br clear=all> |
| | | |
| ==Software== | | ==Software== |
| + | ===Plugins LV2=== |
| + | [[File:zynthian_webconf_software_plugins.png|600px|right]] |
| + | Manage the installed LV2 plugins. Enable/Disable synthesizers, audio effects and MIDI tools. |
| + | |
| + | ===Pianoteq=== |
| + | Configure the Pianoteq plugin. Enable license, add instrument packs, etc. |
| | | |
| ===Update=== | | ===Update=== |
| + | Update the Zynthian software. |
| | | |
− | Update the Zynthian OS and associated application software.
| |
− |
| |
− | ===Pianoteq===
| |
− | configure the Pianoteq plugin. (enable paid license)
| |
− |
| |
− | ===Plugins===
| |
− | [[File:zynthian_webconf_software_plugins.png|right]]
| |
| | | |
− | Manage the installed plugins.
| + | ===Repositories=== |
| + | Maintain the Zynthian Repositories |
| + | [[File:Zynthian software repositories.png|600px|right]] |
| | | |
| <br clear=all> | | <br clear=all> |
Line 97: |
Line 100: |
| | | |
| ===MIDI=== | | ===MIDI=== |
− | [[File:zynthian_webconf_MIDI.png|right]] | + | [[File:zynthian_webconf_MIDI.png|600px|right]] |
| MIDI configuration page. Setup and store different profiles that are MIDI configurations. | | MIDI configuration page. Setup and store different profiles that are MIDI configurations. |
− |
| |
− | <br clear=all>
| |
| | | |
| ====Profiles==== | | ====Profiles==== |
Line 106: |
Line 107: |
| | | |
| ====Options==== | | ====Options==== |
| + | Master Channel, Active Layer, MIDI over Network, Preload Presets on Note, etc. |
| | | |
− | Master Channel, Active Layer, MIDI over Network, Preload Presets on Note, etc.
| + | <br clear=all> |
| | | |
| ====[[Configure_MIDI_Filter/Router|Filter/Router]]==== | | ====[[Configure_MIDI_Filter/Router|Filter/Router]]==== |
− | Visit here to [[Configure_MIDI_Filter/Router|Filter/Router]]
| + | [[File:zynthian_webconf_midi_router.png|600px|right]] |
| + | The MIDI filter allows to filter the MIDI messages using rules. You can use the visual rule builder, or type the rules directly. |
| + | [[Configure_MIDI_Filter/Router|Read the MIDI Filter Rule Language documentation.]] |
| + | |
| + | <br clear=all> |
| + | |
| + | ====Ports==== |
| + | [[File:zynthian_webconf_midi_ports.png|600px|right]] |
| + | This is an "advanced" option that allows to configure your hardware MIDI ports as INPUT/OUTPUT or for receiving MIDI feedback on controllers that support this feature (i.e. motorized faders). |
| | | |
| <br clear=all> | | <br clear=all> |
| | | |
| ====MIDI Log==== | | ====MIDI Log==== |
− | [[File:MIDILog.png|right]] | + | [[File:MIDILog.png|600px|right]] |
| Displays all received MIDI messages. Useful for debugging MIDI connection and configuration. | | Displays all received MIDI messages. Useful for debugging MIDI connection and configuration. |
| + | |
| + | <br clear=all> |
| + | |
| + | ====Keyboard Binding==== |
| + | [[File:Keyboard binding.png|600px|right]] |
| + | The keyboard Binding Page allows configuration of particular functions from a connected USB keyboard this can obviously be a |
| + | full ASCII keyboard or a small number pad or even 3 foot switches. |
| + | |
| + | [[File:3footpedal.png|left|400px]] |
| + | |
| + | <br clear=all> |
| | | |
| ====Using MIDI controllers instead of Encoders==== | | ====Using MIDI controllers instead of Encoders==== |
Line 130: |
Line 151: |
| | | |
| ===User Interface=== | | ===User Interface=== |
− | [[File:zynthian_webconf_ui.png|right]] | + | [[File:zynthian_webconf_ui.png|600px|right]] |
| Customize the user interface. | | Customize the user interface. |
| | | |
Line 137: |
Line 158: |
| | | |
| ====UI Log==== | | ====UI Log==== |
− | [[File:UIlog.png|right]] | + | [[File:UIlog.png|600px|right]] |
| Display a log of User Interface actions for debugging. | | Display a log of User Interface actions for debugging. |
| | | |
Line 146: |
Line 167: |
| ===WIFI=== | | ===WIFI=== |
| | | |
− | [[File:zynthian_webconf_wifi.png|right]] | + | [[File:zynthian_webconf_wifi.png|600px|right]] |
| | | |
| This page allows your to connect to WiFi networks, as well as manage stored connections. | | This page allows your to connect to WiFi networks, as well as manage stored connections. |
Line 164: |
Line 185: |
| ===Security / Access=== | | ===Security / Access=== |
| | | |
− | [[File:Security-access.png|right]] | + | [[File:Security-access.png|600px|right]] |
| | | |
| Allows you to change the password & set the hostname of the zynthian ( don't forget to select advanced to get hostname) | | Allows you to change the password & set the hostname of the zynthian ( don't forget to select advanced to get hostname) |
Line 173: |
Line 194: |
| | | |
| These pages allow you to backup & restore your system & data components. | | These pages allow you to backup & restore your system & data components. |
| + | |
| + | == Configuration with ssh == |
| + | For Linux savvy users: |
| + | |
| + | If you can't access the WebConf pages with a browser, you can login with ssh and "manually" edit the configuration file. |
| + | |
| + | Simply edit this file: |
| + | |
| + | /zynthian/config/zynthian_envars.sh |
| + | |
| + | and run this command after saving the changes: |
| + | |
| + | # zynthian_update_sys.sh |