Installation On Premise¶

Pour accéder au dépôt où se trouvent nos livrables, il vous faudra demander des données d’identification sous la forme d’un identifiant et d’une clé au support.

Notations¶

Liste des notations utilisées dans ce document :

[clé]: Clé d’identification pour télécharger le logiciel (voir Données d’identification).
[dossier_data]: Dossier contenant les données de Carto-SI. (Voir Installation et lancement), Installer Carto-SI ou Installer Carto-SI)
[identifiant]: Identifiant pour télécharger le logiciel (voir Données d’identification).
[version]: Version du logiciel à installer (voir Dernière version stable).

Prérequis¶

Avec la licence On Premise, Carto-SI s’installe dans votre système d’information.

Il peut être installé au choix avec :

Une image Docker
Un installateur au format .exe, .deb ou .rpm en fonction du système d’exploitation.

Indépendamment du système d’exploitation Windows ou Unix, les éléments suivants seront nécessaires :

8 Go de RAM minimum
5 Go de disque dur minimum
CPU : 1.7 GHz minimum
Les ports 80 et 443 doivent être ouverts sur la machine et non utilisés par d’autres processus

Les installateurs ont été testés sur :

CentOS 7/8, RockyLinux 8
Debian 10/11, Ubuntu 18/20
Windows Server 2019

Dernière version stable¶

Consultez ce lien pour connaitre le numéro de la dernière version stable de Carto-SI. Dans ce document, ce numéro de version est noté [version].

Pour le temps de l’installation, définissez une variable VERSION. Dans les illustrations, nous supposons l’installation de la version 4.1.1.

Sous Windows, dans l’invite de commande qui sera utilisée pour télécharger le logiciel, tapez :

set VERSION=[version]

set VERSION=4.1.1

Sous Linux, dans le terminal qui sera utilisé pour installer le logiciel, tapez :

VERSION=[version]

VERSION=4.1.1

Données d’identification¶

Lors de votre souscription, un identifiant et une clé de connexion vous sont fournis. Ces données à durée de vie limitée sont nécessaires pour télécharger le logiciel. Dans ce document, ces deux informations sont notées [identifiant] et [clé].

Dans les illustrations, l’identifiant est alice et la clé x15nb163FMjcguvvXHno.

Sous Windows, dans l’invite de commande, tapez :

set IDENTIFIANT=[identifiant]
set CLE=[clé]

set IDENTIFIANT=alice set CLEE=x15nb163FMjcguvvXHno

Sous Linux, dans le terminal, tapez :

IDENTIFIANT=[identifiant]
CLE=[clé]

IDENTIFIANT=alice; CLEE=x15nb163FMjcguvvXHno

Procédure d’installation via Docker¶

Vous devez au préalable avoir installé Docker sur votre environnement.

Définir les variables de connexion¶

Définir la variable de version comme explicitée dans Dernière version stable.

Définir les variables d’identification comme explicitées dans Données d’identification.

Installation et lancement¶

Choisissez le dossier qui contiendra les données de l’application. Dans ce document, le chemin du dossier sera nommé [dossier_data]. Dans les illustrations, le dossier est /home/carto-si.

Sous Linux, dans le terminal, définissez une variable DOSSIER contenant le chemin avec la commande suivante :

DOSSIER=[dossier_data]

DOSSIER=/home/carto-is/

Loggez-vous sur le repository docker de Carto-SI avec la commande suivante :

docker login -u $IDENTIFIANT -p $CLE registry.gitlab.com/cartosi

docker login -u $IDENTIFIANT -p $CLE registry.gitlab.com/cartosi

Lancez le conteneur docker avec la commande suivante :

docker run --rm -v $DOSSIER:/carto-si/data -p 80:80 registry.gitlab.com/c3772/cartosi/carto-si:$VERSION

docker run --rm -v $DOSSIER:/carto-si/data -p 80:80 registry.gitlab.com/c3772/cartosi/carto-si:$VERSION

Configurer Nginx¶

Le container contient un serveur Java caché derrière un serveur nginx. Il est possible de fournir votre propre configuration.

