Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
tutorial:adm:czechidm_installation [2020/01/13 14:12]
urbanl Uprava návodu na ruční instalaci tomcatu 8
tutorial:adm:czechidm_installation [2020/07/28 09:10] (current)
urbanl predelani navodu pro centos8
Line 1: Line 1:
-====== Installation of CzechIdM - Linux ======+====== Installation of CzechIdM - Linux - CentOS8 ​======
  
 {{tag>​installation jdbc quickstart encryption}} {{tag>​installation jdbc quickstart encryption}}
  
-We presume ​that the server is prepared as described in [[tutorial:​adm:​server_preparation|]].+We expect ​that the server is prepared as described in [[tutorial:​adm:​server_preparation|]].
  
-This tutorial shows how to install full production-ready version of CzechIdM on standard software setup (javapostgreSQL, Tomcat, Apache ​httpd). If you are looking for a demo installation please see [[:​getting-started|]].+This tutorial shows how to install full production-ready version of CzechIdM on standard software setup (JavaPostgreSQL, Tomcat, Apache ​HTTPd). If you are looking for a demo installation please see [[:​getting-started|]].
  
-<note tip>If you install CzechIdM on Sql server ​please skip instruction with setup DB and install JDBC driver ​and [[tutorial:​adm:​mssql_database_support|follow the tutorial.]]</​note>​+<note tip>If you install CzechIdM on with Microsoft SQL Server database backend, ​please skip PostgreSQL-related sections ​and [[tutorial:​adm:​mssql_database_support|swap them for this tutorial]] ​instead.</​note>​
 ==== 1. Create DB user and database in PostgreSQL ==== ==== 1. Create DB user and database in PostgreSQL ====
 Switch the user from root to postgres and use **psql** to add the user and database into PostgreSQL: Switch the user from root to postgres and use **psql** to add the user and database into PostgreSQL:
Line 15: Line 15:
 psql  psql 
 CREATE USER czechidm PASSWORD '​XXXXXXXXXXXX';​ CREATE USER czechidm PASSWORD '​XXXXXXXXXXXX';​
 +
 +# Choose appropriate collation and create database.
 +# with english collation
 CREATE DATABASE "​czechidm"​ WITH OWNER '​czechidm'​ ENCODING '​UTF8'​ LC_COLLATE = '​en_US.UTF-8'​ LC_CTYPE = '​en_US.UTF-8'​ template '​template0';​ CREATE DATABASE "​czechidm"​ WITH OWNER '​czechidm'​ ENCODING '​UTF8'​ LC_COLLATE = '​en_US.UTF-8'​ LC_CTYPE = '​en_US.UTF-8'​ template '​template0';​
 +# with czech collation
 +CREATE DATABASE "​czechidm"​ WITH OWNER '​czechidm'​ ENCODING '​UTF8'​ LC_COLLATE = '​cs_CZ.UTF-8'​ LC_CTYPE = '​cs_CZ.UTF-8'​ template '​template0';​
 </​code>​ </​code>​
  
Line 35: Line 40:
 and restart PostgreSQL. and restart PostgreSQL.
 </​note>​ </​note>​
-==== 2. JDBC driver installation ​- CentOS7 ​​==== ​+==== 2. JDBC driver installation ​- CentOS8 ​​==== ​
 **CentOS** **CentOS**
  
