Page History
...
- First of all, you don't need to read this article in all its parts. For most situations it is sufficient to check the prerequisites, download the software and run the installer that will guide you.
- In this article you find the details about available installer options, updates and rollback for interested parties.
- The Controller can be installed by use of the graphical installer, for headless installation see JS7 - Controller - Headless Installation on Linux /and Windows.
Prerequisites
- A Java Runtime Environment 1.8 or newer is required. For details see Which Java versions is JobScheduler available for?
- It is required to operate necessary that a time service is operated on the server that which hosts the Controller in order . This is to synchronize the system clock's time.
- Technically the Controller can be operated in any Unix environment. HoweverNote, however, that the JS7 - Platforms include article describes support for Controller operation with Linuxin more detail.
Download
- Choose Select the Controller archive for Windows systems and the graphical installer from the JS7 - Download page.
- For On Windows systems a .zip archive including the installer is available from
js7_controller_windows_installer.<release>.zip
.
...
The installer can be run in graphical mode or in headless mode, see JS7 - Controller - Headless Installation on Linux /and Windows.
- The installer asks for elevated administrative privileges, therefore it is not required to change the permissions in the
.\service
directory and the installer sets read/write permissions for the.\logs
directory. - After the installation you will find
- a Windows Service "
SOS JS7 Controller -id=<controller-id>
" - an executable file
.\service\
js7_controller_<controller-id>.exe
that is started by the Windows Service.
- a Windows Service "
...
Run the installer for the JS7 Controller using the following script:
Code Block language bash title Windows command to run the graphical installer > C:\Temp\controller.<release>\setup.cmd
- The installer asks for administrative privileges.
- Select the language to be used for the setup: English, Japanese and German are available.
...
- The resulting directory structure after installation includes (only files and folders immediately relevant):
C:\Program Files\sos-berlin.com\js7\controller
(installation directory).js7controllerinstallinformation
(binary installer information).version
(release informationvar
(symbolic link to configuration directory)controller_install.xml
(installer response file used for from previous installation)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
(copy of JS7 JobScheduler Commercial License Agreementplain 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 included with the used by JS7 Controller).version
(release- information
var
(junction to data directory) bin
anonymize-logs.cmd
(used to anonymize log files, see JS7 - Log Anonymization)controller.cmd
(Start Script)controller.cmd|sh
The Start Script for Windows/Unix platformscontroller_instance.cmd|sh-example
example
(Sample Instance Start Script to set individual environment variables. Drop the-example
extension to activate this file.)controller_watchdog.cmd|sh
Restartscmd
(restarts the Controller for Windows/Unix platforms.if not operated as a Windows Service, called by Start Script)
lib
(directory for Java libraries)log4j2.xml
(used for based console logging to stdout, see JS7 - Logging)patches
(used for JS7 - Patches for Controller, the directory is cleaned up when running the installer)user_lib (
used for licensed binary code, see JS7 - How to apply a JS7 License Key)- (additional directories for Java libraries)
service
(directory for operation as a Windows Service)install_controller_windows_service.cmdcmd
(used by installer)js7_controller_<controller-id>.exe
js7_controller_<controller-id>w.exe
LICENSE.txt.txt
(copy of Apache License, Version 2.0)NOTICE.txttxt
(Apache Commons Daemon license notice)RELEASE-NOTES.txttxt
(Apache Commons Daemon release notes)uninstall_controller_windows_service.cmdcmd
(used by uninstaller)amd64
manager
x86
Uninstaller
(Uninstaller directory for Windows only, the empty directory remains in place after uninstall)install.log
(lists installed files)js7.ico
(uninstaller icon)shortcut.vbs
(creates shortcuts for the Windows start menu)uninstall.cmd
(used by uninstaller)uninstall_prepare.cmdcmd
(used by uninstaller)uninstaller.jarjar
(used by uninstaller)
C:\ProgramData\sos-berlin.com\js7\controller
(configuration directory)
var
(data directory)
controller_home
(symbolic link junction to installation directory)config
(directory for configuration files)controller.conf
(general Controller configuration, see JS7 - Controller Configuration Items)lib
(optional directory for licensed binary code)license
(optional directory for license certificate files)private
(directory for security related configuration files)private.conf-example
(security related configuration, see JS7 - Controller Configuration Items)- For setting up HTTPS connections see up JS7 - Controller Configuration ItemsHTTPS Connections
- For setting up authentication and digital signature checks
trusted-pgp-keys
(empty directory, can be used to add individual PGP public keys for signing, see JS7 - Secure Deployment of Scheduling Objects)trusted-x509-keys
(directory to hold X.509 certificates for signing, see JS7 - Secure Deployment of Scheduling Objects)sos.intermediate-ca.pem
(default certificate of SOS to allow deployment with JOC Cockpit)
logs
(directory for log files)state
(directory for journal files)work
(directory for work files)
Rollback
To perform a rollback on Windows systems follow the below steps:
...
- Consider use of the
JS7_CONTROLLER_USER
environment variable from the./bin/controller_instance.sh
script to run a Controller that is started byroot
for a different user account. - For use with
systemd
find a sample service file from./bin/controller.service-example
. - For details see JS7 - systemd Service Files for automated Startup / and Shutdown with Unix Systems
For Windows systems operation of the Controller by a Windows Service is recommended as such services can be configured to start/stop automatically on server startup and shutdown.
...
Further References
- Installation
- Operation
- Configuration
...
Overview
Content Tools