> Source: https://docs.cyberelements.io/bastion/4.6/fr/Installation/Docker/EdgeGateway/

# Installation de la Edge Gateway Docker

## Importation de l'image Docker

Avant de pouvoir créer un conteneur Edge Gateway Docker, il est nécessaire d'importer l'image Docker. Pour se faire, lancer un shell depuis lequel les commandes Docker vous sont disponibles ainsi que le fichier `cleanroom-gateway-4.6.1-33-v4.tgz`. Depuis le shell exécutez la commande suivante en adaptant le chemin vers le fichier `TGZ` s'il ne se trouve pas dans le répertoire courant :

```
1
```

Contrôlez ensuite que l'importation a bien réussi avec la commande suivante :

```
1
```

La sortie attendue est la suivante (l'ID SHA256 peut varier en fonction de l'OS sur lequel Docker est installé, les exemples proviennent de Debian 13), si ce n'est pas le cas alors l'importation a échouée :

```
1
2
3
4
5
6
```

> **Sortie complète**
>
> ```
>  1
>  2
>  3
>  4
>  5
>  6
>  7
>  8
>  9
> 10
> 11
> 12
> 13
> 14
> 15
> 16
> 17
> 18
> 19
> 20
> 21
> 22
> 23
> 24
> 25
> 26
> 27
> 28
> 29
> 30
> 31
> 32
> 33
> 34
> 35
> 36
> 37
> 38
> 39
> 40
> 41
> 42
> 43
> 44
> 45
> 46
> 47
> 48
> 49
> 50
> 51
> 52
> 53
> 54
> 55
> 56
> 57
> 58
> 59
> 60
> 61
> 62
> 63
> 64
> 65
> 66
> 67
> 68
> 69
> 70
> 71
> 72
> 73
> 74
> 75
> 76
> 77
> 78
> 79
> 80
> 81
> 82
> 83
> ```

## Configuration du conteneur

### Variables d'environnement

#### Variables pour un déploiement par appairage

| Nom | Obligatoire | Valeur par défaut | Commentaire |
|---|---|---|---|
| `ENV_MEDIATION` | OUI |  | Utilisé pour la connexion avec appairage. Nom DNS ou adresse IP de connexion à l'interface Web d'une plateforme CyberElements Bastion. |
| `ENV_TOKEN` | OUI |  | Utilisé pour la connexion avec appairage. Indication du jeton d'appairage à utiliser pour la connexion au Mediation Controller. |
| `ENV_NO_CHECK_CERT` | NON | `false` | Utilisé pour la connexion avec appairage. Désactivation ou non du contrôle du certificat Web du Mediation Controller, utile avec CyberElements Bastion lors d'un accès via adresse IP ou lorsque le certificat Web n'est pas un certificat reconnu avec les autorités de certification publiques par défaut. Valeurs acceptées : `true` ou `false`. |

#### Variables pour un déploiement manuel

| Nom | Obligatoire | Valeur par défaut | Commentaire |
|---|---|---|---|
| `ENV_GW_CERT_NAME` | OUI |  | Utilisé pour la connexion avec configuration manuelle. Nom du fichier de certificat pour la connexion au Routeur SSL. |
| `ENV_GW_CERT_PASSWORD` | OUI |  | Utilisé pour la connexion avec configuration manuelle. Mot de passe du fichier de certificat pour la connexion au Routeur SSL. |
| `ENV_CARE_CERT_NAME` | NON | Valeur de `ENV_GW_CERT_NAME` | Utilisé pour la connexion avec configuration manuelle. Nom du fichier de certificat pour le service d'enregistrement. |
| `ENV_CARE_CERT_PASSWORD` | NON | Valeur de `ENV_GW_CERT_PASSWORD` | Utilisé pour la connexion avec configuration manuelle. Mot de passe du fichier de certificat du service d'enregistrement. |
| `ENV_SSL_ROUTER_IP` | OUI |  | Utilisé pour la connexion avec configuration manuelle. Adresse IP ou nom DNS du Routeur SSL vers lequel la Edge Gateway se connectera. |
| `ENV_SSL_ROUTER_PORT` | NON | `443` | Utilisé pour la connexion avec configuration manuelle. Port du Routeur SSL vers lequel la Edge Gateway se connectera. |

#### Variables diverses