-Install the package with PostgreSQL JDBC driver:+Download ​PostgreSQL JDBC driver ​from [[https://​jdbc.postgresql.org/​download.html|official page]]. 
 +In this example we download version 42.2.11.
  
 <code bash> <code bash>
-yum install -y postgresql-jdbc+wget https://​jdbc.postgresql.org/​download/​postgresql-42.2.11.jar -P /​opt/​tomcat/​current/​lib/​
 </​code>​ </​code>​
  
-allow Tomcat to use the driver: +==== 3. Configure environment properties. Select application profile ====
- +
-<code bash> +
-ln -s /​​usr/​​share/​​java/​​postgresql-jdbc.jar /​opt/​tomcat/​current/​lib/​ +
-</​code>​  +
- +
-==== 3. JDBC driver installation - Debian ​====  +
- +
-Install the package with PostgreSQL JDBC driver: +
- +
-<code bash> +
-apt-get install libpostgresql-jdbc-java +
-</​code>​ +
- +
-allow Tomcat to use the driver: +
- +
-<code bash> +
-ln -s /​usr/​share/​java/​postgresql.jar /​var/​lib/​tomcat8/​lib/​postgresql-jdbc4.jar +
-</​code>​  +
-==== 4. Configure environment properties. Select application profile ====+
  
 Edit the configuration file ''/​etc/​systemd/​system/​tomcat.service''​ - edit the line with environment variable choosing the appropriate application profile. We use **production** profile in our example, which enables you to configure production-ready instace of the identity manager. Edit the configuration file ''/​etc/​systemd/​system/​tomcat.service''​ - edit the line with environment variable choosing the appropriate application profile. We use **production** profile in our example, which enables you to configure production-ready instace of the identity manager.
 <​note>​The **dev** profile is for development and testing environments and as such it has debug logging enabled. For production deployment, use a profile named **production** as is shown in the example. The profile naming convention is mandatory because other CzechIdM configuration depends on it.</​note>​ <​note>​The **dev** profile is for development and testing environments and as such it has debug logging enabled. For production deployment, use a profile named **production** as is shown in the example. The profile naming convention is mandatory because other CzechIdM configuration depends on it.</​note>​
  
-<note important>​To prevent application startup fails due to Flyway bug, property ''​-Djava.util.Arrays.useLegacyMergeSort=true''​ has to be added into environment properties. If property is not set, then application can fail on error: 
-<​code>​Error creating bean with name '​flywayCore'​ defined in class path resource [eu/​bcvsolutions/​idm/​core/​config/​flyway/​CoreFlywayConfig.class]: ​ 
-Initialization of bean failed; nested exception is java.lang.IllegalArgumentException:​ Comparison method violates its general contract!</​code>​ 
-</​note>​ 
  
 Change ​the following line: Change ​the following line:
Line 79: Line 62:
 into: into:
 <code bash> <code bash>
-Environment='​JAVA_OPTS=-Djava.awt.headless=true -Djava.security.egd=file:/​dev/​./​urandom -Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true -Djavax.servlet.request.encoding=UTF-8 -Dspring.profiles.active=production ​-Djava.util.Arrays.useLegacyMergeSort=true' ​+Environment='​JAVA_OPTS=-Djava.awt.headless=true -Djava.security.egd=file:/​dev/​./​urandom -Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true -Djavax.servlet.request.encoding=UTF-8 -Dspring.profiles.active=production' ​
 </​code>​ </​code>​
  
Line 86: Line 69:
 systemctl daemon-reload systemctl daemon-reload
 </​code>​ </​code>​
-==== 5. Create CzechIdM configuration folders ====+==== 4. Create CzechIdM configuration folders ====
 In CzechIdM, you can store all deployment-specific configuration (i.e. database credentials) outside the war file. This is a configure-once approach which greatly simplifies future deployments. In CzechIdM, you can store all deployment-specific configuration (i.e. database credentials) outside the war file. This is a configure-once approach which greatly simplifies future deployments.
   * The **etc** directory stores configuration files.   * The **etc** directory stores configuration files.
Line 92: Line 75:
   * The **backup** directory stored Groovy scripts backups.   * The **backup** directory stored Groovy scripts backups.
   * The **data** directory stores various user-attached files.   * The **data** directory stores various user-attached files.
-  * The **app** directory stores war files. 
   *    * 
 Create the directory structure: Create the directory structure:
Line 101: Line 83:
  
  
-==== 6. Create CzechIdM configuration ====+==== 5. Create CzechIdM configuration ====
 Now we will create configuration files the CzechIdM will use. Now we will create configuration files the CzechIdM will use.
 <​note>​Code snippets in this chapter can be **mostly** copy-pasted or (but please read through whole chapter to be aware of setting you have to adjust). Configuring the CzechIdM is about altering four or five lines altogether.</​note>​ <​note>​Code snippets in this chapter can be **mostly** copy-pasted or (but please read through whole chapter to be aware of setting you have to adjust). Configuring the CzechIdM is about altering four or five lines altogether.</​note>​
-  * The **/​opt/​czechidm/​etc/​secret.key** is a file with confidential storage secret key. This key has to have 128 bit (= 16 bytes).<​code>​ +  * The **/​opt/​czechidm/​etc/​secret.key** is a file with confidential storage secret key. This key has to have 128 bit (= 16 bytes) or 256 bit (= 32b bytes). The length of the key determines the AES cipher used (AES-128 od AES-256).<​code>​ 
-cat /​dev/​urandom | tr -dc '​a-z0-9'​ | head -c 16 > /​opt/​czechidm/​etc/​secret.key+cat /​dev/​urandom | tr -dc '​a-z0-9'​ | head -c 32 > /​opt/​czechidm/​etc/​secret.key
 </​code>​ </​code>​
   * The **/​opt/​czechidm/​etc/​quartz-production.properties** file stores, the Quartz scheduler configuration. You can use the following snippet as a production-safe configuration file.<​file properties quartz-production.properties>​   * The **/​opt/​czechidm/​etc/​quartz-production.properties** file stores, the Quartz scheduler configuration. You can use the following snippet as a production-safe configuration file.<​file properties quartz-production.properties>​
Line 135: Line 117:
     </​springProfile>​     </​springProfile>​
  
-    <​springProfile name="test"> +    <​springProfile name="production">
-        <logger name="​eu.bcvsolutions"​ level="​DEBUG"/>​ +
-        <logger name="​org.springframework"​ level="​INFO"/>​ +
-        <logger name="​org.springframework.web"​ level="​INFO"/>​ +
-        <logger name="​org.hibernate.SQL"​ level="​INFO"/>​ +
-        <logger name="​org.hibernate.type.descriptor.sql.BasicBinder"​ level="​INFO"/>​ +
-    </​springProfile>​ +
- +
-    <​springProfile name="​dev">  ​+
         <​springProperty name="​spring.datasource.driver-class-name"​ source="​spring.datasource.driver-class-name"/>​         <​springProperty name="​spring.datasource.driver-class-name"​ source="​spring.datasource.driver-class-name"/>​
         <​springProperty name="​spring.datasource.url"​ source="​spring.datasource.url"/>​         <​springProperty name="​spring.datasource.url"​ source="​spring.datasource.url"/>​
Line 163: Line 137:
         </​appender>​         </​appender>​
  
-        <logger name="​eu.bcvsolutions"​ level="​TRACE">+        <logger name="​eu.bcvsolutions"​ level="​INFO">
             <​appender-ref ref="​DB_ASYNC"​ />             <​appender-ref ref="​DB_ASYNC"​ />
         </​logger>​         </​logger>​
         <logger name="​org.springframework"​ level="​INFO"/>​         <logger name="​org.springframework"​ level="​INFO"/>​
-        <logger name="​org.springframework.web"​ level="​DEBUG"/>​ +        <logger name="​org.springframework.web"​ level="​INFO"/>​ 
-        <logger name="​org.hibernate.SQL"​ level="​DEBUG"/>​ +        <logger name="​org.hibernate.SQL"​ level="​INFO"/>​ 
-        <logger name="​org.hibernate.type.descriptor.sql.BasicBinder"​ level="​TRACE"/+        <logger name="​org.hibernate.type.descriptor.sql.BasicBinder"​ level="​INFO"/>
-    </​springProfile>+
  
-    <​springProfile name="​dev-mysql"> ​   ​ 
-        <logger name="​eu.bcvsolutions"​ level="​TRACE"​ /> 
-        <logger name="​org.springframework"​ level="​INFO"/>​ 
-        <logger name="​org.springframework.web"​ level="​DEBUG"/>​ 
-        <logger name="​org.hibernate.SQL"​ level="​DEBUG"/>​ 
-        <logger name="​org.hibernate.type.descriptor.sql.BasicBinder"​ level="​TRACE"/> ​       ​ 
     </​springProfile>​     </​springProfile>​
 +
 </​configuration>​ </​configuration>​
 </​file>​ </​file>​
Line 197: Line 165:
 flyway.enabled=true flyway.enabled=true
    
-scheduler.enabled=true +
-scheduler.task.queue.process=1000 +
-scheduler.event.queue.process=1000+
 scheduler.properties.location=quartz-production.properties scheduler.properties.location=quartz-production.properties
 +
 logging.config=/​opt/​czechidm/​etc/​logback-spring.xml logging.config=/​opt/​czechidm/​etc/​logback-spring.xml
 +
 idm.sec.core.demo.data.enabled=false idm.sec.core.demo.data.enabled=false
-  + 
-#spring.cache.ehcache.config=classpath:​ehcache.xml +attachments will be stored under this path
-  +# new directories for attachment will be created in this folder (permissions has to be added) 
-spring.activiti.processDefinitionLocationPrefix=classpath*:/​eu/​bcvsolutions/​idm/​workflow+# System.getProperty("​user.home")/idm_data will be used if no path is given 
-idm.sec.core.notification.template.folder=classpath*:/eu/​bcvsolutions/​idm/​templates/​ +idm.sec.core.attachment.storagePath=/opt/czechidm/data
-idm.sec.core.script.folder=classpath*:/​eu/​bcvsolutions/​idm/scripts/+
 # configuration property for default backup ​ # configuration property for default backup ​
 idm.sec.core.backups.default.folder.path=/​opt/​czechidm/​backup idm.sec.core.backups.default.folder.path=/​opt/​czechidm/​backup
- +
    
 idm.pub.security.allowed-origins=http://​localhost idm.pub.security.allowed-origins=http://​localhost
Line 219: Line 186:
 idm.sec.security.jwt.expirationTimeout=36000000 idm.sec.security.jwt.expirationTimeout=36000000
  
-# recaptcha 
-# - recaptchaservice endpoint ​ 
-#​idm.sec.security.recaptcha.url=https://​www.google.com/​recaptcha/​api/​siteverify 
-# - secret key, can be generated here https://​www.google.com/​recaptcha/​admin 
-idm.sec.security.recaptcha.secretKey=xxx 
-# Proxy for HTTP requests 
-#​idm.sec.core.http.proxy=12.34.56.78:​1234 
-  
 # Cipher secret key for crypt values in confidential storage # Cipher secret key for crypt values in confidential storage
 # for crypt values is used secretKey or secretKey defined by file - secretKeyPath # for crypt values is used secretKey or secretKey defined by file - secretKeyPath
 #​cipher.crypt.secret.key=XXXXXXXXXXXXXXXX #​cipher.crypt.secret.key=XXXXXXXXXXXXXXXX
 cipher.crypt.secret.keyPath=/​opt/​czechidm/​etc/​secret.key cipher.crypt.secret.keyPath=/​opt/​czechidm/​etc/​secret.key
-  + 
- +# Defaults for: emailer.* 
 +# test.enabled=true means mail WILL NOT be sent
 idm.sec.core.emailer.test.enabled=true idm.sec.core.emailer.test.enabled=true
 # http://​camel.apache.org/​mail.html # http://​camel.apache.org/​mail.html
Line 241: Line 201:
 # idm.sec.core.emailer.password=password # idm.sec.core.emailer.password=password
 idm.sec.core.emailer.from=czechidm@localhost idm.sec.core.emailer.from=czechidm@localhost
-  
-## Global property that allow disable or enable sending notification from WF 
-idm.sec.core.wf.notification.send=false 
-  
-  
-# supports delete identity 
-idm.pub.core.identity.delete=true 
-# 
-# default password change type for custom users, one of values: ​ 
-# DISABLED - password change is disable 
-# ALL_ONLY - users can change passwords only for all accounts 
-# CUSTOM - users can choose for which accounts change password 
-idm.pub.core.identity.passwordChange=ALL_ONLY 
-# 
-# required old password for change password 
-idm.pub.core.identity.passwordChange.requireOldPassword=true 
-# 
-# create default identity'​s contract, when identity is created 
-idm.pub.core.identity.create.defaultContract.enabled=true 
-  
    
 # Default user role will be added automatically,​ after an identity is logged in # Default user role will be added automatically,​ after an identity is logged in
Line 268: Line 208:
 # Admin user role # Admin user role
 idm.sec.core.role.admin=superAdminRole idm.sec.core.role.admin=superAdminRole
-  
-  
-# ID system against which to authenticate 
-idm.sec.security.auth.systemId= 
  
-attachments will be stored under this path. +Max file size of uploaded fileValues can use the suffixed "​MB"​ or "​KB" ​to indicate a Megabyte or Kilobyte size. 
-# new directories for attachment will be created in this folder (permissions has to be added) +spring.servlet.multipart.max-file-size=100MB 
-# System.getProperty("​user.home"​)/​idm_data will be used if no path is given +spring.servlet.multipart.max-request-size=100MB
-idm.sec.core.attachment.storagePath=/​opt/​czechidm/​data+
 </​file>​ </​file>​
  
Line 303: Line 238:
  
 There are two properties in application-production.properties that influence the confidential storage: There are two properties in application-production.properties that influence the confidential storage:
-  * You can set the 128bit (16byte) ​key directly in the property file using **cipher.crypt.secret.key** property ​or +  * You can set the key directly in the property file using **cipher.crypt.secret.key** property 
-  * you can create separate file (in our case **secret.key**) containing a random string. Then you reference this file with **cipher.crypt.secret.keyPath** property.+  * or (better) ​you can create separate file ''​secret.key'' ​containing a random string. Then you reference this file with **cipher.crypt.secret.keyPath** property.
  
 <note warning>​CzechIdM doesn'​t contain any default key for crypt confidential storage. Please define it before you start using the IdM.</​note>​ <note warning>​CzechIdM doesn'​t contain any default key for crypt confidential storage. Please define it before you start using the IdM.</​note>​
  
-Confidential storage uses AES/​CBC/​PKCS5Padding ([[https://​docs.oracle.com/​javase/​7/​docs/​api/​javax/​crypto/​Cipher.html|more info]]) algorithm which operates with 128bit key.+Confidential storage uses AES/​CBC/​PKCS5Padding ([[https://​docs.oracle.com/​javase/​7/​docs/​api/​javax/​crypto/​Cipher.html|more info]]) algorithm which operates with 128bit ​or 256bit ​key. 
 +<​note>​ 
 +Length of the key determines the cipher which will be used. If you use 128b (16byte) key, CzechIdM will use AES-128. If you use 256b (32byte) key, CzechIdM will use AES-256. 
 + 
 +  * OpenJDK/JDK 1.8u161 and all higher versions support AES-256 by default. 
 +  * Older versions (below 1.8u161) do not offer it. On those Java distributions,​ you can use AES-128 or obtain the [[https://​www.oracle.com/​java/​technologies/​javase-jce8-downloads.html|Unlimited Strength Jurisdiction Policy Files]] to enable AES-256. 
 + 
 +</​note>​
  
 === Attachment store === === Attachment store ===
Line 331: Line 273:
  
  
-==== 7. Set correct permissions on CzechIdM files ==== +==== 6. Set correct permissions on CzechIdM files ====
-**CentOS**+
 <​code>​ <​code>​
 chown tomcat:​tomcat /​opt/​czechidm chown tomcat:​tomcat /​opt/​czechidm
Line 340: Line 281:
 </​code>​ </​code>​
  
-==== 8. Adjust Tomcat'​s classpath ==== +==== 7. Adjust Tomcat'​s classpath ==== 
-Apache Tomcat has to know where the new configuration is. Because CzechIdM uses SpringBoot project, we simply add the **/​opt/​czechidm/​etc** directory (and others) on the classpath.+Apache Tomcat has to know where the new configuration is. Because CzechIdM uses SpringBoot project, we simply add the ''​/​opt/​czechidm/​etc'' ​directory (and others) on the classpath. 
 + 
 +Create new file ''/​opt/​tomcat/​current/​bin/​setenv.sh''​ with following ​content:
  
-Create new file **/​opt/​tomcat/​current/​​bin/​​setenv.sh** with following ​content:​ +<code bash:>
-<code bash>+
 CLASSPATH=/​opt/​czechidm/​etc:/​opt/​czechidm/​lib/​* CLASSPATH=/​opt/​czechidm/​etc:/​opt/​czechidm/​lib/​*
 </​code>​ </​code>​
Line 353: Line 295:
 </​code>​ </​code>​
  
-==== 9. Create dedicated Java truststore ====+==== 8. Create dedicated Java truststore ====
 Java truststore is a file which contains SSL certificates which we consider trusted. Usually this means some certificates of end systems or their respective certificate authorities. Java truststore is a file which contains SSL certificates which we consider trusted. Usually this means some certificates of end systems or their respective certificate authorities.
 When we need CzechIdM to communicate with some new system with SSL-encrypted way, we need to import particular certificate here and restart the Tomcat container. When we need CzechIdM to communicate with some new system with SSL-encrypted way, we need to import particular certificate here and restart the Tomcat container.
Line 380: Line 322:
 systemctl restart tomcat.service systemctl restart tomcat.service
 </​code>​ </​code>​
-==== 10. Deploy the CzechIdM ==== +==== 9. Deploy the CzechIdM ==== 
-Download the latest CzechIdM version. Currently it is idm-app-9.4.0.war.+Download the latest CzechIdM version. Currently it is idm-app-10.4.1.war.
  
 Ensure Tomcat is stopped: Ensure Tomcat is stopped:
Line 387: Line 329:
 systemctl stop tomcat.service systemctl stop tomcat.service
 </​code>​ </​code>​
-Copy the identity manager WAR into webapps folder in Tomcat and name it **idm.war**:+Copy the identity manager WAR into webapps folder in Tomcat and name it ''​idm.war''​:
 <​code>​ <​code>​
-cp idm-app-9.4.0.war /​opt/​tomcat/​current/​​webapps/​idm.war +cp idm-app-10.4.1.war /​opt/​tomcat/​current/​webapps/​idm.war
-chown tomcat:​tomcat /​opt/​tomcat/​current/​​webapps/​idm.war+
 </​code>​ </​code>​
 Start the Tomcat container:<​code>​ Start the Tomcat container:<​code>​
 systemctl start tomcat.service systemctl start tomcat.service
 </​code>​ </​code>​
-If everything is set up right, the CzechIdM will deploy. Default log is **/​opt/​tomcat/​​current/​logs/​​catalina.out**+If everything is set up right, the CzechIdM will deploy. Default log is ''​/​opt/​tomcat/​​current/​logs/​​catalina.out''​.
  
  
-==== 11. Final Steps ==== +==== 10. Final Steps ==== 
  
 === Allow network services === === Allow network services ===
Line 404: Line 345:
  
 <code bash> <code bash>
 +firewall-cmd --permanent --add-port=80/​tcp
 firewall-cmd --permanent --add-port=443/​tcp firewall-cmd --permanent --add-port=443/​tcp
 firewall-cmd --reload firewall-cmd --reload