Administration

The Workspaces platform is a powerful and flexible system. It is highly recommended to watch this quick start administration guide, which configures Workspaces from a fresh install for common use cases and walks through many of the advanced features of the platform.

---

• System Architecture
• Users
  • Create User
  • User Properties
  • Add User to Group
  • User Settings
  • User Permissions
  • User File Mappings
• Groups
  • Create Group
  • Group Properties
  • Group Settings
    • Session Time Limits
      • keepalive_expiration
      • keepalive_expiration_action
      • keepalive_interval
      • idle_disconnect
      • usage_limit
      • session_time_limit
  • Group Permissions
    • Permission Changes
    • Permission Dependencies
    • Special Permissions
  • Group Workspaces
  • SSO Group Mappings
  • Group File Mappings
• Deployment Zones
  • Capabilities
  • Configuring Deployment Zones
    • Defining Zone Configurations
    • Assigning Zone Configurations
• Login Configurations
  • Login Notice
  • Login Assistance
• LDAP Authentication
  • Create an LDAP Configuration
  • User Domain Name Matching
  • Test Authentication
  • Common Errors
  • Create LDAP linked Group
  • LDAP Attribute Mapping
  • AD Sync
    • Synchronize AD Groups
    • AD User Attributes
  • Configuration Examples
    • Active Directory / OpenLDAP
      • Configure the LDAP Configuration (Active Directory)
      • Configure the LDAP Configuration (OpenLDAP / IDM)
      • Configure an LDAP Enabled Group
      • Verifying Configurations
      • Group Assignment
    • JumpCloud
      • Kasm LDAP Configuration
      • LDAP Group Mapping
      • Verifying Configurations
      • Helpful References
• SAML 2.0 Authentication
  • Configuration
    • Service Provider
    • Identity Provider
  • Advanced Settings
  • SAML Setup
  • Group Assignment
  • SAML Attribute Mapping
  • Known Issues
    • RequestedAuthnContext
      • Workaround
  • Configuration Examples
    • Active Directory Federation Services (ADFS) SAML Setup
      • ADFS Signing Certificate
      • Create a new SAML configuration in Kasm
      • ADFS Party Trust
      • ADFS Edit Claim Issuance Policy
      • Verifying Access
      • ADFS Group Mapping
    • Azure Active Directory SAML Setup
      • Create a new SAML configuration in Kasm
      • Add a new application in Azure
      • Basic SAML Configurations
      • User Attributes and Claims
      • SAML Signing Certificate
      • Set Up Kasm
      • Mapping Users
      • Testing Access
      • Known Issues
        • SLO Error AADSTS75005
    • Google Workspace SAML Setup
      • Create a new SAML configuration in Kasm
      • Add a new application in Google Workspace
      • Enabling Access for Users
    • Group Mappings
      • Testing Access
    • Keycloak SAML Setup
      • Create a new SAML configuration in Kasm
      • Realm SAML Settings
      • Add a new client in Keycloak
      • Client Configurations
      • Adjust Single Role Attribute in Keycloak
      • Testing Access
      • Mapping Roles
    • Okta SAML Setup
    • OneLogin SAML Setup
    • PingOne SAML Setup
      • Create a new SAML configuration in Kasm
      • Create a new SAML Application in PingOne
      • Complete SAML configuration in Kasm
      • Mapping Users
      • Testing Access
    • VMware Workspace ONE SAML Setup
      • Create a new SAML configuration in Kasm
      • Add a new SaaS Application
    • Testing Access
      • Group Mappings
• OpenID Authentication
  • Configuration
  • Group Assignment
  • OpenID Attribute Mapping
  • Configuration Examples
    • Github OpenID Setup
      • Creating a Github OAuth App
      • Kasm OpenID Config
      • Github Login Test
    • Google OpenID Setup
      • Creating a Google OAuth App
      • Kasm OpenID Config
      • Google Login Test
    • Keycloak OpenID Setup
      • Creating a Keycloak OAuth App
      • Kasm OpenID Config
      • Keycloak Login Test
      • Group Mapping
    • Microsoft (Public) OpenID Setup
      • Creating a Microsoft OAuth App
      • Kasm OpenID Config
      • Microsoft Login Test
    • Microsoft (Internal) OpenID Setup
      • Creating a Microsoft OAuth App
      • Kasm OpenID Config
      • Microsoft Login Test
      • Group Mapping
    • Auth0 OpenID Setup
      • Creating an Auth0 OAuth App
      • (Optional) Configuring Auth0 to forward User Roles
      • Kasm OpenID Config
      • Auth0 Login Test
      • Group Mapping
