Page History
...
The JOC Cockpit can be installed on Linux and Windows systems without the use of a graphical installer by running the JOC Cockpit installer in headless mode. See the JS7 - JOC Cockpit - Installation Using the Graphical Installer for Linux /and Windows Graphical Installer article for instructions on the use of a graphical installer.
...
- A Java Runtime Environment in version 1.8 or newer is required. Starting from Release 2.5.0 the minimum Java version is Java 11. For details see the Which Java versions is JobScheduler available for? article.
- It is necessary that a time service is operated on the server that hosts JOC Cockpit in order to synchronize the system clock's time.
- Technically the JOC Cockpit can be operated in any Unix environment. However, support for operation of the JOC Cockpit is limited to Linux systems as described in the JS7 - Platforms article.
- The JOC Cockpit requires access to a database to store inventory and status information, as well as workflow related logs - see the JS7 - Database article.
- A schema has to be created in the database prior to installation.
- A user account has to be created that is granted full privileges for the schema.
- If you intend to use different accounts and privilege sets for setup and for operation of the JOC Cockpit then consider switching Hibernate configuration files after setup (see below) to use an account with limited privileges to select, insert, update, delete and execute permissions for schema objects.
- Installation of the JOC Cockpit requires administrative privileges in the following situations:
- for Unix systems
- the JOC Cockpit installer cannot be executed from the root account but can be executed from a user account that makes use of
sudo
to acquire privileges:- to make the root account owner of the installation directory, for example, in
/opt
- to make the user account owner of the configuration directory, for example, in
/var
- to make the root account owner of the installation directory, for example, in
- administrative privileges are not required for installation with a user account that owns the installation and configuration directories.
- the JOC Cockpit installer cannot be executed from the root account but can be executed from a user account that makes use of
- for Windows systems
- the setup requires administrative privileges.
- for Unix systems
...
- To run the installer in graphical mode see JS7 - JOC Cockpit - Installation Using the Graphical Installer for Linux /and Windows Graphical Installer.
- Installation in headless mode is described below.
...
/opt
(Unix installation directory),Program Files
(Windows installation directory)sos-berlin.com
js7
joc
(installation directory).jocinstallinformation
(installation response file, remains in place after uninstall)jetty_base
(symbolic link to data directory)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
(plain text format of license terms for the commercial JS7 - License)sbom.json
(JS7 - Software Bill of Materials)ThirdParty.txt
(lists the the 3rd party components and licenses used by JS7)db
(directory for DBMS *.sql scripts to populate the database)h2
mssql
mysql
oracle
pgsql
install
(directory with Jetty installer scripts)install_jetty_base.sh|.cmd
(used by installer)install_jetty_service.sh
(used by installer for Unix)joc_install_tables.sh
,|.cmd
(creates or updates database objects, used for JS7 - Rescue in case of lost access to JOC Cockpit)joc_manage_identity_service.sh|.cmd
(see JS7 - Shiro Identity Service Migration)uninstall_jetty_service.sh
(used by installer for Unix)update_jetty_base.sh|.cmd
(used by installer)
jetty
(directory for Jetty binary files and scripts)bin
anonymize-logs.sh|.cmd
(used to anonymize log files, see JS7 - Log Anonymization)jetty.sh
(start script for JOC Cockpit Unix daemon)joc.service
(sample file for use with JS7 - systemd Service Files for automated Startup / and Shutdown with Unix Systems)
lib
(directory for user specific configurations)log4j2.xml
(used for based console logging to stdout, see JS7 - Logging)patches
(used for JS7 - Patches for JOC Cockpit, the directory is cleaned up when running the installer)user_lib (
used for individual .jar files such as JDBC Drivers, see JS7 - Database)
service
(directory for operation as a Windows Service)install_jetty_windows_service.cmd
(used by installer)js7_joc.exe, js7_jocw.exe
(used for start-up and configuration of the service, see JS7 - How To - Apply Java Options)set_java_home_for_jetty_windows_service.cmd
(see JS7 - Troubleshooting - JOC Cockpit Windows Service does not start)start_jetty_windows_service.cmd
(used by installer)uninstall_jetty_windows_service.cmd
(used by installer)
Uninstaller
(Uninstaller directory, the empty directory remains in place after uninstall)joc_install.xml
(installer response file, remains in place after uninstall)uninstaller.jar
(binary file of the uninstaller)uninstall.sh|cmd
(script to invoke uninstaller)
/var
(Unix data directory), ProgramData
(Windows data directory)sos-berlin.com
js7
joc
jetty_base
(configuration directory)joc_home
(symbolic link to installation directory)start.ini
(Jetty servlet container configuration file, remains in place after uninstall. This file is migrated to thestart.d
folder starting from Release 2.5.0)archive
(directory for JOC Cockpit versions before applying patches, remains in place after uninstall)lib
(directory for Java libraries, remains in place after uninstall)logs
(directory for log files files, remains in place after uninstall)resources
(directory for configuration files, remains in place after uninstall)joc
(directory for configuration files, remains in place after uninstall)hibernate.cfg.xml
(Hibernate configuration file for database access, remains in place after uninstall if modified)joc.properties
(JOC Cockpit configuration file, remains in place after uninstall)log4j2.xml
(log configuration file, remains in place after uninstall if modified, see JS7 - Logging)shiro.ini.active
(Shiro configuration file if the JS7 - Shiro Identity Service is used. This file reports the currently active configuration, remains in place after uninstall)shiro.ini-example
(Shiro example configuration file if the JS7 - Shiro Identity Service is used)lib
(optional directory for JDBC Drivers and licensed binary code)license
(optional directory for license certificate files, remains in place after uninstall)xsd
(directory for XSD schema files, remains in place after uninstall)
start.d
(starting from Releases 2.5 (in progress) that introduces Jetty 11 this directory holds *.ini files for settings previously available withstart.ini
)temp
(directory for temporary files, remains in place after uninstall)webapps
(directory for JOC Cockpit installation)joc
(directory for JOC Cockpit GUI files and patches)WEB-INF
classes
(directory for resource files and JS7 - Patches for JOC Cockpit)lib
(Java binary files)
root
/home/<user-account>
(Unix home directory).jocrc
(user profile script applied on start-up of JOC Cockpit)
...
For Unix systems a start-up and shutdown configuration can be used that is executed by systemd
running with the root
account.
- For details see the JS7 - systemd Service Files for automated Startup / and Shutdown with Unix Systems article.
For Windows systems operation of the JOC Cockpit by a Windows Service is recommended as such services can be configured to start/stop automatically on server start-up and shutdown.
...
Further References
- Installation
- Operation
- Configuration
- Troubleshooting
...