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

# HTML5 Gateway Docker -version asennus

## Docker-levykuvan tuonti

Ennen kuin voit luoda HTML5 Gateway Docker -kontin, sinun on tuotava Docker-vedos. Käynnistä tätä varten shell, jossa Docker-komennot ja tiedosto `cleanroom-html5-4.6.1-33-v2.tgz` ovat käytettävissäsi. Suorita shellissä seuraava komento ja sovita `TGZ`-tiedoston polku, jos tiedosto ei ole nykyisessä hakemistossa:

```
1
```

Tarkista sen jälkeen seuraavalla komennolla, että tuonti onnistui:

```
1
```

Odotettu tuloste on seuraava. Jos näin ei ole, tuonti on epäonnistunut:

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

> **Täydellinen tuloste**
>
> ```
>  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
> ```

## Kontin määritys

### Ympäristömuuttujat

#### Pairing-käyttöönoton muuttujat

| Nimi | Pakollinen | Oletusarvo | Kommentti |
|---|---|---|---|
| `ENV_MEDIATION` | KYLLÄ |  | Käytetään pairing-yhteydessä. Ilmoittaa DNS-nimen tai IP-osoitteen yhteyden muodostamiseen CyberElements Bastion -alustan verkkoliittymään. |
| `ENV_TOKEN` | KYLLÄ |  | Käytetään pairing-yhteydessä. Ilmoittaa pairing-tokenin, jota käytetään yhteyden muodostamiseen Mediation Controller -palvelimeen. |
| `ENV_NO_CHECK_CERT` | EI | `false` | Käytetään pairing-yhteyksissä. Poistaa Mediation Controller -palvelimen verkkosertifikaatin tarkistuksen käytöstä tai ei; hyödyllinen CyberElements Bastion -tuotteessa, kun käyttö tapahtuu IP-osoitteen kautta tai kun verkkosertifikaatti ei ole julkisten oletusvarmentajien tunnustama sertifikaatti. Hyväksytyt arvot: `true` tai `false`. |

#### Manuaalisen käyttöönoton muuttujat

| Nimi | Pakollinen | Oletusarvo | Kommentti |
|---|---|---|---|
| `ENV_GW_CERT_NAME` | KYLLÄ |  | Käytetään yhteydessä, jonka määritys on tehty käsin. Sen sertifikaattitiedoston nimi, jolla muodostetaan yhteys SSL Router -palveluun. |
| `ENV_GW_CERT_PASSWORD` | KYLLÄ |  | Käytetään yhteydessä, jonka määritys on tehty käsin. SSL Router -palveluun yhdistämiseen käytettävän sertifikaattitiedoston salasana. |
| `ENV_SSL_ROUTER_IP` | KYLLÄ |  | Käytetään yhteydessä, jossa on manuaalinen määritys. Sen SSL Router -komponentin IP-osoite tai DNS-nimi, johon HTML5 Gateway muodostaa yhteyden. |
| `ENV_SSL_ROUTER_PORT` | EI | `443` | Käytetään yhteydessä, jossa on manuaalinen määritys. Sen SSL Router -komponentin portti, johon HTML5 Gateway muodostaa yhteyden. |

#### Muut muuttujat

| Nimi | Pakollinen | Oletusarvo | Kommentti |
|---|---|---|---|
| `ENV_DISABLE_RSYSLOG` | EI | `false` | Palvelun `rsyslog` poistaminen käytöstä. Hyväksytyt arvot: `true` tai `false`. |

### Volumet

| Volume | Kommentti |
|---|---|
| `/etc/ipdiva/` | HTML5 Gateway -komponentin määritystaltio. Suosittelemme liittämään sen nimettyyn taltioon tai host-koneen tiedostojärjestelmään. |
| `/opt/certificates/` | Taltio, joka sisältää HTML5 Gateway -komponentin sertifikaatin tai sertifikaatit, kun määritys tehdään ilman pairingia. |
| `/var/log/` | Taltio, joka sisältää HTML5 Gateway -komponentin lokit. |

### Portit

| Portti | Kommentti |
|---|---|
| `8080` | HTML5-palvelun kuunteluportti. |

## HTML5 Gateway Docker -version käyttöönotto

### Käyttöönotto pairingin avulla

