Wiki source code of Guide d'installation Linux

Last modified by Aurelie Bertrand on 2026/07/02 10:53
Show last authors
1 This guide provides installation and configuration instructions for a production environment on Ubuntu 24.04.
2
3 ----
4
5 {{toc/}}
6
7 ----
8
9 This document describes how to install DigDash on Linux with Ubuntu 24.04.
10
11 For installation on Windows, please refer to the document [[Windows Installation Guide>>doc:Digdash.deployment.installation.install_guide_windows.WebHome]].
12
13 To update an existing installation, please refer to the document [[Upgrade Guide>>doc:Digdash.deployment.installation.upgrade_dde.WebHome]].
14
15 = Supported versions =
16
17 The following versions are supported:
18
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
24
25 (((
26 = Digdash =
27 )))
28
29 == OpenJDK ==
30
31 (% class="box warningmessage" %)
32 (((
33 Java is required to run DigDash. The version to use is **Java 17, 21 or 25.**
34 )))
35
36 {{code language="shell"}}
37 # Install last version of openjdk (adapt to Java version)
38 sudo apt install openjdk-17-jdk
39
40 # Check installation
41 java -version
42 {{/code}}
43
44 == Tomcat 10{{id name="Tomcat_ubuntu"/}} ==
45
46 === Installation ===
47
48 {{code language="shell"}}
49 sudo apt install tomcat10
50 {{/code}}
51
52 === Creating the tree structure ===
53
54 {{code language="shell"}}
55 # Location of webapps
56 sudo mkdir -p /home/digdash/webapps/default/
57 # Working directory
58 sudo mkdir -p /home/digdash/appdata/default/
59 # Location of the .properties file
60 sudo mkdir -p /etc/digdash/
61 # Location of logs
62 sudo mkdir -p /var/log/digdash/
63 {{/code}}
64
65 Changing folder permissions
66
67 {{code language="shell"}}
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
71 {{/code}}
72
73 === Configuring server.xml ===
74
75 (% class="wikigeneratedid" %)
76 Location: /etc/tomcat10/server.xml
77
78 ==== Location of webapps ====
79
80 {{code language="shell"}}
81 # Replace the appBase value
82 <Host name="localhost" appBase="webapps"
83
84 # by this one
85 <Host name="localhost" appBase="/home/digdash/webapps/default"
86 {{/code}}
87
88 ==== Valve Connector ====
89
90 {{code language="shell"}}
91 # Complete the Connector valve
92 <Connector port="8080" protocol="HTTP/1.1"
93 connectionTimeout="20000"
94 redirectPort="8443" ></Connector>
95
96 # as follows
97 <Connector port="8080" protocol="HTTP/1.1"
98 connectionTimeout="20000"
99 maxConnections="30000"
100 maxParameterCount="100000"
101 maxThreads="10000" maxPostSize="62914560"
102 redirectPort="8443" compression="on" ></Connector>
103 {{/code}}
104
105 ==== Valve Reverse Proxy ====
106
107 (% class="box warningmessage" %)
108 (((
109 ❗In the case of SSO authentication (SAML or OpenID), the valve below must be placed before the SSO valve.
110 )))
111
112 {{code language="shell"}}
113 # Add this valve in the Host element near the end of the file
114 <Valve className="org.apache.catalina.valves.RemoteIpValve"
115 internalProxies="127\.0\.[0-1]\.1"
116 remoteIpHeader="X-Forwarded-For"
117 requestAttributesEnabled="true"
118 protocolHeader="X-Forwarded-Proto"
119 protocolHeaderHttpsValue="https"></Valve>
120 {{/code}}
121
122 In the case of an ipv6 server, use :
123
124 {{code language="shell"}}
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
133 (% class="box warningmessage" %)
134 (((
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.
137 )))
138
139 ==== Valve Log ====
140
141 {{code language="shell"}}
142 # Add this valve in the Host element near the end of the file
143 <Valve className="org.apache.catalina.valves.ErrorReportValve" showReport="false" showServerInfo="false" ></Valve>
144 {{/code}}
145
146 ==== Limit the localhost_access_log file (optional) ====
147
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.
149
150 {{code language="shell"}}
151 # For example
152 <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
153 prefix="localhost_access_log" suffix=".txt"
154 pattern="%h %l %u %t &quot;%r&quot; %s %b" maxDays="10" ></Valve>
155
156 {{/code}}
157
158 === Editing the context.xml file ===
159
160 (% class="wikigeneratedid" id="HEmplacement:2Fetc2Ftomcat92Fcontext.xml" %)
161 Location: /etc/tomcat10/context.xml
162
163 {{code language="shell"}}
164 # Add the following line in the <Context> tag
165 <Resources cachingAllowed="true" cacheMaxSize="500000"></Resources>
166 {{/code}}
167
168 === Changing RAM ===
169
170 {{code language="shell"}}
171 # Edit the following file
172 sudo vi /etc/default/tomcat10
173
174 # Replace the existing JAVA_OPTS by
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"
176
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.
180 {{/code}}
181
182 === Activating log write permission for tomcat ===
183
184 {{code language="shell"}}
185 # Create the folder in /etc/systemd/system/
186 sudo mkdir -p /etc/systemd/system/tomcat10.service.d
187
188 # Create file
189 sudo vi /etc/systemd/system/tomcat10.service.d/logging-allow.conf
190
191 # Add the following lines
192 [Service]
193 ReadWritePaths=/var/log/digdash/ /home/digdash/
194
195 #Reload the "daemon" configuration
196 sudo systemctl daemon-reload
197
198 sudo systemctl restart tomcat10.service
199 {{/code}}
200
201 === Enabling automatic service start on startup ===
202
203 {{code language="shell"}}
204 sudo systemctl enable tomcat10
205 {{/code}}
206
207 == Deployment of Digdash Version 2026 R1 ==
208
209 {{warning}}
210 Download the Digdash version
211
212 Unzip the version you just downloaded.
213 {{/warning}}
214
215 === Properties files ===
216
217 Place the digdash.properties file (contained in the root of the unzipped folder) in the// /etc/digdash// folder.
218
219 Create the following files in the /etc/digdash folder:
220
221 * [[log4j2_api.properties>>attach:log4j2_api.properties]]
222 * [[log4j2_dash.properties>>attach:log4j2_dash.properties]]
223 * [[log4j2_studio.properties>>attach:log4j2_studio.properties]]
224
225 Modify the digdash.properties file previously copied
226
227 {{code language="shell"}}
228 # Add these lines at the beginning of the file
229
230 # Log files location
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
235 # Appadata location
236 ddenterpriseapi.AppDataPath=/home/digdash/appdata/default
237 digdash_dashboard.AppDataPath=/home/digdash/appdata/default
238 studio.AppDataPath=/home/digdash/appdata/default
239 adswrapper.ads.instance.name=/home/digdash/appdata/default/ldapdigdash
240
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
258 # IODS scripts location
259 studio.iods_exe_path=path/to/IODS/scripts
260 ddenterpriseapi.iods_exe_path=path/to/IODS/scripts
261
262 # NodeJS export
263 ddenterpriseapi.DDAPIFORNODEJSURL=http://localhost:8080
264 ddenterpriseapi.NODEJSURL=http://localhost:4000 #Random value between 4000 and 3000 different for each environment hosted on the same Tomcat
265
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
277 ddenterpriseapi.autoBackupKeepDays=20
278 digdash_dashboard.CANCHANGEPASSWORD=true
279
280 {{/code}}
281
282 === Location of war files ===
283
284 Place the following items (contained in the //apache_tomcat/webappps// directory of the unzipped folder) in the ///home/digdash/webapps/default// folder //~://
285
286 * adminconsole.war
287 * ddenterpriseapi.war
288 * digdash_dashboard.war
289 * studio.war
290 * the ROOT/ folder
291
292 {{include reference="Digdash.deployment.installation.install_guide_ubuntu.OpenDJ.WebHome"/}}
293
294 {{include reference="Digdash.deployment.installation.install_guide_ubuntu.MariaDB.WebHome"/}}
295
296 {{include reference="Digdash.deployment.installation.install_guide_ubuntu.NGINX.WebHome"/}}
297
298 = Configuring DigDash after installation =
299
300 == Launching Digdash ==
301
302 1. Restart the Tomcat service.
303
304 {{code language="shell"}}
305 sudo service tomcat10 restart
306 {{/code}}
307
308 (% start="2" %)
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.
312
313 {{include reference="Digdash.deployment.installation.install_guide_ubuntu.connect_DigDash.WebHome"/}}