• Two Factor Authentication
  • Require Two Factor Authentication
  • Self Enrollment
  • Two Factor Setup
  • User Authentcator App Setup
    • Reset Single-User Authentication
  • Physical TOTP Token Setup
    • Import Physical Tokens
    • Assigning Tokens
      • Administrator Assigned
      • User Self Register
    • Deleting Tokens
  • Token Time Drift
  • WebAuthn Authentication
• Workspaces
  • Add Edit Workspaces
  • Containers
    • Docker Exec Config
    • Docker Run Config
      • Examples
    • File Mapping
  • Links
  • Servers
    • RemoteApp
      • Registering a RemoteApp
      • Configure RemoteApp Path
  • Server Pools
• Default Docker Images
  • Core Docker Images
  • Rolling Docker Images
  • Custom Docker Images
• Workspace Launch Forms
  • Quick Example
  • Launch Config Schema
    • file_mapping
    • launch_form
• Compute
  • Docker Agents
    • View Agents
    • Agent Chart
    • Agent Settings
    • CPU / Memory / GPU Override
    • GPU Support
    • GPU Accelerated Graphics
    • Changing Manager Token
  • Servers
    • Create Server
      • Single Sign-On to Windows Systems via LDAP
    • Authentication Options When Connecting to an SSH Server
    • SSH session continuity
      • Tmux Connection Settings Example
      • Screen Connection Settings Example
    • Creating Templates For Use With The VMware vSphere Provider
      • Linux Templates
        • Troubleshooting Linux Startup Script Execution
      • Windows Templates
        • Troubleshooting Windows Startup Script Execution
  • Pools
    • Create Pool
    • Servers List
    • Docker Agents List
    • AutoScale Configurations
      • AutoScale Scheduling
        • Example AutoScale Schedules
      • AutoScale Config (Server Pool)
        • Max Simultaneous Sessions Per Server
        • Require Checkin
        • Create Active Directory Computer Record
        • Single Sign-On to Windows Systems via LDAP
        • Authentication Options When Connecting to an SSH Server
      • AutoScale Config (Docker Agent Pool)
      • Aggressive Scaling
  • VM Provider Configs
    • AWS Settings
    • Azure Settings
    • Register Azure app
    • Azure VM Settings
    • Digital Ocean Settings
      • Tag Does Not Exist Error
    • Google Cloud (GCP) Settings
      • Note on Updating Existing Google Cloud Providers (GCP)
    • Oracle Cloud (OCI) Settings
      • OCI Config Override Examples
    • VMware vSphere Settings
      • Notes on vSphere Datastore Storage
    • OpenStack Settings
      • Openstack Notes
    • KubeVirt Enabled Providers
      • Overview
      • Startup Scripts
      • Config Overrides
      • Caveats
      • KubeVirt Settings
      • KubeVirt GKE Setup Example
        • Ensure GKE is configured
        • Install KubeVirt
        • Install the Containerized Data Importer extension
        • Create local kubectl authentication
        • Upload a PVC
        • Ensure KASM is configured
      • Harvester Settings
      • Harvester Setup Example
        • Generate credentials to access the Kubernetes cluster
        • Create a namespace
        • Create a VM network
        • Create a VM image
        • Create a KASM deployment VM
        • Install KASM
        • Create Certs
        • Configure KASM
  • DNS Provider Configs
    • AWS DNS Provider Settings
    • Azure DNS Provider Settings
    • Digital Ocean DNS Provider Settings
    • Google Cloud (GCP) DNS Provider Settings
    • Oracle Cloud (OCI) DNS Provider Settings
• Connection Proxies
  • Components
    • Guacamole (GUAC)
    • RDP Gateway
    • RDP HTTPS Gateway
  • RDP Native Connections
  • Architecture
