To run SourceAgent open the command terminal, navigate to the
bin folder in SourceAgent installation directory and
run the file “sa.bat” on Windows, and “sa.sh” 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.
Enter to accept the default settings, or customise as desired.
1 2 3 4 5 6 7 8 9
user@host:~/sa> bin/sa.sh start Documentation: https://go.spectx.com/link/102 Service interface (host) [127.0.0.1]: Service port (port) : Enforce TLS (tls.enabled) [false]: Disable API authentication (api.auth.disabled) [false]: API auth key (api.auth.key) : Configuration saved to /......./sa/conf/sa.conf
These questions define:
- Defines the IP address or hostname SourceAgent is hosted on. Default value is
- Defines the port that SourceAgent is hosted on. Default value is
- Defines whether o not TLS must be enforced for all incoming connections. By default it is not enabled (
false), and answering
truemakes 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.
- 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. This key becomes a master key and allows users knowing it to access all containers. Configuring per-container access keys can be performed later on in SourceAgent configuration file.