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
710:install [2023/09/22 12:45] – [Stages installation on Windows] alz710:install [2024/10/29 10:11] (current) – Suess, Bernhard
Line 39: Line 39:
 <code> <code>
 create database stages; create database stages;
-create user 'stages' identified by 'pass'; +create user 'stages'@'localhost' identified by 'pass'; 
-grant all privileges on *.* to 'stages'@'%';+grant all privileges on *.* to 'stages'@'localhost';
 flush privileges; flush privileges;
 exit; exit;
Line 92: Line 92:
 ## settings for oracle ## settings for oracle
 torque.database.default.driver=oracle.jdbc.driver.OracleDriver torque.database.default.driver=oracle.jdbc.driver.OracleDriver
-torque.database.default.url=jdbc:oracle:thin:@<IP/hostname>:<port>/<service_name>+torque.database.default.url=jdbc:oracle:thin:@<IP/hostname>:<port>/<service_name(pdb)>
 torque.database.default.username=<oracle-username> torque.database.default.username=<oracle-username>
 torque.database.default.password=<oracle-password> torque.database.default.password=<oracle-password>
Line 98: Line 98:
 </code> </code>
  
-Hint: ensure that torque.database.default.adapter = DBMM is commented out or deleted+Hints: \\ Ensure that torque.database.default.adapter = DBMM is commented out or deleted \\ For none Oracle RAC databases (Cluster) - **<port>/<service_name(pdb)>**  can be replaced by **<port>:<sid>**
  
   * Activate the configuration   * Activate the configuration
Line 138: Line 138:
       * complete the installation with your organizational policy       * complete the installation with your organizational policy
       * Proceed with the steps provided below       * Proceed with the steps provided below
-        * [[:79:install#create-database-database-user-and-grant-privileges|Create Database, Database User and Grant Privileges]]+        * [[:710:install#create-database-database-user-and-grant-privileges|Create Database, Database User and Grant Privileges]]
  
 ==== MySQL installation on CentOS 7.9 ==== ==== MySQL installation on CentOS 7.9 ====
Line 176: Line 176:
   * Start MySQL cli: mysql -uroot -p<root-pass>   * Start MySQL cli: mysql -uroot -p<root-pass>
   * Execute the following commands:   * Execute the following commands:
-<code> 
  
 +<code ->
 create database stages; create database stages;
 create user 'stages'@'localhost' identified by 'Pass.1234'; create user 'stages'@'localhost' identified by 'Pass.1234';
Line 183: Line 183:
 flush privileges; flush privileges;
 exit; exit;
- 
 </code> </code>
  
   * Import dump file into database “stages”   * Import dump file into database “stages”
-      * Unzip the file or customer specific dumpfile(*.sql) that has been sent to you +    * Unzip the file or customer specific dumpfile(*.sql) that has been sent to you 
-      * Execute to Import: mysql -uroot -p stages < /path/to/dumpfile/stages7_mysql_content.sql+    * Execute to Import: mysql -uroot -p stages < /path/to/dumpfile/stages7_mysql_content.sql 
  
 ==== Database installation with Oracle 11g, 12c or 19c ==== ==== Database installation with Oracle 11g, 12c or 19c ====
Line 236: Line 236:
   * Start Stages   * Start Stages
       * execute “stages start”       * execute “stages start”
 +
 +==== (Optional) Start without Root Privileges on Linux ====
 +
 +Normally Stages is started by the "root" user and then drops its privileges to the "stages" user after successful startup. In high risk environments, Stages can now also be started with a user id other than root. It can be enabled via the ''STAGES_NONROOTSTART''  variable in ''…/bin/rc.conf''. If enabled, the same user id starting the service will also be used to run the service.
 +
 +Please note that privileged ports below 1024 cannot be opened in this configuration, so the normal HTTPS port 443 cannot be used. The non-root setting can only be used when the Tomcat connectors are configured to use ports higher than 1024 and e.g. a reverse proxy is being used to allow normal access via HTTPS.
 +
 +**How to configure the user that Stages service should run as?**
 + 
 +1. Edit stages.service file:
 +  * vi /etc/systemd/system/stages.service 
 +  * add the line User=<username> within the [Service] section (IMPORTANT: DO NOT ADD QUOTES AROUND THE USERNAME)
 +
 +2. Reload system manager configuration with systemctl command:
 +  * systemctl daemon-reload
 +
 +3. Additionally change the user ownership for all files below stages installation folder with following command: 
 +  * chown -R <username> /opt/stages
  
 ===== (Optional) Secure MySQL connection with SSL ===== ===== (Optional) Secure MySQL connection with SSL =====
Line 292: Line 310:
   * Modify the red colored setting:   * Modify the red colored setting:
  
-set TOMCAT_OPTS=–JvmMx= <font inherit/inherit;;#e74c3c;;inherit><RAM in MB></font>+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"//
Line 301: Line 319:
   * //Open file "<Stages installation path>/stages/bin/rc.conf"//   * //Open file "<Stages installation path>/stages/bin/rc.conf"//
   * //Modify the red colored value://   * //Modify the red colored value://
-CONF_TOMCAT_OPTS="-Xmx <font inherit/inherit;;#e74c3c;;inherit><RAM in MB></font> m -XX:+UseG1GC -XX-OmitStackTraceInFastThrow"+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 346: Line 364:
  
  
-===== Configure SSL =====+===== Configure TLS/SSL =====
  
-To encrypt all connections between the users and Stages, we strongly recommend to configure SSL for the Stages server. +Please refer to [[configure_stages#configuring-tlsssl-certificate|here]].
- +
-In addition to the following guidelines, a detailed guide on how to easily configure SSL with Stages can be found here : [[https://download.methodpark.de/stages/static/documentation/Stages_SSL_configuration_guide.pdf|Stages_SSL_configuration_guide.pdf]] +
- +
-  * Ask for a DNS alias for the server, e.g. "stages.company.com" +
-  * 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/kb/csr-ssl-installation/tomcat-keytool.htm|https://www.digicert.com/kb/csr-ssl-installation/tomcat-keytool.htm]] 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. +
-  * 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> +
-    <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> +
- +
-===   ===+
  
 === Add CAs to your TrustStore === === Add CAs to your TrustStore ===
  
-For using reports in Stages you need to add your company's root certificate and all Intermediate certificates (if existing) to the server Java truststore. The Java truststore includes all trusted root certificates. If a report tries to connect via SSL to your Stages server it will be not executed correctly because Java does not trust the SSL certificate. It was not issued by a Java trusted certificate authority - included in the Java truststore. +Please refer to [[configure_stages#Use the system trust store|here]].
- +
-  * Import your company's root certificate and all intermediate certificates (if existing) into this file: \\ <Java Development Kit Installation Directory>\lib\security\cacerts +
- +
-(Linux directories may differ) +
- +
-  * Please restart Stages service after applying changes to the Java Trust Store +
- +
 ===== 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://stages.localhost|https://stages.localhost]]. As Stages is delivered with a self signed certificate your browser will warn you that the certificate is not trustworthy. For a first test you can instruct the browser to direct you to the website anyhow. After that please [[configure_stages#configuring-tlsssl-certificate|configure a trusted certificate]].
  
 ===== Change password of "root" user ===== ===== Change password of "root" user =====
  
-''Log in with the "root" user and the provided password. Click on the "Superuser" link in the bottom left corner of the navigation and change the password to a secure and unique one. ''+Log in with the "root" user and the provided password. Click on the "Superuser" link in the bottom left corner of the navigation and change the password to a secure and unique one.
  
 ===== Prepare Stages for productive usage ===== ===== Prepare Stages for productive usage =====