Platform configuration

You can configure general settings from the Platform configuration view, including Single Sign-on (SSO), mail server, and data retention. Navigate to Administration > Tenant operations > Platform configuration to access this page.

General

General authentication parameters for JWT and external API authentication keys.

General NXLog Platform configuration settings
Table 1. General settings explained
Setting Description

SSO JWT signing key

The key for signing Single Sign-On JWT cookies. You must restart NXLog Platform to start using the new keys. See How NXLog Platform uses JSON Web Tokens for more information.

Clients JWT signing key

The key for signing client applications (e.g., the portal UI and agent management API) JWT cookies. You must restart NXLog Platform to start using the new keys. See How NXLog Platform uses JSON Web Tokens for more information.

External API Key

The key for authenticating machine-to-machine API calls.

Mail server

NXLog Platform sends automatic emails triggered by specific actions, such as user invites, password reset requests, and system alerts. NXLog Platform will use the mail server and account you configure here to send the emails. Without these settings, NXLog Platform will be unable to send automatic emails.

NXLog Platform mail server settings
Table 2. SMTP server settings explained
Setting Description

Host

The SMTP server’s URL.

Port

The SMTP server’s port.

Sender

The email address to use. Users will see NXLog Platform emails coming from this address.

Username

The user account name to use to authenticate to the SMTP server.

Password

The user account password to authenticate to the SMTP server.

Send test email

Sends an email to the email address configured in your user account.

Security

Configure settings related to One-Time Passcode (OTP) and password reset link lifetime.

NXLog Platform security settings
Table 3. Security settings explained
Setting Description

OTP lifetime (minutes)

The period a one-time password (OTP) is valid for in minutes. An OTP is sent to the user when they change their phone number, change their organization’s primary contact, delete their account, or delete an organization. The default is 1 minute.

OTP lifetime for account deletion (minutes)

This setting is not used and will be removed in a future version.

Reset password link lifetime (minutes)

The period the password reset link is valid for in minutes. The default is 1 hour.

Storage

Configure settings related to the log database backend and audit log retention.

NXLog Platform storage settings
Table 4. Storage settings explained
Setting Description

Default retention time (days)

The default data retention period. See Set data retention for further data retention settings.

Default retention time for Audit logs (days)

The default retention period for audit logs.

Max. retention time for Audit logs (days)

The maximum audit logs retention period in days.

Audit log email recipient

This setting is not currently in use.

Min. included storage space (GB)

This setting is not currently in use.

Max. storage space (GB)

This setting is not currently in use.