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

# Instalação do Edge Gateway Docker

## Importação da imagem Docker

Antes de poder criar um contentor Edge Gateway Docker, tem de importar a imagem Docker. Para isso, abra uma shell na qual disponha dos comandos Docker, bem como do ficheiro `cleanroom-gateway-4.6.1-33-v4.tgz`. A partir da shell, execute o comando seguinte, ajustando o caminho do ficheiro `TGZ` se este não se encontrar no diretório atual:

```
1
```

Em seguida, verifique se a importação foi bem-sucedida com o comando seguinte:

```
1
```

O resultado esperado é o seguinte (o identificador SHA256 pode variar em função do sistema operativo no qual o Docker está instalado; os exemplos provêm do Debian 13). Se não for o caso, a importação falhou:

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

> **Resultado completo**
>
> ```
>  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
> ```

## Configuração do contentor

### Variáveis de ambiente

#### Variáveis para a implementação por pairing

| Nome | Obrigatório | Valor predefinido | Comentário |
|---|---|---|---|
| `ENV_MEDIATION` | SIM |  | Utilizado para a ligação por pairing. Nome DNS ou endereço IP de ligação à interface web de uma plataforma CyberElements Bastion. |
| `ENV_TOKEN` | SIM |  | Utilizada para a ligação por pairing. Indica o token de pairing a utilizar para a ligação ao Mediation Controller. |
| `ENV_NO_CHECK_CERT` | NÃO | `false` | Utilizado para as ligações por pairing. Desativa ou não a verificação do certificado web do Mediation Controller; é útil com CyberElements Bastion quando o acesso é feito por endereço IP ou quando o certificado web não é reconhecido pelas autoridades de certificação públicas predefinidas. Valores aceites: `true` ou `false`. |

#### Variáveis para a implementação manual

| Nome | Obrigatório | Valor predefinido | Comentário |
|---|---|---|---|
| `ENV_GW_CERT_NAME` | SIM |  | Utilizada para a ligação com configuração manual. Nome do ficheiro de certificado para a ligação ao SSL Router. |
| `ENV_GW_CERT_PASSWORD` | SIM |  | Utilizada para a ligação com configuração manual. Palavra-passe do ficheiro de certificado para a ligação ao SSL Router. |
| `ENV_CARE_CERT_NAME` | NÃO | Valor de `ENV_GW_CERT_NAME` | Utilizada para a ligação com configuração manual. Nome do ficheiro de certificado do serviço de gravação. |
| `ENV_CARE_CERT_PASSWORD` | NÃO | Valor de `ENV_GW_CERT_PASSWORD` | Utilizada para a ligação com configuração manual. Palavra-passe do ficheiro de certificado do serviço de gravação. |
| `ENV_SSL_ROUTER_IP` | SIM |  | Utilizada para a ligação com configuração manual. Endereço IP ou nome DNS do SSL Router ao qual o Edge Gateway se liga. |
| `ENV_SSL_ROUTER_PORT` | NÃO | `443` | Utilizada para a ligação com configuração manual. Porta do SSL Router à qual o Edge Gateway se liga. |

#### Variáveis diversas

| Nome | Obrigatório | Valor predefinido | Comentário |
|---|---|---|---|
| `ENV_DISABLE_RSYSLOG` | NÃO | `false` | Desativação do serviço `rsyslog`. Valores aceites: `true` ou `false`. |
| `ENV_KERBEROS_CONFIG_ENABLE` | NÃO | `false` | Ativa a configuração Kerberos para permitir que as aplicações RDP se autentiquem em modo sem agente através de Kerberos. Valores aceites: `true` ou `false`. Se for `false`, as restantes variáveis Kerberos são ignoradas. |
| `ENV_KERBEROS_DEFAULT_REALM` | SIM (se a configuração Kerberos estiver ativada) |  | Nome do realm Kerberos. |
| `ENV_KERBEROS_DEFAULT_DOMAIN` | SIM (se a configuração Kerberos estiver ativada) |  | Nome do domínio Kerberos. |
| `ENV_KERBEROS_CONTROLLER_ADDRESS` | SIM (se a configuração Kerberos estiver ativada) |  | Endereço de ligação ao controlador Kerberos. |

### Volumes

| Volume | Comentário |
|---|---|
| `/etc/ipdiva/` | Volume de configuração do Edge Gateway. Recomendamos montá-lo num volume com nome ou no sistema de ficheiros da máquina anfitriã. |
| `/opt/certificates/` | Volume que contém o ou os certificados do Edge Gateway numa configuração sem pairing. |
| `/var/lib/ipdiva/carerecord/archives/` | Volume que contém as gravações gráficas. Recomendamos montá-lo num volume com nome ou no sistema de ficheiros da máquina anfitriã. |
| `/var/ipdiva/care/sshrecord/` | Volume que contém as gravações SSH. Recomendamos montá-lo num volume com nome ou no sistema de ficheiros da máquina anfitriã. |
| `/var/log/` | Volume que contém os logs do Edge Gateway. |

### Portas

| Porta | Comentário |
|---|---|
| `2222` (ou qualquer outra porta disponível escolhida pelo administrador) | Porta de escuta do serviço de acesso direto SSH/SFTP. |
| `3389` | Porta de escuta do serviço de acesso direto RDP. |
| `8443` | Porta de escuta do serviço de gravação, a expor quando se utiliza o agente de gravação Windows. |

## Implementação do Edge Gateway Docker

### Implementação com pairing

