Versions Compared

Key

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

...

  • --id=<JS7 Controller ID>
    • Specifies a unique identifier for a Controller. You can use identifiers such as "controller-test", "controller-production" etc. Upper case and lower case characters are considered, 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 member, then specify the same Controller ID for both Controller instances as otherwise the instances will not be considered members of the same cluster.
  • --http-port=<[hostname or ip address:]number>
    • Specifies the HTTP port that the Controller instance is listening to in order to receive requests from JOC Cockpit.
      • controller.sh|cmd command --http-port=####

      • where #### is the numeric port.
      • This option can be also used to indicate which network interface the JS7 Controller should listen to if in addition you specify a hostname or IP address for example with --http-port=myhost:4444.
    • Without this option being used the port defaults to 4444 and the Controller listens to all available network interfaces.
    • Should you want to specify a port then the following precedence applies:
      • First precedence: command line option
      • Second precedence: environment variable JS7_CONTROLLER_HTTP_PORT (see below)
      • Third precedence: use of default value
  • --https-port=<[hostname or ip address:]number>
    • Specifies the HTTPS port that the Controller is listening to in order to receive requests from a Controller:
      • controller.sh|cmd command --https-port=####

      • where #### is the numeric port.
      • This option can be used to indicate which network interface the Controller should listen to if you additionally specify a hostname or IP address such as --https-port=myhost:4443.
      • When using the HTTPS protocol for connections from JOC Cockpit and from a pairing Controller instance consider additionally allowing the HTTP protocol for local connections such as --http-port=localhost:4444. As the Controller Start Script makes use of an HTTP connection this protocol has to be in place to allow the Controller instance to be started, stopped etc. by its Start Script.
    • Should you want to specify a port then the following precedence order applies:
      • First precedence: command line option
      • Second precedence: environment variable JS7_CONTROLLER_HTTPS_PORT (see below)
      • Third precedence: use of default value
  • --data-directory=<location of data directory>
    • Specifies the location of the data directory that usually includes the config, logs and state directories.
    • Should you want to specify a data directory then the following precedence orderappliesorder applies:
      • First precedence: command line option
      • Second precedence: environment variable JS7_CONTROLLER_DATA (see below)
      • Third precedence: use of default value JS7_CONTROLLER_HOME\var
  • --config-directory=<location of config directory>
    • Specifies the location of the config directory for configuration data.
    • Should you want to specify a configuration directory then the following precedence order applies:
      • First precedence: command line option
      • Second precedence: environment variable JS7_CONTROLLER_CONFIG_DIR (see below)
      • Third precedence: use of default value JS7_CONTROLLER_DATA/config
  • --java-options=<java options>
    • With Java 1.8 the initial memory allocation has changed, for details see How to manage the Java heap space.

    • This option can be used to apply Java options for the Controller, e.g. for memory settings.

    • Without this option being used the Java options default to '-Xms500m'.

    • Should you want to specify the Java options then the following precedence order applies:

      • First precedence: command line option
      • Second precedence: environment variable JAVA_OPTIONS (see below)
      • Third precedence: use of default value

...