On This Page

Home / Edge/ Set Up Cribl Edge/Configure Environment Variables

Configure Environment Variables

Configure environment variables to control Cribl Edge behavior.


The procedure for configuring environment variables depends on the operating system the Cribl Edge Node is deployed to.

Whenever you change environment variables, you must restart Cribl Edge on the affected Nodes.

For a full list of available variables, see Environment Variables.

Configure Environment Variables on Linux

Set Variables with systemd

If Cribl Edge runs as a systemd service, add environment variables to the systemd override file (for example, /etc/systemd/system/cribl-edge.service.d/override.conf) so they persist across restarts and upgrades.

  1. Open the override file for editing:

    sudo systemctl edit cribl-edge
  2. Add the variables under the [Service] section:

    override.conf
    [Service]
    Environment=CRIBL_NOEXEC=1
    Environment=HTTP_PROXY=http://proxy.example.com:3128
  3. Reload the systemd daemon and restart Cribl Edge:

    sudo systemctl daemon-reload
    sudo systemctl restart cribl-edge

For details on persisting overrides, see Persisting Overrides.

Set Variables Without systemd

If you are not using systemd, add export lines to a shell profile file (such as /etc/environment or the Cribl user’s ~/.bashrc) so they load on login:

export CRIBL_NOEXEC=1
export HTTP_PROXY=http://proxy.example.com:3128

Configure Environment Variables on Windows

Set Variables During Installation

You can configure environment variables while installing Cribl Edge on Windows using either the interactive wizard or a parameter for the MSI installer.

  • Wizard: In the setup wizard, in the Set Environment Variables modal, enter one variable per line. See Use the Wizard for more details.

  • MSI installer: When installing via MSI, use the SETENVVARS parameter with pipe-delimited key-value pairs. The entire string must be quoted:

    msiexec /qn /i cribl-<version>-<build>.msi ^
      SETENVVARS="HTTP_PROXY=http://203.0.113.1:8080|HTTPS_PROXY=http://203.0.113.1:8080" ^
      MODE=mode-managed-edge ^
      HOSTNAME=<yourhostname> ^
      PORT=4200 ^
      AUTH=myAuthToken ^
      FLEET=myfleet

    See Use the MSI Installer for the full syntax.

Set Variables After Installation

Environment variables specified during installation are stored in the Windows registry under HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\cribl under the Environment key.

To add or modify variables after installation, edit this registry key directly. See About Environment Variables for details.

Restart the Cribl Edge service for the changes to take effect.

Configure Environment Variables on macOS

Add Variables to the LaunchDaemon Plist

To define environment variables to a macOS deployment of Cribl Edge, you need to add them to the io.cribl.plist file.

  1. Open the Cribl plist file, for example: sudo vi /Library/LaunchDaemons/io.cribl.plist.

  2. Locate the EnvironmentVariables key and add your variable under it. For example, to define the NODE_EXTRA_CA_CERTS variable, add:

    <key>EnvironmentVariables</key>
    <dict>   
       <key>NODE_EXTRA_CA_CERTS</key>
       <string>path/to/cert/ca.pem</string>
       <!-- other keys --> 
    </dict>
  3. Reload the plist file by running:

    sudo launchctl unload /Library/LaunchDaemons/io.cribl.plist
    sudo launchctl load /Library/LaunchDaemons/io.cribl.plist

The environment variable added this way is retained when upgrading the Edge Node in a Fleet. However, if you upgrade via the bootstrap script, the plist file is replaced. In that case, re-add the environment variable.