De HTML5 Gateway Docker installeren¶

Het Docker-image importeren¶

Voordat u een HTML5 Gateway Docker-container kunt aanmaken, moet u het Docker-image importeren. Open daarvoor een shell waarin de Docker-opdrachten en het bestand cleanroom-html5-4.6.1-33-v2.tgz voor u beschikbaar zijn. Voer vanuit de shell de volgende opdracht uit en pas het pad naar het TGZ-bestand aan als het zich niet in de huidige map bevindt:

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

Controleer daarna met de volgende opdracht of de import is gelukt:

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

De verwachte uitvoer is de volgende. Is dat niet het geval, dan is de import mislukt:

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

Volledige uitvoer

[
    {
        "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": ""
        }
    }
]

Configuratie van de container¶

Omgevingsvariabelen¶

Variabelen voor de implementatie via pairing¶

Naam	Verplicht	Standaardwaarde	Opmerking
`ENV_MEDIATION`	JA		Wordt gebruikt voor de verbinding via pairing. Geeft de DNS-naam of het IP-adres aan voor de verbinding met de webinterface van een CyberElements Bastion-platform.
`ENV_TOKEN`	JA		Wordt gebruikt voor de verbinding via pairing. Geeft het pairing-token aan dat voor de verbinding met de Mediation Controller moet worden gebruikt.
`ENV_NO_CHECK_CERT`	NEE	`false`	Wordt gebruikt voor de verbindingen via pairing. Schakelt de controle van het webcertificaat van de Mediation Controller al dan niet uit; nuttig bij CyberElements Bastion wanneer de toegang via een IP-adres verloopt of wanneer het webcertificaat geen certificaat is dat door de standaard openbare certificeringsinstanties wordt erkend. Toegestane waarden: `true` of `false`.

Variabelen voor de handmatige implementatie¶

Naam	Verplicht	Standaardwaarde	Opmerking
`ENV_GW_CERT_NAME`	JA		Wordt gebruikt voor de verbinding met handmatige configuratie. Naam van het certificaatbestand voor de verbinding met de SSL Router.
`ENV_GW_CERT_PASSWORD`	JA		Wordt gebruikt voor de verbinding met handmatige configuratie. Wachtwoord van het certificaatbestand voor de verbinding met de SSL Router.
`ENV_SSL_ROUTER_IP`	JA		Wordt gebruikt voor de verbinding met handmatige configuratie. IP-adres of DNS-naam van de SSL Router waarmee de HTML5 Gateway verbinding maakt.
`ENV_SSL_ROUTER_PORT`	NEE	`443`	Wordt gebruikt voor de verbinding met handmatige configuratie. Poort van de SSL Router waarmee de HTML5 Gateway verbinding maakt.

Diverse variabelen¶

Naam	Verplicht	Standaardwaarde	Opmerking
`ENV_DISABLE_RSYSLOG`	NEE	`false`	Uitschakeling van de service `rsyslog`. Toegestane waarden: `true` of `false`.

Volumes¶

Volume	Opmerking
`/etc/ipdiva/`	Configuratievolume van de HTML5 Gateway. Wij raden aan het te mounten op een benoemd volume of op het bestandssysteem van de hostmachine.
`/opt/certificates/`	Volume dat het certificaat of de certificaten van de HTML5 Gateway bevat bij een configuratie zonder pairing.
`/var/log/`	Volume dat de logs van de HTML5 Gateway bevat.

Poorten¶

Poort	Opmerking
`8080`	Luisterpoort van de HTML5-service.

Implementatie van de HTML5 Gateway Docker¶

Implementatie met pairing¶

Voorwaarden

Voordat u de HTML5 Gateway Docker implementeert, moet u een pairing-token verkrijgen.

De hieronder beschreven implementatie gebruikt alle beschikbare volumes (behalve /opt/certificates/, dat in deze context niet nuttig is) en stelt alle poorten beschikbaar.
De volumes worden gemount in het bestandssysteem van de hostmachine op de locatie HTML5_GATEWAY_REP. Binnen deze locatie bevinden zich de volgende submappen:

config
log

U kunt de variabelen van de volgende opdrachten aanpassen:

