Przejdź do treści

Przeglądasz przedpremierową wersję dokumentacjiTreści tutaj służą do testów i mogą różnić się od dokumentacji produkcyjnej.

Przejdź do dokumentacji produkcyjnej

Przegląd self-hostingu

Uruchom własną instancję, a każdy sekret, każde konto i każda linia logów pozostaną na infrastrukturze, którą kontrolujesz. To Ty decydujesz, jak uwierzytelniane są konta, czy instancja jest w ogóle dostępna z publicznego internetu i jaki branding nosi interfejs.

Tryb decyduje o tym, co jeszcze musi działać, więc ustal go przed instalacją.

simple to domyślny tryb w dostarczanej konfiguracji i wymaga jedynie magazynu danych Valkey/Redis. full dodaje bazę danych SQL dla kont, która domyślnie korzysta z SQLite pod adresem sqlite://data/auth.db; PostgreSQL jest obsługiwaną opcją, a nie wymogiem. W kontenerze ten plik potrzebuje zamontowanego wolumenu, aby przetrwać restart.

Simple czy Full wyjaśnia, co odblokowuje każdy tryb, gdzie musi znajdować się ta baza danych i jak trudno później zmienić tryb.

Spieszysz się i masz już działający Valkey lub Redis? Pojedyncze polecenie docker run z Instalacji z Dockerem uruchamia instancję na porcie 3000 z wygenerowaną wartością SECRET. Wszystko pozostałe na tej stronie nadal obowiązuje, gdy instancja już działa.

  • Obrazy i warianty — który z publikowanych obrazów uruchomić i jak działają tagi wydań.
  • Instalacja z Dockerem — dwa stosy Compose, które projekt dostarcza.
  • Instalacja na Linuksie — instalacja bare-metal na Debianie lub Ubuntu. Testy instalacji projektu nie obejmują żadnej innej rodziny dystrybucji.
  • Uruchamianie jako usługa — jednostki systemd dostarczane w repozytorium oraz runner Procfile dla hostów bez systemd.
  • Reverse proxy i TLS — aplikacja nigdy nie terminuje TLS, więc zakłada się proxy przed nią. Przeczytaj to, zanim wystawisz instancję na zewnątrz.
  • Weryfikacja instalacji — upewnij się, że instancja faktycznie działa, zanim przekażesz ją komukolwiek, i utwórz pierwsze konto: rola operatora witryny jest nadawana wyłącznie z CLI.

Aktualizujesz istniejącą instalację? Przewodniki aktualizacji wymieniają dostępne przewodniki, od najnowszego. Zacznij od pierwszego przewodnika po wydaniu, które obecnie uruchamiasz, i przechodź dalej, czytając informacje o wydaniu dla każdego wydania pośredniego.

Zalecane dla instancji działającej w trybie uwierzytelniania simple:

  • 2+ rdzenie CPU
  • 2 GB+ RAM
  • 10 GB+ przestrzeni dyskowej

Wdrożenie w trybie full, które uruchamia także PostgreSQL, proces roboczy w tle i harmonogram, potrzebuje mniej więcej dwa razy tyle.

Część prac administracyjnych nie ma ekranu w aplikacji i wykonuje się ją z wiersza poleceń instancji.

Najważniejsze z nich to przeniesienie organizacji na nowego właściciela. Właściciele organizacji nie mają do tego ekranu ani punktu końcowego, więc przeniesienie należy do Ciebie. Użyj poniższego polecenia. Do automatyzacji Colonel API udostępnia tę samą operację pod adresem POST /api/colonel/organizations/:org_id/transfer-ownership; wymaga ona roli colonel, przyjmuje nazwę organizacji jako potwierdzenie i jest stosowana natychmiast, bez podglądu.

Okno terminala
bin/ots org transfer-ownership ORG NEW_OWNER

ORG to publiczny identyfikator organizacji (extid, ten, który wypisuje CLI) lub jej wewnętrzny identyfikator (objid). NEW_OWNER to adres e-mail, extid klienta lub identyfikator konta Rodauth, a osoba ta musi już być aktywnym członkiem — polecenie nigdy nie tworzy klienta, więc jeśli nim nie jest, najpierw uruchom bin/ots memberships add ORG CUSTOMER.

Uruchomione bez --yes planuje przeniesienie, zanim czegokolwiek dotknie: wypisuje, kto traci własność, ile członkostw właściciela zostałoby zdegradowanych i do jakiej roli, a następnie prosi o potwierdzenie. Odpowiedź n to sposób na podgląd przeniesienia. Dostępne opcje to --demote-to ROLE (dowolna rola członkostwa poza owner, domyślnie admin), --yes (także -y i -f) oraz --json.

Dotychczasowy właściciel zostaje zdegradowany, a nie usunięty. Operacja awansuje nowego właściciela, zanim zdegraduje poprzedniego — zabezpieczenie przed brakiem właściciela odrzuca każdą inną kolejność — więc przez czas trwania tych dwóch zapisów organizacja ma dwa członkostwa właściciela, a bin/ots org doctor zgłasza kontrolę 4 (membership_role_sync) jako ostrzeżenie. Jeśli przeniesienie zostanie przerwane w tym oknie, uruchom polecenie przeniesienia ponownie, a nie org doctor. Przeniesienie jest idempotentne i degraduje każdego innego właściciela; org doctor oznacza tę kontrolę jako repairable: false i nie naprawia jej.

Stroną użytkownika końcowego jest tutaj Własność i przeniesienie — to właśnie przeczytają Twoi użytkownicy, zanim się do Ciebie zwrócą.