Merge pull request #127 from ubtue/develop

Überarbeitung NeG

Author: mtrojan-ub

README.md

@@ -1,13 +1,15 @@
 # NeG - Nomen et Gens
 
+You can also have a look at the installation example in the docker subdirectory.
+
 Prerequisites:
 - System
   - Tomcat 9 / Ubuntu (for automated build process). WAR-file should work with Tomcat >= 7.
   - find /etc/tomcat<n> (might also be /usr/share/tomcat)
   - conf/web.xml
     - Find this servlet <servlet-class>org.apache.jasper.servlet.JspServlet</servlet-class>
     - Add parameter `<init-param><param-name>strictQuoteEscaping</param-name><param-value>false</param-value></init-param>`
-  - Catalina/localhost/neg.xml (needs to be created)
+  - Catalina/localhost/neg.xml (needs to be created with correct user credentials)
 ```
 <Context>
     <!-- Mandatory -->
@@ -18,23 +20,56 @@ Prerequisites:
     <!-- Optional -->
     <Environment name="matomoURL" value="" type="java.lang.String"/>
     <Environment name="matomoSiteId" value="" type="java.lang.String"/>
+    
+    <!-- Mail -->
+    <Environment name="smtpHost" value="smtpserv.uni-tuebingen.de" type="java.lang.String"/>
+    <Environment name="smtpPort" value="587" type="java.lang.String"/>
+    <Environment name="smtpUser" value="exampleUser" type="java.lang.String"/>
+    <Environment name="smtpPassword" value="examplePassword" type="java.lang.String"/>
 </Context>
 ```
 - Java >= 1.8.0_77
 - MySQL >= 5.7
-  - collation-server=utf8_unicode_ci
-  - character-set-server=utf8
+  - collation-server = utf8_unicode_ci
+  - character-set-server = utf8mb4
   - group_concat_max_len = 100000000
+  - log_bin_trust_function_creators = 1
   - sql_mode=STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION
   - (please note that NO_AUTO_CREATE_USER has been deprecated & can be omitted in newer SQL Versions)
   - If you use MariaDB, also use the following settings to avoid performance problems, especially in search queries (this works for MyISAM but should be tested again when migrating to InnoDB):
     - optimizer_switch="derived_merge=off,derived_with_keys=off"
     - see also: https://stackoverflow.com/questions/35889706/mariadb-running-a-left-join-query-100-times-slower-than-mysql
 
+For servers (ZDV):
+- MySQL
+    - Make sure you change the db user passwords to something safe.
+    - if you want to install neg-dmp on a separate machine and access the mysql db in this instance,
+      you also have to change the host for the user and prevent it to be bound to localhost (e.g. disable bind-address and mysqlx-bind-address in mysqld.cnf).
+    - [client]
+        default-character-set = utf8mb4
+      [mysqld]
+        character-set-server = utf8mb4
+        collation-server = utf8mb4_unicode_ci
+      [mysql]
+        default-character-set = utf8mb4
+- Tomcat
+    - if tomcat installation fails, contact ZDV admin (workaround for default group 100).
+    - change tomcat ports to 80+443
+    - instead of Catalina/localhost/neg.xml:
+        - move settings to server.xml Host section to avoid access via /neg in url.
+        - Also add these attributes to <Context path="" docBase="neg" debug="0" reloadable="true"></Context>
+    - don't forget the SSL certificate
+    - make sure you use the correct matomoSiteId
+- Firewall
+    - adjust firewall scripts, see /zdv-system/scripts/ipt
+- Backup
+    - for backups, make sure bacula is installed correctly and there is also a mysqldump cronjob
+
 Build:
 - Use build-function in netbeans (.war file see target/ dir)
 - Deploy 1st time using http://localhost:8080/manager/html
 - Update copying neg.war to /var/lib/tomcat/webapps/ and removing the old unpacked neg/ subdirectory
+- Make sure the file /var/lib/tomcat9/conf/Catalina/localhost/neg.xml exists
 
 Production:
 - https://wiki.owasp.org/index.php/Securing_tomcat

docker/Dockerfile

@@ -14,6 +14,7 @@ RUN apt-get --yes install mysql-server openjdk-11-jre tomcat9
 RUN echo "collation-server = utf8_unicode_ci" >> /etc/mysql/mysql.conf.d/mysqld.cnf
 RUN echo "character-set-server = utf8" >> /etc/mysql/mysql.conf.d/mysqld.cnf
 RUN echo "group_concat_max_len = 100000000" >> /etc/mysql/mysql.conf.d/mysqld.cnf
