Przejdź do treści

Pierwsze kroki

Podręcznik Mint Service Desk 3.4.2: instalacja, administracja oraz praca agentów i klientów.

Pierwsze logowanie

Logowanie administratora

Wpisz adres IP lub domenę serwera w przeglądarce i zaloguj się danymi domyślnego konta administratora. Pamiętaj o ich zmianie:

Login: admin Hasło: admin1

Konfiguracja początkowa

Aby rozpocząć pracę z Mint Service Desk, wykonaj następujące czynności:

  1. Zdefiniuj konto pocztowe, z którego będą wysyłane wiadomości. Przejdź do sekcji Poczta elektroniczna > Konta i kliknij mały przycisk , po prawej stronie paska wyszukiwania.

W widoku tworzenia konta uzupełnij wymagane pola oznaczone gwiazdką *. Dodatkowe informacje możesz wpisać w polu opisu.

W kolejnym widoku wybierz używaną usługę pocztową:

  • Gmail
  • Yahoo!
  • Microsoft Office 365
  • Inna
  • Microsoft Graph API

Następnie uzupełnij wymagane dane. Więcej informacji o tworzeniu kont znajduje się w części Administracja > Poczta elektroniczna > Konta tego podręcznika.

Po zakończeniu kliknij przycisk , aby zapisać nowe konto pocztowe.

System przeniesie Cię do listy istniejących kont. Pojawi się na niej nowy wpis z informacjami o utworzonym koncie.

  1. Zdefiniuj co najmniej jeden komponent szablonu typu treść (Body), zawierający przynajmniej znacznik {{EmailURL}}.

    Przejdź do sekcji Zgłoszenia > Komponenty i kliknij mały przycisk , po prawej stronie paska wyszukiwania.

W widoku tworzenia komponentu szablonu kliknij przycisk , znajdujący się pod opisem. W menu wybierz Poczta elektroniczna > Adres URL.

Kliknij przycisk .

Szczegółowy opis tworzenia szablonów znajduje się w części Administracja > Zgłoszenia > Szablony tego podręcznika.

  1. Zdefiniuj co najmniej jeden szablon w sekcji Zgłoszenia > Szablony.

    Kliknij mały przycisk , po prawej stronie paska wyszukiwania.

W polu wyboru treści wskaż utworzony wcześniej komponent typu Body. Nadaj szablonowi odpowiednią nazwę i wybierz typ systemowy (system).

Kliknij przycisk .

  1. Ustaw szablon wiadomości potwierdzającej adres e-mail. Przejdź do Ustawienia > Ogólne > Szablony i wybierz wcześniej utworzony szablon w polu szablonu potwierdzenia adresu e-mail.

Następnie kliknij przycisk .

  1. Utwórz co najmniej jednego użytkownika typu agent w sekcji Agenci > Agenci. Kliknij mały przycisk , po prawej stronie paska wyszukiwania.

W widoku tworzenia użytkownika uzupełnij wymagane informacje, wybierz właściwą rolę i kliknij przycisk .

MINT Service Desk zawiera jedną wstępnie zdefiniowaną rolę agenta. Więcej informacji o dodawaniu ról systemowych i zarządzaniu nimi znajduje się w części administracyjnej tego podręcznika.

  1. Po utworzeniu agenta pierwsza próba logowania spowoduje wysłanie wiadomości weryfikacyjnej na adres e-mail podany w poprzednim kroku. Wiadomość zawiera prośbę o potwierdzenie adresu.

    Po jego potwierdzeniu można rozpocząć pracę.

Tworzenie kopii zapasowej

Aby rozpocząć tworzenie kopii zapasowej, wejdź do kontenera, w którym działa baza danych:

docker exec -it id_container /bin/sh

id_container oznacza identyfikator kontenera bazy danych. Po wejściu do kontenera wykonaj:

pg_dumpall -U postgres --filename.sql

filename.sql to nazwa pliku z rozszerzeniem .sql.

Następnie opuść kontener poleceniem:

exit

Po wyjściu z kontenera wykonaj:

docker cp id_container:/filename.sql .

docker cp id_container:/filename.sql . kopiuje plik kopii zapasowej bazy danych na komputer, na którym działa MINT.

Odtwarzanie danych

Aby rozpocząć odtwarzanie, skopiuj zrzut bazy danych do kontenera:

docker cp filename.sql id_container:/filename.sql

Następnie wejdź do kontenera bazy danych:

docker exec -it id_container /bin/sh

Na koniec wykonaj polecenie odtworzenia kopii zapasowej:

psql -U postgres -f filename.sql

Format certyfikatów

Usługa Reverse Proxy wymaga certyfikatu publicznego w formacie crt/pem.

