Documentation

Contents
Contents
Contents
Contents

Config File Syntax

uberAgent’s configuration file supports several advanced syntax features.

Windows

ConfigInclude

A @ConfigInclude directive includes another configuration file. The other file is identified by name (without path) and must reside in the same directory as the configuration file including it. The additional platform parameter may be used to conditionally include a file on the selected platform (Windows or macOS). Platform matching is case-insensitive.

Examples:

#Include on all platforms
@ConfigInclude other-file.conf
# Include on Windows only
@ConfigInclude windows-specific.conf platform=Windows

PATH_REGEX

PATH_REGEX stands for a regex in which environment variables can be used. It is matched against a file system path. The following rules apply:

  • Environment variables (enclosed in percent signs, e.g., %ProgramFiles%) are expanded first, regex matching happens second.
  • Paths are specified as regular expressions.
  • Backslashes must be escaped by prepending a second backslash.
  • Matching is case-insensitive.
  • Specifying only the file name without the full path works but is not recommended.

Agents on All Operating Systems

PROCESS_NAME_REGEX

PROCESS_NAME_REGEX stands for a regex that is matched against a process name. The following rules apply:

  • Backslashes must be escaped by prepending a second backslash.
  • Matching is case-insensitive.
  • Only the file name is used for matching, not the full path.

URL_REGEX

URL_REGEX stands for a regex that is matched against a URL. The following rules apply:

  • Backslashes must be escaped by prepending a second backslash.
  • Matching is case-sensitive.

Format of the URLs matched against URL_REGEX:

  • Origin and path (without query segment), e.g.: https://uberagent.com/download/
  • Port numbers are stripped from the URL if they match the default port number.

Leave a Reply

Your email address will not be published. Required fields are marked *