Skip to content

Configuration

Lynx AI Agent should be configured before it's used for the first time. The agent can be configured either through the Splunk Web UI or by editing the configuration files directly.

Note

Also applies for Search-Head Cluster deployment. Configuring on one server is sufficient, it'll be replicated to all other members.

  1. Navigate to Apps > Lynx AI Agent for Splunk.
  2. On the setup page, fill in:
    • License key: UUID that authenticates with the Lynx AI backend.
    • Backend server: Defaults to api.lynxai.dev.
    • Backend schema: Defaults to https.
  3. Click Complete Setup.

Tip

You can access the setup page again at any time by navigating in Splunk to:

/app/lynx_ai_agent/setup_page_dashboard

This is hidden from normal navigation but can be accessed again by using the URL directly.

Setup from configuration files

Note

Also applies for Search-Head Cluster deployment. Configure the app on the Deployer and apply the bundle.

While configuration via files is supported, UI configuration is recommended. To access the setup page after initial configuration, set is_configured = 0 in local/ai.conf and reload the app:

[install]
is_configured = 0

See ai.conf for advanced configuration options.

  1. Navigate to $SPLUNK_HOME/etc/apps/lynx_ai_agent.
  2. Create local/ai.conf with the following configuration:

    [install]
    is_configured = 1
    

    For air-gapped environments, add the backend server configuration:

    [backend]
    schema = https
    server = example.com:3000
    

  3. Create local/passwords.conf and configure the license key. See passwords.conf.

  4. Restart Splunk with $SPLUNK_HOME/bin/splunk restart.

Warning

Passwords set manually will not be encrypted by the Splunk instance. Use the UI for proper encryption.