Versions Compared

Key

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

...

  • Download the Controller archive for the target system from the JS7 - Download page.
    • For Unix systems:
      • A tarball archive is available that is extracted to create the Controller's directory structure (see below).
        • js7_controller_unix.<release>.tar.gz
    • For Windows systems:
      • A .zip archive is available that is extracted to create the Controller's directory structure (see below).
        • js7_controller_windows.<release>.zip
      • A .zip archive including the installer is available that is used to run the installer in headless mode.
        • js7_controller_windows_installer.<release>.zip

Installation from

...

.tar.gz/.zip Archive

Installation

  • Extract the downloaded archive to a directory.
  • The After extraction the resulting directory structure includes (only files and folders directly relevant):
    • controller
      • bin
        • controller.cmd|sh
          • The Start Script for Windows/Unix platforms
        • controller_watchdog.cmd|sh
          • Restarts the Controller for Windows/Unix platforms
        • environment_variables.cmd|sh
          • Environment Startup Script for the JS7 Controller
      • lib
        • The directory for Java libraries
      • service (for operation as a Windows Service)
        • amd64 (directory)
        • manager (directory)
        • x86 (directory)
        • install_controller_windows_service.cmd
        • js7_controller_<Controller ID>.exe
        • js7_controller_<Controller ID>w.exe
        • LICENSE.txt
        • NOTICE.txt
        • RELEASE-NOTES.txt
        • set_java_home_for_jetty_windows_service.cmd
        • uninstall_controller_windows_service.cmd
      • user_bin
          Uninstaller (Windows only, the empty directory remains in place after uninstall)
          • environment_variables.cmd|sh-example 
            • Sample configuration file to set individual environment variables. Drop the -example extension to activate this file.
          • install.log
          • js7.ico
          • shortcut.vbs
          • uninstall.cmd
          • uninstall_prepare.cmd
          • uninstaller.jar
        • var
          • logs
          • config
          • state
      • On Windows Systems:
        • You have to modify the directory permissions for the above .\logs and .\service directories if you extracted extract the Controller to e.g. 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 e.g.

            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 

    ...

    • The controller_install.xml file is explained with the code listing below. The comments included are intended to be self-explanatory.
      Download: controller_install.xml

      Code Block
      languagexml
      titleConfiguration of the controller_install.xml file
      linenumberstrue
      collapsetrue
      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
      <!-- 
      XML rseponseresponse file for JS7 Controller setup
      
      The JS7 Controller is available with a dual license model:
      - GNU GPL v3.0 License, see https://www.gnu.org/licenses/gpl-3.0.en.html
      - JS7 Commercial License, see license.txt
      
      The setup asks you for the desired license model,
      see below <entry key="licenceOptions" .../>
      
      If you run the installer and do not specify a commercial license key
      then at the same time you accept the terms of the
      licence agreement under the GNU GPL v3.0 License.
      -->
      <AutomatedInstallation langpack="eng">
          <com.izforge.izpack.panels.UserInputPanel id="home">
              <userInput/>
          </com.izforge.izpack.panels.UserInputPanel>
          <!--com.izforge.izpack.panels.UserInputPanel id="licences">
              <userInput-->
              
                  <!-- Select the license model (GPL or Commercial) -->
                  <!--entry key="licenceOptions" value="GPL"/-->
                  
                  <!-- If you select 'GPL' as the license model than the licence must be empty.
                       Otherwise please add a license file if available.
                       It is also possible to add the license file later. -->
                  <!--entry key="licence" value=""/>
                  
              </userInput>
          </com.izforge.izpack.panels.UserInputPanel-->
          <com.izforge.izpack.panels.HTMLLicencePanel id="gpl_licence"/>
          <com.izforge.izpack.panels.HTMLLicencePanel id="commercial_licence"/>
          <com.izforge.izpack.panels.TargetPanel id="target">
              
              <!-- SELECT THE INSTALLATION PATH
                   The installer expands this path with the JS7 Controller ID as a sub-directory.
                   The path must be absolute!
                   The default path is C:\Program Files\sos-berlin.com\js7\controller -->
              <installpath>C:\Program Files\sos-berlin.com\js7\controller</installpath>
              
          </com.izforge.izpack.panels.TargetPanel>
          <com.izforge.izpack.panels.UserPathPanel id="userpath">
              
              <!-- SELECT THE DIRECTORY FOR CONFIGURATION FILES AND LOG FILES
                   The installer expands this path with the JS7 Controller ID as a sub-directory.
                   The path must be absolute!
                   The default path is C:\ProgramData\sos-berlin.com\js7\controller -->
              <UserPathPanelElement>C:\ProgramData\sos-berlin.com\js7\controller</UserPathPanelElement>
              
          </com.izforge.izpack.panels.UserPathPanel>
          <com.izforge.izpack.panels.UserInputPanel id="network">
              <userInput>
              
                  <!-- ID of the JS7 Controller -->
                  <entry key="controllerId" value="controller"/>
                  
                  <!-- Choose 'yes' if the JS7 Controller instance is a standby Controller instance in a cluster -->
                  <entry key="isStandby" value="no"/>
                  
                  <!-- Choose 'yes' or 'no' whether the JS7 Controller should be started after installation -->
                  <entry key="launchController" value="yes"/>
                  
                  <!-- HTTP port of the JS7 Controller -->
                  <entry key="controllerPort" value="4444"/>
                  
                  <!-- Optionally specify an IP address or hostname that is used to indicate which network 
                       interface the JS7 Controller should listen to when using HTTP. If empty then 
                       the Controller listens to any available network interfaces. -->
                  <entry key="controllerHost" value=""/>
                  
                  <!-- The JS7 Controller will be installed as a Windows Service. You can set the service
                       account otherwise the local system account will be used. The account has to be
                       specified according to the pattern 'Domain\User'. -->
                  <entry key="serviceAccount" value=""/>
                  <entry key="servicePassword" value=""/>
                  
              </userInput>
          </com.izforge.izpack.panels.UserInputPanel>
          <com.izforge.izpack.panels.UserInputPanel id="environment">
              <userInput>
      
                  <!-- Directory where the JS7 Controller's log files are stored 
                       (default: '[above configuration path]\logs'). -->
                  <entry key="logPath" value=""/>
                  
                  <!-- Directory where the JS7 Controller's PID file is stored 
                       (default: above log path). -->
                  <entry key="pidFilePath" value=""/>
                  
                  <!-- Working directory for the JS7 Controller
                       e.g. %USERPROFILE% (default: [installation path]) -->
                  <entry key="workPath" value=""/>
                  
                  <!-- The JS7 Controller requires a Java JRE minimum version '1.8'. You can choose 
                       a different Java environment than the Java used during installation. -->
                  <entry key="javaHome" value=""/>
                  
                  <!-- Optionally specify Java options (default: -Xmx500m). -->
                  <entry key="javaOptions" value=""/>
                  
              </userInput>
          </com.izforge.izpack.panels.UserInputPanel>
          <com.izforge.izpack.panels.UserInputPanel id="end">
              <userInput/>
          </com.izforge.izpack.panels.UserInputPanel>
          <com.izforge.izpack.panels.InstallPanel id="install"/>
          <com.izforge.izpack.panels.ProcessPanel id="process"/>
          <com.izforge.izpack.panels.FinishPanel id="finish"/>
      </AutomatedInstallation>

    ...