Przejdź do głównej zawartości

Wymagania systemowe

Minimalne wymagania

KomponentWymaganie
System operacyjnyLinux, macOS lub Windows z Docker Desktop
DockerDocker Engine 24+ lub Docker Desktop 4.x
Docker Composev2 (wbudowany w Docker Desktop)
RAMminimum 4 GB (zalecane 8 GB)
Dyskminimum 2 GB wolnego miejsca
Port8080 (gateway) -- jedyny wymagany port
Nie potrzebujesz git, curl ani żadnych dodatkowych narzędzi

Wystarczy Docker i przeglądarka. Plik docker-compose.yml skopiujesz z Szybkiego startu.

Porty

Gateway nasłuchuje na porcie 8080 i udostępnia wszystkie usługi pod jednym adresem. Pozostałe porty są opcjonalne (bezpośredni dostęp do poszczególnych usług):

PortUsługaWymagany?Zmienna .env
8080Gateway (portal + API + Keycloak)takAPP_HOST_PORT
8081API (bezpośredni dostęp / Swagger)nieAPI_HOST_PORT
8082Keycloak (konsola admina)nieKEYCLOAK_HOST_PORT
8083Portal Web (bezpośredni dostęp)niePORTAL_WEB_HOST_PORT
5432PostgreSQLniePOSTGRES_HOST_PORT

Porty można zmienić w pliku .env -- szczegóły w Konfiguracja zaawansowana.

Dostęp z sieci

Jeśli chcesz udostępnić OpenKSeF w sieci lokalnej lub przez internet:

  1. Ustaw APP_EXTERNAL_BASE_URL na publiczny adres, np. http://192.168.1.50:8080
  2. Upewnij się, że port 8080 (lub wybrany) jest dostępny z zewnątrz
  3. Dla HTTPS -- użyj reverse proxy (nginx, Traefik, Caddy) przed gatewayem
Aplikacja mobilna

Aplikacja mobilna na Androidzie wymaga HTTPS do logowania (OIDC). Dla testów lokalnych użyj ngrok -- skrypt dev-env-up.ps1 konfiguruje to automatycznie.

Następny krok

Przejdź do Szybkiego startu, żeby uruchomić OpenKSeF.