Versions Compared

Key

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

...

  • 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, to download the software and to 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/Windows.

...

...

  • Choose the configuration directory for the Controller to which you want to store the Controller's configuration files and journal files.

Installation Settings

  • With In the next window specify the Controller ID that , which is a unique identifier for a Controller, is specified. You can use identifiers such as "controller-test", "controller-production" etc. Upper case and lower case characters are consideredCharacter case is significant, the characters a-z, A-Z, 0-9, underscore and hyphen are allowed. Spaces are not allowed in a Controller ID.
  • If you intend to operate a Controller cluster with two Controller instances for the active and for the standby cluster membermembers, then specify the same identifier during installation of each Controller instance as otherwise the instances will not be considered members of the same cluster. This identifier cannot be modified after installation, changes to the Controller ID require reinstallation of the Controller.
    • A checkbox allows to specify if the currently installed Controller instance will initially start the initial role of the current Controller instance to be specidied - i.e. whether it starts with an active or a standby role. Do not select this checkbox if you operate are operating a standalone Controller instance.
    • Consider Note that operation of a Controller cluster requires to add a license certificate from a previous above step, see to have been specified in the License Agreement step described above. See also JS7 - Licensing.
  • Add the HTTP port that is to be used by the JS7 Controller. Make sure that the HTTP port is available and is not otherwise used. If you run other applications that use this port then choose a different port.
  • If you specify a Windows Service account then make sure that this account has "Log on as service permissions". Consider that credentials that you enter to this window are stored in clear text with the installer response file. It is considered more secure not to add credentials with this step, but to add credentials directly with after installation using the Windows Service panel after installation.

Specific Directories

  • If you choose the installation directory to be located in C:\Program Files then it is recommended to choose configure the log directory to be outside of the installation path, e.g. C:\ProgramData\sos-berlin.com\js7\controller\logs.
  • The installer sets read/write permissions for the specified Windows Service account. Typically only the administrator group should have write permissions for C:\Program Files.

...

  • This step displays progress of the first part of the installation procedure.
  • Changes to installer options can no longer be applied once this step is has been started.

Configuration Progress

  • The processing panel displays progress of the second part of the installation procedure that includes to set setting permissions and to install installation of the Windows Service.



    • The information displayed with this step is written to the installation log file that can be found in the JS7_CONTROLLER_DATA/logs folder.

...

  • Note that if a problem occurs during installation a warning will be displayed and a link to the installation log file will be provided.

  • A failed installation can be repeated at any time, no uninstallation is not required.

Directory Structure

...

The update of the JS7 Controller is performed from the same download archive as used for any a fresh installation:

  • js7_controller_windows_installer.<release>.zip

...

  • Stop the JS7 Controller instance, e.g. from using the Controller's Windows Service.
  • Prepare to rollback in case that the update of the JS7 Controller is not successful:
    • Take a backup of the Controller's installation directory and configuration directorydirectories, e.g. by creating a .zip archive.
      • Installation Directory
        • The default installation directory for the Controller is C:\Program Files\sos-berlin.com\js7\controller\<controller-id>
      • Configuration Directory
        • The default configuration directory for the Controller is C:\ProgramData\sos-berlin.com\js7\controller\<controller-id>

Update

The An update using the graphical installer can be done by rerunning running the installer setup.cmd file from the .zip archive and by providing the same parameters such as installation directory, port etc.

...

  • Run the JS7 Controller uninstaller.
    • The default location of the uninstall.cmd file is:
      • C:\Program Files\sos-berlin.com\js7\controller\<controller-id>\Uninstaller
  • Restore the Controller folders from the backup by unzipping the .zip archive for the installation directory and configuration directory directories to the their respective locations.
  • Re-install the Windows Service from the command line:
    • Switch to the Controller's .\bin directory from the command line.
      • The default location of the .\bin directory is:
        • C:\Program Files\sos-berlin.com\js7\controller\<controller-id>\bin

    • Run the following command that installs the Controller's Windows Service:

      controller.cmd install-service

...

The installer creates a log file in the directory that is pointed to indicated by the environment variable JS7_CONTROLLER_LOGS or in the logs sub-directory of the Controller's configuration directory.

...

For Windows systems operation of the Controller by a Windows Service is recommended as such these services can be configured to start/stop automatically on server startup and shutdown.

  • Consider to assign assigning a service account to the JS7 Controller service with the Windows Service Panel.
  • Consider to allow allowing the JS7 Controller service to be automatically started on server startup.

...