> **Edellytykset**
>
> Ennen HTML5 Gateway Docker -version käyttöönottoa sinun on [hankittava pairing-token](https://docs.cyberelements.io/bastion/4.6/fi/Usage/Configuration/AdminConsole/CreatePairingTokenForEdgeGateway/#__tabbed_1_2).

Alla kuvattu käyttöönotto käyttää kaikkia käytettävissä olevia volumeja (paitsi `/opt/certificates/`, josta ei ole hyötyä tässä yhteydessä) ja avaa kaikki portit.
Taltiot liitetään host-koneen tiedostojärjestelmään sijaintiin `HTML5_GATEWAY_REP`. Tämän sijainnin sisällä ovat seuraavat alihakemistot:

- config
- log

Voit muokata seuraavien komentojen muuttujia:

| Muokattu arvo | Muuttuja | Kommentti |
|---|---|---|
|  | `DOCKER_NAME` | Docker-kontin nimi. |
|  | `HTML5_GATEWAY_REP` | Tiedostojärjestelmän sijainti, johon taltiot liitetään. |
|  | `ENV_MEDIATION_VALUE` | [Ympäristömuuttujan](#environment-variables) `ENV_MEDIATION` arvo. |
|  | `ENV_TOKEN_VALUE` | [Ympäristömuuttujan](#environment-variables) `ENV_TOKEN` arvo. |
|  | `ENV_NO_CHECK_CERT_VALUE` | [Ympäristömuuttujan](#environment-variables) `ENV_NO_CHECK_CERT` arvo. |

Luo volumejen liittämiseen tarvittava hakemistorakenne tiedostojärjestelmään:

**Bash**

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

**PowerShell**

> ```
> 1
> ```

Käynnistä lopuksi uusi kontti:

**Bash**

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

**PowerShell**

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

Kontin lokeja voi tarkastella seuraavalla komennolla:

```
1
```

### Manuaalinen käyttöönotto

> **Edellytykset**
>
> Ennen HTML5 Gateway Docker -version käyttöönottoa sinulla on oltava HTML5 Gateway -komponentille vaadittava sertifikaatti.

> **Salasanat näkyvät komennolla `docker inspect`**
>
> Kontin ympäristömuuttujat, sertifikaattien salasanat mukaan lukien, ovat edelleen luettavissa kenelle tahansa, joka saa suorittaa komennon `docker inspect` Docker-palvelimella. Siksi kannattaa suosia [käyttöönottoa pairingin avulla](#deployment-with-pairing), jossa ei käytetä sertifikaatin salasanaa.

Alla kuvattu käyttöönotto käyttää kaikkia käytettävissä olevia volumeja ja avaa kaikki portit.
Volumet liitetään isäntäkoneen tiedostojärjestelmään sijaintiin `MANUAL_REP`. Tämän sijainnin sisällä ovat seuraavat alihakemistot:

- config
- log
- certificates

Voit muokata seuraavien komentojen muuttujia:

| Muokattu arvo | Muuttuja | Kommentti |
|---|---|---|
|  | `MANUAL_NAME` | Docker-kontin nimi. |
|  | `MANUAL_REP` | Tiedostojärjestelmän sijainti, johon volumet liitetään. |
|  | `ENV_GW_CERT_NAME_VALUE` | [Ympäristömuuttujan](#environment-variables) `ENV_GW_CERT_NAME` arvo. |
|  | `ENV_SSL_ROUTER_IP_VALUE` | [Ympäristömuuttujan](#environment-variables) `ENV_SSL_ROUTER_IP` arvo. |
|  | `ENV_SSL_ROUTER_PORT_VALUE` | [Ympäristömuuttujan](#environment-variables) `ENV_SSL_ROUTER_PORT` arvo. |

Luo volumejen liittämiseen tarvittava hakemistorakenne tiedostojärjestelmään:

**Bash**

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

**PowerShell**

> ```
> 1
> ```

Sijoita sen jälkeen HTML5 Gateway -komponentin ja tallennuspalvelun sertifikaatit hakemistoon `MANUAL_REP/certificates`.

Jotta sertifikaattien salasanat eivät jäisi shell-historiaan, syötä ne nykyisen istunnon ympäristömuuttujiin (syötettä ei näytetä):

**Bash**

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

**PowerShell**

> ```
> 1
> ```

Käynnistä lopuksi uusi kontti:

**Bash**

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

**PowerShell**

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

Kun kontti on käynnistynyt, poista nämä muuttujat istunnosta:

**Bash**

> ```
> 1
> ```

**PowerShell**

> ```
> 1
> ```

Kontin lokeja voi tarkastella seuraavalla komennolla:

```
1
```

## Mediation Controller -palvelimen määritys

Jotta uusi HTML5 Gateway Docker olisi toimintakunnossa, on vielä määritettävä Mediation Controller -palvelin SSH- tai konsoliyhteyden kautta `root`-oikeuksin.

Tämä viimeinen määritys vaaditaan, jotta Mediation Controller voi olla yhteydessä HTML5-palveluun.
Tämä määritys vaihtelee kuitenkin HTML5 Gateway Docker -version sijainnin mukaan:

**Sijoitettu DMZ-verkkoon**

> Kokonaiskaavio on seuraavanlainen:
>
> ```mermaid
> flowchart LR
>     subgraph DMZ
>         direction TB
>         HTML5(HTML5 Gateway Docker)
>         MED(Mediation Controller)
>     end
>
>     subgraph LAN
>         GW(Edge Gateway)
>     end
>
>
>     MED -.-> |Yhteys HTML5-palveluun ; TCP 8080| HTML5
>     HTML5 --> |TLS Tunnel| MED
>     MED ~~~ GW
>     GW --> |TLS Tunnel| MED
>     GW ~~~ MED
>
>     linkStyle 0 stroke:#d22,color;
> ```
>
> Tässä yhteydessä alla annetut tiedot on lisättävä `/etc/ipdiva/httpd/commonParameters.extra.conf`-tiedostoon tai kyseinen tiedosto on luotava.
> Asetuksia voi mukauttaa:
>
> | Muokattu arvo | Muuttuja | Kommentti |
> |---|---|---|
> |  | `HTML5_URL_DMZ` | URL-osoite, joka määritettiin, kun HTML5 Gateway ilmoitettiin hallintakonsolissa. |
> |  | `HTML5_IP_DMZ` | Sen Docker-palvelimen DNS-nimi tai IP-osoite, jolla HTML5 Gateway Docker on aktiivinen. |
> |  | `HTML5_PORT_DMZ` | Portti, jonka Docker-palvelin julkaisee HTML5 Gateway Docker -versiolle. |
>
> ```
>  1
>  2
>  3
>  4
>  5
>  6
>  7
>  8
>  9
> 10
> 11
> 12
> 13
> ```

**Sijoitettu LAN-verkkoon, johon Edge Gateway -palvelin pääsee**

> Kokonaiskaavio on seuraavanlainen:
>
> ```mermaid
> flowchart LR
>     subgraph DMZ
>         direction TB
>         MED(Mediation Controller)
>     end
>
>     subgraph LAN
>         HTML5(HTML5 Gateway Docker)
>         GW(Edge Gateway)
>     end
>
>
>     MED -.- | Yhteys HTML5-palveluun ; TLS-tunnelin kautta| GW -.-> |Yhteys HTML5-palveluun ; TCP 8080| HTML5
>     HTML5 --> |TLS Tunnel| MED
>     GW --> |TLS Tunnel| MED
>
>     linkStyle 0,1 stroke:#d22,color;
> ```
>
> Tässä yhteydessä alla annetut tiedot on lisättävä `/etc/ipdiva/httpd/commonParameters.extra.conf`-tiedostoon tai kyseinen tiedosto on luotava.
> Asetuksia voi mukauttaa:
>
> | Muokattu arvo | Muuttuja | Kommentti |
> |---|---|---|
> |  | `HTML5_URL_LAN` | URL-osoite, joka määritettiin, kun HTML5 Gateway ilmoitettiin hallintakonsolissa. |
> |  | `GW_NAME_LAN` | Sen Edge Gateway -palvelimen nimi, jota käytetään yhteyden muodostamiseen HTML5-palveluun. Rivin lopussa oleva putkimerkki **on säilytettävä**. |
> |  | `ORGANIZATION_NAME_LAN` | Sen organisaation nimi, johon Edge Gateway muodostaa yhteyden. |
> |  | `HTML5_IP_LAN` | Sen Docker-palvelimen DNS-nimi tai IP-osoite, jolla HTML5 Gateway Docker on aktiivinen. |
> |  | `HTML5_PORT_LAN` | Portti, jonka Docker-palvelin julkaisee HTML5 Gateway Docker -versiolle. |
>
> ```
>  1
>  2
>  3
>  4
>  5
>  6
>  7
>  8
>  9
> 10
> 11
> 12
> 13
> 14
> 15
> 16
> 17
> 18
> 19
> 20
> 21
> ```
>
> > **Vihje**
> >
> > Tätä määritystä voi käyttää myös seuraavassa tilanteessa, jossa Edge Gateway Docker ja HTML5 Gateway Docker toimivat samassa Docker-verkossa:
> >
> > ```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 -.- | Yhteys HTML5-palveluun ; TLS-tunnelin kautta| GW -.-> |Yhteys HTML5-palveluun ; TCP 8080 Docker-verkon kautta| HTML5
> >     HTML5 --> |TLS Tunnel| MED
> >     GW --> |TLS Tunnel| MED
> >
> >     linkStyle 0,1 stroke:#d22,color;
> > ```
> >
> > > **Esimerkki**
> > >
> > > Tässä esimerkissä otamme käyttöön Edge Gateway -palvelimen ja HTML5 Gateway -palvelimen samalla Docker-palvelimella.
> > >
> > > Esimerkissä käytetty infrastruktuuri on seuraavanlainen:
> > >
> > > - Mediation Controller -palvelin
> > >     - Web-IP-osoite: `10.0.10.10`
> > >     - organisaation nimi: `my-organization-name`
> > >     - Token Edge Gateway -palvelimelle: `YJ5N-JN05-N5LS-N26H-7JHA-HZ9R-BGJF-MAVH`
> > >     - Token HTML5 Gateway -palvelimelle: `ATCW-OMVR-0RY4-LW1M-D9G9-H5VF-WPX5-YCXF`
> > >     - HTML5-palvelun käytön URL-osoite: `HTML5_DOCKER`
> > > - Docker-palvelin
> > >     - Docker-verkon nimi: `cyberelements-cleanroom-network`
> > >     - Edge Gateway
> > >         - Nimi: `my-edge-gateway-docker`
> > >         - Juurisijainti tiedostojärjestelmässä: `/opt/my-edge-gateway-docker`
> > >     - HTML5 Gateway
> > >         - Nimi: `my-html5-gateway-docker`
> > >         - Juurisijainti tiedostojärjestelmässä: `/opt/my-html5-gateway-docker`
> > >
> > > Luo ensin Docker-palvelimella hakemistorakenne Docker-taltioiden liittämistä varten:
> > >
> > > ```
> > > 1
> > > 2
> > > 3
> > > 4
> > > 5
> > > 6
> > > ```
> > >
> > > Luo sen jälkeen `bridge`-tyypin Docker-verkko, jotta molemmat kontit voivat olla yhteydessä toisiinsa:
> > >
> > > ```
> > > 1
> > > ```
> > >
> > > Käynnistä seuraavaksi Edge Gateway -kontti. Huomaa, että esimerkissä yhteys muodostetaan pairingin avulla siten, että Mediation Controller -palvelimeen otetaan yhteys sen IP-osoitteella eikä sertifikaatin tarkistusta lisätä. Lisäksi lisätään `--network`-parametri, jolla määritetään aiemmin luodun Docker-verkon käyttö:
> > >
> > > ```
> > >  1
> > >  2
> > >  3
> > >  4
> > >  5
> > >  6
> > >  7
> > >  8
> > >  9
> > > 10
> > > 11
> > > 12
> > > 13
> > > ```
> > >
> > > Käynnistä seuraavaksi HTML5 Gateway -kontti. Huomaa, että esimerkissä yhteys muodostetaan pairingin avulla siten, että Mediation Controller -palvelimeen otetaan yhteys sen IP-osoitteella eikä sertifikaatin tarkistusta lisätä. Lisäksi lisätään `--network`-parametri, jolla määritetään aiemmin luodun Docker-verkon käyttö, ja koska HTML5-palvelua käytetään Docker-verkon kautta, portin 8080 julkaisu ei ole tarpeen:
> > >
> > > ```
> > > 1
> > > 2
> > > 3
> > > 4
> > > 5
> > > 6
> > > 7
> > > 8
> > > ```
> > >
> > > Lopuksi on määritettävä Mediation Controller -palvelimen tai -palvelimien `/etc/ipdiva/httpd/commonParameters.extra.conf`-tiedosto. Siihen on lisättävä seuraava osio:
> > >
> > > ```
> > >  1
> > >  2
> > >  3
> > >  4
> > >  5
> > >  6
> > >  7
> > >  8
> > >  9
> > > 10
> > > 11
> > > 12
> > > 13
> > > 14
> > > 15
> > > 16
> > > 17
> > > 18
> > > 19
> > > 20
> > > 21
> > > ```

Ennen kuin otat uuden määrityksen käyttöön, tarkista, ettei se aiheuta Apache2-verkkopalvelimelle estävää virhettä.
Suorita tätä varten seuraava komento:

```
1
```

Jos vastaus on `Syntax OK`, muutokset voi ottaa käyttöön alla olevalla komennolla. Muussa tapauksessa tarkista `/etc/ipdiva/httpd/commonParameters.extra.conf`-tiedostosi määritys.

```
1
```
