Documentation contents

Install the server from a .run file

The installer includes the server and the software that handles HTTPS. It runs without internet access.

The installer bundles the Gadka server and HTTPS reverse proxy in a single file. It downloads nothing from the network. It asks a few questions, saves the configuration and starts the systemd services.

Before you start

  • x86-64 Linux with systemd and openssl. See Requirements.
  • Root access.
  • A domain pointing to the server.
  • A TLS certificate with the full chain and a private key on the server, both in PEM format. See Domain and HTTPS.
  • For PostgreSQL or MySQL, an existing empty database and a database user with a password.

1. Download and run the installer

  1. Get the server installer from the downloads page.
  2. Copy it to the server and run it as root. Replace <wersja> with the version in the filename.
chmod +x gadka-server-<wersja>-linux-amd64.run
sudo ./gadka-server-<wersja>-linux-amd64.run

2. Answer the prompts

Press Enter to accept the default shown in square brackets.

Installer promptWhat to enter
Domena serwera (bez https:// i portu)The domain without the scheme or port, e.g. gadka.example.com
Publiczny port TCP/UDP [6543]Keep 6543 unless you need a different public port
Wybór [1]Database type: 1 for SQLite, 2 for PostgreSQL or 3 for MySQL
Ścieżka bazy SQLite [/var/lib/gadka/gadka.db]Press Enter for the default SQLite path
Plik pełnego łańcucha certyfikatu TLS (PEM)Path to the full certificate chain
Plik prywatnego klucza TLS (PEM)Path to the private key
Źródło Listy Ostrzeżeń CERT Polska (URL lub firmowy mirror)Press Enter for the default warning list or enter the URL of your own copy

For PostgreSQL or MySQL, the installer also asks for the database host (Host bazy), port (Port bazy), existing database name (Nazwa istniejącej bazy), user (Użytkownik bazy) and password (Hasło użytkownika bazy). For PostgreSQL, it also asks for the TLS mode (Tryb TLS PostgreSQL (require/verify-full/disable)).

SQLite stores data in a file. Choose it if you don’t want to maintain a separate database server.

3. Check the services

After the last prompt, the installer prints Sprawdzanie konfiguracji i migracja bazy… while it checks the configuration and creates the database schema. It enables the services and prints the domain your team should enter in the app.

Gotowe. Pracownicy wpisują w aplikacji domenę: gadka.example.com

Check the services and server readiness.

systemctl status gadka gadka-proxy
gadka healthcheck && echo OK

Both services should show active (running). The second command should print OK.

Installed files and services

Path or servicePurpose
/usr/local/bin/gadkaServer and administration tool
/usr/local/bin/gadka-caddyHTTPS reverse proxy
/etc/gadka/gadka.yamlServer configuration
/etc/gadka/CaddyfileReverse proxy configuration
/etc/gadka/tls-cert.pem, /etc/gadka/tls-key.pemCopies of your certificate and private key
/etc/gadka/jwt-signing-key.pem, /etc/gadka/mfa-keyKeys generated during installation
/etc/gadka/db-passwordDatabase password (PostgreSQL and MySQL only)
/var/lib/gadkaData, including the SQLite database
gadka.service, gadka-proxy.servicesystemd services
/etc/systemd/system/gadka.service.d/10-credentials.confGives the service access to the machine identifiers needed for licensing

The services run as the unprivileged system user gadka.

Running the installer again

Installers from version 0.3.2 onward recognize the existing configuration. The installer displays Gadka — aktualizacja istniejącej instalacji and asks you to confirm the update. It preserves your configuration, keys and data. See Updating the server.

Troubleshooting

Message or symptomWhat to do
Błąd: uruchom instalator jako rootRun the installer using sudo
Błąd: pakiet jest przeznaczony dla amd64/x86_64Use a server with an x86-64 processor
Błąd: wymagany jest opensslInstall the openssl package
Błąd: nie można odczytać certyfikatu: …Correct the path to the PEM file
The gadka service fails to startRun journalctl -u gadka -n 50 to see the configuration error