Documentation

    Amazon Web Services

    Microsoft Azure

    RapidAPI

    APILayer

Last Update: 2024-11-01

openSUSE with GUI Desktop


Table of Content


Launch and Configure openSUSE with GUI Desktop
Connect to GUI (VNC)
Connect to your instance via SSH
Deploy files to your VM remotely
Configure GUI
Troubleshooting

Launch and Configure openSUSE with GUI Desktop

Go to the listings page of openSUSE with GUI Desktop on Azure Marketplace.

Click on 'Get it now' to initiate the launch dialogue.

Enter a username. Please note that using one of the following reserved keywords will lead to a non-functional GUI: root, daemon, messagebus, systemd-network, systemd-timesync, nscd, nobody, man, lp, chrony, at, polkitd, rpc, dockremap, salt, sshd, statd, mail, postfix, scard, rtkit, pulse, srvGeoClue, tftp, avahi, bin, dnsmasq, usbmux, lightdm, vnc.

Review the settings and create the virtual machine.

The username for RDP/VNC is the username you set. The password is the vmId of your virtual machine. You can find the vmId on the overview page of the virtual machine after clicking on "JSON View".

Optional: By default, the VM network ports for SSH and VNC are open to the public. You can restrict access (e.g., only allow access from your local IP address) under selected VM -> Network settings.

Connect to your Linux instance via VNC


Please refer to the 'Launch and Configure' section above before proceeding with this part. For the VNC connection, you will need the username you created in the Azure portal, as well as the Virtual Machine ID (vmId) for your password.

Obtain the public IP address of your Virtual Machine:

Open 'VNC Viewer' (available at https://www.realvnc.com/de/connect/download/viewer/windows) or select another VNC client according to your preference. It's possible to use the app without signing in.

Enter the public IP address of your virtual machine, followed by ':5901', into the search bar and then click on 'Connect'.

When prompted, enter the password, which is to the vmid of the virtual machine (please refer to the 'Launch and Configure' section above for details)

Connect to your Linux VM via SSH


Please refer to the official documentation for detailed instructions on how to connect to a virtual machine with SSH.

Open a Command Prompt / Terminal window and navigate to the directory where you have saved the .pem key file, which was created in the Azure portal. You can connect to your VM using the username specified during the virtual machine creation process by executing the following command:

ssh -i <name-of-key-file.pem> <username>@<public-ip>

Deploy files on your VM remotely

Download and install WinSCP or any other SCP client of your choice.

Choose 'SFTP' as the file protocol and enter the public IP address of your instance, along with the username you specified when launching the virtual machine.

If you opted for password authentication, enter the specified password. Alternatively, if you wish to use a private key file (.pem) that you generated, you can add it by first clicking 'Advanced' and then selecting 'Authentication' from the left-side menu.

Connect to the virtual machine by clicking on 'Login'.

Configure GUI


The script that launches the GUI on every reboot is centrally located at /home/start-gui.sh. You can configure it with:

nano /home/start-gui.sh

The script is executed by a cron job as the root user. You can modify the cron job with:

sudo crontab -e


Change Password for the GUI Session:

To change the password for the GUI session, edit the start-gui.sh file and modify the password variable as desired. Then, reboot the instance. Please note that the password for the GUI session is different from the password for the Linux user.


Use Another User for the GUI Session:

To use a different user for the GUI session, create a new user with:

sudo useradd -m -c "Full Name" -s /bin/bash  guiuser

Set a password for this user (please note that this password is different than the password for the GUI):

sudo passwd guiuser

Then, add the user to the sudo group with:

sudo usermod -aG wheel guiuser

Next, edit the start-gui.sh file, change the username variable, and reboot the instance.

Troubleshooting

Resolving VNC Connection Issues

Potential solutions to resolve your connection issues are:

  • Ensure that you are using the correct login credentials. As outlined in our "Connect to GUI" section above, the default password for the GUI is the name of the virtual machine you specified at launch.
  • The GUI is designed to reconfigure and restart with every instance reboot. Please try restarting your virtual machine to resolve any connection issues. If the connection issues persist and are not resolved by a reboot, you may need to consider deploying a new virtual machine.
  • Verify that your local network is not blocking access to port 5901 (VNC). Corporate networks, in particular, tend to block these ports. Ensure that your internal network is not blocking these ports before attempting to connect to the instance GUI.

Resolving Copy & Paste Issues

You may experience issues with copying and pasting to and from the virtual machine. Ensure that your local RDP and VNC clients support clipboard sharing. If the keyboard shortcuts for copy and paste do not work, try using right-click to copy or right-click to paste.

The GUI Desktop Freezes

If your desktop environment gets stuck or freezes, ensure that your virtual machine has sufficient memory. We recommend using a virtual machine type with at least 4 GB of memory. Additionally, check if you are running low on available disk space, as this could also cause the GUI to freeze.