New: Cybus Helm Charts 3.0.0.
Learn more.
Ctrlk
Contact Uscybus.io
For the complete documentation index, see llms.txt. This page is also available as Markdown.

User Session Expiration

Configure how long user sessions remain valid before re-authentication is required.

You can configure the session expiration time to determine how long a user stays signed in before a new login is required. When the session is close to expiring, the Admin UI shows a ten minute countdown in the top right corner and users receive a warning message.

Session Expiration Parameters

You can set the session expiration time through the following parameters. The parameter differs between Kubernetes and Docker deployments.

Kubernetes Parameter

Parameter
Description
Default

global.authentication.tokenExpiryHours

Defines how long (in hours) a user stays signed in before being logged out for security reasons. After the configured time has passed, the user session expires and a new login is required. The Admin UI displays a ten-minute countdown in the top right corner, and users receives a warning ten minutes before the session ends.

12

Docker Parameter

Parameter
Description
Default

CYBUS_AUTH_TOKEN_EXPIRE_TIME_IN_HOURS

Defines how long (in hours) a user stays signed in before being logged out for security reasons. After the configured time has passed, the user session expires and a new login is required. The Admin UI displays a ten-minute countdown in the top right corner, and users receives a warning ten minutes before the session ends. If the variable is not set, or if the value is negative or not a valid number, the system uses the default duration of 12 hours.

12

Setting the Session Expiration Time

You can adjust the session duration by modifying the corresponding parameter for your deployment.

Changing the Session Expiration Time (Kubernetes)

  1. Open the values.yaml file.

  2. Set the global.authentication.tokenExpiryHours Helm value to the desired number of hours.

global:
  authentication:
    tokenExpiryHours: 8

  1. Upgrade your Helm chart to apply the Helm configuration changes. For details, see Applying Helm Configuration Changes.

Changing the Session Expiration Time (Docker)

If the configured value is invalid (e.g. negative or not a valid number), the system reverts to the default duration of twelve hours.

  1. Navigate to your Connectware installation directory. The default installation directory is /opt/connectware. This directory contains the .env file used when starting Connectware.

  2. Open the docker-compose.yml file.

  3. Set the CYBUS_AUTH_TOKEN_EXPIRE_TIME_IN_HOURS environment variable to the desired number of hours.

environment:
  - CYBUS_AUTH_TOKEN_EXPIRE_TIME_IN_HOURS=8

  1. Start or restart Connectware. For details, see Restarting Connectware.

PreviousDefault Admin UserNextRoles

Last updated

Was this helpful?