Konfigurace
nimap se konfiguruje proměnnými prostředí v sekci environment souboru compose.yaml (viz Instalace). Po změně je použijte příkazem docker compose up -d.
| Proměnná | Výchozí hodnota | Popis |
|---|---|---|
SERVICE_DATABASE_URL |
povinná | Připojení k PostgreSQL |
SERVICE_ENV |
production |
Prostředí běhu |
SERVICE_PORT |
8080 |
HTTP port uvnitř kontejneru |
SERVICE_MEDIA_DIR |
./data/media |
Adresář pro nahrané soubory |
SERVICE_AUTO_MIGRATE |
true |
Aktualizace schématu databáze při startu |
SERVICE_LOG_LEVEL |
info |
Podrobnost logování |
SERVICE_LOG_FORMAT |
text |
Formát logů |
SERVICE_BASE_URL |
— | Veřejná adresa instance |
SERVICE_OIDC_ISSUER |
— | OIDC poskytovatel; prázdná vypíná jednotné přihlášení |
SERVICE_OIDC_CLIENT_ID |
— | Client ID u poskytovatele |
SERVICE_OIDC_CLIENT_SECRET |
— | Client secret u poskytovatele |
SERVICE_OIDC_NAME |
SSO |
Název na přihlašovacím tlačítku |
SERVICE_OIDC_SCOPES |
openid,email,profile |
Scopes vyžádané od poskytovatele |
SERVICE_OIDC_ALLOWED_DOMAINS |
— | E-mailové domény, které si mohou založit účet |
SERVICE_OIDC_LINK_BY_EMAIL |
true |
Propojit první přihlášení s existujícím uživatelem podle e-mailu |
SERVICE_DATABASE_URL
Sekce “SERVICE_DATABASE_URL”Připojovací řetězec k PostgreSQL 18 s PostGIS ve tvaru postgres://uzivatel:heslo@host:port/databaze?sslmode=disable. Bez něj se nimap nespustí. Speciální znaky v hesle musí být zakódované pro URL.
Pokud databáze běží na jiném stroji, použijte sslmode=require.
SERVICE_ENV
Sekce “SERVICE_ENV”production nebo development. Výchozí: production.
V režimu production je session cookie označená jako zabezpečená a prohlížeč ji posílá jen přes HTTPS. Přes čisté HTTP ji prohlížeč zahodí, takže přihlášení nefunguje. Výjimkou je http://localhost, který prohlížeče považují za zabezpečený.
development používejte jen pro vyzkoušení nimapu v lokální síti bez HTTPS.
SERVICE_PORT
Sekce “SERVICE_PORT”Port, na kterém nimap naslouchá uvnitř kontejneru, 1–65535. Výchozí: 8080.
Pokud chcete nimap vystavit na jiném portu hostitele, změňte jen levou stranu ports v compose.yaml, například "80:8080". Když změníte SERVICE_PORT, upravte i pravou stranu ports a port v healthcheck.
SERVICE_MEDIA_DIR
Sekce “SERVICE_MEDIA_DIR”Adresář pro nahrané fotky, dokumenty a vygenerované náhledy. Výchozí: ./data/media. V Compose instalaci je to /data/media ve volume media.
Do adresáře musí mít právo zápisu uživatel kontejneru (1001). Jinak se nimap při startu zastaví s hláškou media directory is not writable. Nový Docker volume dostane správného vlastníka automaticky; adresář připojený z hostitele musí patřit uživateli 1001.
Zálohujte ho spolu s databází, protože databáze na soubory jen odkazuje.
SERVICE_AUTO_MIGRATE
Sekce “SERVICE_AUTO_MIGRATE”true nebo false. Výchozí: true.
Když je zapnutá, nimap při každém startu aktualizuje schéma databáze, i po přechodu na novější image. Vypněte ji jen tehdy, když chcete migrace spouštět ručně příkazem /nimap migrate up.
SERVICE_LOG_LEVEL
Sekce “SERVICE_LOG_LEVEL”debug, info, warn nebo error. Výchozí: info.
SERVICE_LOG_FORMAT
Sekce “SERVICE_LOG_FORMAT”text nebo json. Výchozí: text. json se hodí, když logy sbírá agregátor logů.
SERVICE_BASE_URL
Sekce “SERVICE_BASE_URL”Adresa, na které uživatelé nimap otevírají, například https://nimap.example.com. Povinná, když je zapnuté jednotné přihlášení, jinak volitelná.
Musí to být absolutní URL bez query a fragmentu. Musí používat https, pokud SERVICE_ENV není development. Na koncovém lomítku nezáleží. Pokud nimap běží pod cestou, uveďte ji: https://example.com/nimap.
Z ní se odvozuje redirect URI pro OIDC jako SERVICE_BASE_URL + /api/auth/oidc/callback. Za reverzní proxy uveďte veřejnou adresu, ne interní.
Jednotné přihlášení
Sekce “Jednotné přihlášení”Proměnné SERVICE_OIDC_* připojují nimap k poskytovateli OpenID Connect, jako je Authentik, Keycloak, Microsoft Entra ID nebo Google. Nastavení poskytovatele a propojování účtů popisuje stránka Jednotné přihlášení.
Pokud je některá z nich neplatná, nimap se nespustí a napíše, která. Pokud poskytovatel při startu není dostupný, nimap se spustí jen s přihlášením heslem a zaloguje single sign-on disabled.
SERVICE_OIDC_ISSUER
Sekce “SERVICE_OIDC_ISSUER”Issuer URL poskytovatele, například https://auth.example.com/application/o/nimap/. nimap pod ní čte /.well-known/openid-configuration. Musí přesně odpovídat hodnotě issuer, kterou tam poskytovatel uvádí, včetně koncového lomítka.
Prázdná (výchozí) jednotné přihlášení vypíná. Musí používat https, pokud SERVICE_ENV není development.
SERVICE_OIDC_CLIENT_ID
Sekce “SERVICE_OIDC_CLIENT_ID”Client ID aplikace zaregistrované u poskytovatele. Povinná, když je nastavená SERVICE_OIDC_ISSUER.
SERVICE_OIDC_CLIENT_SECRET
Sekce “SERVICE_OIDC_CLIENT_SECRET”Client secret té aplikace. Povinná, když je nastavená SERVICE_OIDC_ISSUER. nimap je důvěrný (confidential) klient, takže poskytovatel musí secret vydat.
SERVICE_OIDC_NAME
Sekce “SERVICE_OIDC_NAME”Text na přihlašovacím tlačítku ve tvaru „Přihlásit se přes …“. Výchozí: SSO. Použijte název, který uživatelé znají, například Authentik nebo firemní účet.
SERVICE_OIDC_SCOPES
Sekce “SERVICE_OIDC_SCOPES”Scopes vyžádané od poskytovatele, oddělené čárkou. Výchozí: openid,email,profile. Musí obsahovat openid. nimap potřebuje e-mail, takže email ponechte, pokud ho poskytovatel neposílá jinak.
SERVICE_OIDC_ALLOWED_DOMAINS
Sekce “SERVICE_OIDC_ALLOWED_DOMAINS”E-mailové domény oddělené čárkou, jejichž uživatelé dostanou při prvním přihlášení nový účet, například example.com,example.org. Na velikosti písmen nezáleží, ale doména se porovnává přesně: example.com nepovolí sub.example.com.
Prázdná (výchozí) povolí každého, koho pustí poskytovatel. Seznam omezuje jen zakládání nových účtů; uživatelé, kteří už jsou propojení nebo se propojí podle e-mailu, se přihlásí bez ohledu na doménu.
SERVICE_OIDC_LINK_BY_EMAIL
Sekce “SERVICE_OIDC_LINK_BY_EMAIL”true nebo false. Výchozí: true.
Když je zapnutá, první přihlášení přes SSO s e-mailem, který už má uživatel v nimapu, se s tímto uživatelem propojí. Jen ale tehdy, když poskytovatel e-mail označí jako ověřený (email_verified). Když je vypnutá nebo e-mail ověřený není, takové přihlášení se odmítne.
Zapínejte ji jen tehdy, když e-mailům od poskytovatele věříte: kdo u poskytovatele ovládá nějaký e-mail, dostane se do účtu v nimapu s tímto e-mailem.