> Source: https://docs.cyberelements.io/bastion/4.6/mt/Installation/Docker/HTML5Gateway/

# Installazzjoni tal-komponent HTML5 Gateway Docker

## Importazzjoni tal-immaġni Docker

Qabel ma tkun tista’ toħloq kontenitur HTML5 Gateway Docker, trid timporta l-immaġni Docker. Biex tagħmel dan, iftaħ shell li minnha jkollok disponibbli l-kmandi Docker, kif ukoll il-fajl `cleanroom-html5-4.6.1-33-v2.tgz`. Mix-shell, ħaddem il-kmand li ġej, u aġġusta l-mogħdija lejn il-fajl `TGZ` jekk ma jkunx fid-direttorju attwali:

```
1
```

Imbagħad iċċekkja li l-importazzjoni rnexxiet bil-kmand li ġej:

```
1
```

Ir-riżultat mistenni huwa dan li ġej. Jekk ma jkunx hekk, l-importazzjoni falliet:

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

> **Output sħiħ**
>
> ```
>  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
> ```

## Konfigurazzjoni tal-kontenitur

### Varjabbli tal-ambjent

#### Varjabbli għall-iskjerament permezz ta’ pairing

| Isem | Obbligatorju | Valur default | Kumment |
|---|---|---|---|
| `ENV_MEDIATION` | IVA |  | Użat għall-konnessjoni permezz ta’ pairing. Jindika l-isem DNS jew l-indirizz IP għall-konnessjoni mal-interfaċċa web ta’ pjattaforma CyberElements Bastion. |
| `ENV_TOKEN` | IVA |  | Użat għall-konnessjoni permezz ta’ pairing. Indikazzjoni tat-token tal-pairing li għandu jintuża għall-konnessjoni mas-servizz Mediation Controller. |
| `ENV_NO_CHECK_CERT` | LE | `false` | Użat għall-konnessjonijiet permezz ta’ pairing. Jekk il-verifika taċ-ċertifikat web tas-servizz Mediation Controller għandhiex tiġi diżattivata jew le; utli ma’ CyberElements Bastion meta l-aċċess isir permezz ta’ indirizz IP jew meta ċ-ċertifikat web mhuwiex ċertifikat rikonoxxut mill-awtoritajiet taċ-ċertifikazzjoni pubbliċi default. Valuri aċċettati: `true` jew `false`. |

#### Varjabbli għall-iskjerament manwali

| Isem | Obbligatorju | Valur default | Kumment |
|---|---|---|---|
| `ENV_GW_CERT_NAME` | IVA |  | Użat għall-konnessjoni b’konfigurazzjoni manwali. Isem il-fajl taċ-ċertifikat għall-konnessjoni mal-komponent SSL Router. |
| `ENV_GW_CERT_PASSWORD` | IVA |  | Użat għall-konnessjoni b’konfigurazzjoni manwali. Il-password tal-fajl taċ-ċertifikat għall-konnessjoni mal-komponent SSL Router. |
| `ENV_SSL_ROUTER_IP` | IVA |  | Użat għall-konnessjoni b’konfigurazzjoni manwali. L-indirizz IP jew l-isem DNS tal-komponent SSL Router li miegħu se jikkonnettja l-komponent HTML5 Gateway. |
| `ENV_SSL_ROUTER_PORT` | LE | `443` | Użat għall-konnessjoni b’konfigurazzjoni manwali. Il-port tal-komponent SSL Router li miegħu se jikkonnettja l-komponent HTML5 Gateway. |

#### Varjabbli diversi

| Isem | Obbligatorju | Valur default | Kumment |
|---|---|---|---|
| `ENV_DISABLE_RSYSLOG` | LE | `false` | Diżattivazzjoni tas-servizz `rsyslog`. Valuri aċċettati: `true` jew `false`. |

### Volumi