• Sessions
  • Create Image from Session
• Session History
  • Recording sessions
    • Set up S3 Storage
    • Set the recording location
    • Enable session recording in group settings
• Server Settings
  • Authentication
  • CAPTCHA Settings
  • Logging
    • Native Kasm Logging
    • Splunk Logging
    • Logging Retention
  • Manager
  • Egress Plugins
  • Images
  • Web Filter
  • Connections
    • Default VM RDP Connection Settings
      • RDP Session Watermarking
    • Default VM VNC Connection Settings
    • Default VM SSH Connection Settings
  • Scale
  • Theme
  • Web Filter
  • Storage
  • Recording
  • Setting Properties
• Kasm Performance
  • Minimum Kasm Settings
  • Standard Kasm Settings
• Database
  • PostgreSQL Database
    • Backups
    • Restore
    • Change Database Password
  • Redis Database
    • Change Redis Database Password
• Browser Isolation
  • Seamless Browsing
  • /go URL
  • Auto Login
    • Workflow
  • Forward Proxy
  • BlueCoat
  • F5
  • Palo Alto
• Kasm Squid
  • Installation
  • Setup Root CA Trust
  • Setup proxy in windows settings
  • Setup Firefox
  • Troubleshooting
• Reporting and Logging
  • Dashboard
  • Logging Dashboard
  • File Based Logs
    • Metrics
    • Common Attributes
• Troubleshooting
  • Reverse Proxies
    • RDP Session Disconnects
  • General Server Issues
  • GPUs
  • No Resources Available
    • Checking That the Agents Are Online
    • Not enough Free Resources
    • The Agent Doesn’t Have the Image Requested
  • SIGTRAP Browser Crash
  • Connectivity Troubleshooting
    • Browser Extensions
    • Validate Session Port
    • Validate Session Cookies
      • Cookie Conflict
      • Browser Blocking Cookies
      • Cookie Transit
    • Validate Session Authorization
    • WebSockets
    • KasmVNC Troubleshooting
  • Server Configuration Issues
    • Confirm Local Connectivity
    • Host Based Firewalls
• Web Filtering
  • Configuration
• Session Staging
  • Configuration
  • Desired Sessions
  • Session List
  • Incompatible Settings
    • Language and Timezone settings
  • Multi-Zone Behavior
  • Docker Exec
• Session Casting
  • Configuration
  • Error Page
  • Remote App Configuration
• Session Sharing
  • Benefits and Use Cases
  • Security Considerations
  • Shared Session Group Settings
  • Chat Communication
  • Session Control
  • User Interface
  • Video and Audio Settings
  • Initiating a shared session
• Session Recording
  • Configuration
    • S3 Policy Configurations
    • S3 Endpoint configuration
      • S3 Session Recording Variable Substitution
  • RDP, VNC, and SSH
    • Resource Considerations
    • Failure Recovery
  • Viewing Session Recordings
  • S3 CORS configuration
    • Amazon S3
    • GCP Cloud Storage
• Gamepad Pass-through
  • Configuration
  • More Details
  • Known Issues
• Webcam Pass-through
  • Configuration
  • More Details
    • Host Level Requirements
    • Troubleshooting
      • Known issues
        • Kernel lacks videodev
        • UEFI Secure Boot
    • Performance
