Difference between revisions of "Command Line User Guide"

From ZynthianWiki
Jump to: navigation, search
(Stopping/Starting the Zynthian Webconf)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
Use '''ssh''' to remotely access the console (terminal) of the Zynthian from another computer. Use the  '''ssh''' command in Mac Terminal or use the freely downloadable '''PuTTY''' software for Windows. You need to know the IP address of the Zynthian on your local network to use ssh. See [[Finding your IP address]] for help on this.
+
Use '''ssh''' to remotely access the console (terminal) of the Zynthian from another computer. Use the  '''ssh''' command on Linux/Mac Terminal or use the freely downloadable '''PuTTY''' software for Windows. In most modern computer, using the name "zynthian.local" should work. If it doesn't, you can use the IP address too. See [[Finding your IP address]] for help on this.
 
=SSH/SFTP access:=
 
=SSH/SFTP access:=
  
Line 5: Line 5:
 
  password: raspberry
 
  password: raspberry
  
User pi doesn't exist any more and ... it's a good idea to change the password :wink:
+
If you use ssh from the linux/mac terminal, it's so easy as:
 +
 
 +
ssh root@zynthian.local
 +
 
 +
* User pi doesn't exist any more
 +
* It's a good idea to change the password, specially if your zynthian is connected to public networks. You can do it easily from the webconf.
  
 
=Base Directory:=
 
=Base Directory:=
Line 11: Line 16:
 
  /zynthian
 
  /zynthian
  
Almost all the zynthian stuff like synth engines, audio plugins, soundfonts, zynthian user interface, setup scripts and other specific software is in this directory.
+
Most of zynthian stuff is in this directory.
  
=UI configuration file=
 
 
/zynthian/zynthian-ui/zynthian_gui_config.py
 
 
This file contains some configuration parameters for the Zynthian User Interface:
 
 
* Logging level
 
* Wiring layout
 
* Font & Color scheme
 
* etc.
 
 
=Stopping/Starting the Zynthian UI=
 
=Stopping/Starting the Zynthian UI=
  
You must use systemd-style commands to stop & start any system service, that includes the zynthian UI:
+
You must use systemd-style commands to stop & start any system service. For the zynthian UI you would use:
  
 
  systemctl stop zynthian
 
  systemctl stop zynthian
Line 32: Line 27:
 
If you want to run the Zynthian UI in the console,  you must stop the zynthian service and run the zynthian UI as a normal script using these commands:
 
If you want to run the Zynthian UI in the console,  you must stop the zynthian service and run the zynthian UI as a normal script using these commands:
  
  systemctl stop zynthian
+
systemctl stop zynthian
  /zynthian/zynthian-sys/sbin/zynthian.sh
+
zynthian.sh
 +
 
 +
Running zynthian from the console (terminal) allows you to view the detailed debug messages, which is convenient for solving issues. Posting these to the forum will enable experts to help you. You can also access the UI log messages from the webconf.
 +
 
 +
=Stopping/Starting the Zynthian Webconf=
 +
 
 +
systemctl stop zynthian-webconf
 +
systemctl start zynthian-webconf
 +
 
 +
If you need access the webconf's log messages, you can use:
 +
 
 +
journalctl -u zynthian-webconf
  
Running zynthian from the console (terminal) allows you to view the logging/debug messages, which is necessary for debugging (posting these to the forum will enable experts to help you.)
 
 
=Viewing the Zynthian graphics display on a computer=
 
=Viewing the Zynthian graphics display on a computer=
 +
 
If you are using Linux on your PC (or MacOSX with a X window server installed), you can login into your Zynthian box with '''ssh''' using the “-Y” flag:
 
If you are using Linux on your PC (or MacOSX with a X window server installed), you can login into your Zynthian box with '''ssh''' using the “-Y” flag:
  
ssh -Y root@zynthian.local
+
  ssh -Y root@zynthian.local
  
 
this will allow you to run graphic applications in your Zynthian, while displaying the graphics window on your PC/laptop.  
 
this will allow you to run graphic applications in your Zynthian, while displaying the graphics window on your PC/laptop.  
=Debugging MIDI=
 
You can use commands to see what's going on with MIDI I/O
 
[[Debugging MIDI]]
 
  
 
=More detailed info=
 
=More detailed info=
  
 
More info on this page [[Accessing_Zynthian_from_your_computer]]
 
More info on this page [[Accessing_Zynthian_from_your_computer]]

Latest revision as of 22:54, 11 August 2020

Use ssh to remotely access the console (terminal) of the Zynthian from another computer. Use the ssh command on Linux/Mac Terminal or use the freely downloadable PuTTY software for Windows. In most modern computer, using the name "zynthian.local" should work. If it doesn't, you can use the IP address too. See Finding your IP address for help on this.

SSH/SFTP access:

login: root
password: raspberry

If you use ssh from the linux/mac terminal, it's so easy as:

ssh root@zynthian.local
  • User pi doesn't exist any more
  • It's a good idea to change the password, specially if your zynthian is connected to public networks. You can do it easily from the webconf.

Base Directory:

/zynthian

Most of zynthian stuff is in this directory.

Stopping/Starting the Zynthian UI

You must use systemd-style commands to stop & start any system service. For the zynthian UI you would use:

systemctl stop zynthian
systemctl start zynthian

If you want to run the Zynthian UI in the console, you must stop the zynthian service and run the zynthian UI as a normal script using these commands:

systemctl stop zynthian
zynthian.sh

Running zynthian from the console (terminal) allows you to view the detailed debug messages, which is convenient for solving issues. Posting these to the forum will enable experts to help you. You can also access the UI log messages from the webconf.

Stopping/Starting the Zynthian Webconf

systemctl stop zynthian-webconf
systemctl start zynthian-webconf

If you need access the webconf's log messages, you can use:

journalctl -u zynthian-webconf

Viewing the Zynthian graphics display on a computer

If you are using Linux on your PC (or MacOSX with a X window server installed), you can login into your Zynthian box with ssh using the “-Y” flag:

 ssh -Y root@zynthian.local

this will allow you to run graphic applications in your Zynthian, while displaying the graphics window on your PC/laptop.

More detailed info

More info on this page Accessing_Zynthian_from_your_computer