Pour ce faire, écrivez votre propre fichier de configuration en vous inspirant de la configuration suivante :

server {
    listen 80 ;
	if ($http_x_forwarded_proto = ‘http’ ) {
        return 301 https://$host$request_uri;
	}
	
	location / {
        root /var/www/html/;
	}
	location /api {
        proxy_pass http://127.0.0.1:9327;
	}
}

Définissez une variable d’environnement NGINX_CONFIG contenant le chemin de votre fichier de configuration. Dans l’illustration, le chemin est /home/carto-si/nginx/carto-si.conf.

Puis, lancez Carto-SI avec la commande suivante :

docker run --rm -v $DOSSIER:/carto-si/data -v $NGINX_CONFIG:/etc/nginx/sites-available/carto-si.com -p 80:80 -p 443:443 registry.gitlab.com/c3772/cartosi/carto-si:$VERSION

docker run --rm -v $DOSSIER:/carto-si/data -v $NGINX_CONFIG:/etc/nginx/sites-available/carto-si.com -p 80:80 -p 443:443 registry.gitlab.com/c3772/cartosi/carto-si:$VERSION

Procédure d’Installation Windows¶

Un installateur au format .exe est disponible pour installer Carto-SI sur Windows.

Définir les variables de connexion¶

Définir la variable de version comme explicitée dans Dernière version stable.

Définir les variables d’identification comme explicitées dans Données d’identification.

Télécharger L’installateur¶

Téléchargez l’installateur dans votre dossier Download avec la commande suivante :

curl --user %IDENTIFIANT%:%CLE% https://gitlab.com/api/v4/projects/1432924/packages/generic/carto-si/%VERSION%/carto-si_%VERSION%.exe -o %userprofile%\Downloads\carto-si_%VERSION%.exe

$curl --user %IDENTIFIANT%:%CLE% https://gitlab.com/api/v4/projects/1432924/packages/generic/carto-si/%VERSION%/carto-si_%VERSION%.exe -o %userprofile%\Downloads\carto-si_%VERSION%.exe$

Installer Carto-SI¶

Exécutez le programme carto-si_X.X.X.exe que vous venez de télécharger. Après avoir choisi le langage d’installation, acceptez les trois licences intégrées au produit.

Puis indiquez dans quel répertoire sera installé Carto-SI. Ce répertoire contiendra à la fois l’exécutable de Carto-SI et un dossier data. Dans ce document, le chemin vers ce dossier data est noté [dossier_data].

Dossier de destination

Laissez-vous guider par l’installateur jusqu’à ce que Carto-SI soit installé.

L’installation configure Windows pour démarrer automatiquement Carto-SI. Quelques dizaines de secondes après la fin de l’installation, vous pouvez vérifier la version installée de Carto-SI en tapant la commande suivante dans une invite de commande :

curl http://localhost/api/version

curl http://localhost/api/version

Vous pouvez vous connecter à la page de login de Carto-SI avec l’URL http://localhost/ (voir Connexion à Carto-SI].

Lancer et arrêter Carto-SI¶

Carto-SI est lancé par l’intermédiaire du service Windows Carto-SI.

Deux raccourcis (Start et Stop) ont été installés dans le menu démarrer.

start et stop

Procédure d’Installation Linux¶

Des installateurs au format .deb et .rpm sont disponibles pour installer Carto-SI sur Linux.

Définir les variables de connexion¶

Définir la variable de version comme explicitée dans Dernière version stable.

Définir les variables d’identification comme explicitées dans Données d’identification.

Télécharger L’installateur¶

Sous Debian, téléchargez l’installateur .deb avec la commande suivante :

curl --user $IDENTIFIANT:$CLE https://gitlab.com/api/v4/projects/1432924/packages/generic/carto-si/$VERSION/carto-si_$VERSION-1_all.deb -o carto-si_$VERSION-1_all.deb

Sous Red Hat 7, téléchargez l’installateur .rpm avec la commande suivante :

