| |
| <!DOCTYPE html> |
| |
| |
| <html lang="en" data-content_root="./" > |
| |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <title>Guacamole’s user interface — Apache Guacamole Manual v1.6.0</title> |
| |
| |
| |
| <script data-cfasync="false"> |
| document.documentElement.dataset.mode = localStorage.getItem("mode") || ""; |
| document.documentElement.dataset.theme = localStorage.getItem("theme") || ""; |
| </script> |
| |
| <!-- Loaded before other Sphinx assets --> |
| <link href="_static/styles/theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" /> |
| <link href="_static/styles/bootstrap.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" /> |
| <link href="_static/styles/pydata-sphinx-theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" /> |
| |
| |
| <link href="_static/vendor/fontawesome/6.5.2/css/all.min.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" /> |
| <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2" /> |
| <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" /> |
| <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" /> |
| |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" /> |
| <link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" /> |
| <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" /> |
| <link rel="stylesheet" type="text/css" href="_static/tabs.css?v=4c969af8" /> |
| <link rel="stylesheet" type="text/css" href="_static/gug.css?v=475feb7f" /> |
| |
| <!-- Pre-loaded scripts that we'll load fully later --> |
| <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" /> |
| <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" /> |
| <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script> |
| |
| <script src="_static/documentation_options.js?v=9eb32ce0"></script> |
| <script src="_static/doctools.js?v=9bcbadda"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="_static/clipboard.min.js?v=a7894cd8"></script> |
| <script src="_static/copybutton.js?v=c136e461"></script> |
| <script src="_static/tabs.js?v=3ee01567"></script> |
| <script src="_static/scripts/sphinx-book-theme.js?v=887ef09a"></script> |
| <script>DOCUMENTATION_OPTIONS.pagename = 'using-guacamole';</script> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="Guacamole’s administrative interface" href="administration.html" /> |
| <link rel="prev" title="Configuring Guacamole" href="configuring-guacamole.html" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <meta name="docsearch:language" content="en"/> |
| </head> |
| |
| |
| <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode=""> |
| |
| |
| |
| <div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div> |
| |
| <div id="pst-scroll-pixel-helper"></div> |
| |
| <button type="button" class="btn rounded-pill" id="pst-back-to-top"> |
| <i class="fa-solid fa-arrow-up"></i>Back to top</button> |
| |
| |
| <input type="checkbox" |
| class="sidebar-toggle" |
| id="pst-primary-sidebar-checkbox"/> |
| <label class="overlay overlay-primary" for="pst-primary-sidebar-checkbox"></label> |
| |
| <input type="checkbox" |
| class="sidebar-toggle" |
| id="pst-secondary-sidebar-checkbox"/> |
| <label class="overlay overlay-secondary" for="pst-secondary-sidebar-checkbox"></label> |
| |
| <div class="search-button__wrapper"> |
| <div class="search-button__overlay"></div> |
| <div class="search-button__search-container"> |
| <form class="bd-search d-flex align-items-center" |
| action="search.html" |
| method="get"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <input type="search" |
| class="form-control" |
| name="q" |
| id="search-input" |
| placeholder="Search..." |
| aria-label="Search..." |
| autocomplete="off" |
| autocorrect="off" |
| autocapitalize="off" |
| spellcheck="false"/> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span> |
| </form></div> |
| </div> |
| |
| <div class="pst-async-banner-revealer d-none"> |
| <aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside> |
| </div> |
| |
| |
| <header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none"> |
| </header> |
| |
| |
| <div class="bd-container"> |
| <div class="bd-container__inner bd-page-width"> |
| |
| |
| |
| <div class="bd-sidebar-primary bd-sidebar"> |
| |
| |
| |
| <div class="sidebar-header-items sidebar-primary__section"> |
| |
| |
| |
| |
| </div> |
| |
| <div class="sidebar-primary-items__start sidebar-primary__section"> |
| <div class="sidebar-primary-item"> |
| |
| |
| |
| |
| |
| <a class="navbar-brand logo" href="index.html"> |
| |
| |
| |
| |
| |
| |
| <p class="title logo__title">Apache Guacamole Manual v1.6.0</p> |
| |
| </a></div> |
| <div class="sidebar-primary-item"> |
| |
| <script> |
| document.write(` |
| <button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <span class="search-button__default-text">Search</span> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> |
| </button> |
| `); |
| </script></div> |
| <div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main"> |
| <div class="bd-toc-item navbar-nav active"> |
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Getting Started</span></p> |
| <ul class="nav bd-sidenav"> |
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="guacamole-architecture.html">Implementation and architecture</a></li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="installing-guacamole.html">Installing Guacamole</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul> |
| <li class="toctree-l2"><a class="reference internal" href="guacamole-native.html">Native installation</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="guacamole-docker.html">Containerized (Docker) installation</a></li> |
| </ul> |
| </details></li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="jdbc-auth.html">Database setup</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul> |
| <li class="toctree-l2"><a class="reference internal" href="mysql-auth.html">MariaDB / MySQL</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="postgresql-auth.html">PostgreSQL</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="sqlserver-auth.html">SQL Server</a></li> |
| </ul> |
| </details></li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="security.html">Securing a Guacamole install</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul> |
| <li class="toctree-l2"><a class="reference internal" href="reverse-proxy.html">SSL termination</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="auth-ban.html">Blocking brute-force attacks</a></li> |
| </ul> |
| </details></li> |
| </ul> |
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Using Guacamole</span></p> |
| <ul class="current nav bd-sidenav"> |
| <li class="toctree-l1"><a class="reference internal" href="configuring-guacamole.html">Configuration</a></li> |
| <li class="toctree-l1 current active"><a class="current reference internal" href="#">General usage</a></li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="administration.html">Administration</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul> |
| <li class="toctree-l2"><a class="reference internal" href="batch-import.html">Importing connections</a></li> |
| </ul> |
| </details></li> |
| <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li> |
| </ul> |
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Extensions</span></p> |
| <ul class="nav bd-sidenav"> |
| <li class="toctree-l1"><a class="reference internal" href="ldap-auth.html">Active Directory / LDAP</a></li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="mfa.html">Multi-factor authentication</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul> |
| <li class="toctree-l2"><a class="reference internal" href="duo-auth.html">Duo</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="totp-auth.html">TOTP</a></li> |
| </ul> |
| </details></li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="sso.html">Single sign-on</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul> |
| <li class="toctree-l2"><a class="reference internal" href="cas-auth.html">CAS</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="openid-auth.html">OpenID Connect</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="saml-auth.html">SAML</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="ssl-auth.html">Smart cards / Certificates</a></li> |
| </ul> |
| </details></li> |
| <li class="toctree-l1"><a class="reference internal" href="vault.html">Retrieving secrets from a vault</a></li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="external-auth.html">External authentication</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul> |
| <li class="toctree-l2"><a class="reference internal" href="json-auth.html">Encrypted, signed JSON</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="header-auth.html">HTTP header</a></li> |
| </ul> |
| </details></li> |
| <li class="toctree-l1"><a class="reference internal" href="radius-auth.html">RADIUS</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="adhoc-connections.html">Ad-hoc connections</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="auth-restrict.html">Login / Connection restrictions</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="recording-playback.html">Session recording player</a></li> |
| </ul> |
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Developer's Guide</span></p> |
| <ul class="nav bd-sidenav"> |
| <li class="toctree-l1"><a class="reference internal" href="guacamole-protocol.html">The Guacamole protocol</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="libguac.html">libguac</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="guacamole-common.html">guacamole-common</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="guacamole-common-js.html">guacamole-common-js</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="guacamole-ext.html">guacamole-ext</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="custom-protocols.html">Adding new protocols</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="custom-auth.html">Custom authentication</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="event-listeners.html">Event listeners</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="writing-you-own-guacamole-app.html">Writing your own Guacamole application</a></li> |
| </ul> |
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendices</span></p> |
| <ul class="nav bd-sidenav"> |
| <li class="toctree-l1"><a class="reference internal" href="protocol-reference.html">Guacamole protocol reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="jdbc-auth-schema.html">Database schema reference</a></li> |
| </ul> |
| |
| </div> |
| </nav></div> |
| </div> |
| |
| |
| <div class="sidebar-primary-items__end sidebar-primary__section"> |
| </div> |
| |
| <div id="rtd-footer-container"></div> |
| |
| |
| </div> |
| |
| <main id="main-content" class="bd-main" role="main"> |
| |
| |
| |
| <div class="sbt-scroll-pixel-helper"></div> |
| |
| <div class="bd-content"> |
| <div class="bd-article-container"> |
| |
| <div class="bd-header-article d-print-none"> |
| <div class="header-article-items header-article__inner"> |
| |
| <div class="header-article-items__start"> |
| |
| <div class="header-article-item"><button class="sidebar-toggle primary-toggle btn btn-sm" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <span class="fa-solid fa-bars"></span> |
| </button></div> |
| |
| </div> |
| |
| |
| <div class="header-article-items__end"> |
| |
| <div class="header-article-item"> |
| |
| <div class="article-header-buttons"> |
| |
| |
| |
| <button onclick="toggleFullScreen()" |
| class="btn btn-sm btn-fullscreen-button" |
| title="Fullscreen mode" |
| data-bs-placement="bottom" data-bs-toggle="tooltip" |
| > |
| |
| |
| <span class="btn__icon-container"> |
| <i class="fas fa-expand"></i> |
| </span> |
| |
| </button> |
| |
| |
| |
| <script> |
| document.write(` |
| <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i> |
| <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i> |
| <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i> |
| </button> |
| `); |
| </script> |
| |
| |
| <script> |
| document.write(` |
| <button class="btn btn-sm pst-navbar-icon search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <i class="fa-solid fa-magnifying-glass fa-lg"></i> |
| </button> |
| `); |
| </script> |
| <button class="sidebar-toggle secondary-toggle btn btn-sm" title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <span class="fa-solid fa-list"></span> |
| </button> |
| </div></div> |
| |
| </div> |
| |
| </div> |
| </div> |
| |
| |
| |
| <div id="jb-print-docs-body" class="onlyprint"> |
| <h1>Guacamole’s user interface</h1> |
| <!-- Table of contents --> |
| <div id="print-main-content"> |
| <div id="jb-print-toc"> |
| |
| <div> |
| <h2> Contents </h2> |
| </div> |
| <nav aria-label="Page"> |
| <ul class="visible nav section-nav flex-column"> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#home-screen">Home screen</a><ul class="nav section-nav flex-column"> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#user-menu">User menu</a></li> |
| </ul> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#client-screen">Client screen</a><ul class="nav section-nav flex-column"> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#the-guacamole-menu">The Guacamole menu</a></li> |
| </ul> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#copying-pasting-text">Copying/pasting text</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#switching-and-tiling-connections">Switching and tiling connections</a><ul class="nav section-nav flex-column"> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#adding-a-connection-to-the-current-view">Adding a connection to the current view</a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#typing-with-multiple-connections">Typing with multiple connections</a></li> |
| </ul> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#disconnecting-and-navigation">Disconnecting and navigation</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#sharing-the-connection">Sharing the connection</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#transferring-files">Transferring files</a><ul class="nav section-nav flex-column"> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#using-the-file-browser">Using the file browser</a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#the-rdp-virtual-drive">The RDP virtual drive</a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#guacctl-guacget"><strong class="program">guacctl</strong> / <strong class="program">guacget</strong></a></li> |
| </ul> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#on-screen-keyboard">On-screen keyboard</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#scaling-the-display">Scaling the display</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#mobile-or-touch-devices">Mobile or touch devices</a><ul class="nav section-nav flex-column"> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#mouse-emulation">Mouse emulation</a><ul class="nav section-nav flex-column"> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#absolute-mode-touchscreen">Absolute mode (touchscreen)</a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#relative-mode-touchpad">Relative mode (touchpad)</a></li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#typing-without-a-physical-keyboard">Typing without a physical keyboard</a></li> |
| </ul> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#changing-preferences">Changing preferences</a><ul class="nav section-nav flex-column"> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#display-language">Display language</a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#changing-your-password">Changing your password</a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#default-input-settings">Default input settings</a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#recent-connection-settings">Recent connection settings</a></li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| </div> |
| </div> |
| </div> |
| |
| |
| |
| <div id="searchbox"></div> |
| <article class="bd-article"> |
| |
| <section id="guacamoles-user-interface"> |
| <h1>Guacamole’s user interface<a class="headerlink" href="#guacamoles-user-interface" title="Link to this heading">#</a></h1> |
| <p>Guacamole provides access to much of the functionality of a desktop from within |
| your web browser. Although most people use remote desktop tools only when |
| absolutely necessary, we believe that Guacamole must be aimed at becoming a |
| primary means of accessing desktops, and the interface is thus intended to be |
| as seamless and unobtrusive as possible.</p> |
| <section id="home-screen"> |
| <h2>Home screen<a class="headerlink" href="#home-screen" title="Link to this heading">#</a></h2> |
| <p>Once you have successfully logged in, you will be taken to either the Guacamole |
| home screen, where all available connections are listed, or directly to a |
| connection, if you only have access to one connection.</p> |
| <p>The home screen will contain a list of all connections to which you have |
| access, along with thumbnails of any recently used or active connections. If |
| you have access to a large number of connections and wish to quickly locate a |
| specific connection, you can also enter search terms within the “Filter” field |
| to filter the list of connections by name.</p> |
| <p><img alt="The Guacamole home screen. The user menu and several recently-usedconnections are visible, along with one active connection." src="_images/guacamole-home-screen.png" /></p> |
| <p>Clicking on any connection will open that connection within the current window |
| or tab, but multiple connections can be used simultaneously. You can easily |
| navigate back to the home screen without disconnecting by using your browsers |
| back button or the “Home” button in the Guacamole menu. Each connection you use |
| will remain active until explicitly disconnected, or until you navigate away |
| from Guacamole entirely. Active connections can be seen as thumbnails updating |
| in real-time on the home screen.</p> |
| <section id="user-menu"> |
| <h3>User menu<a class="headerlink" href="#user-menu" title="Link to this heading">#</a></h3> |
| <p>With the exception of the client screen discussed below, all Guacamole screens |
| contain a menu in the upper-right corner called the “user menu”. This menu |
| displays your username and contains several options which depend on your user’s |
| level of access:</p> |
| <dl class="simple myst"> |
| <dt>Home</dt><dd><p>Navigates back to the home screen, if you are not already there. If you only |
| have access to one connection, this will be replaced with a link to that |
| connection.</p> |
| </dd> |
| <dt>Settings</dt><dd><p>Navigates to the settings interface, which provides access to user |
| preferences such as display language. If you have access to administrative |
| functions, those are found within the settings interface, as well, and are |
| discussed in more detail in <a class="reference internal" href="administration.html"><span class="doc std std-doc">Guacamole’s administrative interface</span></a>.</p> |
| </dd> |
| <dt>Logout</dt><dd><p>Logs out of Guacamole completely, closing all current connections and ending |
| the Guacamole session.</p> |
| </dd> |
| </dl> |
| </section> |
| </section> |
| <section id="client-screen"> |
| <h2>Client screen<a class="headerlink" href="#client-screen" title="Link to this heading">#</a></h2> |
| <p>Once you open a connection, you will see a real-time view of the remote |
| display. You can interact with this display just as you would your normal |
| desktop. Your mouse and keyboard will function as if they were connected |
| directly to the remote machine.</p> |
| <p><img alt="Guacamole client interface, with the Guacamole menuopen." src="_images/guacamole-client-interface.png" /></p> |
| <p>The remote display will take up the entire browser window, with no buttons or |
| menus to disturb the view. With the intent of providing a seamless experience, |
| options specific to remote desktop are hidden within the Guacamole menu, which |
| can be opened as needed.</p> |
| <section id="the-guacamole-menu"> |
| <span id="guacamole-menu"></span><h3>The Guacamole menu<a class="headerlink" href="#the-guacamole-menu" title="Link to this heading">#</a></h3> |
| <p>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 <kbd class="kbd docutils literal notranslate">Ctrl</kbd>+<kbd class="kbd docutils literal notranslate">Alt</kbd>+<kbd class="kbd docutils literal notranslate">Shift</kbd>. 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. To hide the menu, you press <kbd class="kbd docutils literal notranslate">Ctrl</kbd>+<kbd class="kbd docutils literal notranslate">Alt</kbd>+<kbd class="kbd docutils literal notranslate">Shift</kbd> |
| again or swipe left across the screen.</p> |
| <p>The Guacamole menu provides options for:</p> |
| <ul class="simple"> |
| <li><p><a class="reference internal" href="#using-the-clipboard"><span class="std std-ref">Reading from (and writing to) the clipboard of the remote |
| desktop</span></a></p></li> |
| <li><p><a class="reference internal" href="#client-connection-menu"><span class="std std-ref">Switching between active connections and displaying multiple connections at |
| once</span></a></p></li> |
| <li><p><a class="reference internal" href="#client-user-menu"><span class="std std-ref">Navigating back to the home screen</span></a></p></li> |
| <li><p><a class="reference internal" href="#client-user-menu"><span class="std std-ref">Disconnecting from the current connection entirely</span></a></p></li> |
| <li><p><a class="reference internal" href="#client-share-menu"><span class="std std-ref">Sharing the current connection</span></a></p></li> |
| <li><p><a class="reference internal" href="#file-transfer"><span class="std std-ref">Uploading and downloading files</span></a></p></li> |
| <li><p><a class="reference internal" href="#scaling-display"><span class="std std-ref">Zooming in and out of the remote display</span></a></p></li> |
| <li><p><a class="reference internal" href="#touch-devices"><span class="std std-ref">Selecting alternative methods of typing or controlling the mouse, |
| particularly for use on mobile or touchscreen devices</span></a></p></li> |
| </ul> |
| </section> |
| </section> |
| <section id="copying-pasting-text"> |
| <span id="using-the-clipboard"></span><h2>Copying/pasting text<a class="headerlink" href="#copying-pasting-text" title="Link to this heading">#</a></h2> |
| <p>At the top of the Guacamole menu is a text area labeled “clipboard” |
| along with some basic instructions:</p> |
| <blockquote> |
| <div><p>Text copied/cut within Guacamole will appear here. Changes to the text below |
| will affect the remote clipboard.</p> |
| </div></blockquote> |
| <p>If the clipboard API is enabled, the contents of the local clipboard will |
| automatically be synchronized to Guacamole, and ultimately to the clipboards |
| of the remote systems (assuming the functionality has not been disabled. The |
| text area, here, functions as a manual interface to the clipboard, allowing |
| text to be manually manipulated - text that you type, or paste into the text |
| area will be available to the remote clipboard, and text that is placed on |
| the remote clipboard it can be seen in this text area.</p> |
| <p>For privacy and security reasons, the contents of the clipboard are initially |
| hidden when the Guacamole menu is opened. Instead, a banner with further |
| instructions is displayed:</p> |
| <blockquote> |
| <div><p>Click to view clipboard contents.</p> |
| </div></blockquote> |
| <p>Upon clicking the text area, the contents of the clipboard will be shown and |
| may be edited or replaced. The clipboard will remain visible until the |
| Guacamole menu is closed.</p> |
| </section> |
| <section id="switching-and-tiling-connections"> |
| <span id="client-connection-menu"></span><h2>Switching and tiling connections<a class="headerlink" href="#switching-and-tiling-connections" title="Link to this heading">#</a></h2> |
| <p>If you have access to more than one connection, clicking the current connection |
| name at the top of the Guacamole menu will open a drop-down menu containing a |
| list of your other available connections:</p> |
| <p><img alt="Connection menu with one connection selected" src="_images/client-connection-menu.png" /></p> |
| <p>Clicking on the name of another connection in this drop-down menu will |
| immediately switch to that connection. The previous connection will remain |
| running as a thumbnail within a panel attached to the lower-right corner of the |
| screen. This panel updates in real-time and remains visible as long as you have |
| multiple active connections, even if you navigate away to another part of the |
| Guacamole application:</p> |
| <p><img alt="Active connection panel" src="_images/client-panel.png" /></p> |
| <p>Clicking on any connection within the panel will navigate back to that |
| connection, while clicking the “X” icon in the upper-right corner of the |
| connection thumbnail will immediately close the connection.</p> |
| <section id="adding-a-connection-to-the-current-view"> |
| <span id="client-tiling"></span><h3>Adding a connection to the current view<a class="headerlink" href="#adding-a-connection-to-the-current-view" title="Link to this heading">#</a></h3> |
| <p>Multiple connections may also be opened simultaneously within the same view by |
| clicking the checkboxes next to the names of those connections in the |
| connection menu:</p> |
| <p><img alt="Connection menu with two connections selected" src="_images/client-connection-menu-multiple.png" /></p> |
| <p>All connections opened in this way are automatically arranged in equally-sized |
| tiles to fill the available area:</p> |
| <p><img alt="Multiple client displays in a tiled arrangement" src="_images/client-tiled.png" /></p> |
| <p>With multiple connections displayed as tiles, keyboard interaction and the |
| Guacamole menu will only affect the currently focused connection, as indicated |
| by the blue title and border. Clicking or tapping within another connection |
| will change the focus and allow keyboard interaction with <em>that</em> connection.</p> |
| </section> |
| <section id="typing-with-multiple-connections"> |
| <span id="client-broadcast-keyboard"></span><h3>Typing with multiple connections<a class="headerlink" href="#typing-with-multiple-connections" title="Link to this heading">#</a></h3> |
| <p>By holding down <kbd class="kbd docutils literal notranslate">Ctrl</kbd> (to select an individual connection) or |
| <kbd class="kbd docutils literal notranslate">Shift</kbd> (to select a rectangle of connections), multiple connection may be |
| focused at the same time. While multiple connections are focused, each key |
| pressed will be broadcast across each focused connection:</p> |
| <p><img alt="Multiple focused client displays in a tiled arrangement" src="_images/client-tiled-multi-focus.png" /></p> |
| <p>This is particularly useful for running the same series of commands on multiple |
| computers. Further, since Guacamole automatically translates between the user’s |
| local keyboard layout and the keyboard layout of the remote server, <em>this will |
| work as expected even if the keyboard layouts of focused connections do not |
| match</em>.</p> |
| </section> |
| </section> |
| <section id="disconnecting-and-navigation"> |
| <span id="client-user-menu"></span><h2>Disconnecting and navigation<a class="headerlink" href="#disconnecting-and-navigation" title="Link to this heading">#</a></h2> |
| <p>When you are done using the current connection, or you wish to navigate |
| elsewhere temporarily, options to do so are within the user menu inside the |
| Guacamole menu:</p> |
| <p><img alt="The user menu within the Guacamole menu." src="_images/guac-menu-disconnect.png" /></p> |
| <p>The user menu within the Guacamole menu provides an additional “Disconnect” |
| option that allows you to explicitly close the current connection only. |
| Clicking “Logout” will also implicitly disconnect all active connections, |
| including the current connection.</p> |
| <p>Navigating back to the home screen or to the settings screen will not |
| disconnect you: your connection will continue running in the background while |
| you change settings or initiate another connection, and you can resume any |
| active connection by clicking on it within the home screen.</p> |
| </section> |
| <section id="sharing-the-connection"> |
| <span id="client-share-menu"></span><h2>Sharing the connection<a class="headerlink" href="#sharing-the-connection" title="Link to this heading">#</a></h2> |
| <p>If the Guacamole server is configured to allow connection sharing, and you have |
| been granted permission to share the current connection, an additional “Share” |
| menu will appear next to your username in the Guacamole menu. Clicking on this |
| menu opens a list of options for sharing the current connection.</p> |
| <p><img alt="" src="_images/guac-menu-share.png" /></p> |
| <p>Clicking any of the options within the “Share” menu will immediately generate a |
| unique share link which can be distributed to anyone, even to users which do |
| not otherwise have accounts within the same Guacamole system.</p> |
| <p><img alt="" src="_images/guac-menu-share-link.png" /></p> |
| <p>When the link is visited, that user will be given temporary access to your |
| connection, restricted according to the sharing option chosen. This access, and |
| the validity of the link overall, lasts only until you disconnect. Once the |
| connection is closed, the link ceases to be valid, and any users sharing the |
| connection with you will be disconnected.</p> |
| </section> |
| <section id="transferring-files"> |
| <span id="file-transfer"></span><h2>Transferring files<a class="headerlink" href="#transferring-files" title="Link to this heading">#</a></h2> |
| <p>You can transfer files back and forth between your local computer and the |
| remote desktop if it is supported by the underlying protocol and enabled on the |
| connection. Currently, Guacamole supports file transfer for VNC, RDP, and SSH, |
| using either the native file transfer support of the protocol or SFTP.</p> |
| <p>Files can be transferred to the remote computer by dragging and dropping the |
| files into your browser window, or through using the file browser located in |
| the Guacamole menu.</p> |
| <section id="using-the-file-browser"> |
| <span id="file-browser"></span><h3>Using the file browser<a class="headerlink" href="#using-the-file-browser" title="Link to this heading">#</a></h3> |
| <p>If file transfer is enabled on the connection, you will see one or more |
| filesystem devices listed within the Guacamole menu. Clicking on one of the |
| filesystems opens a file browser which lists the files and directories within |
| that filesystem.</p> |
| <p><img alt="The file browser within the Guacamole menu." src="_images/file-browser.png" /></p> |
| <p>Double-clicking on any directory will change the current location of the file |
| browser to that directory, updating the list of files shown as well as the |
| “breadcrumbs” at the top of the file browser. Clicking on any of the directory |
| names listed in the breadcrumbs will bring you back to that directory, and |
| clicking on the drive icon on the far left will bring you all the way back to |
| the root level.</p> |
| <p>Downloads are initiated by double-clicking on any file shown, while uploads are |
| initiated by clicking the “Upload Files” button. Clicking “Upload Files” will |
| open a file browsing dialog where you can choose one or more files from your |
| local computer, ultimately uploading the selected files to the directory |
| currently displayed within the file browser.</p> |
| <p>The state of all file uploads can be observed within the notification dialog |
| that appears once an upload begins, and can be cleared once completed by |
| clicking the “Clear” button. Downloads are tracked through your browser’s own |
| download notification system.</p> |
| <p><img alt="In-progress and completed file transfers." src="_images/file-transfers.png" /></p> |
| <p>When you are done browsing the filesystem and transferring files, click “Back” |
| to return to the Guacamole menu.</p> |
| </section> |
| <section id="the-rdp-virtual-drive"> |
| <span id="rdp-virtual-drive"></span><h3>The RDP virtual drive<a class="headerlink" href="#the-rdp-virtual-drive" title="Link to this heading">#</a></h3> |
| <p>RDP provides its own native support for file transfer called “drive |
| redirection” or “RDPDR”. Guacamole provides support for this mechanism by |
| emulating a virtual drive. Typically, this virtual drive will appear as a |
| network drive within the RDP session. Files uploaded and downloaded will be |
| preserved within this drive, even after disconnecting.</p> |
| <p><img alt="The Guacamole drive within a Windows RDP session." src="_images/guacamole-drive.png" /></p> |
| <p>Files can be downloaded from this drive using the file browser in the Guacamole |
| menu or using the special “Download” folder within the virtual drive. All files |
| dropped into this folder will automatically begin uploading to the client, and |
| thus downloading through the browser.</p> |
| <p><img alt="The Guacamole drive's "Download" folder." src="_images/guacamole-drive-download.png" /></p> |
| </section> |
| <section id="guacctl-guacget"> |
| <span id="guacctl"></span><h3><strong class="program">guacctl</strong> / <strong class="program">guacget</strong><a class="headerlink" href="#guacctl-guacget" title="Link to this heading">#</a></h3> |
| <p>In addition to traditional drag-and-drop and the file browser, Guacamole’s SSH |
| support can be used with the <strong class="program">guacctl</strong> utility. The <strong class="program">guacctl</strong> |
| utility is a simple shell script <a class="reference external" href="https://raw.githubusercontent.com/apache/guacamole-server/master/bin/guacctl">included with Guacamole</a> which |
| allows you to use and configure file transfer directly from the command line |
| within the SSH session:</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>guacctl |
| <span class="go">guacctl 0.8.0, Guacamole SSH session control utility.</span> |
| <span class="go">Usage: guacctl [OPTION] [FILE]...</span> |
| |
| <span class="go"> -d, --download download each of the files listed.</span> |
| <span class="go"> -s, --set-directory set the destination directory for future uploaded </span> |
| <span class="go"> files.</span> |
| <span class="gp">$ </span>guacctl<span class="w"> </span>-d<span class="w"> </span>FILENAME |
| <span class="gp">$ </span>guacctl<span class="w"> </span>-s<span class="w"> </span>DIRECTORY |
| <span class="gp">$</span> |
| </pre></div> |
| </div> |
| <p>For convenience, you may also create a symbolic link or alias to |
| <strong class="program">guacctl</strong> called <strong class="program">guacget</strong>. When run as <strong class="program">guacget</strong>, |
| the utility behaves as if the <code class="docutils literal notranslate"><span class="pre">--download</span></code> option were supplied and initiates a |
| download for each file specified on the command line.</p> |
| </section> |
| </section> |
| <section id="on-screen-keyboard"> |
| <span id="using-the-osk"></span><h2>On-screen keyboard<a class="headerlink" href="#on-screen-keyboard" title="Link to this heading">#</a></h2> |
| <p>Certain key combinations are impossible to press within a web application like |
| Guacamole because they are reserved by the operating system |
| (<kbd class="kbd docutils literal notranslate">Ctrl</kbd>+<kbd class="kbd docutils literal notranslate">Alt</kbd>+<kbd class="kbd docutils literal notranslate">Del</kbd> or <kbd class="kbd docutils literal notranslate">Alt</kbd>+<kbd class="kbd docutils literal notranslate">Tab</kbd>, for example) or by the web browser. If |
| you press one of these reserved combinations, the effect will be observed |
| locally, not remotely, and the remote desktop will receive only some of the |
| keys.</p> |
| <p>Guacamole provides its own, built-in on-screen keyboard which allows keys to be |
| sent to the remote desktop without affecting the local system. If the device |
| you’re using does not have certain keys which the remote desktop depends on, |
| such as the arrow keys or <kbd class="kbd docutils literal notranslate">Ctrl</kbd>, you can use the on-screen keyboard for |
| this, too. You can show the on-screen keyboard by selecting the “On-screen |
| keyboard” option from the menu.</p> |
| <p>Clicking (or tapping) the buttons of the on-screen keyboard has the same effect |
| as pressing the same buttons on a real keyboard, except that the operating |
| system and browser will not intercept these keypresses; they will only be sent |
| to the remote desktop.</p> |
| </section> |
| <section id="scaling-the-display"> |
| <span id="scaling-display"></span><h2>Scaling the display<a class="headerlink" href="#scaling-the-display" title="Link to this heading">#</a></h2> |
| <p>Guacamole will default to shrinking or expanding the remote display to fit the |
| browser window exactly, but this is not necessarily ideal. If the remote |
| display is much larger than your local display, the screen may be impossible to |
| see or interact with. This is especially true for mobile phones, whose screens |
| need to be small enough to fit in the average hand.</p> |
| <p>You can scale the display on touch devices by using the familiar pinch gesture. |
| Place two fingers on the screen and bring them closer together to zoom out or |
| further apart to zoom in.</p> |
| <p>If your device lacks a touch screen, you can also control the zoom level |
| through the menu. The controls for zooming in and out are located at the bottom |
| of the menu. The current zoom level is displayed between two “-” and “+” |
| buttons which control the zoom level in 10% increments.</p> |
| </section> |
| <section id="mobile-or-touch-devices"> |
| <span id="touch-devices"></span><h2>Mobile or touch devices<a class="headerlink" href="#mobile-or-touch-devices" title="Link to this heading">#</a></h2> |
| <p>Guacamole is designed to work equally well across all HTML5 browsers, including |
| those of mobile devices. It will automatically handle input from a touch screen |
| or a traditional mouse (or both, if you happen to have such a gifted computer), |
| and provides alternative input methods for devices which lack a physical |
| keyboard.</p> |
| <section id="mouse-emulation"> |
| <span id="touch-mouse"></span><h3>Mouse emulation<a class="headerlink" href="#mouse-emulation" title="Link to this heading">#</a></h3> |
| <p>In the case that your device has a touchscreen and lacks a mouse, Guacamole |
| will emulate a mouse for the sake of interacting with remote desktops that |
| expect mouse input. By default, Guacamole uses “absolute” mouse emulation. This |
| means that the mouse pointer is positioned at the location of each tap on the |
| screen.</p> |
| <p>In both absolute and relative modes, you can click-and-drag by tapping the |
| screen and then quickly placing your finger back down. This gesture only causes |
| the mouse button to press down, but does not release it again until you lift |
| your finger back up.</p> |
| <section id="absolute-mode-touchscreen"> |
| <span id="absolute-mouse-emulation"></span><h4>Absolute mode (touchscreen)<a class="headerlink" href="#absolute-mode-touchscreen" title="Link to this heading">#</a></h4> |
| <p>Absolute mouse emulation is the default as it tends to be what people expect |
| when using a touch device to interact with applications designed for mouse |
| input.</p> |
| <p>Each tap on the screen is translated into a left-click at that position. |
| Right-clicking is accomplished through pressing and holding your finger on the |
| screen. If parts of the remote display are off-screen, you can drag your finger |
| around the screen to pan the off-screen parts back into view.</p> |
| <p>Although absolute mouse emulation works generally well, a finger makes for a |
| very inaccurate pointing device. To address this, Guacamole also provides |
| “relative” mouse emulation. Relative mouse emulation provides a way to deal |
| with the need for accurate pointer control, when a true pointer device is not |
| present.</p> |
| <p><img alt="" src="_images/touchscreen.png" /></p> |
| </section> |
| <section id="relative-mode-touchpad"> |
| <span id="relative-mouse-emulation"></span><h4>Relative mode (touchpad)<a class="headerlink" href="#relative-mode-touchpad" title="Link to this heading">#</a></h4> |
| <p>Guacamole’s relative mouse emulation behaves similarly to the touchpad present |
| on most modern laptops. You drag your finger across the display to move the |
| mouse pointer, and tap the display to left-click. The pointer moves relative to |
| the motion of your finger. Right-clicking is accomplished with a two-finger |
| tap, and middle-clicking with a three-finger tap. The mouse scroll wheel can be |
| operated by dragging two fingers up or down.</p> |
| <p>Because the relative mouse emulation reserves so many gestures for the |
| different mouse buttons and actions, common touch gestures like panning and |
| pinch-to-zoom will not work while relative mouse emulation is enabled. Instead, |
| the screen will automatically pan to keep the mouse pointer in view, and you |
| can zoom through the buttons in the menu.</p> |
| <p><img alt="" src="_images/touchpad.png" /></p> |
| </section> |
| </section> |
| <section id="typing-without-a-physical-keyboard"> |
| <span id="text-input"></span><h3>Typing without a physical keyboard<a class="headerlink" href="#typing-without-a-physical-keyboard" title="Link to this heading">#</a></h3> |
| <p>Many mobile devices lack a physical keyboard entirely, and instead provide |
| their own on-screen keyboards. As these are not true keyboards per se and do |
| not produce key presses, Guacamole’s text input mode is required for typing on |
| these platforms.</p> |
| <p>“Text input” allows input of keystrokes based on the input of text. Choosing |
| “Text input” tells Guacamole to infer keystrokes by tracking text entered, |
| rather than relying on actual key presses. Guacamole will instead determine the |
| combination of keypresses necessary to produce the same pattern of input, |
| including deletions.</p> |
| <p>If you wish to type via an IME (input method editor), such as those required |
| for Chinese, Japanese, or Korean, text input mode is required for this as well. |
| Such IMEs function through the explicit insertion of text and do not send |
| traditional key presses. Using text input mode within Guacamole thus allows you |
| to use a locally-installed IME, without requiring the IME to be installed on |
| the remote desktop.</p> |
| </section> |
| </section> |
| <section id="changing-preferences"> |
| <span id="preferences"></span><h2>Changing preferences<a class="headerlink" href="#changing-preferences" title="Link to this heading">#</a></h2> |
| <p>User preferences can be changed within the settings screen. These preferences |
| are stored locally within the browser, so if you use multiple computers to |
| access Guacamole, you can have different settings for each location. The |
| settings screen allows users to change the language of the Guacamole interface, |
| to change the default input method used by Guacamole connections, and to change |
| the default mouse emulation mode for if a touch device is used. If you have |
| sufficient permissions, you may also change your password, or administer the |
| system.</p> |
| <p><img alt="Guacamole preferences screen." src="_images/guacamole-preferences.png" /></p> |
| <section id="display-language"> |
| <h3>Display language<a class="headerlink" href="#display-language" title="Link to this heading">#</a></h3> |
| <p>The Guacamole interface is currently available in English, Dutch, French, |
| German, Italian, and Russian. By default, Guacamole will attempt to determine |
| the appropriate display language by checking the language preferences of the |
| browser in use. If this fails, or the browser is using a language not yet |
| available within Guacamole, English will be used as a fallback.</p> |
| <p>If you wish to override the current display language, you can do so by |
| selecting a different language within the “Display language” field. The change |
| will take effect immediately.</p> |
| </section> |
| <section id="changing-your-password"> |
| <span id="changing-password"></span><h3>Changing your password<a class="headerlink" href="#changing-your-password" title="Link to this heading">#</a></h3> |
| <p>System administrators can restrict the ability of individual users to change |
| their own passwords, so this section may not always be available. If your |
| account <em>does</em> have permission, the preferences screen will contain a “Change |
| Password” section.</p> |
| <p>To change your password, you must provide your current password, enter the |
| desired new password, and click “Update Password”. You will remain logged in, |
| and the change will affect any future login attempt.</p> |
| </section> |
| <section id="default-input-settings"> |
| <h3>Default input settings<a class="headerlink" href="#default-input-settings" title="Link to this heading">#</a></h3> |
| <p>Guacamole provides multiple keyboard input methods and multiple mouse emulation |
| modes. Many of these settings are specifically useful for touch devices, while |
| others are aimed mainly at traditional desktop use. By default, Guacamole will |
| use the keyboard and mouse modes most commonly preferred by users, but you can |
| change these defaults if they do not fit your tastes or your current device.</p> |
| <p>The choices available mirror those within the Guacamole menu discussed earlier |
| in this chapter, and changing these settings will affect the default values |
| selected within the Guacamole menu of future connections.</p> |
| </section> |
| <section id="recent-connection-settings"> |
| <h3>Recent connection settings<a class="headerlink" href="#recent-connection-settings" title="Link to this heading">#</a></h3> |
| <p>The user interface can be configured with regard to whether recent connections |
| are displayed and how many are tracked. The default setting is to track the most |
| recent 6 connections, but you can use the checkbox to disable the recent |
| connections area altogether, or you can adjust the number of recent |
| connections kept in history from the default of 6.</p> |
| </section> |
| </section> |
| </section> |
| |
| |
| </article> |
| |
| |
| |
| |
| |
| |
| <footer class="prev-next-footer d-print-none"> |
| |
| <div class="prev-next-area"> |
| <a class="left-prev" |
| href="configuring-guacamole.html" |
| title="previous page"> |
| <i class="fa-solid fa-angle-left"></i> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">previous</p> |
| <p class="prev-next-title">Configuring Guacamole</p> |
| </div> |
| </a> |
| <a class="right-next" |
| href="administration.html" |
| title="next page"> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">next</p> |
| <p class="prev-next-title">Guacamole’s administrative interface</p> |
| </div> |
| <i class="fa-solid fa-angle-right"></i> |
| </a> |
| </div> |
| </footer> |
| |
| </div> |
| |
| |
| |
| <div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner"> |
| |
| |
| <div class="sidebar-secondary-item"> |
| <div class="page-toc tocsection onthispage"> |
| <i class="fa-solid fa-list"></i> Contents |
| </div> |
| <nav class="bd-toc-nav page-toc"> |
| <ul class="visible nav section-nav flex-column"> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#home-screen">Home screen</a><ul class="nav section-nav flex-column"> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#user-menu">User menu</a></li> |
| </ul> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#client-screen">Client screen</a><ul class="nav section-nav flex-column"> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#the-guacamole-menu">The Guacamole menu</a></li> |
| </ul> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#copying-pasting-text">Copying/pasting text</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#switching-and-tiling-connections">Switching and tiling connections</a><ul class="nav section-nav flex-column"> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#adding-a-connection-to-the-current-view">Adding a connection to the current view</a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#typing-with-multiple-connections">Typing with multiple connections</a></li> |
| </ul> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#disconnecting-and-navigation">Disconnecting and navigation</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#sharing-the-connection">Sharing the connection</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#transferring-files">Transferring files</a><ul class="nav section-nav flex-column"> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#using-the-file-browser">Using the file browser</a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#the-rdp-virtual-drive">The RDP virtual drive</a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#guacctl-guacget"><strong class="program">guacctl</strong> / <strong class="program">guacget</strong></a></li> |
| </ul> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#on-screen-keyboard">On-screen keyboard</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#scaling-the-display">Scaling the display</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#mobile-or-touch-devices">Mobile or touch devices</a><ul class="nav section-nav flex-column"> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#mouse-emulation">Mouse emulation</a><ul class="nav section-nav flex-column"> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#absolute-mode-touchscreen">Absolute mode (touchscreen)</a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#relative-mode-touchpad">Relative mode (touchpad)</a></li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#typing-without-a-physical-keyboard">Typing without a physical keyboard</a></li> |
| </ul> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#changing-preferences">Changing preferences</a><ul class="nav section-nav flex-column"> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#display-language">Display language</a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#changing-your-password">Changing your password</a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#default-input-settings">Default input settings</a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#recent-connection-settings">Recent connection settings</a></li> |
| </ul> |
| </li> |
| </ul> |
| </nav></div> |
| |
| </div></div> |
| |
| |
| </div> |
| <footer class="bd-footer-content"> |
| |
| <div class="bd-footer-content__inner container"> |
| |
| <div class="footer-item"> |
| |
| <p class="component-author"> |
| By The Apache Software Foundation |
| </p> |
| |
| </div> |
| |
| <div class="footer-item"> |
| |
| |
| <p class="copyright"> |
| |
| © Copyright 2025 The Apache Software Foundation. |
| <br/> |
| |
| </p> |
| |
| </div> |
| |
| <div class="footer-item"> |
| |
| </div> |
| |
| <div class="footer-item"> |
| |
| </div> |
| |
| </div> |
| </footer> |
| |
| |
| </main> |
| </div> |
| </div> |
| |
| <!-- Scripts loaded after <body> so the DOM is not blocked --> |
| <script src="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b"></script> |
| <script src="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b"></script> |
| |
| <footer class="bd-footer"> |
| </footer> |
| </body> |
| </html> |
