Konfiguracja
Aplikację Mitra konfiguruje się wyłącznie zmiennymi środowiskowymi. Nie ma pliku konfiguracyjnego do zamontowania: ustawiasz zmienne w kontenerze, a Mitra odczytuje je przy uruchomieniu. Każda zmienna jest opcjonalna, a te, których nie ustawisz, przyjmują wartości domyślne podane niżej.
W Docker Compose zmienne trafiają do bloku environment:
services: mitra: image: ghcr.io/a11delavar/mitra:latest environment: MITRA_URL: 'https://mitra.example.com' MITRA_NAME: 'Family Calendar'Równie dobrze sprawdzi się plik .env albo sekrety Dockera, jeśli wolisz trzymać poufne dane poza plikiem Compose. Zmiana zaczyna działać przy następnym uruchomieniu aplikacji Mitra:
docker compose up -dCo trzeba skonfigurować na serwerze
Section titled “Co trzeba skonfigurować na serwerze”Prawie nic. Kalendarze Mitra, CalDAV, Kalendarz Apple, subskrypcje kalendarzy, Notion, Todoist i Tempo użytkownicy dodają sami, w aplikacji.
Dwie rzeczy wymagają danych uwierzytelniających, które trzeba najpierw zarejestrować u kogoś innego: Kalendarz Google (MITRA_GOOGLE_*) i logowanie (MITRA_OIDC_*).
Udostępnij aplikację przez HTTPS
Section titled “Udostępnij aplikację przez HTTPS”Gdy tylko Mitra ma być dostępna z innych urządzeń niż twój komputer, umieść ją za odwrotnym serwerem proxy, takim jak Caddy, Traefik lub nginx, i powierz mu obsługę HTTPS. Sama Mitra mówi wewnątrz kontenera zwykłym HTTP. Niektóre funkcje działają tylko przez HTTPS:
- Przeglądarki pozwalają na przypomnienia i instalowanie aplikacji tylko pod adresami
https://(orazhttp://localhost). - Pliki cookie logowania są oznaczane jako bezpieczne tylko pod adresem
https://, a większość dostawców tożsamości wymaga adresu przekierowaniahttps://. - Kalendarz Google wymaga adresu przekierowania
https://.
Następnie ustaw w MITRA_URL adres publiczny.
Z Caddy wystarczy tyle:
mitra.example.com { reverse_proxy localhost:3000}Z Traefikiem kieruj ruch do aplikacji Mitra za pomocą etykiet usługi:
services: mitra: image: ghcr.io/a11delavar/mitra:latest restart: unless-stopped volumes: - ~/mitra:/app/data labels: - "traefik.enable=true" - "traefik.http.routers.mitra.rule=Host(`mitra.example.com`)" - "traefik.http.services.mitra.loadbalancer.server.port=3000" environment: MITRA_URL: 'https://mitra.example.com'Ustaw publiczny adres URL
Section titled “Ustaw publiczny adres URL”MITRA_URL to adres, który użytkownicy wpisują w przeglądarce, aby otworzyć aplikację Mitra, a nie wewnętrzny adres kontenera:
environment: MITRA_URL: 'https://mitra.example.com'Na jego podstawie Mitra tworzy adresy zwrotne dla Kalendarza Google i logowania, a gdy zaczyna się od https://, oznacza swoje pliki cookie jako bezpieczne. Możesz go pominąć, dopóki testujesz aplikację Mitra pod adresem http://localhost. Ustaw go, gdy tylko Mitra dostanie prawdziwy adres. Bez niego nie włączysz logowania.
Nazwij swoją instancję
Section titled “Nazwij swoją instancję”MITRA_NAME zastępuje nazwę „Mitra” w panelu bocznym, na karcie przeglądarki i w zainstalowanej aplikacji:
environment: MITRA_NAME: 'Family Calendar'Kliknięcie nazwy otwiera okno O aplikacji, które pokazuje uruchomioną wersję i commit. Zainstalowana aplikacja zachowuje nazwę i ikonę „Mitra”, bo są one ustalane podczas budowania aplikacji.
Wszystkie zmienne
Section titled “Wszystkie zmienne”Podstawowe
Section titled “Podstawowe”| Zmienna | Domyślnie | Opis |
|---|---|---|
MITRA_URL | (nieustawiona) | Publiczny adres, pod którym użytkownicy otwierają aplikację Mitra, na przykład https://mitra.example.com. Wynikają z niego adresy zwrotne logowania i Kalendarza Google oraz to, czy pliki cookie są bezpieczne. Opcjonalna, dopóki testujesz aplikację Mitra na localhost, wymagana do logowania i zalecana dla Kalendarza Google oraz każdego publicznego serwera. |
MITRA_NAME | (Mitra, w języku każdego użytkownika) | Nazwa wyświetlana w panelu bocznym, na karcie przeglądarki i w zainstalowanej aplikacji. |
MITRA_PORT | 3000 | Port, na którym nasłuchuje serwer. W Dockerze zmień raczej port po stronie hosta w mapowaniu portów; tę zmienną ustawiaj tylko wtedy, gdy sam proces musi nasłuchiwać na innym porcie. Wbudowana kontrola stanu się do niej dostosowuje. |
MITRA_LOG_LEVEL | info | Ile Mitra zapisuje w logach: error, warn, info, debug lub trace. Każdy poziom obejmuje wszystko, co zapisują poziomy cichsze od niego. |
MITRA_UPDATE_CHECK | (włączone) | Ustaw off (albo false, 0, no), aby wyłączyć sprawdzanie aktualizacji. |
MITRA_MCP | (włączone) | Ustaw off (albo false, 0, no), aby zamknąć adres, z którym łączą się narzędzia AI. |
Przypomnienia
Section titled “Przypomnienia”| Zmienna | Domyślnie | Opis |
|---|---|---|
MITRA_VAPID_SUBJECT | mailto:mitra@localhost | Kontakt, który widzą usługi push przy przypomnieniach z twojego serwera, zwykle adres mailto:. Użytkownicy aplikacji Mitra go nie widzą. Klucze podpisu są generowane automatycznie, więc nic więcej nie trzeba ustawiać. |
Lokalizacja
Section titled “Lokalizacja”| Zmienna | Domyślnie | Opis |
|---|---|---|
MITRA_PHOTON_URL | https://photon.komoot.io | Geokoder Photon, z którego korzysta pole lokalizacji. Możesz wskazać własną instancję Photon zamiast publicznej instancji komoot. |
Załączniki
Section titled “Załączniki”| Zmienna | Domyślnie | Opis |
|---|---|---|
MITRA_FILE_MAX_SIZE | 25M | Największy plik, jaki można załączyć do wpisu, w bajtach albo z przyrostkiem k, M lub G. Ustaw 0, aby wyłączyć dodawanie plików. |
MITRA_FILE_QUOTA | (nieustawiona) | Ile łącznie każda osoba może przechowywać w załączonych plikach, zapisane w ten sam sposób. Bez niej nie ma limitu. |
Kalendarz Google
Section titled “Kalendarz Google”Ustaw obie zmienne, aby użytkownicy mogli łączyć Kalendarz Google. Jeśli ustawisz tylko identyfikator, Mitra się nie uruchomi.
| Zmienna | Domyślnie | Opis |
|---|---|---|
MITRA_GOOGLE_CLIENT_ID | (nieustawiona) | Identyfikator klienta OAuth z konsoli Google Cloud. |
MITRA_GOOGLE_CLIENT_SECRET | (nieustawiona) | Tajny klucz klienta OAuth. Wymagany zawsze, gdy ustawiono MITRA_GOOGLE_CLIENT_ID. |
Logowanie jednokrotne
Section titled “Logowanie jednokrotne”Ustawienie MITRA_OIDC_ISSUER włącza logowanie. Jeśli brakuje zmiennych, których ono wymaga, Mitra odmawia uruchomienia.
| Zmienna | Domyślnie | Opis |
|---|---|---|
MITRA_OIDC_ISSUER | (nieustawiona) | Adres URL wystawcy (issuer) twojego dostawcy OIDC. Wymaga MITRA_OIDC_CLIENT_ID i MITRA_URL. |
MITRA_OIDC_CLIENT_ID | (nieustawiona) | Identyfikator klienta zarejestrowanego u dostawcy. |
MITRA_OIDC_CLIENT_SECRET | (nieustawiona) | Tajny klucz klienta. Pomiń go w przypadku klienta publicznego; Mitra zawsze używa PKCE. |
MITRA_OIDC_SCOPES | openid profile email | Zakresy, o które prosi Mitra, rozdzielone spacjami. openid jest wymagany; profile i email przekazują aplikacji Mitra imię i nazwisko oraz adres e-mail każdego użytkownika. |
Ustawiane przy budowaniu
Section titled “Ustawiane przy budowaniu”Tych zmiennych nie ustawia się na serwerze. Ustawia je proces budowania lub obraz albo służą do pracy nad samą aplikacją Mitra.
| Zmienna | Ustawia | Opis |
|---|---|---|
MITRA_VERSION | Budowanie | Wersja wbudowana w obraz. |
MITRA_COMMIT | Budowanie | Commit wbudowany w obraz. |
MITRA_DEV | Środowisko deweloperskie | Udostępnia integrację Demo, czyli zestaw przykładowych kalendarzy, podczas pracy nad aplikacją Mitra. |
NODE_ENV | Obraz | production w obrazie kontenera. |
Przykład
Section titled “Przykład”Serwer z logowaniem, Kalendarzem Google i własnym geokoderem:
services: mitra: image: ghcr.io/a11delavar/mitra:latest restart: unless-stopped ports: - '3000:3000' volumes: - ~/mitra:/app/data environment: MITRA_URL: 'https://mitra.example.com' MITRA_NAME: 'Family Calendar'
# Sign-in MITRA_OIDC_ISSUER: 'https://auth.example.com' MITRA_OIDC_CLIENT_ID: 'mitra' MITRA_OIDC_CLIENT_SECRET: '…'
# Google Calendar MITRA_GOOGLE_CLIENT_ID: '….apps.googleusercontent.com' MITRA_GOOGLE_CLIENT_SECRET: '…'
# Your own geocoder MITRA_PHOTON_URL: 'https://photon.internal.example.com'