Server Settings¶
Server settings are settings that are global, as opposed to those that are per user group. They can be found in the Settings tab on the left side of the Administrative Web UI. A change to a global setting requires restarting the Kasm serices.
cd /opt/kasm/bin
./stop
./start
public_hostname |
The IP or DNS name of the Admin API Server. |
enable_kasm_auth |
Require client requests to the Kasm for content such as downloads and uploads to be authenticated with the user’s current session token. |
max_login_attempts |
The number of invalid login attempts before an account is locked out. This setting only applies to local accounts. |
session_lifetime |
The number of seconds a session token is valid for. |
kasm_auth_domain |
Override the domain used in the Kasm session cookie. |
host_dead_expiration |
The number of seconds since an Agent’s last check-in before marking it as dead. Dead servers are automatically destroyed if they were dynamically provisioned. |
guardian_interval |
The number of seconds between the Manager API inspection of existing Agent, and Kasm availability. |
guardian_provision_threads |
The number of threads the Manager API server uses for teardown and provision tasks. |
min_slot_buffer |
The minimum amount of free slots that should be available before the Manager attemts to automatically provision more agents. This setting only takes effect if dynamic provisioning modules are installed and enabled. |
host_missing_expiration |
The number of seconds since an Agent’s last check-in before marking it as dead. |
max_kasms_per_user |
The maximum number of simultaneous Kasms a users is allowed to provision. |
keepalive_expiration |
Clients regularly send keepalive requests when logged into a Kasm. This value is the number of seconds a Kasm will remain active after the last keepalive is received. |
proxy_hostname |
The IP or DNS name used in the url for proxied connections to the Kasm i.e (https://:/) . This setting only applies if proxy_connections is set to true. |
cert_in |
The nginx cert will be read from this location on the Manager API server when automatically provisioning Agents. |
cert_out |
The nginx cert will be placed at this directory path for automatically provisioned Agents |
proxy_port |
The Port used in the proxied connection url. i.e (https://:/) . This setting only applies if proxy_connections is set to true. |
key_in |
The nginx key will be read from this location on the Manager API server when automatically provisioning Agents. |
proxy_path |
The url path used in the proxied connections. i.e (https://:/) . This setting only applies if proxy_connections is set to true. |
proxy_connections |
When creating a Kasm, instruct the client to connect to the Kasm via another proxy server. When false, the client connects directly to the Kasm via the Agent’s address. |
key_out |
The nginx key will be placed at this directory path for automatically provisioned Agents. |
public_hostname |
The IP or DNS name of the Manager API Server. This address will be used by Kasm services or Kasms to communicate. |
primary_manager_timeout |
The number of seconds until the primary manager is considered unavailable. If other managers are alive one will take over the primary role. |
token |
An authentication token used the communication between Kasm Agents and the Manager API server. |
agent_version |
This setting is used to restrict which versions of the Kasm Agent are allowed to communicate with the Manager. |
public_hostname |
The IP or DNS name of the client API server. This address will be used by Kasm services or Kasms to communicate. |
default_image_memory_gb |
When dynamic agent provisioning is enabled, this system calculates the number of Kasms that could be provisioned at the time. This setting represents the Image memory, in gigabytes, used during the calculation. |
default_image_cores |
When dynamic agent provisioning is enabled, this system calculates the number of Kasms that could be provisioned at the time. This setting represents the Image cores that should be used during the calculation. |
login_assistance |
Enables a Login Assitance link on the login page to the entered URL. Not shown if value is None. |
notice_message |
Login notice banner message. |
Setting Properties¶
Name |
Setting name |
Category |
Setting Category |
Services Restart |
What services need to be restarted on setting change |
Value |
Settings Actual Value |
Value Type |
Data Type |
Description |
Setting Description |