Przykładowy certyfikat pem:

-----BEGIN CERTIFICATE-----
MIID/TCCAuWgAwIBAgIUWOtKfWa9w1Fqh7ghzA+iflYebGAwDQYJKoZIhvcNAQEL
BQAwgY0xCzAJBgNVBAYTAlBMMRMwEQYDVQQIDApUZXN0X1N0YXRlMQ4wDAYDVQQH
DAVUZXN0IDEVMBMGA1UECgwMVGVzdF9OYW1lICAgMRIwEAYDVQQLDAlUZXN0X1Vu
aXQxDzANBgNVBAMMBkNvbW1vbjEdMBsGCSqGSIb3DQEJARYOdGVzdEB0ZXN0LnRl
c3QwHhcNMjAxMDA2MDg1MjQwWhcNMzAxMDA0MDg1MjQwWjCBjTELMAkGA1UEBhMC
...
WbVPWX706/s/tAgdXzz6AnVlUrErPPy+2zk0iZoIjLh1oXaqcLea4hXyFoRj6QBm
8Z8p3Fbm3NyyeEMTj91fu5UB647yU6ZBsW+dgiYBJaPuoKUrXbqZz/cQ92jnd+TF
6FzFOvXqM36Kl/dLmYibv0VXMjYT6PnY1nikBc2ve1aMM0TUR70Jb1U7Fv1FNH7V
/JhMr7rCO9UHL91KoF9t1Lc=
-----END CERTIFICATE-----

Przykładowy klucz key:

-----BEGIN PRIVATE KEY-----
MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDW2KUzPcyf3mTo
HI4mm1UR9+cggDNn6Uufyur6kI2Qj+ILKBvwX/+SnBimGuEtJJjddiNJo/Ahu0LI
A01tsa0wfsGErtuGK/poPGlA47Ucq6bVbtnzDZp2Hn4bdGAHvqILRZldE8S9QT6x
hsl40JJVWN8aOrOTdyAo3OQ4CAORMOss1jod+44OTH8P/0OYQ/MLZNdwOXVBMqM9
qy28LXrxkfugGvGVIZiQGueAJSijzPmh0ydNvejhA1QnotJSb2QnVppPmtzk/sGM
...
Z4VW3myfK64qsRP3syGOFFcWDqZZe28dL/8LYb0CgYEA2W2nHVIu0cUIPT9tMvz7
nhNMuYCgP7yKWU4WCLkksLxfYL/zSdveCBddT0dFeq8chZzD4qeOHavwajYosEej
M1q9Obq7vOkDtB3GqJHNp+1CCJvzZAW2Aca5FR+mnIZ1JgzVC6f2/m0fPpyksJaL
LtosfA36JGx73J3QRshFNHg=
-----END PRIVATE KEY-----

Generowanie certyfikatów samopodpisanych

W systemie Linux z zainstalowanym openssl wygeneruj certyfikat samopodpisany poleceniem:

$ openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 \
  -keyout "privkey.key" -out "fullchain.pem" -subj \
  "/C=PL/ST=Test State/L=Test /O=Test Name\
  /OU=Test Unit/CN=Common/emailAddress=test@test.test"

Wymiana certyfikatu w sekrecie Dockera

Aby wymienić sekret z certyfikatem, najpierw odłącz go od działającej usługi Reverse Proxy:

$ docker service update --secret-rm Certificate__pem --secret-rm CertificateKey__key mintsd_reverse-proxy

Następnie usuń istniejące sekrety z magazynu sekretów:

$ docker secret rm Certificate__pem CertificateKey__key

Utwórz nowe sekrety na podstawie klucza i certyfikatu, używając poleceń:

'$ docker secret create Certificate__pem certificate_name.pem'
'$ docker secret create CertificateKey__key key_name.key'

Na koniec podłącz nowe sekrety do usługi Reverse Proxy:

$ docker service update \
  --secret-add source=Certificate__pem,target=/etc/ssl/private/fullchain.pem \
  --secret-add source=CertificateKey__key,target=/etc/ssl/private/privkey.key \
  mintsd_reverse-proxy

Bezpłatne certyfikaty SSL z Let’s Encrypt

Let’s Encrypt umożliwia bezpłatne wygenerowanie podpisanego certyfikatu za pomocą polecenia:

$ sudo certbot certonly --nginx

Szczegółowe instrukcje instalacji i użytkowania znajdują się w dokumentacji:

Dokumentacja Certbot

UWAGA: Do uruchomienia programu certbot potrzebne są porty 80 i 433 oraz przypisana domena. Programu nie można więc uruchomić, jeśli Mint SD już działa i zajmuje te porty.

Powiązane artykuły

