Zum Inhalt springen

Diese Seite ist eine maschinelle Übersetzung der englischen Seite, die maßgeblich ist. Englische Seite lesen

Überblick über einen mycroblog-Server

Die erste Seite, die du liest, bevor du einen Server betreibst. mycroblog ist ein Microblog, der über ActivityPub mit dem Rest des Fediverse föderiert; my ist seine Server-Software, eine einzige Binary, die den Server, den Job-Worker, den Web-Client und die Befehle enthält, die sich um sie kümmern. Diese Seite zeigt, woraus ein Server besteht, was du per Konfiguration wählst, wie ein kleiner Server zu einem großen wächst und wo du als Nächstes weiterliest.

Die Architektur eines mycroblog-Servers: Clients erreichen die my-Prozesse über HTTPS; die Prozesse nutzen die per Konfiguration gewählten Teile und die Dienste außerhalb des Servers, die du einschaltest. Die Abschnitte unten beschreiben jeden Teil.

Im Diagramm von oben nach unten:

  • Wer sich verbindet. Menschen nutzen den Web-Client in ihrem Browser (er lässt sich als App installieren), Apps und Bots nutzen die Client-API, und andere Fediverse-Server liefern und holen Beiträge über ActivityPub. Alle erreichen den Server über HTTPS.
  • Vor dem Server. Standardmäßig spricht my reines HTTP, daher beendet ein Reverse-Proxy oder Load Balancer HTTPS vor ihm. Auf einer einzelnen Maschine kann my stattdessen selbst HTTPS ausliefern (HTTPS vom Server aus ausliefern). Ein CDN vor den Mediendateien ist optional.
  • Die my-Prozesse. Jeder Prozess führt my serve aus, und seine role legt fest, was er ausführt: web den HTTP-Server, worker den Job-Worker, der Beiträge zustellt, von anderen Servern abruft, E-Mails sendet, Medien verarbeitet und die periodischen Jobs ausführt, und all, der Standard, beides in einem Prozess.
  • Die Teile, die du wählst. Jeder Teil in der Mitte des Diagramms hat eine Einstellung, die seinen Adapter wählt, aufgelistet im nächsten Abschnitt.
  • Dienste außerhalb des Servers. CAPTCHA, Sprachchat, Zahlungen, Plugins und der Import der Cloud-Kosten bleiben jeweils aus, bis du sie einstellst, und der Server ruft dann den Dienst auf, den du nennst.

Jeder Teil ist eine Einstellung der Konfigurationsreferenz, gesetzt in einer TOML-Datei oder als Umgebungsvariable (MY_ und der Schlüssel in Großbuchstaben, etwa MY_DATABASE). Die erste Option jeder Liste ist der Standard. Wo ein Teil Daten hält, wähle ihn vor dem ersten Start: Die Daten ziehen nicht von selbst um, wenn sich die Einstellung ändert.

Teil Einstellung Optionen Weiterlesen
Datenbank database sqlite (eine Datei), postgres (PostgreSQL und kompatible Dienste) Datenbank, Backup
Job-Queue queue db (eine Tabelle in der Datenbank), inline (führt jeden Job sofort im selben Prozess aus, für Tests und Entwicklung), cloudtasks (Google Cloud Tasks weckt den Server für jeden Job; braucht PostgreSQL) Die Job-Queue
Key-Value-Store, für Caches, Rate Limits und die Antworten, die einen Tag lang für erneut gesendete Schreibvorgänge aufbewahrt werden kv db (eine Tabelle in der Datenbank), memory (jeder Prozess für sich), valkey (Valkey oder ein anderer Server mit Redis-Protokoll, von allen Prozessen geteilt) kv
Medienspeicher blob fs (ein Verzeichnis), s3 (Amazon S3, Cloudflare R2, MinIO, Garage und andere S3-kompatible Speicher), gcs (Google Cloud Storage) Docker-Compose-Dateien, Medien sichern
Medienverarbeitung media_image, media_video, media_audio, je eine für jede Dateiart native (im Server), plugin (ein Plugin von dir wandelt die Dateien dieser Art um) Medien umwandeln
Echtzeit-Stream zwischen Prozessen stream hub (innerhalb eines Prozesses), postgres (LISTEN / NOTIFY), valkey, sns (Amazon SNS und SQS), pubsub (Google Cloud Pub/Sub) stream
Key-Manager, der die privaten Schlüssel der Konten verschlüsselt key_manager local (ein Schlüsselverschlüsselungsschlüssel, den du aufbewahrst), gcpkms (Google Cloud KMS), awskms (AWS KMS), plugin Den Schlüssel verwalten
E-Mail mail none, smtp, ses (Amazon SES), plugin E-Mails versenden
CAPTCHA captcha none, turnstile (Cloudflare Turnstile), hcaptcha, recaptcha (Google reCAPTCHA v2) CAPTCHA
Sprachchat voice off, p2p (Browser zu Browser, mit TURN aus voice_turn: none, coturn oder cloudflare), livekit, sora Sprachchat
Zahlungen von Unterstützern payments none, stripe, payjp (PAY.JP) Unterstützer, Stripe, PAY.JP
Plugins plugin_<kind>_address standardmäßig keine; eine Adresse für jede Art: translator, search, billing, mailer, media_image, media_video, media_audio, key_manager und die Entscheidungs-Hooks inbound.status, local.status, inbound.follow, signup.check, media.check, inbound.actor, local.profile Plugins, Entscheidungs-Hooks
Übersetzung von Beiträgen translator_<provider>_*, plugin_translator_address keine (nur die eigene Übersetzung des Browsers); libretranslate, deepl, google (Google Cloud Translation), aws (Amazon Translate) oder ein Plugin von dir vor dem Dienst, den du wählst Beiträge übersetzen, ein Übersetzer-Plugin
Volltextsuche der Beiträge search none; oder elasticsearch, opensearch oder meilisearch (Suchmaschinen); oder plugin, ein Plugin von dir vor einer anderen Suchmaschine Volltextsuche, ein Such-Plugin
CDN für Medien media_origin nicht gesetzt (der Server liefert Medien von seinem eigenen Origin aus) oder der Origin deines CDN Medien über ein CDN ausliefern
Cloud-Kosten billing_sources keine, oder beliebige von aws (AWS Cost Explorer), gcp (Billing-Export oder Budget von Google Cloud), cloudflare (Nutzungskosten von Cloudflare), plugin Cloud-Kosten importieren
Metriken metrics_exporter none, prometheus, otlp (OpenTelemetry), emf (CloudWatch) Metriken, Alarme
Traces traces_exporter none, otlp Traces
Fehlerberichte errors_exporter none (nur die Logzeile und die Fehlergruppen), sentry (Sentry, GlitchTip, Datadog), otlp Fehlerberichte

