# Konfiguracja

Strona opisuje wszystkie zmienne konfiguracyjne Infokiosku, ich znaczenie i wartości domyślne. Jest dla administratorów i programistów, którzy ustawiają kiosk dla nowego magazynu albo środowiska.

## Skąd pochodzi konfiguracja

Plik `application.properties` czyta wartości z pliku `env.properties` przez `spring.config.import`. Plik `env.properties` nie jest w repozytorium, bo leży na liście `.gitignore`.

Wzorem są dwa pliki w `src/main/resources`.

| Plik | Zastosowanie |
| --- | --- |
| `env.default.properties` | uruchomienie lokalne, pełna lista zmiennych z komentarzami |
| `env.default.docker.properties` | wartości dla stacku Docker, część pochodzi ze zmiennych `INFOKIOSK_*` z `apollo-docker` |

Do pracy lokalnej wystarczy skopiować plik wzorcowy:

```
cp src/main/resources/env.default.properties src/main/resources/env.properties
```

Zmienne środowiskowe procesu mają pierwszeństwo przed plikiem, bo Spring czyta je jako osobne źródło. Wartość tokenu `ACCESS_TOKEN` z pliku wzorcowego służy tylko do pracy lokalnej.

## Zmiany najczęstsze

Przy nowym magazynie zmieniamy zwykle dwie zmienne.

| Zmienna | Znaczenie |
| --- | --- |
| `APOLLO_WAREHOUSE_IDS` | identyfikatory magazynów w Apollo, rozdzielone przecinkami |
| `APOLLO_CHECKPOINT_ALIAS` | aliasy statusów, które kiosk może potwierdzać |

Aliasy statusów różnią się między środowiskami, np. w Atlasie i w Apollo.

## Kiosk

