Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Extract the downloaded archive to a directory.
  • After extraction the resulting directory structure will include (only files and folders immediately relevant):
    • controller
      • license.gpl (copy of  GPLv3 (General Public License) used for the Open Source JS7 - License)
      • license.html (HTML format of license terms for the commercial JS7 - License)
      • license.txt (plain text format of license terms for the commercial JS7 - License)
      • sbom.json (JS7 - Software Bill of Materials)
      • ThirdParty.txt (list of 3rd party components and licenses used by JS7)
      • .version (release information)
      • bin
        • anonymize-logs.sh|.cmd (used to anonymize log files, see JS7 - Log Anonymization)
        • controller.sh|.cmd (Start Script for Unix/Windows platforms)
        • controller.service-example (sample file for use with JS7 - systemd Service Files for automated Startup and Shutdown with Unix Systems)
        • controller_instance.sh|.cmd-example (Sample Instance Start Script to set individual environment variables. Drop the -example extension to activate this file.)
        • controller_watchdog.sh|.cmd (restarts the Controller on Unix/Windows platforms if not operated as a Daemon/Service, called by Start Script)
      • lib (directory for Java libraries)
      • service (directory for operation as a Windows Service)
        • install_controller_windows_service.cmd (used by installer)
        • LICENSE.txt (copy of Apache License, Version 2.0)
        • NOTICE.txt (Apache Commons Daemon license notice)
        • RELEASE-NOTES.txt (Apache Commons Daemon release notes)
        • uninstall_controller_windows_service.cmd (used by uninstaller)
        • amd64
        • manager
        • x86
      • var (data directory)
        • config (directory for configuration files)
        • logs (directory for log files)
        • state (directory for journal files)
        • work (directory for work files)
  • On Windows Systems:
    • You have to modify the directory permissions for the above-mentioned .\logs and .\service directories if you extract the Controller to, for example: C:\Program Files.
      • This step is not required if you extract the Controller e.g. to C:\ProgamData.
      • Start a command prompt with elevated administrative rights and execute, for example:

        Code Block
        languagebash
        titleAllow 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
  • To start the Controller you can use the commands described in the JS7 - Controller - Command Line Operation article or your can automate startup using the instructions provided by the "Automated Startup and Shutdown" section below.

...