Automatyczne odnawianie certyfikatu

Dodaj polecenie odnawiania certyfikatu przez certbot do /etc/crontab, aby uruchamiać je cyklicznie.

Przykładowy wpis w /etc/crontab:

$ echo "0 0,12 * * * root python -c 'import random; import time; time.sleep(random.random() * 3600)' && certbot renew -q" \
  sudo tee -a /etc/crontab > /dev/null

Wymiana sekretu z certyfikatem podczas działania usługi Reverse Proxy wymaga dodatkowych kroków. Przenieś konfigurację proxy na hosta, aby certbot mógł bezpośrednio wymieniać pliki certyfikatów.

Szczegóły konfiguracji odwrotnego serwera proxy opisano w kolejnej części podręcznika.

Konfiguracja przekierowań

Konfiguracja przekierowań znajduje się w bloku server pliku nginx.conf. Wbudowany serwer reverse proxy zawiera cztery bloki location:

location /api/ {
  proxy_pass http://gateway/api/;
  include common_location.conf;
}

location /livereloadHub {
  proxy_pass http://gateway/livereloadHub;
  proxy_http_version 1.1;
  proxy_set_header Upgrade $http_upgrade;
  proxy_set_header Connection "Upgrade";
}

location ~* ^/(idp|connect|\.well-known|Account|external) {
  proxy_pass http://auth;
  include common_location.conf;
}

location / {
  proxy_pass http://frontend;
  include common_location.conf;
}

Pierwszy blok kieruje wszystkie żądania o adresach w postaci https://domain.name/api/ do usługi Gateway.

Drugi blok kieruje ruch z https://domain.name/livereloadHub do usługi Gateway i dodatkowo umożliwia komunikację za pomocą protokołu WebSocket.

Trzeci blok określa przekierowania do usługi Auth, obejmujące m.in. stronę logowania, OpenID Connect i zasoby statyczne używane na stronie logowania.

Ostatni blok kieruje wszystkie pozostałe żądania do usługi Frontend.

Plik common_location.conf definiuje nagłówki niezbędne do prawidłowego działania proxy, takie jak X-Forwarded-For, X-Forwarded-Proto, X-Forwarded-Host i X-Forwarded-Port.

Konfiguracja SSL

W pliku ssl.conf ustaw obsługiwane protokoły, opcje szyfrowania i ścieżki certyfikatów. Domyślny katalog certyfikatów to /etc/ssl/private/:

ssl_certificate             /etc/ssl/private/fullchain.pem;
ssl_certificate_key         /etc/ssl/private/privkey.key;

Zmiany w pliku services.yml

Aby prawidłowo uruchomić usługi, wprowadź poniższe zmiany w ich definicjach w pliku services.yml.

  1. Udostępnij bezpośrednio porty usług Frontend, Gateway i Auth. Przykład dla jednej z usług:
gateway:
   image: mint/gateway:latest
   ...
   ports:
     - port_on_which_we_want_to_start_service:80
  1. Usuń definicję usługi Reverse Proxy z pliku services.yml.

Uwaga: Porty zdefiniowane w tym pliku będą potrzebne podczas konfiguracji odwrotnego serwera proxy. Po uruchomieniu stosu usługi będą dostępne bezpośrednio na hoście.

Definicja odwrotnego serwera proxy

Serwer reverse proxy HTTP można skonfigurować przy użyciu różnych serwerów HTTP. W tym przykładzie użyto nginx. Początkowa konfiguracja odpowiada konfiguracji domyślnej usługi Reverse Proxy.

W Docker Swarm używany jest sterownik sieci typu overlay. Oznacza to, że usługi NIE będą dostępne pod adresem localhost. Adres dostępu do stosu można sprawdzić poleceniem ip addr.

Wynik powinien wyglądać następująco:

...
5: docker_gwbridge: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP group default
    link/ether 02:42:98:4e:fe:bc brd ff:ff:ff:ff:ff:ff
    inet 172.21.0.1/16 brd 172.21.255.255 scope global docker_gwbridge
       valid_lft forever preferred_lft forever
    inet6 fe80::42:98ff:fe4e:febc/64 scope link
       valid_lft forever preferred_lft forever
...

Do konfiguracji odwrotnego serwera proxy użyj adresu przypisanego interfejsowi docker_gwbridge. W tym przykładzie jest to 127.21.0.1.

W porównaniu z konfiguracją wbudowanej usługi Reverse Proxy w pliku nginx.conf należy zmienić jedynie adresy docelowe przekierowań. Zamiast http://gateway użyj http://ip_address_docker_gwbridge:the_port_where_the_service_was_exposed. Analogiczne zmiany wprowadź w pozostałych blokach location.