• Persistent Data
  • Persistent Profiles
    • Volume Mount Profiles
    • S3 Based Profiles
      • S3 Policy Configurations
      • S3 Endpoints
    • Adding a persistent profile to a Workspace
    • How to configure a persistent profile in a workspace
    • Limiting group access to persistent profiles
    • Utilize a persistent profile with creating a Kasm
    • Size Limits
    • Filters
    • Video Example
  • Volume Mapping
    • Configuration Example
      • Create Host Directory
      • Workspace Volume Mapping Settings
      • Verify Functionality
    • User and Image Tokens
    • Volume Mapping Configuration options
    • Configure Volume Mapping at a Group Level
    • Video Example
  • Storage Mappings
    • Storage Providers
      • Volume Config
      • Mount Config
      • Variable Substitution
      • Configuration Examples
        • Dropbox Storage Provider Setup
          • Creating a Dropbox OAuth App
          • Kasm Storage Provider Config
          • Dropbox Storage Mapping Configuration
        • Google Drive Storage Provider Setup
          • Creating a Google OAuth App
          • Kasm Storage Provider Config
          • Google Drive Storage Mapping Configuration
        • Nextcloud Storage Provider Setup
          • Nextcloud Storage Mapping Configuration
        • OneDrive Storage Provider Setup
          • Creating a Microsoft OAuth App
          • Kasm Storage Provider Config
          • OneDrive Storage Mapping Configuration
        • S3 Storage Provider Setup
          • Kasm Storage Provider Config
          • S3 Storage Mapping Configuration
        • Custom Storage Provider Setup
          • Create Storage Mapping
      • Troubleshooting
        • Failures to Provision Sessions
      • File Browser shortcuts (Bookmarks)
  • Host Configuration Guides
    • Using NFS
      • NFS Server Setup
      • NFS Client Setup
    • File Permissions and Isolation
• Configuration Import / Export
  • Exporting System Configurations
  • Importing System Configuration
  • Exporting Configuration Schema
  • Configuration Schema Versioning and Details
    • Alembic Version
    • All Users Group ID
    • Default Global Settings
    • Default Group Settings
  • Slip-Stream Install Configurations
    • Default Properties Pre-Processing
• Progressive Web App (PWA)
  • Requirements
    • Group setting
    • Secure connection
    • Valid installed JSON manifest
    • Icons
    • Installed service worker
• Workspace Registry
  • Video Tutorial
  • 1st Party Registry
  • 3rd Party Registry
  • Installing Workspaces
  • Configuration Warnings
  • Updates
  • Search and filter
  • Create your own workspace registry
    • Schema
  • Using workspace registries in Kasm
• Egress
  • Video tutorial
  • PureVPN Integration
  • Gateway Selection Behavior
  • Configuration
    • Creating Provider and Gateways
    • Assigning Provider and Credentials
  • Implementation
    • Troubleshooting
  • Managed Egress Providers
    • Egress Plugin System Info
    • Egress Plugin License Info
    • Managed Egress Provider Info
  • Forensics and Geolocation
• File Mappings
  • File Permissions and Ownership
    • Container Sessions
    • Windows Sessions
  • User Home Profile
    • Container Sessions
    • Windows Sessions
  • Volume Mappings
  • File Mapping Usage Examples
    • Mapping in a File to The User’s Desktop
    • Using File Mapping to Install and Enable Sudo
    • Using File Mapping to Clone a Repo and Start VScode
    • Using File Mapping to Change the Default Background of a Workspace
    • Using File Mapping to Apply a Custom KasmVNC Watermark
• Windows
  • Windows Overview
    • Supported Architectures
    • Licensing Restrictions
  • Kasm Desktop Service
    • System Requirements
    • Installation
      • Installation Troubleshooting
      • Scripted Installation
    • Optional Dependencies
    • SSL Certificates
    • Upgrade
    • Uninstall
    • Configuration
      • Uploads and Downloads on Multi-user Systems
      • Authentication of Service
    • Scripts
      • Builtin Scripts
      • Variables
    • Logging
    • Manage Registry Settings
  • Windows Authentication
    • Static Credentials
    • Prompt User
    • Single Sign-On with Static Local Accounts
    • Single Sign-On with Dynamic Local Accounts
    • Single Sign-on with Active Directory
    • SmartCard authentication
  • Fixed Servers
    • Server Pools
    • Servers
    • Workspace
    • Groups
  • Auto Scaled
    • Auto Scaling Pool
    • Auto Scale Configuration
    • VM Providers
      • Azure
      • AWS
      • VM Startup Scripts
      • Auto Join Active Directory
    • Workspace
  • RDS
    • Kasm Configuration
      • Desktops
      • RemoteApps
    • Group Policy Configurations
      • Remove Logout
      • Remove Disconnect Button
      • Auto logout
  • Auto-Opening RDP files for each Client OS
    • Windows
      • Google Chrome
      • Firefox
    • ChromeOS
      • Google Workspace configuration
    • MacOS