curl --user $IDENTIFIANT:$CLE https://gitlab.com/api/v4/projects/1432924/packages/generic/carto-si/$VERSION/carto-si-$VERSION-1.el7.noarch.rpm -o carto-si-$VERSION-1.el7.noarch.rpm

Sous Red Hat 8, téléchargez l’installateur .rpm avec la commande suivante :

curl --user $IDENTIFIANT:$CLE https://gitlab.com/api/v4/projects/1432924/packages/generic/carto-si/$VERSION/carto-si-$VERSION-1.el8.noarch.rpm -o carto-si-$VERSION-1.el8.noarch.rpm

Installer Carto-SI¶

Utiliser la commande suivante pour installer Carto-SI sur Debian :

sudo apt install -y ./carto-si_$VERSION-1_all.deb

Utiliser la commande suivante pour installer Carto-SI sur Red Hat 7 :

sudo yum install -y ./carto-si-$VERSION-1.el7.noarch.rpm

Utiliser la commande suivante pour installer Carto-SI sur Red Hat 8 :

sudo yum install -y ./carto-si-$VERSION-1.el8.noarch.rpm

Sous Linux, les données se trouvent dans le dossier /opt/carto-si/data. Dans ce document, ce dossier est noté [dossier_data].

Lancer et arrêter Carto-SI¶

Le service carto-si a été ajouté à systemd. Vous pouvez lancer et arrêter Carto-SI avec les commandes suivantes :

systemctl start carto-si.service

systemctl stop carto-si.service

Fichier de configuration¶

Le chemin du fichier de configuration de Carto-SI® est [dossier_data]/conf/carto-si.properties (voir [dossier_data]). Il est composé des propriétés suivantes :

# mail de l’administrateur
mailadmin : admin@carto-si.com

# mot de passe de l'administrateur
password : ****

# clef utilisée pour signer le jeton jwt
jwt-secret : ****

# port de connexion HTTP. 80 sur Windows, 9327 sur Linux et docker.
port-http : 9327

# port de connexion HTTPS
port-https : 443

# niveau de log. Les valeurs valides sont trace, debug, info, warn et error.
log-level : info

Connexion à Carto-SI¶

A l’aide d’un navigateur, connectez-vous ensuite sur l’URL suivante pour tester Carto-SI :

http://localhost/

Note : les identifiants par défaut sont le mail de l’administrateur et le mot de passe de l’administrateur. Ses informations sont disponibles dans Fichier de configuration.

Entrez cette URL pour consulter la doc des API REST :

http://localhost/apidocs

Entrez cette URL pour vérifier la version de Carto-SI :

http://localhost/api/version

Sauvegarde¶

La conception de Carto-SI permet la mise en place d’une sauvegarde simple et sécurisée. Celle-ci pourra s’intégrer dans votre politique de sauvegarde actuelle.

La totalité des données à sauvegarder se trouve dans le répertoire [dossier_data] de Carto-SI (voir sur [dossier_data]).

Il est demandé à nos clients On Premise de stocker les sauvegardes dans un espace de stockage distinct avec une durée de rétention adaptée à l’entreprise.

En cas de restauration du répertoire, un arrêt-relance de Carto-SI est nécessaire.

Dans le répertoire [dossier_data] se trouvent la base de données, les logs et les fichiers de conf de Carto-SI

Ce répertoire doit impérativement être sauvegardé.

En cas de modification des fichiers de conf ou des données de [dossier_data], le service doit être éteint et relancé pour que les modifications soient prisent en compte.

Installation On Premise¶

Notations¶

Prérequis¶

Dernière version stable¶

Données d’identification¶

Procédure d’installation via Docker¶

Définir les variables de connexion¶

Installation et lancement¶

Configurer Nginx¶

Procédure d’Installation Windows¶

Définir les variables de connexion¶

Télécharger L’installateur¶

Installer Carto-SI¶

Lancer et arrêter Carto-SI¶

Procédure d’Installation Linux¶

Définir les variables de connexion¶

Télécharger L’installateur¶

Installer Carto-SI¶

Lancer et arrêter Carto-SI¶

Fichier de configuration¶

Connexion à Carto-SI¶

Sauvegarde¶

Table des matières

Versions