First Run

To run SourceAgent open the command terminal, navigate to the bin folder in SourceAgent installation directory and run the command sa.exe setup on Windows, and sa.sh start on Linux or Mac OSX. The SourceAgent server will initiate.

Upon its first run, SourceAgent asks several questions to define server’s listening address and security settings.

Press Enter to accept the default settings, or customise as desired.

    user@host:~/sa> bin/sa.sh start
    Documentation: https://go.spectx.com/link/102
1   Service interface (host)                       [127.0.0.1]:
2   Service port (port)                            [8389]:
3   Enforce TLS (tls.enabled)                      [false]:
4   Disable API authentication (api.auth.disabled) [false]:
5   API auth key (api.auth.key)                    []:
6   Do you wish to add a mount point (y/N)?        [N]: y
    Mount point name                               : weblogs
    Mountpoint path (roots.logs.path)              []: /var/log/www
    Do you wish to add another mount point (y/N)?  [N]: n

    Configuration saved to /......./sa/conf/sa.conf

These questions define:

  1. Defines the IP address or hostname SourceAgent is hosted on. Default value is 127.0.0.1.
  2. Defines the port that SourceAgent is hosted on. Default value is 8389.
  3. Defines whether or not TLS must be enforced for all incoming connections. By default it is not enabled (false), and answering true makes the SourceAgent to enforce TLS with self-signed server certificate generated on startup. Use of permanent certificate can be configured later on in SourceAgent configuration file.
  4. Defines whether or not SourceAgent must restrict access to its API to authenticated users only. Default value is false, meaning the API authentication is enabled. In this case, an API access key must be specified.
  5. Defines the API access key. This key becomes a master key and allows users knowing it to access all defined containers. Configuring per-container access keys can be performed later on in SourceAgent configuration file.
  6. Allows to define a set of containers, or mount points, to be exposed through the API. Each mount point has a logical name it can be referred to in the API, and physical path in the local file system. If you do not change the default answer, SourceAgent will expose its logs directory with name “own” through the API. In the above example we’ve chosen to define a mount point which exposes content of directory “/var/log/www” under name “weblogs” through the API. Please note that specified directories must exist, and the account SourceAgent uses must have read access to its content.