# Apache-Guacamole

Apache-Guacamole is a clientless remote desktop gateway that provides browser-based access to RDP, VNC, and SSH sessions without requiring client-side plugins. It is open source and self-hosted, installable on Docker Hub, Proxmox and Unraid.

Canonical page: https://ourlocalhost.com/app/4465/apache-guacamole

## Description

Apache Guacamole is a clientless remote desktop gateway that provides browser-based access to RDP, VNC, and SSH sessions without requiring client-side plugins.

## Platform availability

Available on 2 of 9 platforms: Unraid, Proxmox.

## Health score

73/100 (Good), based on 4 of 4 factors.
- Maintained: 100 (last commit 24 days ago)
- Popular: 65 (1,722 GitHub stars)
- Easy to install: 45 (2 install platforms, install notes, Docker image)
- Light to run: 50 (2 GB minimum RAM)

## Links

- GitHub: https://github.com/apache/guacamole-client
- Docker Hub: https://hub.docker.com/r/guacamole/guacamole
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=apache-guacamole
- Official website: https://guacamole.apache.org/
- Unraid: https://ca.unraid.net/apps/apacheguacamole-0mxd5s81fok2x8?q=ApacheGuacamole
- Documentation: https://guacamole.apache.org/doc/gug/

## Common questions

### How do I build the Guacamole web application from source?

Run Maven with mvn package; the deployable .war file is created in the guacamole/target subdirectory. Deploy that war file to a servlet container such as Tomcat or Jetty, using the container-specific location and possibly root access.

### Can the Unraid Docker setup use a database outside the container?

Yes, the Unraid Docker setup can use a built-in MariaDB database or an external database. It also describes VNC, RDP, SSH, and Telnet support for the container.

### How should I integrate Guacamole into my own web page instead of using an iframe?

Use the Guacamole JavaScript API, guacamole-common-js, to integrate Guacamole directly into your page. If that is insufficient, the FAQ suggests building your own web application from guacamole-common.

### Which single sign-on methods are documented in the Guacamole manual?

The manual lists CAS, OpenID Connect, and SAML under single sign-on.

### What should I do before assuming a Guacamole problem is a bug?

The project FAQ says to perform basic troubleshooting first to confirm that Guacamole is the only factor affecting whether things work. It also notes that many other users run Guacamole without issue, so fundamental problems are less likely to be Guacamole bugs.

## Alternatives

- Boundary: HashiCorp Boundary Community Edition is an archived zero-trust access gateway that lets teams and homelab admins securely reach internal se…
- FreeRDP: FreeRDP is a free implementation of the Remote Desktop Protocol (RDP), released under the Apache license.
- HopToDesk: HopToDesk is a free, open source remote desktop application for Windows, macOS, Linux, FreeBSD, Android, iOS, Chrome OS and Raspberry Pi, p…
- LogMeIn Resolve: Endpoint management with remote control, IT management, monitoring, access, support, ticketing, and automation.
- MeshCentral: MeshCentral is a self-hosted, web-based platform for remotely monitoring, controlling, and managing computers and devices on a local networ…
- NoMachine: Access remote computers easily with enterprise-class speed and features supporting any content including audio and video.
- RealVNC: Secure, cost-effective remote access and support for your computer, from your desktop or mobile device.
- Remmina: Remmina is a cross-platform remote desktop client for system administrators and users who need to manage many remote computers through Remo…
- RustDesk: RustDesk is an open-source remote desktop and control platform that lets self-hosters securely access and manage devices from anywhere with…
- TeamViewer: Establish remote desktop access in seconds with instant control, secure data, VoIP and webcam integration, file transfer, and fast, easy co…
- TigerVNC: TigerVNC is an advanced VNC implementation.
- TightVNC: TightVNC is a free remote desktop application.

---
Source: Our Local Host (https://ourlocalhost.com/app/4465/apache-guacamole), the self-hosted and open-source app directory.