Instalacja HTML5 Gateway Docker¶

Import obrazu Docker¶

Zanim będziesz mógł utworzyć kontener HTML5 Gateway Docker, musisz zaimportować obraz Docker. W tym celu otwórz powłokę, w której dostępne są polecenia Docker oraz plik cleanroom-html5-4.6.1-33-v2.tgz. W powłoce wykonaj następujące polecenie, dostosowując ścieżkę do pliku TGZ, jeśli nie znajduje się on w bieżącym katalogu:

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

Następnie sprawdź poniższym poleceniem, czy import się udał:

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

Oczekiwane wyjście jest następujące. Jeśli tak nie jest, import się nie udał:

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

Pełne wyjście

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

Konfiguracja kontenera¶

Zmienne środowiskowe¶

Zmienne dla wdrożenia przez pairing¶

Nazwa	Obowiązkowa	Wartość domyślna	Komentarz
`ENV_MEDIATION`	TAK		Używane do połączenia przez pairing. Wskazuje nazwę DNS lub adres IP do połączenia z interfejsem webowym platformy CyberElements Bastion.
`ENV_TOKEN`	TAK		Używana do połączenia przez pairing. Wskazuje token pairing, który ma zostać użyty do połączenia z Mediation Controller.
`ENV_NO_CHECK_CERT`	NIE	`false`	Używane do połączeń przez pairing. Wyłącza sprawdzanie certyfikatu webowego Mediation Controller lub nie; przydatne w CyberElements Bastion, gdy dostęp odbywa się przez adres IP lub gdy certyfikat webowy nie jest certyfikatem uznawanym przez domyślne publiczne urzędy certyfikacji. Akceptowane wartości: `true` lub `false`.

Zmienne dla wdrożenia ręcznego¶

Nazwa	Obowiązkowa	Wartość domyślna	Komentarz
`ENV_GW_CERT_NAME`	TAK		Używana do połączenia z konfiguracją ręczną. Nazwa pliku certyfikatu do połączenia z SSL Router.
`ENV_GW_CERT_PASSWORD`	TAK		Używana do połączenia z konfiguracją ręczną. Hasło pliku certyfikatu do połączenia z SSL Router.
`ENV_SSL_ROUTER_IP`	TAK		Używane do połączenia z konfiguracją ręczną. Adres IP lub nazwa DNS SSL Router, z którym połączy się HTML5 Gateway.
`ENV_SSL_ROUTER_PORT`	NIE	`443`	Używane do połączenia z konfiguracją ręczną. Port SSL Router, z którym połączy się HTML5 Gateway.

Różne zmienne¶

Nazwa	Obowiązkowa	Wartość domyślna	Komentarz
`ENV_DISABLE_RSYSLOG`	NIE	`false`	Wyłączenie usługi `rsyslog`. Dozwolone wartości: `true` lub `false`.

Wolumeny¶

Wolumen	Komentarz
`/etc/ipdiva/`	Wolumin konfiguracji HTML5 Gateway. Zalecamy zamontowanie go na wolumenie nazwanym lub w systemie plików maszyny hosta.
`/opt/certificates/`	Wolumin zawierający certyfikat lub certyfikaty HTML5 Gateway przy konfiguracji bez pairingu.
`/var/log/`	Wolumin zawierający logi HTML5 Gateway.

Porty¶

Port	Komentarz
`8080`	Port nasłuchu usługi HTML5.

Wdrożenie HTML5 Gateway Docker¶

Wdrożenie z pairing¶

Wymagania wstępne

Przed wdrożeniem HTML5 Gateway Docker musisz uzyskać token pairingu.

Opisane poniżej wdrożenie wykorzystuje wszystkie dostępne wolumeny (poza /opt/certificates/, który w tym kontekście nie jest przydatny) i udostępnia wszystkie porty.
Woluminy zostaną zamontowane w systemie plików maszyny hosta w lokalizacji HTML5_GATEWAY_REP. Wewnątrz tej lokalizacji znajdują się następujące podkatalogi:

config
log

Możesz dostosować zmienne poniższych poleceń:

Wartość dostosowana	Zmienna	Komentarz
	`DOCKER_NAME`	Nazwa kontenera Docker.
	`HTML5_GATEWAY_REP`	Lokalizacja w systemie plików, w której zostaną zamontowane woluminy.
	`ENV_MEDIATION_VALUE`	Wartość zmiennej środowiskowej `ENV_MEDIATION`.
	`ENV_TOKEN_VALUE`	Wartość zmiennej środowiskowej `ENV_TOKEN`.
	`ENV_NO_CHECK_CERT_VALUE`	Wartość zmiennej środowiskowej `ENV_NO_CHECK_CERT`.

Utwórz w systemie plików strukturę katalogów wymaganą do zamontowania wolumenów:

mkdir -p HTML5_GATEWAY_REP/config
mkdir HTML5_GATEWAY_REP/log

Na koniec uruchom nowy kontener:

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

Logi kontenera można wyświetlić za pomocą poniższego polecenia:

docker logs -f DOCKER_NAME

Wdrożenie ręczne¶

Wymagania wstępne

Przed wdrożeniem HTML5 Gateway Docker musisz mieć certyfikat wymagany dla HTML5 Gateway.

Opisane poniżej wdrożenie wykorzystuje wszystkie dostępne wolumeny i udostępnia wszystkie porty.
Wolumeny zostaną zamontowane w systemie plików maszyny hosta w lokalizacji MANUAL_REP. W tej lokalizacji znajdują się następujące podkatalogi:

config
log
certificates

Możesz dostosować zmienne poniższych poleceń:

Wartość dostosowana	Zmienna	Komentarz
	`MANUAL_NAME`	Nazwa kontenera Docker.
	`MANUAL_REP`	Lokalizacja w systemie plików, w której montowane są wolumeny.
	`ENV_GW_CERT_NAME_VALUE`	Wartość zmiennej środowiskowej `ENV_GW_CERT_NAME`.
	`ENV_GW_CERT_PASSWORD_VALUE`	Wartość zmiennej środowiskowej `ENV_GW_CERT_PASSWORD`.
	`ENV_SSL_ROUTER_IP_VALUE`	Wartość zmiennej środowiskowej `ENV_SSL_ROUTER_IP`.
	`ENV_SSL_ROUTER_PORT_VALUE`	Wartość zmiennej środowiskowej `ENV_SSL_ROUTER_PORT`.

Utwórz w systemie plików strukturę katalogów wymaganą do zamontowania wolumenów:

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

Następnie umieść certyfikaty HTML5 Gateway i usługi nagrywania w MANUAL_REP/certificates.

Na koniec uruchom nowy kontener:

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

Logi kontenera można wyświetlić za pomocą poniższego polecenia:

docker logs -f MANUAL_NAME

Konfiguracja Mediation Controller¶

Aby nowy HTML5 Gateway Docker był sprawny, trzeba jeszcze skonfigurować serwer Mediation Controller przez dostęp SSH lub konsolowy z uprawnieniami root.

Ta ostatnia konfiguracja jest wymagana, aby Mediation Controller mógł komunikować się z usługą HTML5.
Ta konfiguracja zależy jednak od lokalizacji HTML5 Gateway Docker:

Umieszczony w DMZUmieszczony w LAN, dostępny przez Edge Gateway

Schemat ogólny wygląda następująco:

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

    subgraph LAN
        GW(Edge Gateway)
    end


    MED -.-> |Połączenie z usługą 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

W tym kontekście trzeba będzie dodać podane poniżej informacje do pliku /etc/ipdiva/httpd/commonParameters.extra.conf lub utworzyć ten plik.
Ustawienia można dostosować:

Wartość dostosowana	Zmienna	Komentarz
	`HTML5_URL_DMZ`	URL skonfigurowany podczas deklarowania HTML5 Gateway w konsoli administracyjnej.
	`HTML5_IP_DMZ`	Nazwa DNS lub adres IP serwera Docker, na którym działa HTML5 Gateway Docker.
	`HTML5_PORT_DMZ`	Port publikowany przez serwer Docker dla 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>

Schemat ogólny wygląda następująco:

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

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


    MED -.- | Połączenie z usługą HTML5 ; przez tunel TLS| GW -.-> |Połączenie z usługą HTML5 ; TCP 8080| HTML5
    HTML5 --> |TLS Tunnel| MED
    GW --> |TLS Tunnel| MED

    linkStyle 0,1 stroke:#d22,color;

Hold "Ctrl" to enable pan & zoom