| Nom | Obligatoire | Valeur par défaut | Commentaire |
|---|---|---|---|
| `ENV_DISABLE_RSYSLOG` | NON | `false` | Désactivation du service `rsyslog`. Valeurs acceptées : `true` ou `false`. |
| `ENV_KERBEROS_CONFIG_ENABLE` | NON | `false` | Activation du paramétrage Kerberos pour permettre l'authentification des applications RDP en mode sans agent en Kerberos. Valeurs acceptées : `true` ou `false`. Si `false` les autres variables Kerberos seront ignorées. |
| `ENV_KERBEROS_DEFAULT_REALM` | OUI (si configuration Kerberos activée) |  | Nom du royaume Kerberos. |
| `ENV_KERBEROS_DEFAULT_DOMAIN` | OUI (si configuration Kerberos activée) |  | Nom du domaine Kerberos. |
| `ENV_KERBEROS_CONTROLLER_ADDRESS` | OUI (si configuration Kerberos activée) |  | Adresse de connexion au contrôleur Kerberos. |

### Volumes

| Volume | Commentaire |
|---|---|
| `/etc/ipdiva/` | Volume de configuration de la Edge Gateway. Nous recommandons de le monter sur un volume nommé ou sur le système de fichiers de la machine hôte. |
| `/opt/certificates/` | Volume contenant le ou les certificats de la Edge Gateway lors d'une configuration sans utilisation de l'appairage. |
| `/var/lib/ipdiva/carerecord/archives/` | Volume contenant les archives graphiques. Nous recommandons de le monter sur un volume nommé ou sur le système de fichiers de la machine hôte. |
| `/var/ipdiva/care/sshrecord/` | Volume contenant les archives SSH. Nous recommandons de le monter sur un volume nommé ou sur le système de fichiers de la machine hôte. |
| `/var/log/` | Volume contenant les logs de la Edge Gateway. |

### Ports

| Port | Commentaire |
|---|---|
| `2222` (ou tout autre port disponible choisi par l'administrateur) | Port d'écoute du service d'accès direct SSH / SFTP. |
| `3389` | Port d'écoute du service d'accès direct RDP. |
| `8443` | Port d'écoute du service d'enregistrement, à exposer en cas d'utilisation de l'agent d'enregistrement Windows. |

## Déploiement de la Edge Gateway Docker

### Déploiement avec appairage

> **Prérequis**
>
> Avant de déployer la Edge Gateway Docker, il est nécessaire d'[obtenir un jeton d'appairage](https://docs.cyberelements.io/bastion/4.6/fr/Usage/Configuration/AdminConsole/CreatePairingTokenForEdgeGateway/).

Le déploiement décrit ci-après utilisera l'ensemble des volumes disponibles (mise à part `/opt/certificates/` qui n'est pas utile dans ce contexte) et exposera l'ensemble des ports.
Les volumes seront montés sur le système de fichiers de la machine hôte avec comme emplacement `EDGE_GATEWAY_REP`. A l'intérieur de celui-ci se trouvent les sous-répertoires suivants :

- config
- graphical_archives
- ssh_archives
- log

Vous pouvez personnaliser les variables des commandes qui suivront :

