Skip to main content
Version: v1.7.0-dev1 🚧

System Settings

Overview​

The System Settings page provides a centralized location for managing configuration parameters across Enterprise h2oGPTe. Use this page to:

  • Control global settings: Manage application-wide configuration parameters
  • Manage API keys: Create and manage API keys for programmatic access
  • Map custom config values to users: Override global settings for specific users
  • Map custom config values to roles: Override global settings for specific roles

Global settings are configured during Helm deployment and enforce maximum value limits. Many global settings can be overridden at the user or role level. Some settings are read-only and cannot be modified.

Important

All actions on the System Settings page require administrator privileges.

Access the System Settings page​

  1. In Enterprise h2oGPTe, click Account Circle.
  2. Select System Dashboard.
  3. In the Configuration section, click System settings.

System settings

Global Settings​

Global settings are application-wide configuration parameters organized by category: General, FEATURES, LIMITS, OAUTH, SECURITY, and SYSTEM. These settings are shown in a table format, organized by the following columns:

  • Setting: The configuration name
  • Value: The current setting value
  • Max Limit: The maximum allowed value (if applicable)
  • Overridable: Whether the setting can be overridden by users or roles (overridable means the setting can be customized at the user or role level)
  • Visibility: Whether the setting is Public or Private
  • Read-Write: Whether the setting can be modified

Global Settings - OAUTH, SECURITY, and SYSTEM categories

Add a global setting​

Only administrators can add global settings. Only settings that are overridable and not read-only can be added as new global settings.

  1. In the Global Settings section, click + New Setting.
  2. Select a setting from the dropdown.
  3. Enter a value for the setting. The value must not exceed the maximum limit specified for the setting.
  4. If applicable, configure overridable and visibility options.
  5. Click Submit.

If all available global settings have been configured, the + New Setting button is disabled and displays the message "All available global settings have been configured".

Global Settings - All configured

Edit a global setting​

Only administrators can edit global settings. Read-only settings cannot be edited.

  1. In the Global Settings table, locate the setting you want to modify.
  2. Click the Actions menu (three dots) for that setting.
  3. Select Edit.
  4. Update the value or other properties as needed. Ensure the value does not exceed the maximum limit.
  5. Click Submit.

Global Settings - All edits

Remove a global setting​

Only administrators can remove global settings.

  1. In the Global Settings table, locate the setting you want to remove.
  2. Click the Actions menu (three dots) for that setting.
  3. Select Delete.
  4. Confirm the deletion.
note

You cannot remove default global settings that are pre-configured by the system. You can only remove settings that were added manually.

User settings​

User settings allow you to override global settings for specific users. Only administrators can manage user settings.

View user settings​

  1. In the User Settings section, select a user from the User dropdown.
  2. View the list of settings configured for that user.

If no settings are configured, the message "Selected user has no settings" is displayed.

User Settings section

Add a user setting​

Only administrators can add user settings. A setting must exist in the global configuration and must be marked as overridable (can_overwrite = true) to be added as a user setting. The setting cannot be read-only.

  1. In the User Settings section, select the user from the User dropdown.
  2. Click + New Setting.
  3. Select a setting from the dropdown. Only overridable and non-read-only settings are available. The LLM Configuration setting (runtime_llms) is not available for user settings because it configures system-wide LLM models and must be managed at the global level only.
  4. Enter a value for the setting. The value must not exceed the maximum limit specified in the global configuration.
  5. Click Submit.

Add User Setting dialog

Edit a user setting​

Only administrators can edit user settings.

  1. In the User Settings table, locate the setting you want to modify.
  2. Click the Actions menu (three dots) for that setting.
  3. Select Edit.
  4. Update the value as needed. Ensure the value does not exceed the maximum limit specified in the global configuration.
  5. Click Submit.

Remove a user setting​

Only administrators can remove user settings.

  1. In the User Settings table, locate the setting you want to remove.
  2. Click the Actions menu (three dots) for that setting.
  3. Select Delete.
  4. Confirm the deletion.

Role Settings​

Role settings override global settings for specific roles. Role settings apply to all users assigned to that role. Only administrators can manage role settings.

View role settings​

  1. In the Role Settings section, select a role from the Role dropdown.
  2. View the list of settings configured for that role.

If no settings are configured, the message "No role settings found" is displayed.

Role Settings and API Keys sections

Add a role setting​

Only administrators can add role settings. A setting must exist in the global configuration and must be marked as overridable (can_overwrite = true) to be added as a role setting. The setting cannot be read-only.

  1. In the Role Settings section, select the role from the Role dropdown.
  2. Click + New Setting.
  3. Select a setting from the dropdown. Only overridable, non-read-only settings are available. The LLM Configuration setting (runtime_llms) is not available for role settings because it configures system-wide LLM models and must be managed at the global level only.
  4. Enter a value for the setting. The value must not exceed the maximum limit specified in the global configuration.
  5. Click Submit.

Add Role Setting dialog

Edit a role setting​

Only administrators can edit role settings. You must select a role before editing its settings.

  1. In the Role Settings table, locate the setting you want to modify.
  2. Click the Actions menu (three dots) for that setting.
  3. Select Edit. The LLM Configuration setting (runtime_llms) cannot be edited from role settings because it configures system-wide LLM models and must be managed at the global level only.
  4. Update the value as needed. Ensure the value does not exceed the maximum limit specified in the global configuration.
  5. Click Submit.

Remove a role setting​

Only administrators can remove role settings. You must select a role before removing its settings.

  1. In the Role Settings table, locate the setting you want to remove.
  2. Click the Actions menu (three dots) for that setting.
  3. Select Delete. The LLM Configuration setting (runtime_llms) cannot be deleted from role settings because it configures system-wide LLM models and must be managed at the global level only.
  4. Confirm the deletion.

API Keys​

The API Keys section provides an overview of all API keys in the system. API keys enable programmatic access to Enterprise h2oGPTe.

Only administrators can view and manage API keys for all users through the System Settings page.

View API keys​

  1. In the API Keys section, select a user from the User dropdown.
  2. View the table of API keys for that user.

The table displays:

  • Name: The API key name
  • Secret key: The masked secret key
  • Collection: The collection the key is restricted to (if applicable)
  • Created: When the key was created
  • Expiry Date: When the key expires (if set)
  • Status: Active or Inactive
  • Actions: Options to manage the key

API Keys table

Create an API key​

Only administrators can create API keys for users through the System Settings page.

  1. In the API Keys section, select the user from the User dropdown.
  2. Click + New API Key.
  3. Enter a key name.
  4. Optionally, restrict the key to a specific collection. The collection must be owned by the selected user.
  5. Optionally, enable expiry and set an expiration date. The expiration date must not exceed the global API key expiry limit.
  6. Click Generate new key.
  7. Copy and securely store the generated secret key.

Add API Key dialog

important

The secret key is displayed only once when the API key is created. Store it securely, as it cannot be retrieved later.

Manage API keys​

Only administrators can manage API keys through the System Settings page. Use the Actions menu (three dots) for each API key to:

  • Edit the key name or expiration date
  • Deactivate the key
  • Delete the key
  • Roles and Permissions - Learn how to manage roles and permissions in Enterprise h2oGPTe
  • APIs - Learn how to use API keys for programmatic access to Enterprise h2oGPTe

Feedback