> **Pré-requisitos**
>
> Antes de implementar o Edge Gateway Docker, tem de [obter um token de pairing](https://docs.cyberelements.io/bastion/4.6/pt/Usage/Configuration/AdminConsole/CreatePairingTokenForEdgeGateway/).

A implementação descrita a seguir utiliza todos os volumes disponíveis (exceto `/opt/certificates/`, que não é útil neste contexto) e expõe todas as portas.
Os volumes são montados no sistema de ficheiros da máquina anfitriã na localização `EDGE_GATEWAY_REP`. Dentro desta localização encontram-se os seguintes subdiretórios:

- config
- graphical_archives
- ssh_archives
- log

Pode personalizar as variáveis dos comandos seguintes:

| Valor personalizado | Variável | Comentário |
|---|---|---|
|  | `DOCKER_NAME` | Nome do contentor Docker. |
|  | `EDGE_GATEWAY_REP` | Localização no sistema de ficheiros onde montar os volumes. |
|  | `ENV_MEDIATION_VALUE` | Valor da [variável de ambiente](#environment-variables) `ENV_MEDIATION`. |
|  | `ENV_TOKEN_VALUE` | Valor da [variável de ambiente](#environment-variables) `ENV_TOKEN`. |
|  | `ENV_NO_CHECK_CERT_VALUE` | Valor da [variável de ambiente](#environment-variables) `ENV_NO_CHECK_CERT`. |
|  | `ENV_KERBEROS_CONFIG_ENABLE_VALUE` | Valor da [variável de ambiente](#environment-variables) `ENV_KERBEROS_CONFIG_ENABLE`. |
|  | `ENV_KERBEROS_DEFAULT_REALM_VALUE` | Valor da [variável de ambiente](#environment-variables) `ENV_KERBEROS_DEFAULT_REALM`. |
|  | `ENV_KERBEROS_DEFAULT_DOMAIN_VALUE` | Valor da [variável de ambiente](#environment-variables) `ENV_KERBEROS_DEFAULT_DOMAIN`. |
|  | `ENV_KERBEROS_CONTROLLER_ADDRESS_VALUE` | Valor da [variável de ambiente](#environment-variables) `ENV_KERBEROS_CONTROLLER_ADDRESS`. |

Crie a árvore de diretórios necessária para montar os volumes no sistema de ficheiros:

**Bash**

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

**PowerShell**

> ```
> 1
> ```

E, por último, inicie um novo contentor:

**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
> ```

Os logs do contentor podem ser consultados com o comando seguinte:

```
1
```

### Implementação manual

> **Pré-requisitos**
>
> Antes de implementar o Edge Gateway Docker, tem de dispor dos certificados necessários para o Edge Gateway e para o serviço de gravação.

> **Palavras-passe visíveis com `docker inspect`**
>
> As variáveis de ambiente de um contentor, incluindo as palavras-passe dos certificados, continuam legíveis por qualquer pessoa autorizada a executar `docker inspect` no servidor Docker. Por isso, deve dar-se preferência à [implementação com pairing](#deployment-with-pairing), que não utiliza nenhuma palavra-passe de certificado.

A implementação descrita a seguir utiliza todos os volumes disponíveis e expõe todas as portas.
Os volumes são montados no sistema de ficheiros da máquina anfitriã na localização `MANUAL_REP`. Dentro desta localização encontram-se os seguintes subdiretórios:

- config
- graphical_archives
- ssh_archives
- log
- certificates

Pode personalizar as variáveis dos comandos seguintes:

| Valor personalizado | Variável | Comentário |
|---|---|---|
|  | `MANUAL_NAME` | Nome do contentor Docker. |
|  | `MANUAL_REP` | Localização no sistema de ficheiros onde montar os volumes. |
|  | `ENV_GW_CERT_NAME_VALUE` | Valor da [variável de ambiente](#environment-variables) `ENV_GW_CERT_NAME`. |
|  | `ENV_CARE_CERT_NAME_VALUE` | Valor da [variável de ambiente](#environment-variables) `ENV_CARE_CERT_NAME`. |
|  | `ENV_SSL_ROUTER_IP_VALUE` | Valor da [variável de ambiente](#environment-variables) `ENV_SSL_ROUTER_IP`. |
|  | `ENV_SSL_ROUTER_PORT_VALUE` | Valor da [variável de ambiente](#environment-variables) `ENV_SSL_ROUTER_PORT`. |
|  | `ENV_KERBEROS_CONFIG_ENABLE_MANUAL_VALUE` | Valor da [variável de ambiente](#environment-variables) `ENV_KERBEROS_CONFIG_ENABLE`. |
|  | `ENV_KERBEROS_DEFAULT_REALM_MANUAL_VALUE` | Valor da [variável de ambiente](#environment-variables) `ENV_KERBEROS_DEFAULT_REALM`. |
|  | `ENV_KERBEROS_DEFAULT_DOMAIN_MANUAL_VALUE` | Valor da [variável de ambiente](#environment-variables) `ENV_KERBEROS_DEFAULT_DOMAIN`. |
|  | `ENV_KERBEROS_CONTROLLER_ADDRESS_MANUAL_VALUE` | Valor da [variável de ambiente](#environment-variables) `ENV_KERBEROS_CONTROLLER_ADDRESS`. |

Crie a árvore de diretórios necessária para montar os volumes no sistema de ficheiros:

**Bash**

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

**PowerShell**

> ```
> 1
> ```

Em seguida, coloque os certificados do Edge Gateway e do serviço de gravação em `MANUAL_REP/certificates`.

Para que as palavras-passe dos certificados não fiquem guardadas no histórico da shell, introduza-as em variáveis de ambiente da sessão atual (o que é escrito não é apresentado):

**Bash**

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

**PowerShell**

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

Por último, inicie um novo contentor:

**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
> ```

Depois de o contentor ter sido iniciado, remova estas variáveis da sessão:

**Bash**

> ```
> 1
> ```

**PowerShell**

> ```
> 1
> ```

Os logs do contentor podem ser consultados com o comando seguinte:

```
1
```
