Stages Documentation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
75:install [2022/01/24 16:30] – [Perform basic installation] cgl75:install [2024/02/15 00:00] (current) – external edit 127.0.0.1
Line 3: Line 3:
 ===== Perform basic installation ===== ===== Perform basic installation =====
  
-  * Download and install Java Development Kit 8 (see [[:75:system_requirements|System Requirements]] for supported variants) +  * Download and install Java Development Kit 8 (see [[:79:system_requirements|System Requirements]] for supported variants) 
-  * Stages installation on Windows: Execute Stages installer as administrator (will be sent to you by [[stages-support@methodpark.de?subject=Stages installation package - Windows|Stages Support]])+  * Stages installation on Windows: 
 +      * Execute Stages installer as administrator (will be sent to you by [[stages-support@ul.com?subject=Stages installation package - Windows|Stages Support]])
   * Stages installation on Linux:   * Stages installation on Linux:
-      * Install RPM package (will be sent to you by [[stages-support@methodpark.de?subject=Stages installation package - Linux|Stages Support]]). \\  Stages will be installed to "/opt/stages" by default. I can be installed to a different location if needed. The path must not contain whitespaces.+      * Install RPM package "sudo rpm -i <stagesrpmpakage>.rpm (RPM pakage will be sent to you by [[stages-support@ul.com?subject=Stages installation package - Linux|Stages Support]]). Stages will be installed to "/opt/stages" by default. It can be installed to a different location if needed. The path must not contain whitespaces.
       * A user with the name "stages" is needed to allow the command "stages start" to automatically start the Stages search engine. The user needs recursive read and execute permissions on the sub-direcory "elasticsearch" and additionally write permissions on "elasticsearch/data" and "elasticsearch/logs".       * A user with the name "stages" is needed to allow the command "stages start" to automatically start the Stages search engine. The user needs recursive read and execute permissions on the sub-direcory "elasticsearch" and additionally write permissions on "elasticsearch/data" and "elasticsearch/logs".
   * Database installation with Oracle 11g, 12c or 19c:   * Database installation with Oracle 11g, 12c or 19c:
-      * Get Oracle database dump and installation instructions from [[stages-support@methodpark.de?subject=Stages database dump - Oracle|Stages Support]]. +  * Get Oracle database dump and installation instructions from [[stages-support@ul.com?subject=Stages database dump - Oracle|Stages Support]]. 
-      * Download Oracle JDBC connector for your Oracle version. +  * Download Oracle JDBC connector for your Oracle version. 
-      * Copy JDBC connector to "<stages installation path>/stages/lib" and rename it to "ojdbc.jar".+  * Copy JDBC connector to "<stages installation path>/stages/lib" and rename it to "ojdbc.jar".
   * Database installation with MySQL 8.0:   * Database installation with MySQL 8.0:
-      * Get MySQL database dump from [[stages-support@methodpark.de?subject=Stages database dump - MySQL|Stages Support]]. +  * Get MySQL database dump from [[stages-support@ul.com?subject=Stages database dump - MySQL|Stages Support]]. 
-      * Download MySQL JDBC connector (Connector/J 8.0 Platform Independent) and installer for MySQL 8.0. +  * Download MySQL JDBC connector (Connector/J 8.0 Platform Independent) and installer for MySQL 8.0. 
-      * Copy JDBC connector to "<stages installation path>/stages/lib" and rename the file mysql-connector-java-*-bin.jar to mysql.jar. +  * Copy JDBC connector to "<stages installation path>/stages/lib" and rename the file mysql-connector-java-*-bin.jar to mysql.jar. 
-      * Install MySQL 8.0 (if not already installed): +  * Install MySQL 8.0 (if not already installed): 
-        * Select Setup Type "Server only" +      * Select Setup Type "Server only" 
-        * Install MySQL with Config Type "Server Machine", default encoding "UTF-8" and servicename "mysql80". +      * Install MySQL with Config Type "Server Machine", default encoding "UTF-8" and servicename "mysql80". 
-        * Adapt/check the following properties within "[mysql]" and "[mysqld]" section in my.ini configuration file. +      * Adapt/check the following properties within "[mysql]" and "[mysqld]" section in my.ini configuration file. 
-          * Windows: \ProgramData\MySQL\MySQL Server 8.0\my.ini +        * Windows: \ProgramData\MySQL\MySQL Server 8.0\my.ini 
-          * Linux: (CentOS) /etc/my.cnf<code>+        * Linux: (CentOS) /etc/my.cnf 
 +<code>
  
 [mysql] [mysql]
Line 89: Line 91:
       * Windows: Start the services "Stages Search" and then "Stages"       * Windows: Start the services "Stages Search" and then "Stages"
       * Linux: Execute "stages start"       * Linux: Execute "stages start"
- 
  
 ===== (Optional) Secure MySQL connection with SSL ===== ===== (Optional) Secure MySQL connection with SSL =====
Line 106: Line 107:
  
 <code> <code>
-&clientCertificateKeyStoreUrl=file:/opt/stages/conf/truststore.jks&useSSL=true&clientCertificateKeyStorePassword=mypassword+&clientCertificateKeyStoreUrl=file:/opt/stages/conf/truststore.jks&useSSL=true&clientCertificateKeyStorePassword=mypassword&enabledTLSProtocols=TLSv1.2
  
 </code> </code>
Line 135: Line 136:
   * Windows:   * Windows:
       * Open file "<Stages installation path>\stages\config.bat"       * Open file "<Stages installation path>\stages\config.bat"
