25 January

Install On Premise

This article shows how to download and install Carto-SI on your servers.

Carto-SI is available in Saas.

However, you can choose to install it in On Premise. To access the repository where our deliverables are located, you will need to request identification data in the form of an identifier and a key from support.

Ratings

List of notations used in this document:

Prerequisites

With the On Premise license, Carto-SI is installed in your information system.

It can be installed with:

  • A Docker image
  • An installer in the format.exe ,.deb Where.rpm depending on the operating system.

Regardless of Windows or Unix operating system, the following will be required:

  • At least 8 GB of RAM
  • 5 GB minimum hard drive
  • CPU: at least 1.7 GHz
  • Ports 80 and 443 must be open on the machine and not used by other processes

The installers have been tested on:

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

Last stable version

4.2.16

Check this link for the latest stable version of Carto-SI if it is not displayed above.

In this document, this version number is noted[version] .

For installation time, set a variableVERSION . In the illustrations, we assume that version 4.1.1 is installed.

On Windows , in the command prompt that will be used to download the software, type:

set VERSION=[version]
set VERSION=4.1.1

On Linux , in the terminal that will be used to install the software, type:

VERSION=[version]
VERSION=4.1.1

Identification data

When you subscribe, you are provided with an identifier and a connection key. This time-limited data is required to download the software. In this document, these two pieces of information are noted[identifiant] and[clé] .

In the illustrations, the identifier is alice and the key x15nb163FMjcguvvXHno .

On Windows , in the command prompt, type:

set IDENTIFIANT=[identifiant]
set CLE=[clé]
set IDENTIFIER=alice set CLEE=x15nb163FMjcguvvXHno

On Linux , in the terminal, type:

IDENTIFIANT=[identifiant]
CLE=[clé]
IDENTIFIER=alice; CLEE=x15nb163FMjcguvvXHno

Installation procedure via Docker

You must first have Docker installed on your environment.

Set connection variables

Set the version variable as explained in Latest stable version .

Define identification variables as explained in Identification data .

Installation and launch

Choose the folder that will contain the app data. In this document, the folder path will be named[dossier_data] . In the illustrations, the folder is/home/carto-si .

On Linux , in the terminal, set a variableDOSSIER containing the path with the following command:

DOSSIER=[dossier_data]
FOLDER=/home/carto-is/

Log into the Carto-SI docker repository with the following command:

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

Launch the docker container with the following command:

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

Configure Nginx

The container contains a Java server hidden behind an nginx server. It is possible to provide your own configuration.

To do this, write your own configuration file based on the following configuration:

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;
    }
}

Set an environment variableNGINX_CONFIG containing the path to your configuration file. In the illustration, the path is/home/carto-si/nginx/carto-si.conf .

Then, launch Carto-SI with the following command:

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 $FOLDER:/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

Windows Installation Procedure

An installer in .exe format is available to install Carto-SI on Windows.

Set connection variables

Set the version variable as explained in Latest stable version .

Define identification variables as explained in Identification data .

Download Installer

Download the installer to your Download folder with the following command:

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

Install Carto-SI

Run the carto-si_X.XXexe program you just downloaded. After choosing the installation language, accept the three licenses integrated into the product.

Then indicate in which directory Carto-SI will be installed. This directory will contain both the Carto-SI executable and a folderdata . In this document, the path to this folderdata is noted[dossier_data] .

Destination folder

Let the installer guide you until Carto-SI is installed.

The installation configures Windows to start Carto-SI automatically. A few tens of seconds after the end of the installation, you can check the installed version of Carto-SI by typing the following command in a command prompt:

curl http://localhost/api/version
curl http://localhost/api/version

You can connect to the Carto-SI login page with the URL http://localhost/ (see Connecting to Carto-SI ].

Start and stop Carto-SI

Carto-SI is launched via the Carto-SI Windows service.

Two shortcuts (Start and Stop) have been installed in the start menu.

start and stop

Linux Installation Procedure

Installers in .deb and .rpm format are available to install Carto-SI on Linux.

Set connection variables

Set the version variable as explained in Latest stable version .

Define identification variables as explained in Identification data .

Download Installer

On Debian , download the installer.deb with the following command:

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

On Red Hat 7 , download the installer.rpm with the following command:

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

On Red Hat 8 , download the installer.rpm with the following command:

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

Install Carto-SI

Use the following command to install Carto-SI on Debian :

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

Use the following command to install Carto-SI on Red Hat 7 :

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

Use the following command to install Carto-SI on Red Hat 8 :

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

In Linux, the data is in the folder/opt/carto-si/data . In this document, this file is noted[dossier_data] .

Start and stop Carto-SI

The carto-si service has been added tosystemd . You can start and stop Carto-SI with the following commands:

systemctl start carto-si.service

systemctl stop carto-si.service

config file

The path of the Carto-SI® configuration file is[dossier_data]/conf/carto-si.properties (see on [dossier_data]). It is composed of the following properties:

# 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

Connection to Carto-SI

Using a browser, then connect to the following URL to test Carto-SI:

http://localhost/

Note: the default identifiers are the administrator’s email and the administrator’s password. Its information is available in the configuration file .

Enter this URL to view the REST APIs doc:

http://localhost/apidocs

Enter this URL to check the version of Carto-SI:

http://localhost/api/version

Backup

The design of Carto-SI allows the implementation of a simple and secure backup. This can be integrated into your current backup policy.

All the data to be backed up is in the directory[dossier_data] of Carto-SI (see on[dossier_data] )).

Our On Premise customers are required to store backups in a separate storage space with a retention period appropriate to the business.

If the directory is restored, Carto-SI must be stopped and restarted.

In the directory[dossier_data] are the Carto-SI database, logs and conf files

This directory must be backed up.

In case of modification of the conf files or the data of[dossier_data] , the service must be shut down and restarted for the changes to take effect.


Tags:

Share:

FacebookTwitterLinkedIn

0 Commentaire