| Valeur personnalisée | Variable | Commentaire |
|---|---|---|
|  | `DOCKER_NAME` | Nom du conteneur Docker. |
|  | `EDGE_GATEWAY_REP` | Emplacement sur le système de fichier pour monter les volumes. |
|  | `ENV_MEDIATION_VALUE` | Valeur de la [variable d'environnement](#environment-variables) `ENV_MEDIATION`. |
|  | `ENV_TOKEN_VALUE` | Valeur de la [variable d'environnement](#environment-variables) `ENV_TOKEN`. |
|  | `ENV_NO_CHECK_CERT_VALUE` | Valeur de la [variable d'environnement](#environment-variables) `ENV_NO_CHECK_CERT`. |
|  | `ENV_KERBEROS_CONFIG_ENABLE_VALUE` | Valeur de la [variable d'environnement](#environment-variables) `ENV_KERBEROS_CONFIG_ENABLE`. |
|  | `ENV_KERBEROS_DEFAULT_REALM_VALUE` | Valeur de la [variable d'environnement](#environment-variables) `ENV_KERBEROS_DEFAULT_REALM`. |
|  | `ENV_KERBEROS_DEFAULT_DOMAIN_VALUE` | Valeur de la [variable d'environnement](#environment-variables) `ENV_KERBEROS_DEFAULT_DOMAIN`. |
|  | `ENV_KERBEROS_CONTROLLER_ADDRESS_VALUE` | Valeur de la [variable d'environnement](#environment-variables) `ENV_KERBEROS_CONTROLLER_ADDRESS`. |

Créez l'arborescence requis pour le montage des volumes sur le système de fichiers :

**Bash**

> ```
> 1
> 2
> 3
> 4
> ```

**PowerShell**

> ```
> 1
> ```

Et enfin démarrez un nouveau conteneur :

**Bash**

> ```
>  1
>  2
>  3
>  4
>  5
>  6
>  7
>  8
>  9
> 10
> 11
> 12
> 13
> 14
> 15
> 16
> ```

**PowerShell**

> ```
>  1
>  2
>  3
>  4
>  5
>  6
>  7
>  8
>  9
> 10
> 11
> 12
> 13
> 14
> 15
> 16
> ```

La visualisation des logs du conteneur peut être obtenu avec la commande suivante :

```
1
```

### Déploiement manuel

> **Prérequis**
>
> Avant de déployer la Edge Gateway Docker, il est nécessaire d'avoir à disposition les certificats requis pour la Edge Gateway et le service d'enregistrement.

> **Mots de passe visibles avec `docker inspect`**
>
> Les variables d'environnement d'un conteneur, mots de passe des certificats compris, restent lisibles par toute personne autorisée à exécuter `docker inspect` sur le serveur Docker. Le [déploiement par appairage](#deployment-with-pairing), qui n'utilise aucun mot de passe de certificat, est donc à privilégier.

Le déploiement décrit ci-après utilisera l'ensemble des volumes disponibles et exposera l'ensemble des ports.
Les volumes seront montés sur le système de fichiers de la machine hôte avec comme emplacement `MANUAL_REP`. A l'intérieur de celui-ci se trouvent les sous-répertoires suivants :

- config
- graphical_archives
- ssh_archives
- log
- certificates

Vous pouvez personnaliser les variables des commandes qui suivront :

| Valeur personnalisée | Variable | Commentaire |
|---|---|---|
|  | `MANUAL_NAME` | Nom du conteneur Docker. |
|  | `MANUAL_REP` | Emplacement sur le système de fichier pour monter les volumes. |
|  | `ENV_GW_CERT_NAME_VALUE` | Valeur de la [variable d'environnement](#environment-variables) `ENV_GW_CERT_NAME`. |
|  | `ENV_CARE_CERT_NAME_VALUE` | Valeur de la [variable d'environnement](#environment-variables) `ENV_CARE_CERT_NAME`. |
|  | `ENV_SSL_ROUTER_IP_VALUE` | Valeur de la [variable d'environnement](#environment-variables) `ENV_SSL_ROUTER_IP`. |
|  | `ENV_SSL_ROUTER_PORT_VALUE` | Valeur de la [variable d'environnement](#environment-variables) `ENV_SSL_ROUTER_PORT`. |
|  | `ENV_KERBEROS_CONFIG_ENABLE_MANUAL_VALUE` | Valeur de la [variable d'environnement](#environment-variables) `ENV_KERBEROS_CONFIG_ENABLE`. |
|  | `ENV_KERBEROS_DEFAULT_REALM_MANUAL_VALUE` | Valeur de la [variable d'environnement](#environment-variables) `ENV_KERBEROS_DEFAULT_REALM`. |
|  | `ENV_KERBEROS_DEFAULT_DOMAIN_MANUAL_VALUE` | Valeur de la [variable d'environnement](#environment-variables) `ENV_KERBEROS_DEFAULT_DOMAIN`. |
|  | `ENV_KERBEROS_CONTROLLER_ADDRESS_MANUAL_VALUE` | Valeur de la [variable d'environnement](#environment-variables) `ENV_KERBEROS_CONTROLLER_ADDRESS`. |

Créez l'arborescence requis pour le montage des volumes sur le système de fichiers :

**Bash**

> ```
> 1
> 2
> 3
> 4
> 5
> ```

**PowerShell**

> ```
> 1
> ```

Placez ensuite les certificats pour la Edge Gateway et le service d'enregistrement dans `MANUAL_REP/certificates`.

Pour que les mots de passe des certificats ne restent pas dans l'historique du shell, saisissez-les dans des variables d'environnement de la session courante (la saisie n'est pas affichée) :

**Bash**

> ```
> 1
> 2
> 3
> ```

**PowerShell**

> ```
> 1
> 2
> ```

Finalement démarrez un nouveau conteneur :

**Bash**

> ```
>  1
>  2
>  3
>  4
>  5
>  6
>  7
>  8
>  9
> 10
> 11
> 12
> 13
> 14
> 15
> 16
> 17
> 18
> 19
> 20
> ```

**PowerShell**

> ```
>  1
>  2
>  3
>  4
>  5
>  6
>  7
>  8
>  9
> 10
> 11
> 12
> 13
> 14
> 15
> 16
> 17
> 18
> 19
> 20
> ```

Une fois le conteneur démarré, supprimez ces variables de la session :

**Bash**

> ```
> 1
> ```

**PowerShell**

> ```
> 1
> ```

La visualisation des logs du conteneur peut être obtenu avec la commande suivante :

```
1
```
