Page History

...

DESCRIPTION

The JOC Cockpit installation script Installation Script can be used to automate installing, updating, patching and patching uninstalling JOC Cockpit.

The script offers the installation options and configuration options available from the JOC Cockpit's graphical installer.

For download see https://kb.sos-berlin.com/display/JS7/JS7+-+Download

...

-LogDir <String>
If a log directory is specified then the installation script Installation Script will log information about processing steps to a log file in this directory.
File names are created according to the pattern: install_js7_joc.<hostname>.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.log
For example: install_js7_joc.centostest_primary.2022-03-19T20-50-45.log

...

-ExecStart <String>
This parameter can be used should the JOC Cockpit be started after installation.
For example, when using systemd for Unix or using a Windows Service then the
-ExecStart "StartService" parameter value
will start the JOC Cockpit service provided that the underlying service has been created manually or by use of the -MakeService switch.

For Unix users can specify individual commands, for example -ExecStart "sudo systemctl start js7_joc".

For Unix systemd service files see the 'JS7 - systemd Service Files for automated Startup and Shutdown with Unix Systems' article.
This parameter is an alternative to use of the -Restart switch which will start the JOC Cockpit from its Instance Start Script.
If specified this parameter overrules the -Restart switch.

...

-ExecStop <String>
This parameter can be used should the JOC Cockpit be stopped before installation.
For example, when using Unix systemd or Windows Services then
the -ExecStop "StopService" parameter value
will stop the JOC Cockpit service provided that the underlying service has been created manually or by use of the -MakeService switch.

For Unix users can specify individual commands, for example -ExecStop "sudo systemctl stop js7_joc".
This parameter is an alternative to use of the -Restart switch which stops the JOC Cockpit from its Instance Start Script.
If specified this parameter overrules the -Restart switch.

...

-DeployDir <String[]>
Specifies the path to a deployment directory that holds configuration files and sub-directories that will be copied to the <data>/resources/joc folderdirectory.
A deployment directory allows to manage central copies of configuration files such as joc.properties, log4j2.xml etc.

Use of a deployment directory has lower precedence as files can be overwritten by individual parameters such as -Properties etc.

...

-KeyAlias <String>
If a keystore holds more than one private key, for example if separate pairs of private keys/certificates for server authentication and client authentication
exist, then it is not determined which private key/certificate will be used.

The alias name of a given private key/certificate is specified
when the entry is added to the keystore. The alias name allows to indicate a specific private key/certificate to be used.

...

-TruststorePassword <SecureString>
Specifies the password for access to the truststore from a secure string.
Use of a password is recommended as : it is not primarily intended to protect access to the truststore, but to ensure integrity.
The password is intended to allow verification that truststore entries have been added using the same password.

There are a number of ways how to specify secure strings, for example:

-TruststorePassword ( 'secret' | ConvertTo-SecureString -AsPlainText -Force )

...

-JavaOptions <String>
Specifies the Java options that will be made available to the JOC Cockpit from the JAVA_OPTIONS environment variable specified with the JOC Cockpit profile
typically available from the $HOME/.jocrc script.

Java options can be used for example to specify Java heap space settings for the JOC Cockpit.
If more than one Java option is used then the value has to be quoted, for example -JavaOptions "-Xms256m -Xmx512m".

...

-ServiceFile <String>
For Unix environments specifies the path to a systemd service file that acts as a template and that will be copied to the JOC Cockpit's <home>/jetty/bin directory.
Users are free to choose any file name as a template for the service file. The resulting service file name will be joc.service.
The installation script Installation Script will perform replacements in the service file to update paths and the port to be used, for details see ./bin/jetty.service-example.

...

-ShowLogs <SwitchParameter>
Displays the log output created by the installation script Installation Script if the -LogDir parameter is used.

...