Wiki source code of Guide d'installation Linux
Last modified by Aurelie Bertrand on 2026/07/02 10:53
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
| |
382.1 | 1 | This guide provides installation and configuration instructions for a production environment on Ubuntu 24.04. |
| |
85.3 | 2 | |
| |
241.1 | 3 | ---- |
| |
85.3 | 4 | |
| |
351.1 | 5 | {{toc/}} |
| |
1.4 | 6 | |
| |
248.1 | 7 | ---- |
| 8 | |||
| |
382.1 | 9 | This document describes how to install DigDash on Linux with Ubuntu 24.04. |
| |
247.1 | 10 | |
| |
382.1 | 11 | For installation on Windows, please refer to the document [[Windows Installation Guide>>doc:Digdash.deployment.installation.install_guide_windows.WebHome]]. |
| |
248.1 | 12 | |
| |
382.1 | 13 | To update an existing installation, please refer to the document [[Upgrade Guide>>doc:Digdash.deployment.installation.upgrade_dde.WebHome]]. |
| |
248.1 | 14 | |
| |
382.1 | 15 | = Supported versions = |
| |
136.1 | 16 | |
| |
382.1 | 17 | The following versions are supported: |
| |
136.1 | 18 | |
| |
382.1 | 19 | * Tomcat 10: latest patch |
| 20 | * Java : OpenJDK 17 | ||
| 21 | * OpenDJ: version 4.8.0 and later | ||
| 22 | * MariaDB: OS version or latest LTS version, latest patch | ||
| 23 | * Nginx: system version | ||
| |
137.1 | 24 | |
| 25 | ((( | ||
| |
1.1 | 26 | = Digdash = |
| |
136.1 | 27 | ))) |
| |
1.1 | 28 | |
| |
247.1 | 29 | == OpenJDK == |
| |
4.1 | 30 | |
| |
247.1 | 31 | (% class="box warningmessage" %) |
| 32 | ((( | ||
| |
382.1 | 33 | Java is required to run DigDash. The version to use is **Java 17, 21 or 25.** |
| |
247.1 | 34 | ))) |
| |
5.1 | 35 | |
| |
7.1 | 36 | {{code language="shell"}} |
| |
382.1 | 37 | # Install last version of openjdk (adapt to Java version) |
| 38 | sudo apt install openjdk-17-jdk | ||
| |
4.1 | 39 | |
| |
382.1 | 40 | # Check installation |
| |
7.1 | 41 | java -version |
| |
4.1 | 42 | {{/code}} |
| 43 | |||
| |
306.1 | 44 | == Tomcat 10{{id name="Tomcat_ubuntu"/}} == |
| |
1.1 | 45 | |
| |
14.1 | 46 | === Installation === |
| 47 | |||
| |
7.1 | 48 | {{code language="shell"}} |
| |
298.1 | 49 | sudo apt install tomcat10 |
| |
7.1 | 50 | {{/code}} |
| |
1.1 | 51 | |
| |
382.1 | 52 | === Creating the tree structure === |
| |
3.1 | 53 | |
| |
7.1 | 54 | {{code language="shell"}} |
| |
382.1 | 55 | # Location of webapps |
| |
29.2 | 56 | sudo mkdir -p /home/digdash/webapps/default/ |
| |
382.1 | 57 | # Working directory |
| |
29.2 | 58 | sudo mkdir -p /home/digdash/appdata/default/ |
| |
382.1 | 59 | # Location of the .properties file |
| |
29.2 | 60 | sudo mkdir -p /etc/digdash/ |
| |
382.1 | 61 | # Location of logs |
| |
29.2 | 62 | sudo mkdir -p /var/log/digdash/ |
| |
7.1 | 63 | {{/code}} |
| 64 | |||
| |
382.1 | 65 | Changing folder permissions |
| |
7.1 | 66 | |
| 67 | {{code language="shell"}} | ||
| |
29.2 | 68 | sudo chown -R tomcat:tomcat /home/digdash |
| 69 | sudo chown -R tomcat:tomcat /var/log/digdash | ||
| 70 | sudo chmod a+w /var/log/digdash | ||
| |
7.1 | 71 | {{/code}} |
| 72 | |||
| |
382.1 | 73 | === Configuring server.xml === |
| |
14.1 | 74 | |
| |
15.1 | 75 | (% class="wikigeneratedid" %) |
| |
382.1 | 76 | Location: /etc/tomcat10/server.xml |
| |
15.1 | 77 | |
| |
382.1 | 78 | ==== Location of webapps ==== |
| |
14.1 | 79 | |
| 80 | {{code language="shell"}} | ||
| |
382.1 | 81 | # Replace the appBase value |
| |
14.1 | 82 | <Host name="localhost" appBase="webapps" |
| 83 | |||
| |
382.1 | 84 | # by this one |
| |
14.1 | 85 | <Host name="localhost" appBase="/home/digdash/webapps/default" |
| 86 | {{/code}} | ||
| 87 | |||
| |
382.1 | 88 | ==== Valve Connector ==== |
| |
150.1 | 89 | |
| 90 | {{code language="shell"}} | ||
| |
382.1 | 91 | # Complete the Connector valve |
| 92 | <Connector port="8080" protocol="HTTP/1.1" | ||
| 93 | connectionTimeout="20000" | ||
| 94 | redirectPort="8443" ></Connector> | ||
| |
150.1 | 95 | |
| |
382.1 | 96 | # as follows |
| |
150.1 | 97 | <Connector port="8080" protocol="HTTP/1.1" |
| 98 | connectionTimeout="20000" | ||
| 99 | maxConnections="30000" | ||
| 100 | maxParameterCount="100000" | ||
| 101 | maxThreads="10000" maxPostSize="62914560" | ||
| |
150.2 | 102 | redirectPort="8443" compression="on" ></Connector> |
| |
150.1 | 103 | {{/code}} |
| 104 | |||
| |
16.1 | 105 | ==== Valve Reverse Proxy ==== |
| |
14.1 | 106 | |
| |
298.1 | 107 | (% class="box warningmessage" %) |
| 108 | ((( | ||
| |
382.1 | 109 | ❗In the case of SSO authentication (SAML or OpenID), the valve below must be placed before the SSO valve. |
| |
298.1 | 110 | ))) |
| 111 | |||
| |
16.1 | 112 | {{code language="shell"}} |
| |
382.1 | 113 | # Add this valve in the Host element near the end of the file |
| |
16.1 | 114 | <Valve className="org.apache.catalina.valves.RemoteIpValve" |
| 115 | internalProxies="127\.0\.[0-1]\.1" | ||
| 116 | remoteIpHeader="X-Forwarded-For" | ||
| 117 | requestAttributesEnabled="true" | ||
| |
34.1 | 118 | protocolHeader="X-Forwarded-Proto" |
| |
26.2 | 119 | protocolHeaderHttpsValue="https"></Valve> |
| |
16.1 | 120 | {{/code}} |
| |
14.1 | 121 | |
| |
382.1 | 122 | In the case of an ipv6 server, use : |
| |
85.1 | 123 | |
| 124 | {{code language="shell"}} | ||
| |
150.2 | 125 | <Valve className="org.apache.catalina.valves.RemoteIpValve" |
| 126 | internalProxies="127\.0\.[0-1]\.1|0:0:0:0:0:0:0:1|::1" | ||
| 127 | remoteIpHeader="X-Forwarded-For" | ||
| 128 | requestAttributesEnabled="true" | ||
| 129 | protocolHeader="X-Forwarded-Proto" | ||
| 130 | protocolHeaderHttpsValue="https"></Valve> | ||
| 131 | {{/code}} | ||
| 132 | |||
| |
153.1 | 133 | (% class="box warningmessage" %) |
| 134 | ((( | ||
| |
382.1 | 135 | In very rare cases, reverse proxy is not installed on the machine. In this case, replace the value "127\.0\.[0-1]\.1" with the reverse proxy's ip address. |
| 136 | ❗Please note: ".*" should only be used as a last resort. | ||
| |
153.1 | 137 | ))) |
| |
150.2 | 138 | |
| |
16.1 | 139 | ==== Valve Log ==== |
| |
14.1 | 140 | |
| |
16.1 | 141 | {{code language="shell"}} |
| |
382.1 | 142 | # Add this valve in the Host element near the end of the file |
| |
26.2 | 143 | <Valve className="org.apache.catalina.valves.ErrorReportValve" showReport="false" showServerInfo="false" ></Valve> |
| |
16.1 | 144 | {{/code}} |
| |
14.1 | 145 | |
| |
382.1 | 146 | ==== Limit the localhost_access_log file (optional) ==== |
| |
176.1 | 147 | |
| |
382.1 | 148 | To limit the size of the localhost_access_log file, add the //maxDays// parameter to the Access Log valve and give it the value of the number of days of your choice. |
| |
176.1 | 149 | |
| 150 | {{code language="shell"}} | ||
| |
382.1 | 151 | # For example |
| |
176.1 | 152 | <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs" |
| |
382.1 | 153 | prefix="localhost_access_log" suffix=".txt" |
| 154 | pattern="%h %l %u %t "%r" %s %b" maxDays="10" ></Valve> | ||
| |
176.1 | 155 | |
| 156 | {{/code}} | ||
| 157 | |||
| |
382.1 | 158 | === Editing the context.xml file === |
| |
151.1 | 159 | |
| |
180.1 | 160 | (% class="wikigeneratedid" id="HEmplacement:2Fetc2Ftomcat92Fcontext.xml" %) |
| |
382.1 | 161 | Location: /etc/tomcat10/context.xml |
| |
180.1 | 162 | |
| |
151.1 | 163 | {{code language="shell"}} |
| |
382.1 | 164 | # Add the following line in the <Context> tag |
| |
345.1 | 165 | <Resources cachingAllowed="true" cacheMaxSize="500000"></Resources> |
| |
151.1 | 166 | {{/code}} |
| 167 | |||
| |
382.1 | 168 | === Changing RAM === |
| |
17.2 | 169 | |
| 170 | {{code language="shell"}} | ||
| |
382.1 | 171 | # Edit the following file |
| |
299.1 | 172 | sudo vi /etc/default/tomcat10 |
| |
42.1 | 173 | |
| |
382.1 | 174 | # Replace the existing JAVA_OPTS by |
| |
369.1 | 175 | JAVA_OPTS="-Djava.awt.headless=true -Xms6G -Xmx6G -Djava.security.egd=file:/dev/urandom -Dfile.encoding=UTF-8 -DPROP_MAX_CONCURRENT_TOTAL=5000 -DPROP_MAX_CONCURRENT_CON_PER_HOST=5000 --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED --add-opens=java.base/sun.security.ssl=ALL-UNNAMED --add-opens=java.base/sun.security.util=ALL-UNNAMED" |
| |
42.1 | 176 | |
| |
382.1 | 177 | # Change the 6G parameter depending on the capacity of the machine, leaving at least 2G for the OS. |
| 178 | # In the example above, the machine has 8G of RAM. | ||
| 179 | # It is recommended to use the same value for Xms and Xmx. | ||
| |
17.2 | 180 | {{/code}} |
| 181 | |||
| |
382.1 | 182 | === Activating log write permission for tomcat === |
| |
15.2 | 183 | |
| |
16.1 | 184 | {{code language="shell"}} |
| |
382.1 | 185 | # Create the folder in /etc/systemd/system/ |
| |
300.1 | 186 | sudo mkdir -p /etc/systemd/system/tomcat10.service.d |
| |
15.2 | 187 | |
| |
382.1 | 188 | # Create file |
| |
300.1 | 189 | sudo vi /etc/systemd/system/tomcat10.service.d/logging-allow.conf |
| |
16.1 | 190 | |
| |
382.1 | 191 | # Add the following lines |
| |
16.1 | 192 | [Service] |
| |
300.1 | 193 | ReadWritePaths=/var/log/digdash/ /home/digdash/ |
| |
29.2 | 194 | |
| |
382.1 | 195 | #Reload the "daemon" configuration |
| |
29.2 | 196 | sudo systemctl daemon-reload |
| 197 | |||
| |
300.1 | 198 | sudo systemctl restart tomcat10.service |
| |
16.1 | 199 | {{/code}} |
| 200 | |||
| |
382.1 | 201 | === Enabling automatic service start on startup === |
| |
156.2 | 202 | |
| 203 | {{code language="shell"}} | ||
| |
300.1 | 204 | sudo systemctl enable tomcat10 |
| |
156.2 | 205 | {{/code}} |
| 206 | |||
| |
382.1 | 207 | == Deployment of Digdash Version 2026 R1 == |
| |
16.1 | 208 | |
| |
382.1 | 209 | {{warning}} |
| 210 | Download the Digdash version | ||
| |
16.1 | 211 | |
| |
382.1 | 212 | Unzip the version you just downloaded. |
| 213 | {{/warning}} | ||
| |
8.1 | 214 | |
| |
382.1 | 215 | === Properties files === |
| |
20.1 | 216 | |
| |
382.1 | 217 | Place the digdash.properties file (contained in the root of the unzipped folder) in the// /etc/digdash// folder. |
| |
102.2 | 218 | |
| |
382.1 | 219 | Create the following files in the /etc/digdash folder: |
| 220 | |||
| |
47.1 | 221 | * [[log4j2_api.properties>>attach:log4j2_api.properties]] |
| 222 | * [[log4j2_dash.properties>>attach:log4j2_dash.properties]] | ||
| 223 | * [[log4j2_studio.properties>>attach:log4j2_studio.properties]] | ||
| |
21.1 | 224 | |
| |
382.1 | 225 | Modify the digdash.properties file previously copied |
| |
21.1 | 226 | |
| 227 | {{code language="shell"}} | ||
| |
382.1 | 228 | # Add these lines at the beginning of the file |
| |
21.1 | 229 | |
| |
382.1 | 230 | # Log files location |
| |
37.1 | 231 | ddenterpriseapi.ddlog4j.properties.file=/etc/digdash/log4j2_api.properties |
| 232 | studio.ddlog4j.properties.file=/etc/digdash/log4j2_studio.properties | ||
| 233 | digdash_dashboard.ddlog4j.properties.file=/etc/digdash/log4j2_dash.properties | ||
| 234 | |||
| |
382.1 | 235 | # Appadata location |
| |
21.1 | 236 | ddenterpriseapi.AppDataPath=/home/digdash/appdata/default |
| 237 | digdash_dashboard.AppDataPath=/home/digdash/appdata/default | ||
| 238 | studio.AppDataPath=/home/digdash/appdata/default | ||
| |
37.1 | 239 | adswrapper.ads.instance.name=/home/digdash/appdata/default/ldapdigdash |
| 240 | |||
| |
21.1 | 241 | adminconsole.adminconsole_domain=adminconsole |
| 242 | adminconsole.webstudio_domain=studio | ||
| 243 | adminconsole.server_domain_list=ddenterpriseapi | ||
| 244 | adminconsole.dashboard_domain=digdash_dashboard | ||
| 245 | |||
| 246 | studio.DOMAIN=ddenterpriseapi | ||
| 247 | studio.FORCEDOMAIN=true | ||
| 248 | studio.SERVERURL=http://localhost:8080 | ||
| 249 | studio.FORCESERVERURL=true | ||
| 250 | studio.adminconsole_domain=adminconsole | ||
| 251 | |||
| 252 | digdash_dashboard.DOMAIN=ddenterpriseapi | ||
| 253 | digdash_dashboard.FORCEDOMAIN=true | ||
| 254 | digdash_dashboard.SERVERURL=http://localhost:8080 | ||
| 255 | digdash_dashboard.FORCESERVERURL=true | ||
| 256 | digdash_dashboard.adminconsole_domain=adminconsole | ||
| 257 | |||
| |
382.1 | 258 | # IODS scripts location |
| |
345.1 | 259 | studio.iods_exe_path=path/to/IODS/scripts |
| 260 | ddenterpriseapi.iods_exe_path=path/to/IODS/scripts | ||
| 261 | |||
| |
382.1 | 262 | # NodeJS export |
| |
345.1 | 263 | ddenterpriseapi.DDAPIFORNODEJSURL=http://localhost:8080 |
| |
382.1 | 264 | ddenterpriseapi.NODEJSURL=http://localhost:4000 #Random value between 4000 and 3000 different for each environment hosted on the same Tomcat |
| |
345.1 | 265 | |
| |
21.1 | 266 | ########### Nettoyage automatique des fichiers programmé |
| 267 | ########### Scheduled automatic file cleaning | ||
| 268 | ddenterpriseapi.startCleaner=true | ||
| 269 | |||
| 270 | ########### Nettoyage des fichiers inutilisés au démarrage du serveur | ||
| 271 | ########### Clean up unused files on server startup | ||
| 272 | ddenterpriseapi.cleanOnStart=false | ||
| 273 | |||
| 274 | ########### Sauvegarde automatique programmée | ||
| 275 | ########### Scheduled automatic backup | ||
| 276 | ddenterpriseapi.autoBackup=true | ||
| |
345.1 | 277 | ddenterpriseapi.autoBackupKeepDays=20 |
| |
21.1 | 278 | digdash_dashboard.CANCHANGEPASSWORD=true |
| 279 | |||
| 280 | {{/code}} | ||
| 281 | |||
| |
382.1 | 282 | === Location of war files === |
| |
21.1 | 283 | |
| |
382.1 | 284 | Place the following items (contained in the //apache_tomcat/webappps// directory of the unzipped folder) in the ///home/digdash/webapps/default// folder //~:// |
| |
7.1 | 285 | |
| |
102.2 | 286 | * adminconsole.war |
| 287 | * ddenterpriseapi.war | ||
| 288 | * digdash_dashboard.war | ||
| 289 | * studio.war | ||
| |
382.1 | 290 | * the ROOT/ folder |
| |
102.2 | 291 | |
| |
382.1 | 292 | {{include reference="Digdash.deployment.installation.install_guide_ubuntu.OpenDJ.WebHome"/}} |
| |
59.2 | 293 | |
| |
382.1 | 294 | {{include reference="Digdash.deployment.installation.install_guide_ubuntu.MariaDB.WebHome"/}} |
| |
39.3 | 295 | |
| |
382.1 | 296 | {{include reference="Digdash.deployment.installation.install_guide_ubuntu.NGINX.WebHome"/}} |
| |
137.2 | 297 | |
| |
382.1 | 298 | = Configuring DigDash after installation = |
| |
378.1 | 299 | |
| |
382.1 | 300 | == Launching Digdash == |
| |
378.1 | 301 | |
| |
382.1 | 302 | 1. Restart the Tomcat service. |
| |
378.1 | 303 | |
| 304 | {{code language="shell"}} | ||
| |
300.1 | 305 | sudo service tomcat10 restart |
| |
137.2 | 306 | {{/code}} |
| 307 | |||
| |
146.1 | 308 | (% start="2" %) |
| |
382.1 | 309 | 1. Check the war deployment in the home/digdash/webapps/default installation folder. |
| 310 | 1. Access DigDash at the following address [[__http:~~/~~/localhost:8080/adminconsole .__>>url:http://localhost:8080/adminconsole]]. | ||
| 311 | The login / password will be admin / admin. | ||
| |
137.2 | 312 | |
| |
362.1 | 313 | {{include reference="Digdash.deployment.installation.install_guide_ubuntu.connect_DigDash.WebHome"/}} |