| Zmienna | Znaczenie | Wartość we wzorcu |
| --- | --- | --- |
| `KIOSK_PORT` | port serwera | `8090` lokalnie, `8080` w Dockerze |
| `KIOSK_CONTEXT_PATH` | kontekst aplikacji | `/infokiosk` |
| `KIOSK_ID` | identyfikator kiosku w zapytaniach do Apollo | `1` |
| `KIOSK_NAME` | nazwa kiosku widoczna w logach | `infokiosk` |
| `KIOSK_TIME_WINDOW_INTERVAL` | zakres szukania okna czasowego w godzinach | `12` |
| `KIOSK_MAX_NUMBER_OF_SMS_RETRIES` | liczba ponownych prób wpisania kodu SMS | `1` |
| `KIOSK_SMS_CODE_LENGTH` | długość kodu SMS | `5` |
| `KIOSK_HTTP_REQUEST_TIMEOUT_SECONDS` | limit czasu zapytań HTTP do Apollo, zob. uwaga na stronie [Integracja](<https://docs.logintegra.com/infokiosk/integracja/index.md>) | `240` |
| `KIOSK_SESSION_TIMEOUT` | czas życia sesji HTTP | `120s` |
| `KIOSK_ERROR_WHITELABEL_ENABLED` | czy pokazywać domyślną stronę błędu Springa | `false` |
| `KIOSK_SHOW_RUSSIAN_LANGUAGE` | czy pokazywać flagę rosyjską w wyborze języka | `false` |
| `KIOSK_TIMEZONE` | strefa czasowa kiosku | `Europe/Warsaw` |
| `CUSTOMER_LOGO_SOURCE` | ścieżka na dysku do logo klienta w formacie PNG | `/images/customer_logo.png` |
| `KIOSK_SELECT_STEP_TYPE` | czy pokazywać ekran wyboru typu kroku | `false` |
| `KIOSK_AUTO_SELECT_EARLIEST` | czy kiosk sam obsługuje transport z najwcześniejszym oknem, gdy pasuje kilka, zamiast pokazywać listę | `false` |

## Autoryzacja

| Zmienna | Znaczenie | Wartość we wzorcu |
| --- | --- | --- |
| `ACCESS_TOKEN` | token autoryzacyjny do Apollo, zob. [Integracja](<https://docs.logintegra.com/infokiosk/integracja/index.md>) | wartość lokalna |
| `ACCESS_TOKEN_REFRESH_JOB_CRON` | harmonogram odświeżania tokenu w formacie Spring cron | `0 0/15 * * * ?` |
| `ACCESS_TOKEN_REFRESH_URL` | adres odświeżania tokenu w Apollo | `.../apollo/api/refresh-token` |

## Magazyny i transporty

| Zmienna | Znaczenie | Wartość we wzorcu |
| --- | --- | --- |
| `APOLLO_WAREHOUSE_IDS` | identyfikatory magazynów | zależy od środowiska |
| `APOLLO_GET_TRANSPORT_API_METHOD` | metoda HTTP wyszukiwania, `POST` dla API v1 i `GET` dla API v2 | `GET` |
| `APOLLO_GET_TRANSPORT_API_VERSION` | wersja API, `v1` albo `v2` | `v2` |
| `APOLLO_GET_TRANSPORT_AUTHORIZE` | czy dodawać token, `false` dla API v1 i `true` dla API v2 | `true` |
| `APOLLO_GET_TRANSPORT_URL` | adres wyszukiwania z zmiennymi `@...` | `.../api/transports?...` |
| `APOLLO_GET_TRANSPORT_URL_ALT` | adres alternatywny dla wahadeł i przerzutów | puste |
| `APOLLO_TRANSFER_TRANSPORT_TYPE_ID` | identyfikator typu transportu przerzutowego, wymagany przy adresie alternatywnym | puste |

## Statusy i BHP

| Zmienna | Znaczenie | Wartość we wzorcu |
| --- | --- | --- |
| `APOLLO_CHECKPOINT_ALIAS` | aliasy statusów do potwierdzenia | `ADDITING_OF_ADVICE,EXIT,EXIT_WEIGHT` |
| `APOLLO_CONFIRM_CHECKPOINT_API_METHOD` | metoda potwierdzenia statusu, działa tylko `POST` | `POST` |
| `APOLLO_CONFIRM_CHECKPOINT_API_VERSION` | wersja API potwierdzenia, działa tylko `v1` | `v1` |
| `APOLLO_CONFIRM_CHECKPOINT_URL` | adres potwierdzenia statusu | `.../api/infokiosk/confirmCheckpoint` |
| `APOLLO_CONFIRM_CHECKPOINT_AUTHORIZE` | czy dodawać token do potwierdzenia | `false` |
| `APOLLO_CONFIRM_CONDITIONS_URL` | adres potwierdzenia warunków BHP | `.../api/infokiosk/confirm-conditions` |
| `REQUIRE_ACCEPTATION` | czy pokazywać ekran akceptacji dokumentu BHP | `false` |
| `ACCEPTATION_FILES_PATH` | katalog z plikami PDF do akceptacji | `/app/bhp` |

Pliki w katalogu `ACCEPTATION_FILES_PATH` nazywamy kodem języka z rozszerzeniem `pdf`, np. `pl.pdf`, `en.pdf`, `ukr.pdf`.

## SMS

| Zmienna | Znaczenie | Wartość we wzorcu |
| --- | --- | --- |
| `MS_SMS_SEND_SMS_URL` | adres API mikroserwisu SMS | adres środowiska testowego |
| `MS_SMS_PRINCIPAL_NAME` | wartość `client_name` w tabeli `connected_app` mikroserwisu SMS | `KIOSK` |
| `MS_SMS_CONNECTED_APP_URL` | wartość `app_url` w tabeli `connected_app` mikroserwisu SMS | adres środowiska testowego |

Lokalnie można zostawić ustawienia wzorcowe i używać SMS-ów przez serwer testowy.

## Docker

W stacku `apollo-docker` część wartości pochodzi ze zmiennych środowiska `apollo-docker`.

| Zmienna kiosku | Zmienna w `apollo-docker` |
| --- | --- |
| `APOLLO_WAREHOUSE_IDS` | `INFOKIOSK_WAREHOUSE_IDS` |
| `APOLLO_GET_TRANSPORT_URL_ALT` | `INFOKIOSK_GET_TRANSPORT_URL_ALT` |
| `APOLLO_TRANSFER_TRANSPORT_TYPE_ID` | `INFOKIOSK_TRANSFER_TRANSPORT_TYPE_ID` |
| `KIOSK_TIMEZONE` | `KIOSK_TIMEZONE` |
| `KIOSK_SELECT_STEP_TYPE` | `KIOSK_SELECT_STEP_TYPE` |
| `KIOSK_AUTO_SELECT_EARLIEST` | `KIOSK_AUTO_SELECT_EARLIEST` |

W kontenerze logo i dokumenty BHP są montowane jako pliki, więc ścieżki `CUSTOMER_LOGO_SOURCE` i `ACCEPTATION_FILES_PATH` wskazują miejsca montowania. Adresy do Apollo w kontenerze używają nazwy usługi `apollo-backend`, np. `http://apollo-backend:8080/apollo/api/...`.