-      * Modify the red colored setting: //set TOMCAT_OPTS=–JvmMx=<font inherit/inherit;;#c0392b;;inherit><RAM in MB></font>//+      * Modify the red colored setting: //set TOMCAT_OPTS=–JvmMx= 
 + <RAM in MB> //
       * Open a cmd with administrative permissions and navigate to folder "<Stages installation path>\stages\bin"       * Open a cmd with administrative permissions and navigate to folder "<Stages installation path>\stages\bin"
       * Reinstall the Stages service: **reinstallService.bat**       * Reinstall the Stages service: **reinstallService.bat**
-      * Restart Stages service: **net start stages**+      * Restart Stages service: **net stop stages**  and **net start stages**
   * Linux:   * Linux:
       * Open file "<Stages installation path>/stages/bin/rc.conf"       * Open file "<Stages installation path>/stages/bin/rc.conf"
-      * Modify the red colored value: //CONF_TOMCAT_OPTS="-Xmx<font inherit/inherit;;#c0392b;;inherit><RAM in MB></font>m -XX:+UseG1GC -XX_-OmitStackTraceInFastThrow"//+      * Modify the red colored value: //CONF_TOMCAT_OPTS="-Xmx 
 + <RAM in MB>  m -XX:+UseG1GC -XX_-OmitStackTraceInFastThrow"//
       * Restart the Stages service:** stages restart**       * Restart the Stages service:** stages restart**
  
Line 163: Line 166:
 ===== Install Fonts ===== ===== Install Fonts =====
  
-If you want to use international UTF-8 charsets (e.g. Chinese, Japanese, Korean), you have to configure Stages to use appropriate fonts for process visualizations and PDF printing. Examples are **Arial Unicode MS**  (subject to add. license conditions) or **Source Han Sans **  (SIL OPEN FONT LICENSE Version): [[https://www.methodpark.de/downloads/stages/SourceHanSans-Regular.ttf|https://www.methodpark.de/downloads/stages/SourceHanSans-Regular.ttf]] \\  \\ **Place the custom font in your <Stages installation path>/conf/fonts folder.**+If you want to use international UTF-8 charsets (e.g. Chinese, Japanese, Korean), you have to configure Stages to use appropriate fonts for process visualizations and PDF printing. Examples are **Arial Unicode MS**  (subject to add. license conditions) or **Source Han Sans **  ([[https://scripts.sil.org/ofl|SIL OPEN FONT LICENSE]]): [[https://www.methodpark.de/downloads/stages/SourceHanSans-Regular.ttf|https://www.methodpark.de/downloads/stages/SourceHanSans-Regular.ttf]] \\  \\ **Place the custom font in your <Stages installation path>/conf/fonts folder.**
  
 __Configure font for Stages process visualizations (metamodel: Unified Configuration):__ __Configure font for Stages process visualizations (metamodel: Unified Configuration):__
   * Make sure the scriptconfig.js in your metamodel is up to date and contains var FONTNAME = availableFontFamilies.getConfiguredFont();   * Make sure the scriptconfig.js in your metamodel is up to date and contains var FONTNAME = availableFontFamilies.getConfiguredFont();
   * Open file: "<Stages installation path>/conf/config.xml"   * Open file: "<Stages installation path>/conf/config.xml"
-  * Add/adjust the "diagram.font" property to the properties section at the beginning of the file in the following way (the path of the font file is not needed - only the name): \\ +  * Add/adjust the "diagram.font" property to the properties section at the beginning of the file in the following way (the path of the font file is not needed - only the name): 
-    <property name=“diagram.font” value=“Source Han Sans:SourceHanSans-Regular.ttf”/>+ 
 +<property name=“diagram.font” value=“Source Han Sans:SourceHanSans-Regular.ttf”/> 
   * Execute update.bat (Windows) or update.sh (Linux) in "<Stages installation path>/bin"   * Execute update.bat (Windows) or update.sh (Linux) in "<Stages installation path>/bin"
  
Line 187: Line 192:
 ===== Configure SSL ===== ===== Configure SSL =====
  
-To encrypt all connections between the users and Stages, we strongly recommend to configure SSL for the Stages server.\\+To encrypt all connections between the users and Stages, we strongly recommend to configure SSL for the Stages server. \\
 In addition to the following guidelines, a detailed guide on how to easily configure SSL with Stages can be found [[http://www.methodpark.de/downloads/stages/static/documentation/Stages_SSL_configuration_guide.pdf|here]]. In addition to the following guidelines, a detailed guide on how to easily configure SSL with Stages can be found [[http://www.methodpark.de/downloads/stages/static/documentation/Stages_SSL_configuration_guide.pdf|here]].
  
Line 194: Line 199:
   * Import the SSL certificate into a keystore (see link above for more info)   * Import the SSL certificate into a keystore (see link above for more info)
   * Configure Tomcat to use this SSL certificate (see link above for more info). The relevant Tomcat config file is located in ''<Stages installation path>/stages/conf/server.xml''  and the SSL info needs to be configured for each ''<Connector>''  section. After updating the config file, run ''bin/update.sh''  or ''bin\update.bat''  to install it at the correct location.   * Configure Tomcat to use this SSL certificate (see link above for more info). The relevant Tomcat config file is located in ''<Stages installation path>/stages/conf/server.xml''  and the SSL info needs to be configured for each ''<Connector>''  section. After updating the config file, run ''bin/update.sh''  or ''bin\update.bat''  to install it at the correct location.
-  * To enforce redirection from http to https add the following to ''conf/web-customer.xml''.<code>+  * To enforce redirection from http to https add the following to ''conf/web-customer.xml'', run ''bin/update.sh''  or ''bin\update.bat''  and restart Stages service 
 +<code>
  
 <security-constraint> <security-constraint>
Line 218: Line 224:
  
   * Please restart Stages service after applying changes to the Java Trust Store   * Please restart Stages service after applying changes to the Java Trust Store
- 
  
 ===== Accessing Stages ===== ===== Accessing Stages =====