+RUN echo "log_bin_trust_function_creators = 1" >> /etc/mysql/mysql.conf.d/mysqld.cnf
 RUN echo "sql_mode = STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION" >> /etc/mysql/mysql.conf.d/mysqld.cnf
 
 # MySQL DB + user

pom.xml

@@ -18,12 +18,12 @@
         <dependency>
             <groupId>mysql</groupId>
             <artifactId>mysql-connector-java</artifactId>
-            <version>5.1.49</version>
+            <version>8.0.30</version>
         </dependency>
         <dependency>
             <groupId>commons-fileupload</groupId>
             <artifactId>commons-fileupload</artifactId>
-            <version>1.2.2</version>
+            <version>1.4</version>
         </dependency>
         <dependency>
             <groupId>com.lowagie</groupId>
@@ -38,7 +38,27 @@
         <dependency>
             <groupId>org.hibernate</groupId>
             <artifactId>hibernate-core</artifactId>
-            <version>5.4.25.Final</version>
+            <version>5.6.11.Final</version>
+        </dependency>
+        <dependency>
+            <groupId>org.hibernate</groupId>
+            <artifactId>hibernate-c3p0</artifactId>
+            <version>5.6.11.Final</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-text</artifactId>
+            <version>1.10.0</version>
+        </dependency>
+        <dependency>
+            <groupId>javax.mail</groupId>
+            <artifactId>javax.mail-api</artifactId>
+            <version>1.6.2</version>
+        </dependency>
+        <dependency>
+            <groupId>com.sun.mail</groupId>
+            <artifactId>javax.mail</artifactId>
+            <version>1.6.2</version>
         </dependency>
         <dependency>
             <groupId>javax</groupId>
@@ -58,6 +78,11 @@
             <version>5.7.2</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.mchange</groupId>
+            <artifactId>c3p0</artifactId>
+            <version>0.9.5.5</version>
+        </dependency>
     </dependencies>
 
     <build>
@@ -72,26 +97,26 @@
                 <artifactId>maven-processor-plugin</artifactId>
                 <version>3.2.0</version>
                 <executions>
-                  <execution>
-                    <id>process</id>
-                    <goals>
-                      <goal>process</goal>
-                    </goals>
-                    <phase>generate-sources</phase>
-                    <configuration>
-                      <processors>
-                        <processor>org.hibernate.jpamodelgen.JPAMetaModelEntityProcessor</processor>
-                      </processors>
-                      <defaultOutputDirectory>${project.build.directory}/generated-sources/hibernate-jpamodelgen/</defaultOutputDirectory>
-                    </configuration>
-                  </execution>
+                    <execution>
+                        <id>process</id>
+                        <goals>
+                            <goal>process</goal>
+                        </goals>
+                        <phase>generate-sources</phase>
+                        <configuration>
+                            <processors>
+                                <processor>org.hibernate.jpamodelgen.JPAMetaModelEntityProcessor</processor>
+                            </processors>
+                            <defaultOutputDirectory>${project.build.directory}/generated-sources/hibernate-jpamodelgen/</defaultOutputDirectory>
+                        </configuration>
+                    </execution>
                 </executions>
                 <dependencies>
-                  <dependency>
-                    <groupId>org.hibernate</groupId>
-                    <artifactId>hibernate-jpamodelgen</artifactId>
-                    <version>5.4.25.Final</version>
-                  </dependency>
+                    <dependency>
+                        <groupId>org.hibernate</groupId>
+                        <artifactId>hibernate-jpamodelgen</artifactId>
+                        <version>5.6.11.Final</version>
+                    </dependency>
                 </dependencies>
             </plugin>
             <plugin>
@@ -141,6 +166,23 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <artifactId>exec-maven-plugin</artifactId>
+                <version>1.1.1</version>
+                <groupId>org.codehaus.mojo</groupId>
+                <executions>
+                    <execution>
+                        <id>Restart Tomcat</id>
+                        <phase>generate-sources</phase>
+                        <goals>
+                            <goal>exec</goal>
+                        </goals>
+                        <configuration>
+                            <executable>${basedir}/restartTomcat9.sh</executable>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
             <!-- Configure the maven-surefire-plugin and maven-failsafe-plugin to be at version 2.22.2 so that they can run JUnit5 -->
             <plugin>
                 <artifactId>maven-surefire-plugin</artifactId>
@@ -152,5 +194,4 @@
             </plugin>
         </plugins>
     </build>
-
 </project>

restartTomcat9.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+systemctl restart tomcat9
+