Installing

The SourceAgent does not require any special permissions on a system and can thus be run in standard user privileges. On the file system level, though, the account SourceAgent uses must have list and read access to all items in directories defined as containers (mount points), and must have full control over SourceAgent installation directory.

Please follow the installation steps below.

Advanced settings such as how to configure the listening port, local access, and logging are covered in configuration section.

Linux and Mac OSX

The following steps must be performed for installing SourceAgent on Linux, Arch Linux ARM or Mac OSX.

1
2
3
4
user@host:~$
user@host:~$ tar -zxf sa-v{version}-{platform}.tar.gz
user@host:~$ cd sa
user@host:~/sa$ bin/sa.sh start
  1. Download SourceAgent for your platform (linux64, aarch64 or osx64).

  2. Open the command-line and unpack the compressed file.

  3. Navigate to the unpacked directory sa/. It has the following layout:

    ./
    └── sa/
        ├── api/                        : SourceAgent API documentation
        ├── bin/
        │   ├── sa.sh                   : script for launching SourceAgent from commandline
        │   └── sa.env.sh.default       : default env variable definitions template
        ├── conf/
        │   └── sa.conf.default         : default configuration template
        ├── jre/                        : Java runtime (is present only in platform-specific builds)
        └── lib/                        : SourceAgent binaries
    
  4. Start the background server by executing SourceAgent startup script bin/sa.sh start.

  5. Upon its first run, SourceAgent will ask several questions to define api authentication parameters and network settings. Configuration settings and defaults can be found in First Run.

During the first run, SourceAgent creates its configuration file conf/sa.conf based on the content of configuration template file conf/sa.conf.default and the user input provided to configuration questions. It also creates environment variables definition file bin/sa.env.sh based on template file bin/sa.env.sh.default. Also, it creates directory logs/ for own logs. The layout of the sa/ directory becomes as follows:

./
└── sa/
    ├── api/                         : SourceAgent API documentation
    ├── bin/
    │   ├── sa.sh                    : script for launching SourceAgent from commandline
    │   ├── sa.env.sh                : copied from sa.env.sh.default template on first run
    │   └── sa.env.sh.default        : default env variable definitions template
    ├── conf/
    │   ├── sa.conf                  : created from sa.conf.default template on first run
    │   └── sa.conf.default          : default configuration template
    ├── jre/                         : Java runtime (is present only in platform-specific builds)
    ├── lib/                         : SourceAgent binaries
    └── logs/                        : SourceAgent logs

Note that the files conf/sa.conf and bin/sa.env.sh will not be modified or deleted during upgrades in the future.

Windows

The following steps must be performed for installing SourceAgent on Microsoft Windows.

  1. Download SourceAgent for Windows.

  2. Unpack the file sa-v{version}-win64.zip.

  3. Open the command line and navigate to the unpacked directory sa\. It has the following layout:

    .\
    └── sa\
        ├── api\                         : SourceAgent API documentation
        ├── bin\
        │   ├── sa.exe                   : SourceAgent's service launcher
        │   └── sa.exe.vmoptions.default : system properties definitions template
        ├── conf\
        │   └── sa.conf.win.default      : default configuration template
        ├── jre\                         : Java runtime (is present only in platform-specific builds)
        └── lib\                         : SourceAgent binaries
    
  4. Start the SourceAgent server in foreground by executing bin\sa.exe run, or install and start it as a Windows service by executing bin\sa.exe setup.

  5. Upon its first run, SourceAgent will ask several questions to define user access and privileges, network, and cache settings, and password for default admin user. Configuration settings and defaults can be found in First Run.

During the first run, SourceAgent creates its configuration file conf\sa.conf based on the content of configuration template file conf\sa.conf.win.default and the user input provided to configuration questions. It also creates system properties definition file bin\sa.exe.vmoptions based on template file bin\sa.exe.vmoptions.default. This file is used for SourceAgent’s java process initialization. Also, it creates directory logs\ for own logs. The layout of the sa\ directory becomes as follows:

.\
└── sa\
    ├── api\                         : SourceAgent API documentation
    ├── bin\
    │   ├── sa.exe                   : SourceAgent's service launcher
    │   ├── sa.exe.vmoptions         : copied from sa.exe.vmoptions.default template on first run
    │   └── sa.exe.vmoptions.default : system properties definitions template
    ├── conf\
    │   ├── sa.conf                  : created from sa.conf.default template on first run
    │   └── sa.conf.win.default      : default configuration template
    ├── jre\                         : Java runtime (is present only in platform-specific builds)
    ├── lib\                         : SourceAgent binaries
    └── logs\                        : SourceAgent logs

Note that the files conf\sa.conf and bin\sa.exe.vmoptions will not be modified or deleted during upgrades in the future.