| Volum | Kumment |
|---|---|
| `/etc/ipdiva/` | Volum tal-konfigurazzjoni tal-komponent HTML5 Gateway. Nirrakkomandaw li jiġi mmuntat fuq volum bl-isem jew fuq is-sistema tal-fajls tal-kompjuter ospitanti. |
| `/opt/certificates/` | Volum li fih iċ-ċertifikat(i) tal-komponent HTML5 Gateway meta l-konfigurazzjoni ssir mingħajr pairing. |
| `/var/log/` | Volum li fih ir-reġistri tal-komponent HTML5 Gateway. |

### Portijiet

| Port | Kumment |
|---|---|
| `8080` | Port tas-smigħ tas-servizz HTML5. |

## Skjerament tal-komponent HTML5 Gateway Docker

### Skjerament bil-pairing

> **Prerekwiżiti**
>
> Qabel ma tiskjera l-komponent HTML5 Gateway Docker, trid [tikseb token tal-pairing](https://docs.cyberelements.io/bastion/4.6/mt/Usage/Configuration/AdminConsole/CreatePairingTokenForEdgeGateway/#__tabbed_1_2).

L-iskjerament deskritt hawn taħt se juża l-volumi disponibbli kollha (ħlief `/opt/certificates/`, li mhuwiex utli f’dan il-kuntest) u se jesponi l-portijiet kollha.
Il-volumi se jiġu mmuntati fuq is-sistema tal-fajls tal-kompjuter ospitanti fil-post `HTML5_GATEWAY_REP`. F’dan il-post hemm is-sottodirettorji li ġejjin:

- config
- log

Tista’ tippersonalizza l-varjabbli għall-kmandi li ġejjin:

| Valur personalizzat | Varjabbli | Kumment |
|---|---|---|
|  | `DOCKER_NAME` | Isem il-kontenitur Docker. |
|  | `HTML5_GATEWAY_REP` | Post fis-sistema tal-fajls fejn għandhom jiġu mmuntati l-volumi. |
|  | `ENV_MEDIATION_VALUE` | Il-valur tal-[varjabbli tal-ambjent](#environment-variables) `ENV_MEDIATION`. |
|  | `ENV_TOKEN_VALUE` | Il-valur tal-[varjabbli tal-ambjent](#environment-variables) `ENV_TOKEN`. |
|  | `ENV_NO_CHECK_CERT_VALUE` | Il-valur tal-[varjabbli tal-ambjent](#environment-variables) `ENV_NO_CHECK_CERT`. |

Oħloq is-siġra tal-folders meħtieġa għall-immuntar tal-volumi fuq is-sistema tal-fajls:

**Bash**

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

**PowerShell**

> ```
> 1
> ```

U fl-aħħar, ibda kontenitur ġdid:

**Bash**

> ```
> 1
> 2
> 3
> 4
> 5
> 6
> 7
> 8
> ```

**PowerShell**

> ```
> 1
> 2
> 3
> 4
> 5
> 6
> 7
> 8
> ```

Ir-reġistri tal-kontenitur jistgħu jiġu kkonsultati bil-kmand li ġej:

```
1
```

### Skjerament manwali

> **Prerekwiżiti**
>
> Qabel ma tiskjera l-komponent HTML5 Gateway Docker, irid ikollok iċ-ċertifikat meħtieġ għall-komponent HTML5 Gateway.

> **Passwords viżibbli b’`docker inspect`**
>
> Il-varjabbli tal-ambjent ta’ kontenitur, inklużi l-passwords taċ-ċertifikati, jibqgħu jinqraw minn kull min huwa awtorizzat iħaddem `docker inspect` fuq is-server Docker. Għalhekk għandu jiġi ppreferut [l-iskjerament bil-pairing](#deployment-with-pairing), li ma juża l-ebda password ta’ ċertifikat.

L-iskjerament deskritt hawn taħt se juża l-volumi kollha disponibbli u jesponi l-portijiet kollha.
Il-volumi se jiġu mmuntati fis-sistema tal-fajls tal-kompjuter ospitanti fil-post `MANUAL_REP`. F’dan il-post hemm is-sottodirettorji li ġejjin:

- config
- log
- certificates

Tista’ tippersonalizza l-varjabbli għall-kmandi li ġejjin:

| Valur personalizzat | Varjabbli | Kumment |
|---|---|---|
|  | `MANUAL_NAME` | Isem il-kontenitur Docker. |
|  | `MANUAL_REP` | Post fis-sistema tal-fajls fejn jiġu mmuntati l-volumi. |
|  | `ENV_GW_CERT_NAME_VALUE` | Valur [tal-varjabbli tal-ambjent](#environment-variables) `ENV_GW_CERT_NAME`. |
|  | `ENV_SSL_ROUTER_IP_VALUE` | Valur [tal-varjabbli tal-ambjent](#environment-variables) `ENV_SSL_ROUTER_IP`. |
|  | `ENV_SSL_ROUTER_PORT_VALUE` | Valur [tal-varjabbli tal-ambjent](#environment-variables) `ENV_SSL_ROUTER_PORT`. |

Oħloq is-siġra tal-folders meħtieġa għall-immuntar tal-volumi fuq is-sistema tal-fajls:

**Bash**

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

**PowerShell**

> ```
> 1
> ```

Imbagħad poġġi ċ-ċertifikati għall-komponent HTML5 Gateway u għas-servizz tar-reġistrazzjoni fil-post `MANUAL_REP/certificates`.

Biex il-passwords taċ-ċertifikati ma jinżammux fl-istorja tax-shell, daħħalhom f’varjabbli tal-ambjent tas-sessjoni attwali (dak li tikteb ma jintweriex):

**Bash**

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

**PowerShell**

> ```
> 1
> ```

Fl-aħħar, ibda kontenitur ġdid:

**Bash**

> ```
>  1
>  2
>  3
>  4
>  5
>  6
>  7
>  8
>  9
> 10
> ```

**PowerShell**

> ```
>  1
>  2
>  3
>  4
>  5
>  6
>  7
>  8
>  9
> 10
> ```

Ladarba l-kontenitur ikun beda, neħħi dawn il-varjabbli mis-sessjoni:

**Bash**

> ```
> 1
> ```

**PowerShell**

> ```
> 1
> ```

Ir-reġistri tal-kontenitur jistgħu jiġu kkonsultati bil-kmand li ġej:

```
1
```

## Konfigurazzjoni tas-servizz Mediation Controller

Biex il-komponent HTML5 Gateway Docker il-ġdid ikun operattiv, is-server Mediation Controller għad irid jiġi kkonfigurat permezz ta’ aċċess SSH jew mill-konsol, bil-permessi ta’ `root`.

Din l-aħħar konfigurazzjoni hija meħtieġa biex is-servizz Mediation Controller ikun jista’ jikkomunika mas-servizz HTML5.
Madankollu, din il-konfigurazzjoni tvarja skont il-post fejn jinsab il-komponent HTML5 Gateway Docker:

**Imqiegħed fiż-żona DMZ**

> Id-dijagramma ġenerali hija din li ġejja:
>
> ```mermaid
> flowchart LR
>     subgraph DMZ
>         direction TB
>         HTML5(HTML5 Gateway Docker)
>         MED(Mediation Controller)
>     end
>
>     subgraph LAN
>         GW(Edge Gateway)
>     end
>
>
>     MED -.-> |Konnessjoni mas-servizz HTML5 ; TCP 8080| HTML5
>     HTML5 --> |TLS Tunnel| MED
>     MED ~~~ GW
>     GW --> |TLS Tunnel| MED
>     GW ~~~ MED
>
>     linkStyle 0 stroke:#d22,color;
> ```
>
> F’dan il-kuntest, ikun meħtieġ li żżid l-informazzjoni mogħtija hawn taħt mal-fajl `/etc/ipdiva/httpd/commonParameters.extra.conf` jew li toħolqu.
> Il-personalizzazzjoni tas-settings hija disponibbli:
>
> | Valur personalizzat | Varjabbli | Kumment |
> |---|---|---|
> |  | `HTML5_URL_DMZ` | URL ikkonfigurat meta jiġi ddikjarat il-komponent HTML5 Gateway fil-konsol tal-amministrazzjoni. |
> |  | `HTML5_IP_DMZ` | Isem DNS jew indirizz IP tas-server Docker li fuqu huwa attiv il-komponent HTML5 Gateway Docker. |
> |  | `HTML5_PORT_DMZ` | Port ippubblikat mis-server Docker għall-komponent HTML5 Gateway Docker. |
>
> ```
>  1
>  2
>  3
>  4
>  5
>  6
>  7
>  8
>  9
> 10
> 11
> 12
> 13
> ```

**Imqiegħed fin-netwerk LAN aċċessibbli minn komponent Edge Gateway**

> Id-dijagramma ġenerali hija din li ġejja:
>
> ```mermaid
> flowchart LR
>     subgraph DMZ
>         direction TB
>         MED(Mediation Controller)
>     end
>
>     subgraph LAN
>         HTML5(HTML5 Gateway Docker)
>         GW(Edge Gateway)
>     end
>
>
>     MED -.- | Konnessjoni mas-servizz HTML5 ; permezz ta’ mina TLS| GW -.-> |Konnessjoni mas-servizz HTML5 ; TCP 8080| HTML5
>     HTML5 --> |TLS Tunnel| MED
>     GW --> |TLS Tunnel| MED
>
>     linkStyle 0,1 stroke:#d22,color;
> ```
>
> F’dan il-kuntest, ikun meħtieġ li żżid l-informazzjoni mogħtija hawn taħt mal-fajl `/etc/ipdiva/httpd/commonParameters.extra.conf` jew li toħolqu.
> Il-personalizzazzjoni tas-settings hija disponibbli:
>
> | Valur personalizzat | Varjabbli | Kumment |
> |---|---|---|
> |  | `HTML5_URL_LAN` | URL ikkonfigurat meta jiġi ddikjarat il-komponent HTML5 Gateway fil-konsol tal-amministrazzjoni. |
> |  | `GW_NAME_LAN` | Isem il-komponent Edge Gateway użat biex jikkonnettja mas-servizz HTML5. Il-karattru pipe (linja vertikali) fl-aħħar tal-linja **għandu jinżamm**. |
> |  | `ORGANIZATION_NAME_LAN` | Isem l-organizzazzjoni li magħha jikkonnettja l-komponent Edge Gateway. |
> |  | `HTML5_IP_LAN` | Isem DNS jew indirizz IP tas-server Docker li fuqu huwa attiv il-komponent HTML5 Gateway Docker. |
> |  | `HTML5_PORT_LAN` | Port ippubblikat mis-server Docker għall-komponent HTML5 Gateway Docker. |
>
> ```
>  1
>  2
>  3
>  4
>  5
>  6
>  7
>  8
>  9
> 10
> 11
> 12
> 13
> 14
> 15
> 16
> 17
> 18
> 19
> 20
> 21
> ```
>
> > **Parir**
> >
> > Din il-konfigurazzjoni tista’ tintuża wkoll fis-sitwazzjoni li ġejja, fejn komponent Edge Gateway Docker u komponent HTML5 Gateway Docker qed jaħdmu fl-istess netwerk Docker:
> >
> > ```mermaid
> > 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 -.- | Konnessjoni mas-servizz HTML5 ; permezz ta’ mina TLS| GW -.-> |Konnessjoni mas-servizz HTML5 ; TCP 8080 permezz tan-netwerk Docker| HTML5
> >     HTML5 --> |TLS Tunnel| MED
> >     GW --> |TLS Tunnel| MED
> >
> >     linkStyle 0,1 stroke:#d22,color;
> > ```
> >
> > > **Eżempju**
> > >
> > > F’dan l-eżempju, se niskjeraw komponent Edge Gateway u komponent HTML5 Gateway fuq l-istess server Docker.
> > >
> > > L-infrastruttura użata għall-eżempju hija din li ġejja:
> > >
> > > - Server Mediation Controller
> > >     - Indirizz IP web: `10.0.10.10`
> > >     - Isem l-organizzazzjoni: `my-organization-name`
> > >     - Token għall-komponent Edge Gateway: `YJ5N-JN05-N5LS-N26H-7JHA-HZ9R-BGJF-MAVH`
> > >     - Token għall-komponent HTML5 Gateway: `ATCW-OMVR-0RY4-LW1M-D9G9-H5VF-WPX5-YCXF`
> > >     - URL għall-aċċess għas-servizz HTML5: `HTML5_DOCKER`
> > > - Server Docker
> > >     - Isem tan-netwerk Docker: `cyberelements-cleanroom-network`
> > >     - Edge Gateway
> > >         - Name: `my-edge-gateway-docker`
> > >         - Post għerq fis-sistema tal-fajls: `/opt/my-edge-gateway-docker`
> > >     - HTML5 Gateway
> > >         - Name: `my-html5-gateway-docker`
> > >         - Post għerq fis-sistema tal-fajls: `/opt/my-html5-gateway-docker`
> > >
> > > L-ewwel nett, fuq is-server Docker, trid toħloq l-istruttura tad-direttorji għall-immuntar tal-volumi Docker:
> > >
> > > ```
> > > 1
> > > 2
> > > 3
> > > 4
> > > 5
> > > 6
> > > ```
> > >
> > > Imbagħad oħloq netwerk Docker tat-tip `bridge` biex iż-żewġ kontenituri jkunu jistgħu jikkomunikaw ma’ xulxin:
> > >
> > > ```
> > > 1
> > > ```
> > >
> > > Wara dan, ibda l-kontenitur Edge Gateway. Innota li l-eżempju jistabbilixxi konnessjoni permezz ta’ pairing, b’aċċess għas-servizz Mediation Controller permezz tal-indirizz IP tiegħu u mingħajr verifika taċ-ċertifikat. Barra minn hekk, jiżdied il-parametru `--network` biex jiġi speċifikat l-użu tan-netwerk Docker maħluq qabel:
> > >
> > > ```
> > >  1
> > >  2
> > >  3
> > >  4
> > >  5
> > >  6
> > >  7
> > >  8
> > >  9
> > > 10
> > > 11
> > > 12
> > > 13
> > > ```
> > >
> > > Wara dan, ibda l-kontenitur HTML5 Gateway. Innota li l-eżempju jistabbilixxi konnessjoni permezz ta’ pairing, b’aċċess għas-servizz Mediation Controller permezz tal-indirizz IP tiegħu u mingħajr verifika taċ-ċertifikat. Barra minn hekk, jiżdied il-parametru `--network` biex jiġi speċifikat l-użu tan-netwerk Docker maħluq qabel, u peress li l-aċċess għas-servizz HTML5 se jgħaddi min-netwerk Docker, mhuwiex meħtieġ li jiġi ppubblikat il-port 8080:
> > >
> > > ```
> > > 1
> > > 2
> > > 3
> > > 4
> > > 5
> > > 6
> > > 7
> > > 8
> > > ```
> > >
> > > Fl-aħħar, il-fajl `/etc/ipdiva/httpd/commonParameters.extra.conf` fuq is-server(s) Mediation Controller għandu jiġi kkonfigurat. Għandha tiżdied it-taqsima li ġejja:
> > >
> > > ```
> > >  1
> > >  2
> > >  3
> > >  4
> > >  5
> > >  6
> > >  7
> > >  8
> > >  9
> > > 10
> > > 11
> > > 12
> > > 13
> > > 14
> > > 15
> > > 16
> > > 17
> > > 18
> > > 19
> > > 20
> > > 21
> > > ```

Qabel ma tapplika s-settings il-ġodda, trid tiċċekkja li l-konfigurazzjoni l-ġdida ma tikkawża ebda żball li jimblokka s-server web Apache2.
Biex tagħmel dan, ħaddem il-kmand li ġej:

```
1
```

Jekk ir-risposta hija `Syntax OK`, il-bidliet jistgħu jiġu applikati bil-kmand ta’ hawn taħt. Inkella, iċċekkja l-konfigurazzjoni tal-fajl `/etc/ipdiva/httpd/commonParameters.extra.conf` tiegħek.

```
1
```
