Ga naar inhoud

Je bekijkt de previewversie van de documentatiesiteDe inhoud hier dient om te testen en kan afwijken van de live documentatie.

Ga naar live documentatie

Overzicht zelf hosten

Draai je eigen instantie en elk bericht, elk account en elke logregel blijft op infrastructuur die jij beheert. Jij bepaalt hoe accounts worden geauthenticeerd, of de instantie überhaupt vanaf het openbare internet bereikbaar is en welke branding de interface draagt.

De modus bepaalt wat er verder moet draaien, dus leg die vast voordat je installeert.

simple is de meegeleverde standaard en heeft alleen de Valkey/Redis-datastore nodig. full voegt een SQL-database voor accounts toe, die standaard SQLite gebruikt op sqlite://data/auth.db; PostgreSQL is een ondersteunde optie, geen vereiste. In een container heeft dat bestand een gekoppeld volume nodig om een herstart te overleven.

Simple of Full beschrijft wat elke modus mogelijk maakt, waar die database moet staan en hoe lastig het is om later van modus te wisselen.

Haast, en draai je al Valkey of Redis? De enkele docker run-vorm in Installeren met Docker start een instantie op poort 3000 met een gegenereerde SECRET-waarde. Alles wat verder op deze pagina staat, geldt nog steeds zodra die draait.

  • Images en varianten — welke van de gepubliceerde images je draait en hoe de release-tags werken.
  • Installeren met Docker — de twee Compose-stacks die het project meelevert.
  • Installeren op Linux — een bare-metal-installatie op Debian of Ubuntu. Geen andere distributiefamilie wordt door de installatietests van het project gedekt.
  • Draaien als service — de systemd-units die de repository meelevert, en de Procfile-runner voor hosts zonder systemd.
  • Reverse proxy en TLS — de applicatie termineert nooit TLS, dus er wordt een proxy ervoor verondersteld. Lees dit voordat je de instantie blootstelt.
  • Controleer je installatie — bewijs dat de instantie echt werkt voordat je haar aan iemand overdraagt, en maak het eerste account aan: de rol van sitebeheerder wordt alleen via de CLI toegekend.

Een bestaande installatie upgraden? De Upgradehandleidingen tonen de beschikbare handleidingen, nieuwste eerst. Begin met de eerste handleiding na de release die je nu draait en werk vooruit, en lees de release notes van elke tussenliggende release.

Aanbevolen voor een instantie met authenticatiemodus simple:

  • 2+ CPU-cores
  • 2GB+ RAM
  • 10GB+ schijfruimte

Een deployment in de modus full die ook PostgreSQL, de achtergrondworker en de scheduler draait, heeft ongeveer het dubbele nodig.

Acties alleen voor beheerders van de instantie

Sectie getiteld “Acties alleen voor beheerders van de instantie”

Sommige administratieve taken hebben geen scherm in de applicatie en worden vanaf de opdrachtregel van de instantie uitgevoerd.

Een organisatie overdragen aan een nieuwe eigenaar is de belangrijkste. Eigenaren van organisaties hebben hier geen scherm of endpoint voor, dus de overdracht is aan jou. Gebruik de onderstaande opdracht. Voor automatisering biedt de Colonel API dezelfde bewerking op POST /api/colonel/organizations/:org_id/transfer-ownership; die vereist de colonel-rol, neemt de naam van de organisatie als bevestiging en wordt direct toegepast, zonder voorvertoning.

Terminalvenster
bin/ots org transfer-ownership ORG NEW_OWNER

ORG is de openbare ID van de organisatie (extid, de ID die de CLI toont) of de interne ID (objid). NEW_OWNER is een e-mailadres, een klant-extid of een Rodauth-account-ID, en die persoon moet al een actief lid zijn — de opdracht maakt nooit een klant aan, dus voer eerst bin/ots memberships add ORG CUSTOMER uit als dat niet zo is.

Voer je de opdracht uit zonder --yes, dan plant die de overdracht voordat er iets wordt aangeraakt: hij toont wie het eigendom verliest, hoeveel eigenaarslidmaatschappen zouden worden gedegradeerd en naar welke rol, en vraagt je daarna om bevestiging. Door n te antwoorden, bekijk je een overdracht vooraf. De opties zijn --demote-to ROLE (elke lidmaatschapsrol behalve owner, standaard admin), --yes (ook -y en -f) en --json.

De vertrekkende eigenaar wordt gedegradeerd, niet verwijderd. De bewerking promoveert de nieuwe eigenaar voordat de oude wordt gedegradeerd — de beveiliging tegen een organisatie zonder eigenaar weigert elke andere volgorde — dus gedurende die twee schrijfacties heeft de organisatie twee eigenaarslidmaatschappen en meldt bin/ots org doctor controle 4 (membership_role_sync) als een waarschuwing. Als een overdracht binnen dat venster wordt onderbroken, voer je de overdrachtsopdracht opnieuw uit, niet org doctor. De overdracht is idempotent en degradeert elke andere eigenaar; org doctor markeert die controle als repairable: false en herstelt het niet.

De kant van de eindgebruiker hiervan is Eigendom en overdracht; dat is wat je gebruikers hebben gelezen voordat ze bij jou aankloppen.