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/07/22 10:26] – [Configure SSL] evt75: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 [[:78: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:   * 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]])       * Execute Stages installer as administrator (will be sent to you by [[stages-support@ul.com?subject=Stages installation package - Windows|Stages Support]])
Line 22: Line 22:
       * 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 90: 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 107: 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 136: 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**
Line 142: Line 143:
   * 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**
- 
  
 ===== Install customer specific metamodel (if available) ===== ===== Install customer specific metamodel (if available) =====
Line 165: 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 189: 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 221: 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 =====