Configure a home path

Configure a home path

The home path can be used to change the URL through which the Kadeck Teams UI and API are accessible.

In the default configuration, all endpoints are exposed via the host domain (e.g. localhost:80/). The home path parameter can be used to append another section to the address, e.g. localhost:80/kadeckteams/.
 

All endpoints are affected
Please note that changing the home path configuration will affect all endpoints, including live and readiness probes, health and metric endpoints, Websocket connections, and HTTP/HTTPS endpoints for both the Kadeck Teams interface and the backend API endpoints.

Configure home path

To change the home path to, e.g. "kadeckteams", you need to configure the parameter xeotek_kadeck_home and set its value to "kadeckteams". 
 
Deployment.yaml example:
[...]
env:
  - name: xeotek_kadeck_home
    value: "kadeckteams"
[...]

 

Docker command example:

docker run [...] -e xeotek_kadeck_home="kadeckteams" [...]

    • Related Articles

    • Configure LDAP Basic module

      Active Directory (AD) and OpenLDAP are supported to authenticate users. LDAP is only available to specific licenses. LDAP is configured via Startup Parameters with the prefix xeotek_kadeck_authentication_ldap. To enable LDAP, the ...

    • Configure OpenId authentication

      This guide outlines the process of setting up OpenID authentication in Kadeck. OpenID provides a secure and standardized way for users to authenticate across different platforms. Environment Variables Kadeck uses the following environment variables ...

    • Configure a Kadeck cluster setup

      This article describes how to configure multiple Kadeck instances that run as a cluster. Define master nodes First define a list of master nodes. In this example, we will configure 3 Kadeck instances running as a minimum (to handle 2 simultaneous ...

    • Startup parameters for Desktop

      You can pass any parameter to Kadeck's Java backend by adding them to the KA_DECK_OPTS environment variable. Windows cmd /c "SET KA_DECK_OPTS='-Xmx6G'&KaDeck.exe MacOS launchctl setenv KA_DECK_OPTS "-Xms6G" && open Kadeck.app/ Linux ...

    • Configure a database

      Kadeck requires a database for storing information. An external database such as H2 or PostgreSQL is recommended in a production environment. If no external database information is supplied, Kadeck will use an internal H2 file-based database. This is ...