W tym kontekście trzeba będzie dodać podane poniżej informacje do pliku /etc/ipdiva/httpd/commonParameters.extra.conf lub utworzyć ten plik.
Ustawienia można dostosować:

Wartość dostosowana	Zmienna	Komentarz
	`HTML5_URL_LAN`	URL skonfigurowany podczas deklarowania HTML5 Gateway w konsoli administracyjnej.
	`GW_NAME_LAN`	Nazwa Edge Gateway używanego do połączenia z usługą HTML5. Znak kreski pionowej na końcu wiersza musi zostać zachowany.
	`ORGANIZATION_NAME_LAN`	Nazwa organizacji, z którą łączy się Edge Gateway.
	`HTML5_IP_LAN`	Nazwa DNS lub adres IP serwera Docker, na którym działa HTML5 Gateway Docker.
	`HTML5_PORT_LAN`	Port publikowany przez serwer Docker dla 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>

Wskazówka

Tę konfigurację można też zastosować w następującej sytuacji, w której Edge Gateway Docker i HTML5 Gateway Docker działają w tej samej sieci 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 -.- | Połączenie z usługą HTML5 ; przez tunel TLS| GW -.-> |Połączenie z usługą HTML5 ; TCP 8080 przez sieć Docker| HTML5
    HTML5 --> |TLS Tunnel| MED
    GW --> |TLS Tunnel| MED

    linkStyle 0,1 stroke:#d22,color;

Hold "Ctrl" to enable pan & zoom

Przykład

W tym przykładzie wdrożymy Edge Gateway i HTML5 Gateway na tym samym serwerze Docker.

Infrastruktura użyta w przykładzie jest następująca:

Serwer Mediation Controller
- Adres IP webowy: 10.0.10.10
- Nazwa organizacji: my-organization-name
- Token dla Edge Gateway: YJ5N-JN05-N5LS-N26H-7JHA-HZ9R-BGJF-MAVH
- Token dla HTML5 Gateway: ATCW-OMVR-0RY4-LW1M-D9G9-H5VF-WPX5-YCXF
- URL dostępu do usługi HTML5: HTML5_DOCKER
Serwer Docker
- Nazwa sieci Docker: cyberelements-cleanroom-network
- Edge Gateway
  - Nazwa: my-edge-gateway-docker
  - Lokalizacja główna w systemie plików: /opt/my-edge-gateway-docker
- HTML5 Gateway
  - Nazwa: my-html5-gateway-docker
  - Lokalizacja główna w systemie plików: /opt/my-html5-gateway-docker

Najpierw na serwerze Docker musisz utworzyć strukturę katalogów do montowania woluminów 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

Następnie utwórz sieć Docker typu bridge, aby oba kontenery mogły się ze sobą komunikować:

docker network create -d bridge cyberelements-cleanroom-network

Następnie uruchom kontener Edge Gateway. Zwróć uwagę, że w przykładzie połączenie jest nawiązywane przez pairing, z dostępem do Mediation Controller przez jego adres IP i bez sprawdzania certyfikatu. Dodatkowo dodano parametr --network, aby wskazać użycie wcześniej utworzonej sieci Docker:

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

Następnie uruchom kontener HTML5 Gateway. Zwróć uwagę, że w przykładzie połączenie jest nawiązywane przez pairing, z dostępem do Mediation Controller przez jego adres IP i bez sprawdzania certyfikatu. Dodatkowo dodano parametr --network, aby wskazać użycie wcześniej utworzonej sieci Docker, a ponieważ dostęp do usługi HTML5 będzie odbywał się przez sieć Docker, publikowanie portu 8080 nie jest konieczne:

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

Na koniec trzeba skonfigurować plik /etc/ipdiva/httpd/commonParameters.extra.conf na serwerze lub serwerach Mediation Controller. Należy dodać następującą sekcję:

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

Przed zastosowaniem nowej konfiguracji musisz sprawdzić, czy nie powoduje ona blokującego błędu serwera webowego Apache2.
Aby to zrobić, wykonaj następujące polecenie:

1	`apache2ctl configtest`

Jeśli odpowiedzią jest Syntax OK, zmiany można zastosować poniższym poleceniem. W przeciwnym razie sprawdź konfigurację swojego pliku /etc/ipdiva/httpd/commonParameters.extra.conf.

1	`systemctl reload apache2`