...

• Extract the downloaded archive file to a directory.
• After extraction the resulting directory structure includes (only files and folders immediately relevant):
  • agent 
    • license.gpl (copy of  GPLv3 (General Public License) )
    • license.html, license.txt (copy of JS7 JobScheduler Commercial License Agreement)
    • ThirdParty.txt (list of 3rd party components and licenses included with the JS7 Agent)
    • bin
      • agent.cmd|sh
        • The Start Script for Windows/Unix platforms
      • agent_credential_value.cmd|sh
        • The script for access to a credential store on Windows/Unix platforms
      • agent_instance.sh-example
        • The template for the Agent Instance Start Script
      • agent_watchdog.cmd|sh
        • Restarts the Agent for Windows/Unix platforms
    • lib (directory for Java libraries)
    • service (directory for operation as a Windows Service)
    • var (configuration directory)
      
      • config (directory for configuration files)
        • agent.conf (general Agent configuration) 
        • private (directory for security related configuration files)
          • private.conf-example  (security related configuration)
            • For setting up HTTPS connections see JS7 - Agent Configuration Items
            • For setting up authentication and digital signature checks 
      • logs (directory for log files)
      • tmp (directory for temporary files)
      • • • • checks
          • trusted-pgp-keys (empty directory, can be used to add individual PGP public keys for signing, see JS7 - Secure Deployment)
          • trusted-x509-keys (directory to hold X.509 certificates for signing, see JS7 - Secure Deployment)
            • sos.intermediate-ca.pem (default certificate of SOS to allow deployment with JOC Cockpit)
      • logs (directory for log files)
      • work (directory for work files)
    • yade (directory for the YADE yade (directory for the YADE file transfer utility)
  • On Windows Systems:
    • You have to modify the directory permissions for the above .\logs and .\service directories if you extracted the Agent to e.g. C:\Program Files.
      • This step is not required if you extract the Agent e.g. to C:\ProgamData.

      • Start a command prompt with elevated administrative rights and execute e.g.

        Code Block
        language bash title Allow full acces for "Users" on .\service and .\logs directories
        cd "path\to\installation-directory" icacls "service" /L /grant *S-1-5-32-545:(OI)(CI)F icacls "logs" /L /grant *S-1-5-32-545:(OI)(CI)F

  • If more than one run-time instance of an Agent starting from the same Agent installation is used then every instance has to use its individual ./var_<http-port of the instance> data directory, e.g. ./var_4445, ./var_4447 etc. as each Agent instance has to use an individual port when operated on the same server.
  • To start the Agent you can use the commands explained with the JS7 - Agent - Command Line Operation article or your can automate startup from the instructions provided by the below chapter "Automated Startup and Shutdown".

...

• When extracting files to a location that has already been used then existing files with the same name will be overwritten. Files added by the user will remain in place.
  • This is particularly true for the Agent Start Script ./bin/agent.sh|cmd, which should not be modified by users. Instead, apply changes to a new Agent Instance Start Script file  ./bin/agent_<http-port>.sh|cmd. This script is used to configure a number of environment variables and before executing the Agent Start Script.
• The .tar.gz/.zip archive includes Java libraries in the ./lib directory that ship with file names that are unique to every Agent release.
  • Therefore, before extracting files, rename or remove an existing ./lib directory in order to store libraries from the current Agent release only in this directory.

Example for Installation from the Unix Command Line

The Agent is installed with a few straightforward commands:

# download archive (consider to use a current release that matches the Controller release)
curl  'https://download.sos-berlin.com/JobScheduler.2.1/js7_agent_unix.2.1.0.tar.gz' --output js7_agent_unix.2.1.0.tar.gz

# extract archive
tar xvzf js7_agent_unix.2.1.0.tar.gz

# find extracted files in the "agent" sub-directory
ls -la agent

# prepare an instance start script from the example
cd agent/bin
cp -p agent_instance.sh-example agent_4445.sh

# optionally activate/adjust environment variables in agent_4445.sh
# JS7_AGENT_HTTP_PORT=4445
# JAVA_HOME=...

# run the Agent
./agent_4445.sh start

Installation using the Windows Installer in Headless Mode

...