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
Next revisionBoth sides next revision
72:install [2019/07/29 14:05] emr72:install [2020/05/18 05:58] – [Adjust Java Heap Space] cnmy
Line 4: Line 4:
  
   * Download and install Java Development Kit 8 (see [[:73:system_requirements|System Requirements]] for supported variants)   * Download and install Java Development Kit 8 (see [[:73:system_requirements|System Requirements]] for supported variants)
-  * Stages installation on Windows: Execute Stages installer as administrator+  * 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 Linux:   * Stages installation on Linux:
-      * Install RPM package+      * Install RPM package (will be sent to you by [[stages-support@methodpark.de?subject=Stages installation package - Linux|Stages Support]])
       * 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 or 12c:   * Database installation with Oracle 11g or 12c:
 +      * Get Oracle database dump and installation instructions from [[stages-support@methodpark.de?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".
-      * Get Oracle database dump and installation instructions from Stages Support. 
   * Database installation with MySQL5.7:   * Database installation with MySQL5.7:
 +      * Get MySQL database dump from [[stages-support@methodpark.de?subject=Stages database dump - MySQL|Stages Support]].
       * Download MySQL JDBC connector (Connector/J 5.1 Platform Independent) and installer for MySQL 5.7.       * Download MySQL JDBC connector (Connector/J 5.1 Platform Independent) and installer for MySQL 5.7.
       * 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.
Line 18: Line 19:
         * Select Setup Type "Server only"         * Select Setup Type "Server only"
         * Install MySQL with Config Type "Server Machine", default encoding "UTF-8" and servicename "mysql".         * Install MySQL with Config Type "Server Machine", default encoding "UTF-8" and servicename "mysql".
-        * Adapt/check the following properties within "[mysql]" and "[mysqld]" section in my.ini configuration file. \\ (Windows: "\ProgramData\MySQL\MySQL Server 5.7\my.ini")+        * Adapt/check the following properties within "[mysql]" and "[mysqld]" section in my.ini configuration file. \\ (Windows: "\ProgramData\MySQL\MySQL Server 5.7\my.ini")<code>
  
-<code> 
 [mysql] [mysql]
 default-character-set=utf8 default-character-set=utf8
Line 30: Line 30:
 lower_case_table_names=1 lower_case_table_names=1
 sql-mode = "STRICT_TRANS_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION" sql-mode = "STRICT_TRANS_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"
 +
 </code> </code>
  
Line 41: Line 42:
 flush privileges; flush privileges;
 exit; exit;
 +
 </code> </code>
  
-  * MySQL: Create database "stages" and import dump file (downloaded from [[http://www.methodpark.de/downloads/stages/mysql/stages7_mysql_content.zip|http://www.methodpark.de/downloads/stages/mysql/stages7_mysql_content.zip]] and unzip the file -or- customer specific dumpfile that has been sent to you). All commands need to be executed within path "<MySQL installation path>/bin":+  * MySQL: Create database "stages" and import dump file (unzip the file -or- customer specific dumpfile that has been sent to you). All commands need to be executed within path "<MySQL installation path>/bin":
  
 <code> <code>
 mysqladmin -uroot -p<mysql-root-password> create stages mysqladmin -uroot -p<mysql-root-password> create stages
 mysql -uroot -p<mysql-root-password> stages <[PATH TO DUMP FILE\stages7_mysql_content.sql] mysql -uroot -p<mysql-root-password> stages <[PATH TO DUMP FILE\stages7_mysql_content.sql]
 +
 </code> </code>
  
Line 57: Line 60:
 torque.database.default.username = stages torque.database.default.username = stages
 torque.database.default.password = <stages-password> torque.database.default.password = <stages-password>
 +
 </code> </code>
  
Line 67: Line 71:
 torque.database.default.username=<oracle-username> torque.database.default.username=<oracle-username>
 torque.database.default.password=<oracle-password> torque.database.default.password=<oracle-password>
 +
 </code> </code>
  
Line 76: Line 81:
       * 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 =====
 +
 +If you want to secure your MySQL connection with SSL you need to provide the server certificate to the MySQL driver. To do this follow these steps:
 +
 +  * Copy the server certificate pem file into the stages conf folder
 +  * Create a Java trust store based on the MySQL server certificate:
 +
 +<code>
 +$JAVA_HOME/bin/keytool -importcert -alias MySQLCACert -file ca.pem -keystore truststore -storepass mypassword
 +
 +</code>
 +
 +  * Change the database.properties and append the following to your JDBC url:
 +
 +<code>
 +&clientCertificateKeyStoreUrl=file:/opt/stages/conf/truststore&&useSSL=trueclientCertificateKeyStorePassword=mypassword
 +
 +</code>
 +
 +  * The complete JDBC url should now look similar like this:
 +
 +<code>
 +torque.database.default.url = jdbc:mysql://localhost:3306/stages?zeroDateTimeBehavior=round&jdbcCompliantTruncation=false&useSSL=true&clientCertificateKeyStoreUrl=file:/opt/stages/conf/truststore&clientCertificateKeyStorePassword=mypassword
 +
 +</code>
  
 ===== Configure Virus Scanner ===== ===== Configure Virus Scanner =====
Line 103: Line 134:
       * 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<font inherit/inherit;;#c0392b;;inherit><RAM in MB></font>m -XX:+UseG1GC -XX_-OmitStackTraceInFastThrow"//
       * Restart the Stages service:** stages restart**       * Restart the Stages service:** stages restart**
 +
 +=== Search engine memory ===
 +
 +Depending on the size of your database it can be necessary to adjust the memory settings of the search engine. To do that open the file "<Stages installation path>elasticsearch/config/jvm.options".
 +
 +Adjust the lines<code>
 +
 +-Xms1g
 +-Xmx1g
 +
 +</code>
 +
 +After that restart the Stages search service.
 +
  
 ===== Install customer specific metamodel (if available) ===== ===== Install customer specific metamodel (if available) =====
Line 132: Line 177:
       * PDF Print: **Arial Unicode MS**  (subject to add. license conditions)       * PDF Print: **Arial Unicode MS**  (subject to add. license conditions)
  
-__Configuring font for Stages process visualizations (metamodel: Unified Configuration):__+__Configuring font for Stages process visualizations (metamodel: Unified Configuration) [<font inherit/inherit;;#e67e22;;inherit>STAGES 7.4.4.4 and earlier</font>]:__
   * Windows:   * Windows:
-      * Open file: " <Stages installation path>\stages\data-cache\generated\model\unified_configuration\diagram\trunk\configs\scriptconfig.js"+      * Unzip: "<Stages installation path>\stages\conf\model\unified_configuration.mm" to "<Stages installation path>\stages\conf\model\unified_configuration" 
 +      * Open file: " <Stages installation path>\stages\conf\model\unified_configuration\diagram\trunk\configs\scriptconfig.js"
       * Adjust the following setting: //var FONTNAME = "Arial Unicode MS";//       * Adjust the following setting: //var FONTNAME = "Arial Unicode MS";//
-      * Repeat this step for file: " <Stages installation path>\stages\data-cache\generated\model\unified_configuration\diagram\trunk\configs\scriptconfig-bpmn_classic.js"+      * Repeat this step for file: " <Stages installation path>\stages\conf\model\unified_configuration\diagram\trunk\configs\scriptconfig-bpmn_classic.js
 +      * Add the diagram.font.list property to your config.xml file in the following way: <property name=“diagram.font.list” value=“Arial Unicode MS:/destinationOfYourFontFile/arialuni.ttf”/> 
 +      * Execute: "<Stages installation path>\stages\bin\update.bat"
   * Linux:   * Linux:
-      * Open file: "<Stages installation path>/stages/data-cache/generated/model/unified_configuration/diagram/trunk/configs/scriptconfig.js"+      * Unzip: "<Stages installation path>/stages/conf/model/unified_configuration.mm" to "<Stages installation path>/stages/conf/model/unified_configuration" 
 +      * Open file: "<Stages installation path>/stages/conf/model/unified_configuration/diagram/trunk/configs/scriptconfig.js"
       * Adjust the following setting according to the font to be used: \\ //var FONTNAME = "Arial Unicode MS"; \\       * Adjust the following setting according to the font to be used: \\ //var FONTNAME = "Arial Unicode MS"; \\
    var FONTNAME = "DejaVu Sans Condensed";//    var FONTNAME = "DejaVu Sans Condensed";//
-      * Repeat this step for file: "<Stages installation path>/stages/data-cache/generated/model/unified_configuration/diagram/trunk/configs/scriptconfig-bpmn_classic.js"+      * Repeat this step for file: "<Stages installation path>/stages/conf/model/unified_configuration/diagram/trunk/configs/scriptconfig-bpmn_classic.js
 +      * Add the diagram.font.list property to your config.xml file in the following way: <property name=“diagram.font.list” value=“DejaVu Sans Condensed:/destinationOfYourFontFile/arialuni.ttf”/> 
 +      * Execute: "<Stages installation path>/stages/bin/update" 
 + 
 +<font inherit/inherit;;#e67e22;;inherit>**Caution**</font>//: //If Stages doesn't recognize your font via the config.xml, please additionally set the JVM parameter to the path of your fonts folder: -Dsun.java2d.fontpath=“c:/yourownfolder”. 
 + 
 +__Configuring font for Stages process visualizations (metamodel: Unified Configuration) [<font inherit/inherit;;#e67e22;;inherit>STAGES 7.4.4.5 and newer</font>]:__ 
 +  * Make sure the scriptconfig.js in your metamodel is up to date and contains var FONTNAME = availableFontFamilies.getConfiguredFont(); 
 +  * Place the custom font in your conf/fonts folder 
 +  * Add the diagram.font property to your config.xml file in the following way: <property name=“diagram.font” value=“DejaVu Sans Condensed:DejaVuSansCondensed.ttf”/> 
 +  * Execute: "<Stages installation path>/stages/bin/update"
  
 __Configuring font for Stages PDF printing:__ __Configuring font for Stages PDF printing:__
Line 150: Line 209:
       * Open file: "<Stages installation path>/stages/conf/config.xml"       * Open file: "<Stages installation path>/stages/conf/config.xml"
       * Adjust the following property: //<property name="pdf.font.list" value="/usr/share/fonts/TTF/arialuni.ttf"/>//       * Adjust the following property: //<property name="pdf.font.list" value="/usr/share/fonts/TTF/arialuni.ttf"/>//
 +
  
 ===== Install Stages license ===== ===== Install Stages license =====
Line 167: Line 227:
   * Ask for a SSL certificate for the server which refers to the above alias. Depending on your local procedures, this might require creating a certificate request (see [[https://www.digicert.com/csr-ssl-installation/tomcat-keytool.htm|https://www.digicert.com/csr-ssl-installation/tomcat-keytool.htm]] for more info).   * Ask for a SSL certificate for the server which refers to the above alias. Depending on your local procedures, this might require creating a certificate request (see [[https://www.digicert.com/csr-ssl-installation/tomcat-keytool.htm|https://www.digicert.com/csr-ssl-installation/tomcat-keytool.htm]] for more info).
   * 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) +  * Configure Tomcat to use this SSL certificate (see link above for more info). The relevant Tomcat config file is located in ''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 a redirect from ports 80 and/or 8080 to the SSL port (typically 443 or 8443)+  * To enforce redirection from http to https add the following to ''conf/web-customer.xml''. This needs a Stages Version > 7.4.2.0.<code> 
 + 
 +<security-constraint> 
 +    <display-name>Enforce HTTPS</display-name> 
 +    <web-resource-collection> 
 +        <web-resource-name>stages-public</web-resource-name> 
 +    </web-resource-collection> 
 +    <user-data-constraint> 
 +        <description>Force SSL for all connections.</description> 
 +        <transport-guarantee>CONFIDENTIAL</transport-guarantee> 
 +    </user-data-constraint> 
 +</security-constraint> 
 + 
 +</code> 
 + 
 +  * Enable global secure mode for Stages to set the neccessary headers for cross site scripting prevention in config.xml 
 + 
 +<code> 
 +[...] 
 +<properties> 
 +    [...] 
 +   <property name="global.secureMode.enabled" value="true"/> 
 +</properties> 
 +[...] 
 + 
 +</code>
  
 ===== Accessing Stages ===== ===== Accessing Stages =====
  
 After successful installation process - Stages is accessible via web browser by URL [[https://localhost:8443|https://localhost:8443]] or [[http://localhost:8080|http://localhost:8080]] (depending on the SSL port) After successful installation process - Stages is accessible via web browser by URL [[https://localhost:8443|https://localhost:8443]] or [[http://localhost:8080|http://localhost:8080]] (depending on the SSL port)
 +
 +===== Prepare Stages for productive usage =====
 +
 +**Users**
 +
 +Delete all users except Superuser and Default, especially the demo users.
 +
 +**Workspaces**
 +
 +Delete the workspaces "''Samples''" and "''Proof of Concept''" or move them under "''Archive''".
 +
 +**Further setup**
 +
 +Please contact your Method Park Product Consultant to further adapt the Stages process content for productive usage.