Aangepaste waarde	Variabele	Opmerking
	`DOCKER_NAME`	Naam van de Docker-container.
	`HTML5_GATEWAY_REP`	Locatie in het bestandssysteem waar de volumes worden gemount.
	`ENV_MEDIATION_VALUE`	Waarde van de omgevingsvariabele `ENV_MEDIATION`.
	`ENV_TOKEN_VALUE`	Waarde van de omgevingsvariabele `ENV_TOKEN`.
	`ENV_NO_CHECK_CERT_VALUE`	Waarde van de omgevingsvariabele `ENV_NO_CHECK_CERT`.

Maak de mappenstructuur aan die nodig is om de volumes in het bestandssysteem te mounten:

mkdir -p HTML5_GATEWAY_REP/config
mkdir HTML5_GATEWAY_REP/log

En start ten slotte een nieuwe container:

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

De logs van de container kunnen met de volgende opdracht worden bekeken:

docker logs -f DOCKER_NAME

Handmatige implementatie¶

Voorwaarden

Voordat u de HTML5 Gateway Docker implementeert, moet u over het vereiste certificaat voor de HTML5 Gateway beschikken.

De hieronder beschreven implementatie gebruikt alle beschikbare volumes en stelt alle poorten beschikbaar.
De volumes worden gemount in het bestandssysteem van de hostmachine op de locatie MANUAL_REP. Binnen deze locatie bevinden zich de volgende submappen:

config
log
certificates

U kunt de variabelen van de volgende opdrachten aanpassen:

Aangepaste waarde	Variabele	Opmerking
	`MANUAL_NAME`	Naam van de Docker-container.
	`MANUAL_REP`	Locatie in het bestandssysteem waar de volumes worden gemount.
	`ENV_GW_CERT_NAME_VALUE`	Waarde van de omgevingsvariabele `ENV_GW_CERT_NAME`.
	`ENV_GW_CERT_PASSWORD_VALUE`	Waarde van de omgevingsvariabele `ENV_GW_CERT_PASSWORD`.
	`ENV_SSL_ROUTER_IP_VALUE`	Waarde van de omgevingsvariabele `ENV_SSL_ROUTER_IP`.
	`ENV_SSL_ROUTER_PORT_VALUE`	Waarde van de omgevingsvariabele `ENV_SSL_ROUTER_PORT`.

Maak de mappenstructuur aan die nodig is om de volumes in het bestandssysteem te mounten:

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

Plaats vervolgens de certificaten van de HTML5 Gateway en van de opnameservice in MANUAL_REP/certificates.

Start ten slotte een nieuwe container:

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

De logs van de container kunnen met de volgende opdracht worden bekeken:

docker logs -f MANUAL_NAME

Configuratie van de Mediation Controller¶

Om de nieuwe HTML5 Gateway Docker operationeel te maken, moet de Mediation Controller-server nog worden geconfigureerd via een SSH- of consoletoegang met root-machtigingen.

Deze laatste instelling is nodig om de Mediation Controller met de HTML5-service te laten communiceren.
Deze configuratie verschilt echter naargelang de locatie van de HTML5 Gateway Docker:

In de DMZ geplaatstIn het LAN geplaatst, toegankelijk via een Edge Gateway

Het algemene schema is het volgende:

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

    subgraph LAN
        GW(Edge Gateway)
    end


    MED -.-> |Verbinding met de HTML5-dienst ; 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

In dit kader moeten de hieronder vermelde gegevens aan het bestand /etc/ipdiva/httpd/commonParameters.extra.conf worden toegevoegd, of moet dit bestand worden aangemaakt.
De instellingen kunnen worden aangepast:

Aangepaste waarde	Variabele	Opmerking
	`HTML5_URL_DMZ`	URL die is geconfigureerd bij het declareren van de HTML5 Gateway in de beheerconsole.
	`HTML5_IP_DMZ`	DNS-naam of IP-adres van de Docker-server waarop de HTML5 Gateway Docker actief is.
	`HTML5_PORT_DMZ`	Poort die door de Docker-server voor de HTML5 Gateway Docker wordt gepubliceerd.

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

Het algemene schema is het volgende:

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

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


    MED -.- | Verbinding met de HTML5-dienst ; via de TLS-tunnel| GW -.-> |Verbinding met de HTML5-dienst ; TCP 8080| HTML5
    HTML5 --> |TLS Tunnel| MED
    GW --> |TLS Tunnel| MED

    linkStyle 0,1 stroke:#d22,color;

Hold "Ctrl" to enable pan & zoom

In dit kader moeten de hieronder vermelde gegevens aan het bestand /etc/ipdiva/httpd/commonParameters.extra.conf worden toegevoegd, of moet dit bestand worden aangemaakt.
De instellingen kunnen worden aangepast:

Aangepaste waarde	Variabele	Opmerking
	`HTML5_URL_LAN`	URL die is geconfigureerd bij het declareren van de HTML5 Gateway in de beheerconsole.
	`GW_NAME_LAN`	Naam van de Edge Gateway die wordt gebruikt om verbinding te maken met de HTML5-service. Het teken van de verticale streep aan het einde van de regel moet behouden blijven.
	`ORGANIZATION_NAME_LAN`	Naam van de organisatie waarmee de Edge Gateway verbinding maakt.
	`HTML5_IP_LAN`	DNS-naam of IP-adres van de Docker-server waarop de HTML5 Gateway Docker actief is.
	`HTML5_PORT_LAN`	Poort die door de Docker-server voor de HTML5 Gateway Docker wordt gepubliceerd.

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

Tip

Deze configuratie kan ook worden gebruikt in de volgende situatie, waarin een Edge Gateway Docker en een HTML5 Gateway Docker in hetzelfde Docker-netwerk draaien:

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 -.- | Verbinding met de HTML5-dienst ; via de TLS-tunnel| GW -.-> |Verbinding met de HTML5-dienst ; TCP 8080 via het Docker-netwerk| HTML5
    HTML5 --> |TLS Tunnel| MED
    GW --> |TLS Tunnel| MED

    linkStyle 0,1 stroke:#d22,color;

Hold "Ctrl" to enable pan & zoom

Voorbeeld

In dit voorbeeld implementeren wij een Edge Gateway en een HTML5 Gateway op dezelfde Docker-server.

De voor het voorbeeld gebruikte infrastructuur is de volgende:

Mediation Controller-server
- Web-IP-adres: 10.0.10.10
- Naam van de organisatie: my-organization-name
- Token voor de Edge Gateway: YJ5N-JN05-N5LS-N26H-7JHA-HZ9R-BGJF-MAVH
- Token voor de HTML5 Gateway: ATCW-OMVR-0RY4-LW1M-D9G9-H5VF-WPX5-YCXF
- URL voor de toegang tot de HTML5-service: HTML5_DOCKER
Docker-server
- Naam van het Docker-netwerk: cyberelements-cleanroom-network
- Edge Gateway
  - Naam: my-edge-gateway-docker
  - Rootlocatie in het bestandssysteem: /opt/my-edge-gateway-docker
- HTML5 Gateway
  - Naam: my-html5-gateway-docker
  - Rootlocatie in het bestandssysteem: /opt/my-html5-gateway-docker

Maak eerst op de Docker-server de mapstructuur aan om de Docker-volumes te mounten:

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

Maak vervolgens een Docker-netwerk van het type bridge aan, zodat de twee containers met elkaar kunnen communiceren:

docker network create -d bridge cyberelements-cleanroom-network

Start daarna de container van de Edge Gateway. Merk op dat in het voorbeeld een verbinding via pairing wordt opgezet, met toegang tot de Mediation Controller via het IP-adres en zonder controle van het certificaat. Bovendien wordt de parameter --network toegevoegd om het gebruik van het eerder aangemaakte Docker-netwerk aan te geven:

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

Start daarna de container van de HTML5 Gateway. Merk op dat in het voorbeeld een verbinding via pairing wordt opgezet, met toegang tot de Mediation Controller via het IP-adres en zonder controle van het certificaat. Bovendien wordt de parameter --network toegevoegd om het gebruik van het eerder aangemaakte Docker-netwerk aan te geven; en aangezien de toegang tot de HTML5-service via het Docker-netwerk verloopt, is het publiceren van poort 8080 niet nodig:

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

Tot slot moet het bestand /etc/ipdiva/httpd/commonParameters.extra.conf van de Mediation Controller-server(s) worden geconfigureerd. De volgende sectie moet worden toegevoegd:

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

Voordat u de nieuwe instellingen toepast, moet u controleren of de nieuwe configuratie geen blokkerende fout van de webserver Apache2 veroorzaakt.
Voer daarvoor de volgende opdracht uit:

1	`apache2ctl configtest`

Als het antwoord Syntax OK is, kunnen de wijzigingen met de onderstaande opdracht worden toegepast. Controleer anders de configuratie van uw bestand /etc/ipdiva/httpd/commonParameters.extra.conf.

1	`systemctl reload apache2`