Diese Seite ist eine maschinelle Übersetzung der englischen Seite, die maßgeblich ist. Englische Seite lesen
Produktions-Checkliste
Gehe diese Liste durch, bevor du den Server für Nutzer und für andere Server öffnest, und erneut nach einer Änderung an der Bereitstellung. Manche Einstellungen lassen sich nicht mehr ändern, sobald der Server föderiert hat, und manche Fehler, etwa der Verlust des Key-Encryption-Keys, lassen sich gar nicht rückgängig machen.
Jeder Punkt sagt, warum er wichtig ist, wie du ihn prüfst und wo die Details stehen. Beginne mit dem automatisierten Teil:
my config check # the configuration, and the settings that do not suit productionmy config check -instance # also the instance settings in the databaseWas my config check prüft
Abschnitt betitelt „Was my config check prüft“Im Profil production (der Standard von profile) validiert my config check
zuerst jede Einstellung und prüft dann, ob die gültigen Einstellungen zu einem Produktions-Server passen.
Die Probleme werden in zwei Gruppen aufgelistet, unter einer Zusammenfassung in der Sprache der Prozess-Locale, jeweils mit dem technischen
Detail auf Englisch:
- Fehler lassen
my config checkmit 1 enden. Es sind Einstellungen, die einen Produktions-Server kaputt machen oder seine Sicherheit schwächen:hostoderaccount_domain, die andere Server nicht erreichen können: mit einem Port,localhost, einem Namen ohne Punkt oder einem Namen unter einer Top-Level-Domain, die für lokale Nutzung oder Tests reserviert ist (.localhost,.local,.test,.example,.invalid,.internal,.home.arpa).web_originüberhttp.- Eine SQLite-
database_url, die die Datenbank im Arbeitsspeicher hält. - Ein
kek, der nicht zufällig ist, etwa lauter Nullen oder ein wiederholtes Byte. - Ein
captcha-Site-Key oder -Secret-Key, der einer der Testschlüssel ist, die die CAPTCHA-Dienste veröffentlichen. worker_job_types,worker_job_types_exceptoder eine Queue-Route, die keinen Job-Typ nennt (in jedem Profil;my job typeslistet sie auf).- Mit
-instanceeinworker_job_concurrency, das der Pool der Datenbank nicht bedienen kann.
- Warnungen lassen den Exit-Code bei 0. Es sind Einstellungen, die in der Entwicklung üblich sind und in der Produktion Absicht sein können:
mail = none.- Eine SQLite-Datenbank oder der
fs-Blob-Store in einem temporären Verzeichnis (/tmp,/var/tmp,/dev/shmoder$TMPDIR). queue = inline.- Kein
vapid_private_key. stream = huboderkv = memorymit einer anderenrolealsall: Sie funktionieren nur innerhalb eines Prozesses.- Voice-Einstellungen, die wahrscheinlich nicht gewollt waren, etwa
voice = p2pohne STUN oder TURN. - Ein Plugin unter einer
http://-Adresse oder unter einerhttps://-Adresse ohne Token und ohne Client-Zertifikat. - Ein Testmodus-Schlüssel des Zahlungsanbieters.
origin_secretgesetzt bei leeremtrusted_proxies, undorigin_secret_previous, das nach einer Rotation gesetzt blieb.- Mit
-instance: die Server-Textename,short_description,termsundprivacy_policy, die Server-Einstellungencontact_account,contact_emailundsecurity_contact, wenn sie nicht gesetzt sind, und ein Server ohne Regeln. Wenn die Datenbank nicht erreichbar ist, ist das eine weitere Warnung, und der Rest der Prüfung läuft trotzdem.
my serve protokolliert beim Start dieselben Befunde als Warnungen, startet aber trotzdem.
Das Profil development überspringt diese Prüfungen; verwende es für lokale Entwicklung und Tests, nie für einen Server, den andere nutzen.
Führe my config check in derselben Umgebung aus wie den Server (dieselben Umgebungsvariablen, Secret-Dateien und Konfigurationsdatei),
zum Beispiel als Schritt der Bereitstellung, bevor die neue Version Traffic annimmt.
Einstellungen, die sich später nicht mehr ändern lassen
Abschnitt betitelt „Einstellungen, die sich später nicht mehr ändern lassen“Die Domain des Servers und die Handle-Domain
Abschnitt betitelt „Die Domain des Servers und die Handle-Domain“- Warum:
hostist Teil jeder ActivityPub-ID des Servers, und andere Server speichern diese IDs.account_domainist die Domain der Handles (@alice@example.org). Das erstemy serveodermy-Kommando, das die Datenbank verwendet, trägt beide darin ein, und von da an weigern sichmy serveund diese Kommandos zu laufen, wenn die Konfiguration abweicht: Eine Änderung nach dem Föderieren zerstört jeden Follow und jeden Verweis auf die Beiträge und Konten des Servers. Setze beide vor dem ersten Start. Ein Fehler, der vor dem Föderieren auffällt, wird behoben, indem du die Datenbank neu anlegst, was jede Zeile löscht. - Entscheide: ob die Handles die Domain des Servers verwenden oder eine eigene (zum Beispiel Handles auf
example.orgund der Server aufsocial.example.org). Eine eigene Handle-Domain muss ihr WebFinger, host-meta und NodeInfo auf den Server weiterleiten. - Prüfe:
my config checkzeigthostundaccount_domainund meldet eine Domain, die andere Server nicht erreichen können.my config check -instancescheitert außerdem, wenn sie von den Werten in der Datenbank abweichen, und trägt nichts ein. Bei einer eigenen Handle-Domain antwortetcurl -sI "https://<account_domain>/.well-known/webfinger?resource=acct:<user>@<account_domain>"mit301aufhttps://<host>/.well-known/webfinger?.... - Details: den Server betreiben (die Föderations-Endpunkte und die Auslieferung der Handles von einer anderen Domain),
hostundaccount_domain.
Über https erreichbar
Abschnitt betitelt „Über https erreichbar“- Warum: Andere Server rufen die IDs unter
https://<host>/auf Port 443 ab, und Browser senden die Anmelde-Cookies nur überhttps. - Prüfen:
curl -sI https://<host>/health/liveantwortet von außerhalb deines Netzwerks mit200und einem Zertifikat, das fürhostgültig ist, undmy config checkmeldet keinen Fehler zuweb_origin,tls,tls_acme_agree_termsodertls_cert_file.curl -sI http://<host>/antwortet mit301aufhttps://<host>/. Entweder beendet der Reverse-Proxy, Load Balancer oder das CDN vor dem Server TLS und leitet um (bei Docker Compose ist die Schichtcompose.caddy.yamlein solcher Proxy), oder der Server übernimmt das selbst. Beitls = acmezeigtmy tls statusein Zertifikat fürhost(und für den Host vonweb_origin, wenn er sich unterscheidet), dessen Aussteller kein Staging-Aussteller ist:tls_acme_directoryist nicht gesetzt oder nennt ein Produktionsverzeichnis. Richte Alarme auf seinen Ablauf und auf fehlgeschlagene Bestellungen ein (Alarme). Beitls = fileswarntmy config check, wenn dem Zertifikat weniger als 14 Tage bleiben, und was auch immer es erneuert, musstls_cert_fileundtls_key_fileaktuell halten. - Details: den Server betreiben, HTTPS vom Server aus ausliefern,
web_origin,tls.
Nicht am CDN vorbei erreichbar
Abschnitt betitelt „Nicht am CDN vorbei erreichbar“- Warum: Mit einem CDN davor und der weiterhin öffentlichen eigenen Adresse des Servers (
*.run.appauf Cloud Run) kann jeder den Server an der WAF und am Cache vorbei aufrufen, und ein Aufrufer auf der eigenen Plattform des CDN kann die Client-IP wählen, die die Ratenlimits sehen. Nur in diesem Fall nötig: nicht, wenn eine Firewall oder die Plattform bereits einschränkt, wer sich verbinden kann, und ohne CDN gibt es nichts zu umgehen. - Prüfen:
origin_secretundorigin_secret_headersind gesetzt, und das CDN setzt den Header bei jedem Hostnamen.curl -s -o /dev/null -w '%{http_code}\n' https://<origin address>/antwortet403, sein/health/liveantwortet200, undhttps://<host>/antwortet200. - Details: Anfragen ablehnen, die nicht über das CDN kamen, einschließlich der Wiederherstellung, wenn es alle aussperrt.
Secrets
Abschnitt betitelt „Secrets“Der Key-Encryption-Key (KEK)
Abschnitt betitelt „Der Key-Encryption-Key (KEK)“- Warum: Der KEK verschlüsselt die privaten Schlüssel jedes Actors. Ohne ihn kann der Server nichts signieren, und die Schlüssel lassen sich nicht aus der Datenbank wiederherstellen: Jedes Konto müsste neu angelegt werden, und andere Server würden ihm nicht mehr vertrauen.
- Prüfe:
- Er wurde zufällig erzeugt (
openssl rand -base64 32);my config checkmeldet einen Schlüssel, der nicht zufällig ist. - Er ist an einem anderen Ort als die Datenbank und ihre Backups gespeichert, zum Beispiel in einem Passwortmanager oder dem Secret-Speicher der Cloud, und mindestens eine weitere Person, die den Server betreibt, kann ihn erreichen.
- Er erreicht den Server nur über
MY_KEKoderMY_KEK_FILE(die Konfigurationsdatei weist Secrets ab). Bei Docker Compose ist er die Dateisecrets/kekund steht nicht in.env(Docker-Compose-Dateien).
- Er wurde zufällig erzeugt (
- Details: Schlüsselverwaltung.
Der VAPID-Schlüssel für Web-Push
Abschnitt betitelt „Der VAPID-Schlüssel für Web-Push“- Warum: Ohne ihn sendet der Server keine Web-Push-Benachrichtigungen. Ihn später zu ändern beendet jedes Abo, also erzeuge ihn einmal und bewahre ihn wie den KEK auf.
- Prüfe:
my config checkwarnt, wennvapid_private_keynicht gesetzt ist. Erzeuge einen mitmy config vapid-key. - Details: Schlüsselverwaltung (der VAPID-Schlüssel für Web-Push).
Andere Secrets bleiben außerhalb des Repositorys und des Images
Abschnitt betitelt „Andere Secrets bleiben außerhalb des Repositorys und des Images“- Warum: Ein Secret in einem Repository, einem Container-Image oder einer Konfigurationsdatei wird an jeden Ort kopiert, an den diese gelangen.
- Prüfe:
database_url,mail_smtp_password,captcha_secret_key, die Schlüssel des Zahlungsanbieters,valkey_urlund jede andere in der Konfigurationsreferenz als Secret markierte Einstellung kommen aus Umgebungsvariablen oder<NAME>_FILE-Dateien, die der Secret-Speicher der Plattform befüllt (Docker- oder Kubernetes-Secrets, Secret Manager, Parameter Store). Die Konfigurationsdatei kann sie nicht enthalten:my config checkweist dort ein Secret ab. Bei Docker Compose kommen sie aus.env, die nur du lesen kannst (chmod 600). Durchsuche das Repository und das Image nach den Werten, um sicherzugehen, dass keine Kopie übrig ist.my config checkgibt für jedes gesetzte Secret(redacted)aus. - Details: Konfigurationsreferenz (die Spalte Secret), CAPTCHA, Stripe, PAY.JP.
Server-Einstellungen
Abschnitt betitelt „Server-Einstellungen“Die Server-Einstellungen liegen in der Datenbank und lassen sich ändern, während der Server läuft, in den Administrations-Screens des Servers
oder mit my instance set. my config check -instance warnt vor den Texten, Kontakten und Regeln, die nicht gesetzt sind.
- Name, Kurzbeschreibung und Beschreibung: werden auf der Startseite, der Informationsseite (
/about), in Link-Vorschauen und in NodeInfo gezeigt. Prüfe auf/about. - Kontakte:
contact_account(das Konto, an das sich Nutzer wegen des Servers wenden) undcontact_email(die Adresse, an die Nutzer und andere Server schreiben; E-Mails des Servers senden Antworten ebenfalls dorthin). Prüfe auf/about. - Kontakt für Sicherheitslücken:
security_contact, einehttps:- odermailto:-URI. Ist sie gesetzt, antwortet der Server auf/.well-known/security.txt. Prüfe mitcurl -s https://<host>/.well-known/security.txt. - Nutzungsbedingungen und Datenschutzerklärung:
termsundprivacy_policy. Die Datenschutzerklärung muss die Dienste nennen, die personenbezogene Daten erhalten, etwa den CAPTCHA-Dienst und den E-Mail-Anbieter. Prüfe die Links auf/aboutund auf dem Registrierungs-Screen. - Serverregeln: dem, was Nutzer bei der Registrierung zustimmen und was Moderatoren durchsetzen. Füge sie mit
my instance rule createoder in den Administrations-Screens hinzu und prüfe sie auf/about. - Registrierungsmodus:
registration_modeistapproval, bis du ihn änderst; wähleopen,approval,inviteoderclosed, je nachdem, wie Leute beitreten. Mitmail = nonewarten auchopen-Registrierungen auf die Freigabe eines Moderators. - Suchmaschinen und KI:
search_indexing,ai_usageundindexable_defaultverweigern beides, bis du es erlaubst. Prüfe/robots.txtund/.well-known/tdmrep.json. - Statusseite: Setze
status_page_url(eine Einstellung, keine Server-Einstellung, damit der Link während der Wartung angezeigt wird) auf eine Statusseite bei einem Dienst abseits des Servers.
Details: Server-Einstellungen, Registrierung, Suchmaschinen und KI-Crawler, CAPTCHA (was in die Datenschutzerklärung gehört), Vorlage der Datenschutzerklärung, Vorlage für das Verzeichnis von Verarbeitungstätigkeiten, Überwachung (die Statusseite).
- Warum: E-Mail bestätigt Adressen und sendet Passwort-Zurücksetzungen und Benachrichtigungen. Mit
mail = noneerreicht keine E-Mail die Nutzer. - Prüfe:
mailistsmtp,sesoderplugin, undmail_fromist eine Adresse auf einer Domain, die du kontrollierst;my config checkwarnt vormail = none.- Die Domain von
mail_fromhat SPF-, DKIM- und DMARC-Records, und der Anbieter signiert mit DKIM. Ohne sie landen E-Mails im Spam. - Registriere dich mit einem Testkonto und empfange die Bestätigungs-E-Mail; fordere ein Zurücksetzen des Passworts an und empfange auch das.
Prüfe die Header der empfangenen Nachricht auf
spf=pass,dkim=passunddmarc=pass. - Bei SES ist das Konto aus der Sandbox, und die Bounce- und Complaint-Benachrichtigungen erreichen den Server.
- Details: E-Mail, Registrierung (E-Mail-Bestätigung).
Administratoren
Abschnitt betitelt „Administratoren“- Warum: Das Konto eines Administrators kann jede Einstellung ändern, private Daten lesen und jeden sperren.
- Prüfe:
- Jeder Administrator hat die Zwei-Faktor-Authentifizierung eingeschaltet (Einstellungen, Zwei-Faktor-Authentifizierung im Web-Client) und bewahrt die Wiederherstellungscodes auf.
- Nur die Leute, die sie brauchen, haben die Rolle
admin; Moderatoren habenmoderatoroder eine Rolle mit nur den Berechtigungen, die sie verwenden. Liste sie mitmy admin roleauf und überprüfe sie in den Administrations-Screens.
- Details: Administratoren und Rollen, Moderation (Berechtigungen und Anmelde-Wiederherstellung).
Betrieb
Abschnitt betitelt „Betrieb“- Backups und Wiederherstellung: Die Datenbank, der Blob-Store (
blob_fs_diroder der Bucket) und der KEK werden nach einem Zeitplan gesichert, an einem Ort abseits des Servers, und eine Wiederherstellung auf einem frischen Server wurde geübt: Der wiederhergestellte Server startet, und die Konten können sich anmelden und posten. Von einem Backup, das nie wiederhergestellt wurde, weißt du nicht, ob es funktioniert. Die Datenbank und die Medien dürfen nicht in einem temporären Verzeichnis liegen;my config checkwarnt, wenn sie es tun. Siehe Schlüsselverwaltung (den KEK sichern) und Datenbank. - Monitoring und Alarme: Ein externer Monitor prüft
/health/liveund alarmiert jemanden, der handeln kann, und die toten Jobs der Job-Queue werden beobachtet. Siehe Monitoring und den Server betreiben (Health-Checks, Metriken und die Job-Queue). - Das Image: Die Instanz betreibt ein veröffentlichtes Image, das per Digest festgelegt ist (
ghcr.io/mycroblog/my:0.1.0@sha256:..., aus den Notizen des Releases), keines, das sich bei einem Neustart ändert, und seine Provenienz wurde geprüft. Es gibt kein Taglatest. Ein Upgrade ändert diese Version mit Absicht und folgt Upgrade, jeweils eine Minor-Version. - Quellcode (AGPL-3.0): Der Server muss seinen Quellcode allen anbieten, die ihn nutzen. Lass
source_urlbei einem unveränderten Release auf seinem Standard; richte sie auf deinen eigenen Quellcode, wenn du einen Fork oder eine veränderte Version betreibst. Prüfe den Link auf/about. Siehe den Server betreiben (den Quellcode veröffentlichen). - Wartung: Wisse, wie du den Server in den Wartungsmodus versetzt, bevor du es brauchst. Siehe Wartung.
Föderation
Abschnitt betitelt „Föderation“- Warum: Andere Server finden Konten über WebFinger und NodeInfo und rufen dann den Actor ab. Scheitert eines davon von außen, ist der Server für das Fediverse unsichtbar.
- Prüfe von einem Rechner außerhalb deines Netzwerks:
curl -s "https://<account_domain>/.well-known/webfinger?resource=acct:<user>@<account_domain>"liefert das Konto, wobei die Weiterleitung zuhostverfolgt wird, wenn die Domains abweichen (curl -L).curl -s https://<host>/.well-known/nodeinfoverlinkt/nodeinfo/2.1, das die Software und ihren Quellcode nennt.curl -s -H 'Accept: application/activity+json' https://<host>/@<user>leitet auf die ID des Actors um, und der Actor unter dieser ID ist JSON mit einempublicKey.- Suche von einem Konto auf Mastodon oder einem anderen Server nach
@<user>@<account_domain>, folge ihm und sieh einen neuen Beitrag eintreffen. - Ein CDN vor dem Server speichert
/ap/*und/@*nicht zwischen, es sei denn, es beachtetVary: Accept.
- Details: den Server betreiben (die Föderations-Endpunkte), CDN, Relays.
Für LLMs und Coding-Agenten:llms.txt,llms-full.txt, llms-small.txt