rustguac v1.13.4 documentation
Install, configure and run rustguac
Everything from a first install to a hardened production deployment: OIDC sign-in, Vault-backed connections, web and VDI sessions, the REST API and migrating from Apache Guacamole.
Quick start
Getting started
What rustguac is, how to install it, configure it and put it into production.
- OverviewWhat rustguac is, how it compares to Apache Guacamole, architecture and session types.
- InstallationDebian packages, Docker, bare-metal, RPM from source and development builds.
- ConfigurationThe TOML config reference, with every section and setting.
- Deployment guideStep-by-step production setup: HAProxy, OIDC, Vault, Knocknoc, drives and recording.
- Reverse proxiesHAProxy, nginx, Caddy, Apache and Traefik in front of rustguac, and the %2F gotcha.
Features
Roles, web and VDI sessions, RDP video, credentials, reports and themes.
- Roles & access controlOIDC, the 4-tier role hierarchy, group mappings, folder access and API tokens.
- Web browser sessionsChromium sessions with autofill, domain allowlisting and login scripts.
- SPICE & Proxmox VESPICE displays and Proxmox VE VM consoles: API tokens, one-time tickets, TLS pinning and tunnels.
- VDI desktop containersEphemeral Docker desktops: image requirements, lifecycle and persistent homes.
- RDP video performanceH.264 passthrough, the GFX pipeline, and Windows and xrdp tuning.
- RDP H.264 passthroughEnabling H.264 passthrough and the Windows host settings it requires.
- Credential variablesShared credentials across connection entries, stored per user in Vault.
- ReportsSession analytics, history, leaderboards and CSV export.
- ThemesBuilt-in colour presets, per-user switching and your own brand themes.
Integration & reference
Vault, SSO, NetBox, security hardening, the REST API and migrating from Guacamole.
- IntegrationsOIDC SSO, Vault/OpenBao, SSH tunnels, Kerberos, HAProxy, Knocknoc and LUKS drives.
- NetBoxOne-click consoles and connections sync via custom fields and webhooks.
- SecurityTLS, network allowlists, rate limiting, headers, audit logging and hardening.
- API referenceREST endpoints, the session connection flow and headless ws-ticket integration.
- Migration from GuacamoleImport connections from an Apache Guacamole MySQL/MariaDB database into Vault.