...

• Extract the downloaded archive file to a directory.
• The resulting directory structure includes (only files and folders immediately relevant):
  • agent 
    • bin
      • agent.cmd|sh
        • The Start Script for Windows/Unix platforms
      • agent_watchdog.cmd|sh
        • The Start Script for Restarts the Agent for Windows/Unix platforms
      • agent_instance.sh-example
        • The template for the Agent Instance Start Script
    • lib
      • The directory for Java libraries
    • var
      
      • logs
        • The directory for log files
      • config/private
        • For setting up HTTPS connections see JS7 - Agent Configuration Items
      • tmp
        • The directory for temporary files
    • yade
      • For use of the YADE file transfer utility
    • service
      • For operation as a Windows Service
  • 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 extracted extract the Agent to 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 multiple run-time instances of an Agent starting from the same Agent installation are used then every instance must have its own ./var_<port of the instance> data directory, e.g. ./var_4445, ./var_4447 etc.

...

• Stop the JS7 Agent instance.
• Prepare to rollback in case that the update of the JS7 Agent is not successful:
  • Take a backup of the Agent's installation directory and configuration directory, e.g. by creating a .tar.gz/.zip archive.
    • Installation Directory:
      • The default installation directory for the Agent is

        • /opt/sos-berlin.com/js7/agent on for Unix systems,

        • C:\Program Files\sos-berlin.com\js7\agent on for Windows systems.
    • Configuration Directory
      • The default configuration directory for the Agent is
        • /home/<user-account>/sos-berlin.com/js7/agent_<port> on for Unix systems,
        • C:\ProgramData\sos-berlin.com\js7\agent_<port> on for Windows systems.

Running the Update

...

• When extracting files to the same location then existing files with the same name will be overwritten. Files added by the user remain in place.
  • This is particularly true for the Agent Start Script ./bin/agent.sh|cmd that should not be modified by users. Instead, apply changes to a new Agent Instance Start Script file  ./bin/agent_<port>.sh|cmd. This script is used to configure a number of environment variables and to finally execute the Agent Start Script.
• The tarball/zip archive includes Java libraries in the ./lib directory that ship with unique file names per 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 to this directory.

Installation from Windows Installer in Headless Mode

...

Steps to run the installer are the same as explained for a fresh installation.

Rollback

Rollback

...

from tarball/zip Archive Installation

• To rollback the installation of a JS7 Agent instance on Unix remove the newly created installation directory and configuration directory of the JS7 Agent.
• Restore the directories from a previous backup, e.g. by extracting the respective .tar.gz/.zip backup archives to the installation directory and configuration directory.

Rollback

...

from Installation with Headless Installer for Windows

• To perform the rollback of a JS7 Agent installation run the uninstaller from the command line.
  • The default location of the uninstall.cmd file is:
    
    • C:\Program Files\sos-berlin.com\js7\agent\Uninstaller on Windows.Uninstaller
• Restore from a previous backup, e.g. by extracting the .tar.gz/.zip archive to the installation directory and configuration directory.
• Re-install the Windows Service from the command line:
  • Switch to the ./\bin directory of the Agent installation.
    • The default location of the ./\bin directory is:
      

      • C:\Program Files\sos-berlin.com\js7\agent\bin on Windows.bin

  • Run the below command that installs the Agent's Windows Service:

    agent.cmd install-service [--http-port=<number>] [--ip-address=<hostname or ip address>]

...