Deploying Apache Guacamole through the Linode Marketplace

Traducciones al Español
Estamos traduciendo nuestros guías y tutoriales al Español. Es posible que usted esté viendo una traducción generada automáticamente. Estamos trabajando con traductores profesionales para verificar las traducciones de nuestro sitio web. Este proyecto es un trabajo en curso.

Apache Guacamole is an open source HTML5-based web application used as a remote desktop gateway. With the Guacamole Marketplace App, you can access your Linode with a graphical VNC session using the XFCE desktop environment from any device. This Marketplace App installs and configures Guacamole on a Linode, complete with an SSL certificate generated by Certbot for your domain.

Deploying the Guacamole Marketplace App

The Linode Marketplace allows you to easily deploy software on a Linode using the Linode Cloud Manager.

  1. Log in to the Cloud Manager and select the Marketplace link from the left navigation menu. This displays the Linode Compute Create page with the Marketplace tab pre-selected.

  2. Under the Select App section, select the app you would like to deploy.

  3. Fill out all required Options for the selected app as well as any desired Advanced Options (which are optional). See the Configuration Options section for details.

  4. Complete the rest of the form as discussed within the Getting Started > Create a Linode.

  5. Click the Create Linode button. Once the Linode has provisioned and has fully powered on, wait for the software installation to complete. If the Linode is powered off or restarted before this time, the software installation will likely fail. To determine if the installation has completed, open the Linode’s Lish console and wait for the system login prompt to appear.

  6. Follow the instructions within the Getting Started After Deployment section.

Software installation should complete within 5-20 minutes after the Linode has finished provisioning.

Configuration Options

Guacamole Options

You can configure your Guacamole App by providing values for the following fields:

The limited sudo/VNC user to be created for the LinodeThe VNC username created for this Linode with sudo permissions. This is used for your VNC session. Required.
The password for the limited sudo/VNC userPassword for your sudo/VNC user. This is used for your VNC session. Required.
The username to be used with GuacamoleYour Guacamole Username. This is used to log in to Guacamole. Required.
The password to be used with GuacamoleYour Guacamole Password. This is used to log in to Guacamole. Required
Your Linode API TokenYour Linode API Token is needed to create DNS records. If this is provided along with the Subdomain and Domain fields, the installation attempts to create DNS records via the Linode API. If you don’t have a token, but you want the installation to create DNS records, you must create a token to use in this field before continuing.
SubdomainThe subdomain you wish the installer to create a DNS record for during setup. The suggestion given is www. The subdomain can only be created if you also provide a Domain and API Token.
DomainThe domain name where you wish to host your Guacamole server. The installer creates a DNS record for this domain during setup if you provide this field along with the required API Token.
Admin EmailThe email address to register with Certbot when generating an SSL certificate for your absolute domain. This field is required along with your API Token and Domain for HTTPS access to your Guacamole remote desktop.

General Options

For advice on filling out the remaining options on the Create a Linode form, see Getting Started > Create a Linode. That said, some options may be limited or recommended based on this Marketplace App:

  • Supported distributions: Debian 10
  • Recommended plan: All plan types and sizes can be used with Guacamole.

Getting Started after Deployment

Access your Guacamole App

After Guacamole has finished installing, access the dashboard over http:// or https:// with your Linode’s IPv4 address or absolute domain name, depending on your setup choices.

  1. If you set up a domain name for your Guacamole App during setup, skip to step 3.

  2. If you didn’t set up a domain name, find your Linode’s IPv4 address by clicking on Linodes in the Cloud Manager sidebar to see a list of all your Linodes. Find the Linode you just created. Under the IP Address column, copy the IPv4 address.

  3. Enter your Linode’s absolute domain or IPv4 address into a browser window (for example, to access the Guacamole login page. Enter your Guacamole username and password.

    View the Guacamole login page.

    The Guacamole login page may take several minutes to become available while the Application completes the creation process.
  4. Once you’ve completed the login process, you have full access to your Linode from your Guacamole remote desktop using VNC and the XFCE desktop environment.

    The Guacamole remote desktop provides access to your Linode through a web browser.

  5. Additional tasks can be performed remotely through your web browser. For example, you can install the Firefox web browser for use with your Guacamole remote desktop by entering the following command in its Terminal Emulator:

     sudo apt install firefox-esr

    When prompted, enter the password you chose for the limited sudo/VNC user. You can now browse the web on your Guacamole browser from within your local browser.

Currently, Linode does not manage software and systems updates for Marketplace Apps. It is up to the user to perform routine maintenance on software deployed in this fashion.

More Information

You may wish to consult the following resources for additional information on this topic. While these are provided in the hope that they will be useful, please note that we cannot vouch for the accuracy or timeliness of externally hosted materials.

This page was originally published on

Create a Linode account to try this guide with a $100 credit.
This credit will be applied to any valid services used during your first 60 days.

Your Feedback Is Important

Let us know if this guide made it easy to get the answer you needed.

Join the conversation.
Read other comments or post your own below. Comments must be respectful, constructive, and relevant to the topic of the guide. Do not post external links or advertisements. Before posting, consider if your comment would be better addressed by contacting our Support team or asking on our Community Site.