Skip to content

Guacamole App

About

Apache Guacamole is a clientless remote desktop gateway. It supports standard protocols like VNC, RDP, and SSH.

RDP

Most Windows/RDP servers do not have a valid certificate installed. For this reason, be sure to check the ignore server certificate checkbox in the Parameters section.

Guacamole menu

The Guacamole menu is a sidebar which is hidden until explicitly shown. On a desktop or other device which has a hardware keyboard, you can show this menu by pressing Ctrl+Alt+Shift. If you are using a mobile or touchscreen device that lacks a keyboard, you can also show the menu by swiping right from the left edge of the screen.

See the docs for more information.

Extensions

Extensions can be downloaded from the Apache Guacamole releases page. They are packaged as tar.gz and when extracted have a jar file inside them.

To add an extension:

  • Upload the jar file (and not .tar.gz) to /app/data/extensions using the File manager
  • Restart Guacamole

Custom properties

Some extensions require adding custom properties. You can add these using the File manager by editing /app/data/guacamole.properties. Be sure to restart the app after you make changes.

Branding

To change the logo and style, you have to use an extension. You can start with the jar file in this repo.

  • Download branding.jar
  • Upload it using the File manager to /app/data/extensions
  • Restart Guacaomole

The login screen should already be different now. You can now modify the branding.jar as needed to make changes. Note that a jar file is just a zip archive. Just extract it, change files and compress it again. When re-creating the jar file, make sure that the files are at the top level and not inside a sub directory.