This script is no longer being maintained. It only works with CentOS 6.4, CentOS 6.9 and Scientific Linux 6.4. It won't work with CentOS 7, because there has been significant changes. If you are interested in helping update this script, please contact QRIScloud Support.
Setup X11 and VNC servers on to run a graphical user interface on RHEL-based systems (e.g. CentOS or Scientific Linux).
q-gui-setup.sh
[ -p | --password str ]
[ -f | --force ]
[ -v | --verbose] [ -q | --quiet ]
username {username...}
Installs the X Windows System and VNC and configures the VNC server for a number of users.
This script will configure a set of user accounts to have VNC servers. The first user's VNC server will be running on port 5900, the second user on 5901, etc. These VNC servers will keep running after the VNC client has disconnected from them, so you can return to the VNC server later. There is one VNC server per user account.
The alternative method, of setting up a single VNC server with a login screen, is not used. There are advantages and disadvantages with either method. The VNC server per user approach was chosen because: there will be very few users, so configuring each user and running a separate VNC server for each is practical; users should be encouraged to ssh tunnel the unencrypted VNC traffic, so providing a graphical login would not encourage them to do that; and it was easier to setup.
This script can be run multiple times. It only installs the packages if they have not been installed and will not change any existing VNC passwords. It will only create new VNC passwords for users that do not have a VNC password.
Note: This script can take a long time to run, because it has to
download and install a large number of yum packages. Depending on
the speed of your machine, it could take between 10 minutes to 40
minutes to run. To see the progress of the install, use the
--verbose option.
-
-p | --password struse this VNC password instead of a randomly generated value. -
-f | --forcerun on untested operating systems and distributions. -
-q | --quietsuppress normal output -
-v | --verboseshow extra output (i.e. does not run yum in quiet mode) -
-h | --helpshows help information.
This script has been designed to run on RedHat Enterprise Linux (RHEL) based distributions. It has been tested on CentOS 6.4 64-bit and Scientific Linux 6.4 64-bit. It does not work on other distributions, e.g. Ubuntu and Fedora.
To force it to run on untested distributions, use the --force
option. There are no guarantees it will work on untested
distributions.
A VNC password is required to access each VNC server. This is different from the user account's password.
The VNC password is important, because it prevents anyone with access to the VNC port to use the account. Even if firewalls block external access to the ports, other users on the machine can still access the port.
The script will generate a new random VNC password for the user, if a
VNC password does not already exist for that user. This VNC password
is printed out to stdout (unless the --quiet option is used). To
specify a value to use, instead of randomly generated values, use the
--password option.
To change the VNC password, run the vncpasswd program as that user
(use sudo if you do not know the user account password for that
user).
$ su jsmith -c vncpasswd
$ sudo su jsmith -c vncpasswd
A user login password is not necessary. Access to the VNC server only requires the VNC password and access to the VNC server port. If the VNC server port is exposed to the external network, anyone can access it -- this is not recommended since VNC traffic is not encrypted, and the VNC servers have been configured so this will not work. The VNC server port will have to be accessed from within the host. A login to any user account will allow a ssh tunnel to be established. That login can be to that VNC user's account or to a different account. For maximum security, that login should be authenticated using a ssh public key instead of a password.
One reason why a user login password might be required is for unlocking screensavers. If that is the only reason, it is better to simply disable the screen saver -- do this as soon as you connect to the VNC server the first time.
The VNC servers are set up to prevent remote VNC clients from connectiong except through a secure tunnel. This setting was chosen because VNC traffic is not encrypted.
Therefore, to connect to the VNC server an ssh tunnel to any account on the host is required (it can be, but does not have to be, the same account as the VNC server).
The command line ssh command creates ssh tunnels using the -L
option. Its argument is "[bind_address:]port:host:hostport" where the
bind_address is optional. This example tunnels port 15900 on the local
machine to port 5900 (the first VNC server) at example.com.
local$ ssh -L 15900:localhost:5900 user@example.com
To run VNC servers for multiple users, specify every user as arguments:
$ ./q-gui-setup.sh alice bob charlie
The first user's VNC server will be running on port 5900, the
second user on 5901, etc. Multiple ssh tunnels can be established
by repeating the -L option:
local$ ssh -L 15900:localhost:5900 -L 15901:localhost:5901 -L 15902:localhost:5902 user@example.com
The VNC server for alice can be accessed through port 15900, bob through port 15901 and charlie through port 15902.
When finished with using the GUI, simply close the VNC client.
When you close the VNC client, the next time you connect to the VNC server it will show you the session as you left it. This is useful, because you can leave programs running and return to them later.
Do not choose the "Log Out" menu item. That will close the Window Manager leaving no easy way to restart it, without restarting all the VNC servers (which is not nice if there are multiple users).
vm$ sudo service vncserver restart
-
Create an instance running RHEL, CentOS or Scientific Linux. Note: the security groups must allow ssh access.
-
Login to the instance using ssh and tunnel port 5900 on the instance to a local port (using 15900 in this example).
local$ ssh -L 15900:localhost:5900 ec2-user@130.102.xxx.xxx -
Put a copy of the q-gui-setup.sh script onto the instance.
$ curl -O https://raw.github.com/qcif/cloud-utils/master/q-gui-setup.sh $ chmod a+x q-gui-setup.sh -
Run the script, providing it a list of at least one user account. Wait until the script finishes running (which can take over an hour to run, depending on the processing power of your machine).
$ ./q-gui-setup.sh neoYou will be prompted to set a VNC password.
-
Set a password for the new user account. Although this is not strictly needed (since you can establish the ssh tunnel to any account on the host), it will be required to unlock the screensaver.
$ sudo passwd neo -
Connect to the VNC server (via the forwarded port) using a VNC client.
For example, on Mac OS X, you can choose Go > Connect to Server in the Finder, or run the following command from the Terminal:
local-mac$ open vnc://localhost:15900Enter the VNC password when prompted.
-
Do this quickly: disable the screensaver. Choose them menu item System > Preferences > Screensaver and uncheck the "Activate screensaver when computer is idle" checkbox.
If you don't do this and the screensaver starts, you will need to have the user account's password to unlock it.
-
When finished, close the VNC client and then log out of the ssh connection.
Additional software can be installed via the GUI or via the command
line. For example, install the Firefox Web browser with the command
yum install firefox and it will appear in the menu Applications >
Internet. The GUI installer (available through the System >
Administration > Add/Remove Software menu item) does not always
work properly under CentOS 6.4 64-bit.
This script must be run with root privileges.
If you logged out of the window manager, restart the VNC server:
$ sudo services vncserver restart
If there are multiple users with VNC servers, they will all be restarted.
/etc/hosts- hosts file/etc/sysconfig/vncservers- VNC configuration file
Please send feedback and queries to Hoylen Sue at h.sue@qcif.edu.au.