Die veröffentlichte Binärdatei und das Container-Image enthalten jeden Adapter der Tabelle.

my config check meldet alle Probleme der Konfiguration auf einmal, bevor du den Server startest (Produktions-Checkliste).

Drei Schritte vom kleinen zum großen Server: ein Prozess auf SQLite und dem Dateisystem, dann PostgreSQL und Objektspeicher hinter einem CDN, dann getrennte Web- und Worker-Prozesse mit einem Stream-Broker. Die Liste unten beschreibt jeden Schritt.

  1. Klein anfangen. Ein Prozess mit role = all, auf SQLite, mit Medien im Dateisystem und den Standardwerten für den Rest: Queue und Key-Value-Store in der Datenbank und der Echtzeit-Stream innerhalb des Prozesses. Die Docker-Compose-Dateien in deploy/docker starten dieses Setup auf einer Maschine (Bereitstellung mit Docker Compose). Es passt zu einem persönlichen oder kleinen Server. stream = hub erreicht nur den Prozess, in dem er läuft, daher bleibt dieses Setup bei einem Prozess.
  2. Die Daten auslagern. PostgreSQL für die Datenbank, ein S3-kompatibler Bucket oder Google Cloud Storage für die Medien und ein CDN vor den Medien. Der Server ist noch ein Prozess, hängt aber nicht mehr an einer Platte, und die Prozesse des nächsten Schritts können die Daten teilen. Entscheide das nach Möglichkeit vor dem ersten Start: Die Daten später von SQLite und dem Dateisystem umzuziehen, ist eine Aufgabe für sich (Was zu sichern ist listet auf, was umziehen muss).
  3. Skalieren. Führe Prozesse mit role = web für die Anfragen und role = worker für die Jobs aus, so viele, wie jede Art braucht, und teile die Worker nach Job-Typ auf (Worker aufteilen). Mit mehr als einem Prozess braucht der Echtzeit-Stream einen Broker, der jeden Prozess erreicht (postgres, valkey, sns oder pubsub), und der Key-Value-Store sollte geteilt werden (db oder valkey), da memory die Rate Limits und die Antworten auf erneut gesendete Schreibvorgänge jedes Prozesses getrennt hält. Die Job-Queue bleibt in PostgreSQL oder zieht zu Google Cloud Tasks um (Cloud Tasks).

Die Bereitstellung auf Cloud Run ist ein Beispiel für ein Setup zwischen dem zweiten und dem dritten Schritt: role = all auf Cloud Run, PostgreSQL auf Neon, Medien in Cloud Storage, Cloud Tasks für die Jobs und Pub/Sub für den Stream, ohne laufende Instanz, solange niemand den Server nutzt.

Lies die Betreiber-Leitfäden in dieser Reihenfolge:

  1. Loslegen: den Server betreiben oder auf Cloud Run deployen, dann die Checkliste für den Produktivbetrieb durchgehen, bevor du ihn für Nutzer öffnest.
  2. Den Server konfigurieren: ihre Einstellungen, die Registrierung, externe Login-Anbieter, E-Mail, CAPTCHA, das CDN, Linkvorschauen und Suchmaschinen und KI-Crawler.
  3. Funktionen einschalten: Moderation, Relays, Webhooks, Plugins und Entscheidungs-Hooks, Sprach-Chat, Volltextsuche, Unterstützer und ihre Zahlungen sowie Cloud-Kosten importieren.
  4. Im Alltag betreiben: Überwachung, Alarme, Fehlerberichte, Wartung, Backup, die Datenbank, den Key Encryption Key und Administratoren und Rollen.
  5. Rechtliches und Schließung: die Vorlagen für Datenschutzerklärung und Verarbeitungsverzeichnis sowie den Dienst schließen.

Die Konfigurationsreferenz listet jede Einstellung auf, und die Job-Referenz jeden Job, den die Worker ausführen.

Für LLMs und Coding-Agenten:llms.txt,llms-full.txt, llms-small.txt

Analyse auf dieser Website