Code source wiki de Guide d'installation Windows

Modifié par fperrier le 2022/07/26 09:39
Masquer les derniers auteurs
fperrier 4.1 1 {{ddtoc/}}
2
3 ----
4
5 (% class="box warningmessage" %)
6 (((
7 Java est requis pour pouvoir lancer DigDash. Actuellement, la version 17 de java n'est pas supportée et ne fonctionnera pas. Nous recommandons d'utiliser java 11 (les versions 12 à 16 n'étant pas des versions LTS) pour le moment.
8 )))
9
10 (% class="box infomessage" %)
11 (((
12 __Vocabulaire__
13
14 Dans toutes les pages de documentation, les "**applications**" font références aux fichiers **.war **présents dans le serveur DigDash Enterprise :
15
16 * **Serveur** : ddenterpriseapi.war
17 * **Tableau de bord** : digdash_dashboard.war
18 * **Web Studio** : studio.war
19 * **Page d'accueil et Desktop Studio** : adminconsole.war
20
21 Cet ensemble d'applications constitue un domaine. Selon les besoins ce domaine peut être dupliqué pour par exemple disposer d'un contexte de développement et un autre de production.
22 Pour déployer plusieurs domaines suivez [[ce lien>>path:/xwiki/wiki/howtos/view/howtos/server/Domain_management/]].
23 )))
24
25 L'installation de DigDash Enterprise sur Windows peut se faire de deux façons :
26
27 * lancement manuel
28 * lancement automatique en tant que service Windows
29
30 Ce document décrit comment installer DigDash sur Windows dans ces deux modes.
31
32 Pour l'installation sur Linux, se reporter au document [[Guide d'Installation Linux>>url:https://doc.digdash.com/xwiki/wiki/dd2021r1/view/Digdash/deployment/installation/install_guide_linux/]].
33
34 Pour une mise à jour d'une installation existante, se reporter au document [[Guide de mise à jour>>url:https://doc.digdash.com/xwiki/wiki/dd2021r1/view/Digdash/deployment/installation/upgrade_dde/]].
35
36 = Installation =
37
38 * Décompressez les fichiers contenus dans le fichier **digdash_enterprise_2022R1_numpatch_64.zip** vers le répertoire de votre choix sur votre ordinateur. **Ne pas utiliser de chemins avec des espaces.**
39 * Renommez le dossier contenant l'installation.
40 ** L'idéal est un nom sans version, pour ne pas induire en erreur sur le contenu de l'installation lors des mises à jour à venir.
41 * Vérifiez que votre dossier d'installation contient le fichier **version.txt**.
42 ** C'est lui qui indiquera de manière certaine la version du produit (sans avoir à démarrer le serveur).
43
44 L'ensemble des fichiers serveurs de DigDash Enterprise est à présent installé sur votre ordinateur.
45
46 = Paramètres Tomcat =
47
48 Certains paramétrages usuels tels que l'allocation de mémoire et les ports réseaux nécessaires sont susceptibles d'être modifiés dès l'installation.
49
50 Ce paragraphe décrit comment modifier trois des paramètres les plus importants au moment de l'installation : l'allocation de mémoire à tomcat, les ports réseau utilisés et le nom du service Windows (si une installation en tant que service Windows est prévue).
51
52 Une liste plus complète de paramètres système se trouve dans le document [[Réglages avancés des paramètres système>>doc:Digdash.deployment.configuration.advanced_system_guide.WebHome]].
53
54 == Mémoire allouée à Tomcat ==
55
56 1. Ouvrez le répertoire <**DD Install>\configure** puis éditez le fichier **setenv.bat**
57 1. Modifiez les valeurs des variables **JVMMS** et **JVMMX** définies en début du fichier. Par exemple : **set JVMMS=4096** et **set JVMMX=4096** pour augmenter la mémoire allouée à Tomcat à 4Go.
58
59 == Ports réseau Tomcat ==
60
61 Si un des ports nécessaires à Tomcat est déjà utilisé par un autre processus, alors il ne se lancera pas. Il est nécessaire de vérifier la disponibilité des ports et si besoin de reconfigurer Tomcat.
62 Par défaut les 3 ports suivants sont configurés : 8005, 8080 et 8009. Pour les modifier :
63
64 1. Ouvrez le répertoire **<DD Install>/apache-tomcat/conf** puis éditer le fichier **server.xml**
65 1. Cherchez et remplacez les valeurs des ports **8005**,** 8080 **et **8009 **par des numéros de port disponibles sur le système.
66
67 == Nom du service Windows Tomcat ==
68
69 Dans certains cas il est intéressant de modifier le nom du service Windows qui sera créé lors de l'installation en tant que service (chapitre suivant), par exemple si un service du même nom existe déjà.
70
71 1. Ouvrez le répertoire **<DD Install>\configure** puis éditez le fichier **servers_install_service.bat**
72 1. Cherchez et modifiez la valeur de la variable **SERVICE_NAME** au début du fichier.
73 Par exemple :**set SERVICE_NAME=Tomcat_DEV**
74
75 = Paramètres DigDash =
76
77 Avant le 1er démarrage du serveur, il est vivement conseillé de s'assurer que certains paramètres sont compatibles avec votre environnement.
78
79 == Fichier de configuration digdash.properties ==
80
81 Le fichier **digdash.properties** présent dans le répertoire d'installation vous permet de configurer tout l'environnement.
82
83 Vous pouvez modifier le fichier **digdash.properties** livré pour personnaliser votre environnement. Vous pouvez aussi changer son emplacement. Voir le chapitre [[Externalisation des paramètres dans le fichier digdash.properties>>url:https://doc.digdash.com/xwiki/wiki/dd2022r1/view/Digdash/deployment/configuration/advanced_system_guide/#HExternalisationdesparamE8tresdansleA0fichierdigdash.properties]].
84
85 == Emplacement du dossier de vos données ==
86
87 DigDash Enterprise stocke les informations de configuration, les modèles de données, les graphiques, les cubes, l'historique des flux et d'autres fichiers de travail dans le **dossier de l'utilisateur du système d'exploitation**, dans un sous dossier **Application Data/Enterprise Server/<domaine>**.
88
89 Par exemple sous Windows, ce dossier est :
90 C:\Users\<utilisateur>\AppData\Roaming\Enterprise Server\ddenterpriseapi
91
92 Il est important de modifier ce dossier pour en garantir l'accessibilité (droits en lecture/écriture/exécution) et pour maitriser l'espace de stockage (ce dossier peut être volumineux).
93 Cette modification est aussi intéressante pour des raisons d'organisation, de scripting, etc.
94
95 Il existe plusieurs moyen de modifier ce chemin.
96
97 === Dossier commun à tous les domaines ===
98
99 Fichier modifié : **digdash.properties**
100
101 Ceci est le moyen le plus simple et efficace. Toutes les applications de DigDash Enterprise en profiteront (un seul paramétrage).
102 L'autre méthode n'est à utiliser qu'en cas de besoin spécifique.
103
104 La variable **digdash.appdata** permet de spécifier l'unique dossier des données.
105 Dans le fichier **<DDE Install>/digdash.properties**, décommentez la ligne **#digdash.appdata=c:/data** en supprimant le caractère **#** en début de ligne :
106
107 (% class="box infomessage" %)
108 (((
109 digdash.appdata=C:/appdata
110 )))
111
112 (% class="box warningmessage" %)
113 (((
114 Attention à n'utiliser que des slash "/", ou deux anti-slash "~\~\".
115 )))
116
117 Si ce dossier n'existe pas, DigDash Enterprise le crée. Les données ne seront pas stockées directement dans ce dossier, mais dans des sous dossier pour chaque application :
118 **<digdash.appdata>/Enterprise Server/<domaine>**
119 **<digdash.appdata>/Enterprise Administrator**
120 **<digdash.appdata>/ldapdigdash**
121
122 **Avantage** : La configuration se faisant au niveau du fichier **digdash.properties**, elle ne sera pas écrasée lors de la mise à jour de DigDash Enterprise par déploiement de nouveaux fichiers WAR.
123
124 **Inconvénient** : Cette configuration est globale au Tomcat de DigDash Enterprise, donc tous les domaines DigDash Enterprise de ce serveur sont concernés.
125 Cependant les données des différents domaines DigDash Enterprise déployés dans ce Tomcat ont bien leur sous-dossier propre, il n'y a aucun risque d'écrasement des données.
126
127 === Dossier différent pour chaque domaine ===
128
129 Fichier modifié : **digdash.properties**
130
131 La variable **<domaine>.AppDataPath** définie dans ce fichier a le même comportement que la variable globale décrite ci-dessus.
132 La différence est que ce paramétrage est spécifique à un domaine DigDash Enterprise.
133
134 Pour définir un dossier des données spécifique à un domaine, modifiez le paramètre AppDataPath préfixé du nom du domaine.
135 Si vous avez un domaine ddenterpriseapi_dev, le paramètre sera :
136
137 ddenterpriseapi_dev.AppDataPath=C:/appdata_dev
138
139 **Avantages** :
140
141 * Configuration locale à un domaine
142 * Fichier externe au WAR
143
144 **Inconvénient** : Configuration à faire pour chaque domaine.
145
146 = Démarrage et arrêt manuel de DigDash Enterprise =
147
148 Lorsque DigDash Enterprise n'est pas installé en tant que service Windows.
149
150 == Démarrage de DigDash Enterprise ==
151
152 Ouvrez le répertoire d'installation de DigDash Entreprise, puis double cliquez sur le fichier **start_tomcat.bat**.
153
154 Le premier démarrage du serveur peut prendre plusieurs minutes car les applications web se déploient.
155
156 == Arrêt de DigDash Enterprise ==
157
158 Ouvrez le répertoire d'installation de DigDash Entreprise, puis double cliquez sur le fichier **stop_tomcat.bat**.
159
160 = Installation en tant que service Windows =
161
162 L'installation en tant que service doit être faite avec un utilisateur ayant des droits d'administration Windows sur cette machine.
163
164 (% class="box warningmessage" %)
165 (((
166 Assurez-vous d'avoir vérifié et modifié les paramètres importants mentionnés dans le chapitre précédent __//avant//__ d'installer le service.
167 Si vous modifiez des paramètres vous devrez installer de nouveau le service (via le script **servers_install_service.bat**)
168 )))
169
170 == Installation ==
171
172 * Démarrez l'invite de commande avec les droits d'administration :
173 ** Faites un clic droit sur le racourcis de l'invite de commande et sélectionnez « Exécuter en tant qu'administrateur »
174 * Positionnez-vous dans le répertoire **<DD Install>\configure** puis entrez la commande **servers_install_service.bat** sur Windows 64 bits.
175 Le service « Tomcat 9» est installé (ou un autre nom que vous auriez spécifié).
176 * Le service est installé en lancement manuel par défaut. Pour modifier ce comportement il faut lancer le gestionnaire de services Windows, et changer les propriétés du nouveau service.
177 Pensez aussi à vérifier au même endroit que l'utilisateur exécutant le service est bien configuré.
178
179 == Démarrage ==
180
181 L'application **Services** de Windows permet de gérer tous les services installés.
182 Dans cette liste faites un clic-droit sur votre service ("Tomcat 9" par défaut), puis cliquez sur **Démarrer**.
183 Une fois le serveur démarré la page d'accueil sera accessible (http:~/~/localhost:8080 par défaut).