Settings
In the Settings section, you manage system-wide parameters and configurations that control the behavior of OpenVLE.
Here, administrators can define fundamental options such as system behavior or integrations with external services.
Where can I find this section?
Navigation:
Via main menu: System → Settings
Via main menu: System → Settings
Features at a glance
- Customization of global system settings and default values
- Management of SMTP, API, and SSO configurations
- Control of system behavior, e.g., logging options or data storage
- Editing of central UI or branding settings (title, contact information)
Important fields at a glance
| Field name | Description |
|---|---|
Data type | Indicates the expected type of the value. Supported data types are **string**, **integer**, **float**, **boolean**, and **json**. The data type is validated on save. This value cannot be changed. |
Description | Brief description of the meaning of the setting. Explains the purpose and possible effects of a change. This value cannot be changed. |
Setting | Identifier of the setting, e.g., "smtp.host" or "default.policy". Used for system-wide identification. This value cannot be changed. |
Value | The actual value of the setting. Can contain text, number, boolean, or JSON – depending on the respective parameter. |
Visibility | Determines who can see the setting. Allowed values are **admins**, **authenticated**, **internal**, or **public**. This value cannot be changed. |
Editing a setting
- Open the System → Settings section from the main menu.
- Search the list for the desired setting.
- Click Edit.
- The form displays all current data of the setting.
- Adjust the value as needed.
- Save the changes.
- Changes typically take effect immediately.
warning
Settings with the visibility internal cannot be edited.
Example or use case
Example: Changing the SMTP server
An administrator wants to update the default mail server for notifications. In
the System → Settings section, she searches for the entry with the key
smtp.host and enters the new hostname – e.g., mail.example.com. After
saving, all future emails will be sent through this server.
Notes / Special considerations
- Changes to settings take effect immediately across the entire system.
- Sensitive values such as API keys or passwords are partially masked for security reasons.
- Incorrect changes can cause unexpected behavior – please proceed with caution.
- Some configurations require a restart of services or workers after modification. This is indicated in the description of the setting.
- Values are stored persistently and are retained even after updates or restarts.
Required permissions
The permissions required for actions can be assigned via roles or individually. If you lack certain rights, the corresponding functions in the user interface are hidden or disabled.
| Action | Required permission | Path | Additional information |
|---|---|---|---|
| View system settings | system_read | / | |
| Update system settings | system_update | / |