Instalar o HTML5 Gateway Docker¶

Importação da imagem Docker¶

Antes de poder criar um contentor HTML5 Gateway Docker, deve importar a imagem Docker. Para isso, abra uma shell a partir da qual disponha dos comandos Docker, bem como do ficheiro cleanroom-html5-4.6.1-33-v2.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:

docker load --input cleanroom-html5-4.6.1-33-v2.tgz

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

docker inspect --type=image cleanroom-html5:4.6.1-33-v2

O resultado esperado é o seguinte. Se não for esse o caso, a importação falhou:

[
    {
        "Id": "sha256:16ae07f1604409f6b092a8a2944e69b3db458a04dbbab6ffc3f945c253c82cee",
        "RepoTags": [
            "cleanroom-html5:4.6.1-33-v2"
        ],

Resultado completo

[
    {
        "Id": "sha256:16ae07f1604409f6b092a8a2944e69b3db458a04dbbab6ffc3f945c253c82cee",
        "RepoTags": [
            "cleanroom-html5:4.6.1-33-v2"
        ],
        "RepoDigests": [],
        "Parent": "",
        "Comment": "buildkit.dockerfile.v0",
        "Created": "2025-08-27T11:35:33.014244258+02:00",
        "DockerVersion": "",
        "Author": "",
        "Architecture": "amd64",
        "Os": "linux",
        "Size": 781097647,
        "GraphDriver": {
            "Data": {
                "LowerDir": "/var/lib/docker/overlay2/aa079416d669709486e3fd3dfefcff51acb3905ffcca7e6e428630d1a499e669/diff:/var/lib/docker/overlay2/da9f43ee88f5961a157af404be018fc7c3f5185a798b26911e38118d83830de7/diff:/var/lib/docker/overlay2/28efb3982392e95711e849cb90985fd534cd6273f4dec758463f98b41a432e93/diff:/var/lib/docker/overlay2/44a3abed0a932259b79c9e5e273749cc06bd8aca7d3adbfd1753a7b053dcae2f/diff:/var/lib/docker/overlay2/e3dfd4c7c4fe568ef731bd91314e69cc5c807ce717d5f4ea94f0d02cc11e70c5/diff:/var/lib/docker/overlay2/5acf2b56871d2537d95b9981c0498e16723a9eca20827f550366b48d8acf508f/diff:/var/lib/docker/overlay2/c732cd17c6501229b3a12c488d7f4c26f8634329211cac54ff1cf0d53055421f/diff:/var/lib/docker/overlay2/fd61cbda2a5e9a578c5a8eea67b63df3d31642588be3b6f2f7ebe6e10964f745/diff",
                "MergedDir": "/var/lib/docker/overlay2/b9c8170b6a9ed8e7c84a9ba208cd6e4b25e88d1dad42cd72b0e1178da62a46d4/merged",
                "UpperDir": "/var/lib/docker/overlay2/b9c8170b6a9ed8e7c84a9ba208cd6e4b25e88d1dad42cd72b0e1178da62a46d4/diff",
                "WorkDir": "/var/lib/docker/overlay2/b9c8170b6a9ed8e7c84a9ba208cd6e4b25e88d1dad42cd72b0e1178da62a46d4/work"
            },
            "Name": "overlay2"
        },
        "RootFS": {
            "Type": "layers",
            "Layers": [
                "sha256:4668f0f488e5ad4494fadff56ad585c514794b3a293e5e8d006410de9da08155",
                "sha256:782f6c5256575fbef0e518a1a1ce9188c457f1a0e9b88b733ed672f6e1be482d",
                "sha256:e09fd3e10e878ef6c812ccde0fa55b66cf4b9b593cf182c2760fec73649968c2",
                "sha256:e51c952c7bd89e0a3188c683d689eed81444d5513c14251f4b21cb9fd056d27d",
                "sha256:233ff67db52988898e3c1b4c2573b86c1c0c50d23f1f4b2365e3fc51abedbf9f",
                "sha256:f832eee42398852cab80a9a45138bf076d63ebbe153263fd8cf66857a0833d02",
                "sha256:f59f79d19c38ae4863b81774ad1d98030370c64e17013eb786da7b727bf2b41b",
                "sha256:0caeed550a29dbb274781e78bbe910fa5ccfdc90119cb4f9e3c815feff5a70b9",
                "sha256:21313651aa44ac0f5dd459a94be172b003b68f81b0db945c24a7ada5c21799e3"
            ]
        },
        "Metadata": {
            "LastTagTime": "0001-01-01T00:00:00Z"
        },
        "Config": {
            "Cmd": null,
            "Entrypoint": [
                "/entrypoint.sh"
            ],
            "Env": [
                "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
                "DEBIAN_FRONTEND=noninteractive",
                "IMAGE_BUILD_DATE=20250827T112940",
                "IMAGE_BUILD_VERSION=4.6.1-33-v2",
                "IMAGE_IPDIPC=IPC-53702"
            ],
            "ExposedPorts": {
                "8080/tcp": {},
                "8090/tcp": {}
            },
            "Labels": {
                "maintainer": "contact@systancia.com",
                "org.label-schema.build-date": "20250827T112940",
                "org.label-schema.description": "Systancia Cleanroom Gateway",
                "org.label-schema.name": "Systancia Cleanroom 4.6.1-33-v2 HTML5 Server",
                "org.label-schema.url": "http://systancia.com/",
                "org.label-schema.vendor": "Systancia",
                "version": "4.6.1-33-v2"
            },
            "OnBuild": null,
            "User": "root",
            "Volumes": null,
            "WorkingDir": ""
        }
    }
]

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. Indica o nome DNS ou o endereço IP para ligar à 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_SSL_ROUTER_IP`	SIM		Utilizado para a ligação com configuração manual. Endereço IP ou nome DNS do SSL Router ao qual o HTML5 Gateway se ligará.
`ENV_SSL_ROUTER_PORT`	NÃO	`443`	Utilizado para a ligação com configuração manual. Porta do SSL Router ao qual o HTML5 Gateway se ligará.

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

Volumes¶

Volume	Comentário
`/etc/ipdiva/`	Volume de configuração do HTML5 Gateway. Recomendamos que o monte num volume com nome ou no sistema de ficheiros da máquina anfitriã.
`/opt/certificates/`	Volume que contém o ou os certificados do HTML5 Gateway em caso de configuração sem pairing.
`/var/log/`	Volume que contém os logs do HTML5 Gateway.

Portas¶

Porta	Comentário
`8080`	Porta de escuta do serviço HTML5.

Implementação do HTML5 Gateway Docker¶

Implementação com pairing¶

Pré-requisitos

Antes de implementar o HTML5 Gateway Docker, deve obter um token de pairing.

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 serão montados no sistema de ficheiros da máquina anfitriã na localização HTML5_GATEWAY_REP. No interior desta localização encontram-se os subdiretórios seguintes:

config
log

Pode personalizar as variáveis dos comandos seguintes:

Valor personalizado	Variável	Comentário
	`DOCKER_NAME`	Nome do contentor Docker.
	`HTML5_GATEWAY_REP`	Localização no sistema de ficheiros onde montar os volumes.
	`ENV_MEDIATION_VALUE`	Valor da variável de ambiente `ENV_MEDIATION`.
	`ENV_TOKEN_VALUE`	Valor da variável de ambiente `ENV_TOKEN`.
	`ENV_NO_CHECK_CERT_VALUE`	Valor da variável de ambiente `ENV_NO_CHECK_CERT`.

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

mkdir -p HTML5_GATEWAY_REP/config
mkdir HTML5_GATEWAY_REP/log

E, por último, inicie um novo contentor:

docker run -d --restart unless-stopped --name "DOCKER_NAME" \
-e ENV_MEDIATION="ENV_MEDIATION_VALUE" \
-e ENV_TOKEN="ENV_TOKEN_VALUE" \
-e ENV_NO_CHECK_CERT="ENV_NO_CHECK_CERT_VALUE" \
-v "HTML5_GATEWAY_REP/config/:/etc/ipdiva/:rw" \
-v "HTML5_GATEWAY_REP/log/:/var/log/:rw" \
-p 8080:8080 \
cleanroom-html5:4.6.1-33-v2

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

docker logs -f DOCKER_NAME

Implementação manual¶

Pré-requisitos

Antes de implementar o HTML5 Gateway Docker, deve dispor do certificado necessário para o HTML5 Gateway.

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
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 `ENV_GW_CERT_NAME`.
	`ENV_GW_CERT_PASSWORD_VALUE`	Valor da variável de ambiente `ENV_GW_CERT_PASSWORD`.
	`ENV_SSL_ROUTER_IP_VALUE`	Valor da variável de ambiente `ENV_SSL_ROUTER_IP`.
	`ENV_SSL_ROUTER_PORT_VALUE`	Valor da variável de ambiente `ENV_SSL_ROUTER_PORT`.

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

mkdir -p MANUAL_REP/config
mkdir MANUAL_REP/log
mkdir MANUAL_REP/certificates

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

Por último, inicie um novo contentor:

docker run -d --restart unless-stopped --name "MANUAL_NAME" \
-e ENV_GW_CERT_NAME="ENV_GW_CERT_NAME_VALUE" \
-e ENV_GW_CERT_PASSWORD="ENV_GW_CERT_PASSWORD_VALUE" \
-e ENV_SSL_ROUTER_IP="ENV_SSL_ROUTER_IP_VALUE" \
-e ENV_SSL_ROUTER_PORT="ENV_SSL_ROUTER_PORT_VALUE" \
-v "MANUAL_REP/config/:/etc/ipdiva/:rw" \
-v "MANUAL_REP/log/:/var/log/:rw" \
-v "MANUAL_REP/certificates/:/opt/certificates/:ro" \
-p 8080:8080 \
cleanroom-html5:4.6.1-33-v2

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

docker logs -f MANUAL_NAME

Configuração do Mediation Controller¶

Para que o novo HTML5 Gateway Docker seja operacional, falta configurar o servidor Mediation Controller através de um acesso SSH ou de consola e com permissões root.

Esta última definição é necessária para permitir que o Mediation Controller comunique com o serviço HTML5.
No entanto, esta configuração varia em função da localização do HTML5 Gateway Docker:

Colocado na DMZColocado na LAN acessível por um Edge Gateway

O esquema geral é o seguinte:

flowchart LR
    subgraph DMZ
        direction TB
        HTML5(HTML5 Gateway Docker)
        MED(Mediation Controller)
    end

    subgraph LAN
        GW(Edge Gateway)
    end


    MED -.-> |Ligação ao serviço HTML5 ; TCP 8080| HTML5
    HTML5 --> |TLS Tunnel| MED
    MED ~~~ GW
    GW --> |TLS Tunnel| MED
    GW ~~~ MED

    linkStyle 0 stroke:#d22,color;

Hold "Ctrl" to enable pan & zoom

Neste contexto, será necessário acrescentar ao ficheiro /etc/ipdiva/httpd/commonParameters.extra.conf as informações indicadas abaixo, ou então criá-lo.
É possível personalizar as definições:

Valor personalizado	Variável	Comentário
	`HTML5_URL_DMZ`	URL configurado ao declarar o HTML5 Gateway na consola de administração.
	`HTML5_IP_DMZ`	Nome DNS ou endereço IP do servidor Docker no qual o HTML5 Gateway Docker está ativo.
	`HTML5_PORT_DMZ`	Porta publicada pelo servidor Docker para o HTML5 Gateway Docker.

<Location /HTML5_URL_DMZ/>
    Order allow,deny
    Allow from all
    ProxyPass http://HTML5_IP_DMZ:HTML5_PORT_DMZ/systanciaHTML5-6.0/ flushpackets=on
    ProxyPassReverse http://HTML5_IP_DMZ:HTML5_PORT_DMZ
</Location>

<Location /HTML5_URL_DMZ/websocket-tunnel>
    Order allow,deny
    Allow from all
    ProxyPass ws://HTML5_IP_DMZ:HTML5_PORT_DMZ/systanciaHTML5-6.0/websocket-tunnel
    ProxyPassReverse ws://HTML5_IP_DMZ:HTML5_PORT_DMZ/systanciaHTML5-6.0/websocket-tunnel
</Location>

O esquema geral é o seguinte:

flowchart LR
    subgraph DMZ
        direction TB
        MED(Mediation Controller)
    end

    subgraph LAN
        HTML5(HTML5 Gateway Docker)
        GW(Edge Gateway)
    end


    MED -.- | Ligação ao serviço HTML5 ; através do túnel TLS| GW -.-> |Ligação ao serviço HTML5 ; TCP 8080| HTML5
    HTML5 --> |TLS Tunnel| MED
    GW --> |TLS Tunnel| MED

    linkStyle 0,1 stroke:#d22,color;

Hold "Ctrl" to enable pan & zoom

Neste contexto, será necessário acrescentar ao ficheiro /etc/ipdiva/httpd/commonParameters.extra.conf as informações indicadas abaixo, ou então criá-lo.
É possível personalizar as definições:

Valor personalizado	Variável	Comentário
	`HTML5_URL_LAN`	URL configurado ao declarar o HTML5 Gateway na consola de administração.
	`GW_NAME_LAN`	Nome do Edge Gateway utilizado para ligar ao serviço HTML5. O caráter de barra vertical no fim da linha deve ser conservado.
	`ORGANIZATION_NAME_LAN`	Nome da organização à qual o Edge Gateway se liga.
	`HTML5_IP_LAN`	Nome DNS ou endereço IP do servidor Docker no qual o HTML5 Gateway Docker está ativo.
	`HTML5_PORT_LAN`	Porta publicada pelo servidor Docker para o HTML5 Gateway Docker.

<Location /HTML5_URL_LAN/>
    Order allow,deny
    Allow from all
    RequestHeader set X-Forwarded-Proto "https"
    RequestHeader set X-IPdiva-Gateway GW_NAME_LAN|
    RequestHeader set X-IPdiva-Orgname ORGANIZATION_NAME_LAN
    RequestHeader set X-IPdiva-Service HTML5_IP_LAN:HTML5_PORT_LAN

    ProxyPass http://127.0.0.1:9016/systanciaHTML5-6.0/ flushpackets=on
</Location>

<Location /HTML5_URL_LAN/websocket-tunnel>
    Order allow,deny
    Allow from all
    RequestHeader set X-Forwarded-Proto "https"
    RequestHeader set X-IPdiva-Gateway GW_NAME_LAN|
    RequestHeader set X-IPdiva-Orgname ORGANIZATION_NAME_LAN
    RequestHeader set X-IPdiva-Service HTML5_IP_LAN:HTML5_PORT_LAN

    ProxyPass ws://127.0.0.1:9016/systanciaHTML5-6.0/websocket-tunnel
</Location>

Sugestão

Esta configuração também pode ser utilizada na situação seguinte, em que um Edge Gateway Docker e um HTML5 Gateway Docker são executados na mesma rede Docker:

flowchart LR
    subgraph DMZ
        direction TB
        MED(Mediation Controller)
    end

    subgraph LAN
        subgraph docker[Docker Server]
            HTML5([HTML5 Gateway Docker])
            GW([Edge Gateway])
        end
    end


    MED -.- | Ligação ao serviço HTML5 ; através do túnel TLS| GW -.-> |Ligação ao serviço HTML5 ; TCP 8080 através da rede Docker| HTML5
    HTML5 --> |TLS Tunnel| MED
    GW --> |TLS Tunnel| MED

    linkStyle 0,1 stroke:#d22,color;

Hold "Ctrl" to enable pan & zoom

Exemplo

Neste exemplo, vamos implementar um Edge Gateway e um HTML5 Gateway no mesmo servidor Docker.

A infraestrutura utilizada para o exemplo é a seguinte:

Servidor Mediation Controller
- Endereço IP web: 10.0.10.10
- Nome da organização: my-organization-name
- Token para o Edge Gateway: YJ5N-JN05-N5LS-N26H-7JHA-HZ9R-BGJF-MAVH
- Token para o HTML5 Gateway: ATCW-OMVR-0RY4-LW1M-D9G9-H5VF-WPX5-YCXF
- URL de acesso ao serviço HTML5: HTML5_DOCKER
Servidor Docker
- Nome da rede Docker: cyberelements-cleanroom-network
- Edge Gateway
  - Nome: my-edge-gateway-docker
  - Localização raiz no sistema de ficheiros: /opt/my-edge-gateway-docker
- HTML5 Gateway
  - Nome: my-html5-gateway-docker
  - Localização raiz no sistema de ficheiros: /opt/my-html5-gateway-docker

Em primeiro lugar, no servidor Docker, tem de criar a árvore de diretórios para montar os volumes Docker:

mkdir -p /opt/my-edge-gateway-docker/config
mkdir /opt/my-edge-gateway-docker/graphical_archives
mkdir /opt/my-edge-gateway-docker/ssh_archives
mkdir /opt/my-edge-gateway-docker/log
mkdir -p /opt/my-html5-gateway-docker/config
mkdir /opt/my-html5-gateway-docker/log

Em seguida, crie uma rede Docker do tipo bridge para que os dois contentores possam comunicar entre si:

docker network create -d bridge cyberelements-cleanroom-network

Depois, inicie o contentor do Edge Gateway. Note que o exemplo estabelece uma ligação por pairing, com acesso ao Mediation Controller através do seu endereço IP e sem verificação de certificado adicional. Além disso, o parâmetro --network é acrescentado para indicar a utilização da rede Docker criada anteriormente:

docker run -d --restart unless-stopped --name "my-edge-gateway-docker" \
-e ENV_MEDIATION="10.0.10.10" \
-e ENV_TOKEN="YJ5N-JN05-N5LS-N26H-7JHA-HZ9R-BGJF-MAVH" \
-e ENV_NO_CHECK_CERT="true" \
-v "/opt/my-edge-gateway-docker/config/:/etc/ipdiva/:rw" \
-v "/opt/my-edge-gateway-docker/graphical_archives/:/var/lib/ipdiva/carerecord/archives/:rw" \
-v "/opt/my-edge-gateway-docker/ssh_archives/:/var/ipdiva/care/sshrecord/:rw" \
-v "/opt/my-edge-gateway-docker/log/:/var/log/:rw" \
-p 2222:2222 \
-p 3389:3389 \
-p 8443:8443 \
--network="cyberelements-cleanroom-network" \
cleanroom-gateway:4.6.1-33-v2

Depois, inicie o contentor do HTML5 Gateway. Note que o exemplo estabelece uma ligação por pairing, com acesso ao Mediation Controller através do seu endereço IP e sem verificação de certificado adicional. Além disso, o parâmetro --network é acrescentado para indicar a utilização da rede Docker criada anteriormente e, dado que o acesso ao serviço HTML5 será feito através da rede Docker, não é necessário publicar a porta 8080:

docker run -d --restart unless-stopped --name "my-html5-gateway-docker" \
-e ENV_MEDIATION="10.0.10.10" \
-e ENV_TOKEN="ATCW-OMVR-0RY4-LW1M-D9G9-H5VF-WPX5-YCXF" \
-e ENV_NO_CHECK_CERT="true" \
-v "/opt/my-html5-gateway-docker/config/:/etc/ipdiva/:rw" \
-v "/opt/my-html5-gateway-docker/log/:/var/log/:rw" \
--network="cyberelements-cleanroom-network" \
cleanroom-html5:4.6.1-33-v2

Por último, é necessário configurar o ficheiro /etc/ipdiva/httpd/commonParameters.extra.conf no ou nos servidores Mediation Controller. Deve ser acrescentada a secção seguinte:

<Location /HTML5_DOCKER/>
    Order allow,deny
    Allow from all
    RequestHeader set X-Forwarded-Proto "https"
    RequestHeader set X-IPdiva-Gateway my-edge-gateway-docker|
    RequestHeader set X-IPdiva-Orgname my-organization-name
    RequestHeader set X-IPdiva-Service my-html5-gateway-docker:8080

    ProxyPass http://127.0.0.1:9016/systanciaHTML5-6.0/ flushpackets=on
</Location>

<Location /HTML5_DOCKER/websocket-tunnel>
    Order allow,deny
    Allow from all
    RequestHeader set X-Forwarded-Proto "https"
    RequestHeader set X-IPdiva-Gateway my-edge-gateway-docker|
    RequestHeader set X-IPdiva-Orgname my-organization-name
    RequestHeader set X-IPdiva-Service my-html5-gateway-docker:8080

    ProxyPass ws://127.0.0.1:9016/systanciaHTML5-6.0/websocket-tunnel
</Location>

Antes de aplicar as novas definições, é necessário verificar que a nova configuração não provoca nenhum erro bloqueante no servidor web Apache2.
Para isso, execute o seguinte comando:

1	`apache2ctl configtest`

Se a resposta for Syntax OK, as alterações podem ser aplicadas com o comando abaixo. Caso contrário, verifique a configuração do seu ficheiro /etc/ipdiva/httpd/commonParameters.extra.conf.

1	`systemctl reload apache2`