Wie man die Outline Knowledge Base & Wiki unter Ubuntu 2024 installiert (Der einfache Weg)

Outline ist eine schöne, schnelle und flexible Team-Wissensdatenbank und Wiki-Software, mit der Sie Ihre interne Dokumentation, Betriebshandbücher, Handbücher und mehr organisieren können.

**Aktualisierung:** Dieses Tutorial wurde für 2024 mit Unterstützung für lokale Dateispeicherung aktualisiert. Schauen Sie sich auch die Kommentare an, da sie einige großartige Lösungen für häufige Probleme enthalten!

Obwohl Outline eine gehostete Lösung ist, handelt es sich um eine Open-Source-Software. Das heißt, Sie können es auf Ihrem eigenen Server installieren und verwalten. Das Outline-Team hat eine Dokumentation für die eigene Installation bereitgestellt, die jedoch etwas kompliziert ist (selbst für einen erfahrenen Entwickler wie mich).

Nach vielen Versuchen und Fehlschlägen habe ich beschlossen, Ihnen zu helfen, den Ärger zu vermeiden, indem ich eine einfache, schrittweise Anleitung schreibe, um die Outline-Team-Wissensdatenbank und das Wiki auf Ihrem eigenen Server zum Laufen zu bringen. Und das mit Erfolg - gleich beim ersten Mal!

Wichtigste Erkenntnisse

• Outline ist eine außergewöhnliche Wissensdatenbank und Wiki-Software, die für Einzelpersonen, Unternehmen und Teams geeignet ist.
• Es ist einfach, Outline selbst zu hosten, wenn Sie die richtige Anleitung haben, und diese detaillierte Anleitung wird Ihnen Schritt für Schritt zeigen, wie.
• Sobald Sie fertig sind, können Sie Outline auf Ihrem eigenen Server nutzen - und das ohne großen Aufwand!

Vision der Ergebnisse

Wenn Sie die einzelnen Schritte dieser Anleitung zur Installation der Outline-Team-Wissensdatenbank und des Wikis unter Ubuntu sorgfältig befolgen, werden Sie die folgenden Ergebnisse erzielen:

• Eine öffentlich zugängliche, SSL-gesicherte URL, unter der Sie auf Ihre neue, selbst gehostete Outline-Installation zugreifen können. Sie können sich die Beispielinstallation ansehen, die ich nach genau dem gleichen Verfahren wie in diesem Tutorial erstellt habe: https://outline.thomasgriffin.com
• Ein täglicher Cron, der Ihr SSL-Zertifikat überprüft und automatisch erneuert
• Ein monatlicher Cron, der automatisch nach neuen offiziellen Outline-Versionen sucht und diese anwendet.
• Sie haben die Gewissheit, dass Sie sich die Kopfschmerzen erspart haben, die Sie sich selbst machen mussten. 💯

Voraussetzungen

Sie benötigen die folgenden Dinge, um dieses Tutorial erfolgreich abzuschließen:

1. Ein Digital Ocean-Konto. Es gibt zwar auch andere Hosting-Plattformen, die Sie verwenden können, aber ich habe mich für Digital Ocean entschieden, weil es so einfach ist, das für die Unterstützung von Outline erforderliche Servergerüst einzurichten. Ich kann nicht garantieren, dass dieses Tutorial auf einer anderen Serverplattform funktioniert, da ich es dort nicht ausprobiert habe.
2. Die Möglichkeit, DNS-Einträge zu ändern, um eine Subdomain für den öffentlichen Zugang zu Ihrer Outline-Instanz hinzuzufügen. Ich empfehle Cloudflare, da ich es in diesem Tutorium zur Demonstration verwenden werde.
3. Ein Google Workspace-Konto. Outline bietet viele verschiedene Arten der Authentifizierung an (z. B. Slack oder Microsoft), aber ich habe mich für Google entschieden, weil ich ein Google Workspace-Konto habe, das ich für Tests verwenden kann.
4. OPTIONAL: ein Amazon Web Services (AWS)-Konto. Wenn Sie Ihre Assets nicht lokal speichern möchten, benötigen Sie dieses, um sowohl IAM als auch S3 einzurichten und zu konfigurieren, um alle Ihre Outline-Assets zu hosten. Beide Optionen werden in diesem Lernprogramm vorgestellt.

Ausgehend von meiner eigenen Erfahrung, die ich gemacht habe, als ich dieses Tutorial mehrmals durchlief, um die Ergebnisse zu überprüfen, werden Sie etwa 45-60 Minuten für die Bearbeitung benötigen. Wenn Sie sich für einen der oben genannten Dienste registrieren müssen, kann es etwas länger dauern.

Außerdem kostet diese Einrichtung in der Regel ~$6/Monat (ohne Gebühren für Google Workspace oder andere Authentifizierungsanbieter), aber wenn Sie sich über meinen Link bei Digital Ocean anmelden, erhalten Sie die ersten 2 Monate kostenlos. Ich halte das für angemessen angesichts des Wertes, den Outline Ihrem Team und seiner Produktivität bieten kann.

Inhaltsübersicht

Da diese Anleitung sehr umfangreich und technisch ist, habe ich ein hilfreiches Inhaltsverzeichnis erstellt, damit Sie bei Bedarf nachschlagen können.

• Einrichten des Servers auf Digital Ocean
  • Bereitstellen eines Nicht-Root-Benutzers
• Installieren und Konfigurieren des Servers Voraussetzungen
  • Installation der Hauptkomponenten
  • Installation von Docker
  • Installation von Docker Compose
  • Absicherung von Docker
• Konfigurieren von Subdomain-DNS-Einträgen, Nginx und Let's Encrypt
  • DNS-Einträge
  • Nginx
  • Let's Encrypt
• Einrichten von AWS IAM und S3
  • Erstellen des S3 Buckets
  • Erstellen des IAM-Benutzers und der Richtlinie
• Erstellen einer Google Workspace Oauth-App
  • Erstellen des Cloud-Projekts
  • Hinzufügen von Authentifizierungs-APIs
  • Konfigurieren des Oauth-Zustimmungsflusses
  • Erzeugen von Oauth-Zugangsdaten
• Erstellen und Ausführen des Outline-Docker-Images
• Konfigurieren des Nginx-Server-Blocks
• Anzeigen und Authentifizieren in Ihrer Gliederung Selbst gehostete Installation
• SMTP konfigurieren
• Konfigurieren von automatischen Updates für Ihre selbst gehostete Outline-Installation
  • Täglich geplante Aufträge
  • Monatliche Updates
• Hilfreiche Befehle, Tipps und Tricks
  • Alte Datenbank-Volumes entfernen
  • Vollständiges Löschen von Docker
• Einpacken

Beginnen wir mit der Installation der Wissensdatenbank und des Wikis des Outline-Teams unter Ubuntu!

Einrichten des Servers auf Digital Ocean

Outline erfordert ein Unix-basiertes Betriebssystem, und da Ubuntu sehr beliebt ist, werde ich es als Betriebssystem verwenden.

Gehen Sie zu Ihrem Digital Ocean-Konto und erstellen Sie ein neues Droplet. Wählen Sie das Rechenzentrum Ihrer Wahl, dann wählen Sie Ubuntu 22.04 LTS x64 als Ihr Image, und wählen Sie dann die Option, die Sie am meisten für Ihren Server bevorzugen. Ich mag die $8/Monat 1GB Intel SSD-Option, da die Ausführung von SSH-Befehlen damit deutlich schneller ist als mit der Basisoption für $6/Monat.

Als Nächstes wählen Sie die gewünschte Authentifizierungsmethode aus (SSH-Schlüssel sind die bevorzugte Option, aber wenn das für Sie nicht funktioniert, werden auch root-Passwörter unterstützt).

Wählen Sie die restlichen Konfigurationsoptionen (ich empfehle, Backups zu aktivieren), passen Sie den Hostnamen Ihres Droplets an, fügen Sie beliebige Tags hinzu und erstellen Sie dann Ihr neues Droplet.

Sobald Ihr Droplet bereitgestellt wurde, verbinden Sie sich per SSH mit dem Server, indem Sie Ihren bevorzugten Terminal-Client verwenden (anstelle von yourip mit der IP, die Sie von Digital Ocean erhalten haben):

ssh -A root@Ihrip

Sobald Sie eingeloggt sind, können Sie alles auf dem Droplet aktualisieren. Wählen Sie "J" oder klicken Sie auf "Zurück", um alles zu aktualisieren/aktualisieren, was während des Prozesses empfohlen wird.

sudo apt update && sudo apt upgrade

Da für das Upgrade wahrscheinlich einige Dienste neu gestartet werden müssen, starten Sie den Server jetzt neu.

sudo Neustart

Durch den Neustart werden Sie von Ihrer Terminalsitzung abgemeldet. Warten Sie ein paar Minuten und melden Sie sich dann wieder an (ersetzen Sie yourip mit der IP, die Sie von Digital Ocean erhalten haben):

ssh -A root@Ihrip

Führen Sie abschließend diesen Befehl erneut aus, um alle Pakete zu aktualisieren und zu aktualisieren, die zuvor einen Neustart erforderten.

sudo apt update && sudo apt upgrade

Bereitstellen eines Nicht-Root-Benutzers

Als Nächstes müssen Sie die Anleitung zur Ersteinrichtung des Servers mit Ubuntu 22.04 auf Digital Ocean befolgen. In dieser Anleitung werden Sie eine sicherere Umgebung für Ihren Server einrichten, einschließlich der Erstellung eines Nicht-Root-Benutzers und der Einrichtung einiger hilfreicher Firewalls, um den Zugriff auf Ihren Server zu sperren.

Bitte befolgen Sie alle in diesem Artikel aufgeführten Schritte! Der Rest des Tutorials setzt voraus, dass Sie über.

Sobald Sie die Schritte dort ausgeführt haben, müssen Sie sich mit dem neuen Benutzer, den Sie gerade erstellt haben, per SSH wieder in Ihren Server einloggen.

Sie können nun mit der Installation der Servervoraussetzungen für Outline fortfahren.

Installieren und Konfigurieren des Servers Voraussetzungen

Installation der Hauptkomponenten

Lassen Sie uns einige allgemeine Dienstprogramme installieren, die Ihr Server benötigt, um Outline erfolgreich in Betrieb zu nehmen.

Vergewissern Sie sich zunächst, dass Sie als Nicht-Root-Benutzer angemeldet sind, den Sie gerade erstellt haben.

Führen Sie dann den folgenden Befehl in Ihrem Terminal aus:

sudo apt update && sudo apt install apt-transport-https ca-certificates curl software-properties-common nano curl wget zip unzip gnupg

Geben Sie "Y" ein und drücken Sie die Eingabetaste, um alle Aufforderungen während der Installation zu akzeptieren.

Installation von Docker

Outline wird in einem Docker-Container ausgeführt. Daher müssen Sie Docker auf Ihrem neuen Server installieren und konfigurieren, um Outline zum Laufen zu bringen. Sie fügen eine neue Quelle für Docker hinzu, um die neueste stabile Version zu beziehen und deren Installation auf Ihrem Server zu überprüfen.

Führen Sie die folgenden Befehle nacheinander aus:

sudo apt update

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg

echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

sudo apt update && apt-cache policy docker-ce && sudo apt install docker-ce

Geben Sie "Y" ein und drücken Sie die Eingabetaste, um alle Aufforderungen während der Installation zu akzeptieren. Zu diesem Zeitpunkt sollte Docker erfolgreich auf Ihrem Server installiert sein. Um dies zu überprüfen, führen Sie diesen Befehl aus:

sudo systemctl status docker

Sie sollten eine Ausgabe wie diese sehen:

Wenn Sie den obigen Befehl eingegeben haben, geben Sie :q ein, um das Docker-Menü zu verlassen.

Erinnern Sie sich an den Nicht-Root-Benutzer, den Sie zuvor angelegt haben? Wenn nicht, folgen Sie bitte der Anleitung für die Ersteinrichtung eines Servers mit Ubuntu 22.04 auf Digital Ocean.

Fügen Sie diesen Benutzer der Gruppe docker Gruppe, so dass Sie den Docker-Befehlen nicht das Präfix sudo jedes Mal. Führen Sie den folgenden Befehl aus und ersetzen Sie dabei ${USER} mit dem Benutzernamen, den Sie zuvor gewählt haben.

sudo usermod -aG docker ${USER} && su - ${USER}

Wenn Sie nun die groups sollten Sie nun sehen, dass Ihr Benutzer zu der docker Gruppe.

Installation von Docker Compose

Um das Docker-Image zu erstellen, das für den Betrieb der Open-Source-Wissensdatenbank Outline und des Team-Wikis auf Ihrem Server erforderlich ist, müssen Sie Docker Compose installieren und konfigurieren.

Führen Sie den folgenden Befehl aus:

sudo apt update && sudo apt install docker-ce-cli containerd.io docker-compose-plugin docker-compose

Geben Sie "Y" ein und drücken Sie die Eingabetaste, um alle Aufforderungen während der Installation zu akzeptieren.

Sie sollten in der Lage sein, den folgenden Befehl auszuführen und die unten stehende Versionsausgabe zu sehen:

docker compose version

Ausgezeichnet! Docker ist bereit, mit Docker Compose verwendet zu werden, und Sie haben nun die erforderlichen Tools installiert, um Ihre benutzerdefinierte Gliederung zu erstellen und bereitzustellen docker-compose.yml Datei.

Absicherung von Docker

Docker und UFW vertragen sich nicht gut miteinander. Docker überschreibt einen Großteil der iptables Funktionalität, die von UFW verwendet wird. Das bedeutet, dass Docker standardmäßig alle Ihre Server-Ports für die Welt offenlegt. Igitt!

Das ist nicht gut, also müssen Sie Docker absichern und die Portfreigabe auf Ihrem Rechner begrenzen. Es gibt ein ausgezeichnetes Github-Repository, das dies im Detail erklärt, wenn Sie mehr erfahren möchten.

Um Docker zu sichern und UFW wie erwartet arbeiten zu lassen, führen Sie den folgenden Befehl aus:

sudo nano /etc/ufw/after.rules

Wenn Sie dazu aufgefordert werden, fügen Sie den folgenden Code ganz am Ende der Datei ein (nach dem letzten COMMIT Text):

# UFW UND DOCKER BEGINNEN
*Filter
:ufw-user-forward - [0:0]
:ufw-docker-logging-deny - [0:0]
:DOCKER-USER - [0:0]
-A DOCKER-USER -j ufw-user-forward

-A DOCKER-BENUTZER -j RETURN -s 10.0.0.0/8
-A DOCKER-USER -j RETURN -s 172.16.0.0/12
-A DOCKER-USER -j RETURN -s 192.168.0.0/16

-A DOCKER-USER -p udp -m udp --sport 53 --dport 1024:65535 -j RETURN

-A DOCKER-USER -j ufw-docker-logging-deny -p tcp -m tcp --tcp-flags FIN,SYN,RST,ACK SYN -d 192.168.0.0/16
-A DOCKER-USER -j ufw-docker-logging-deny -p tcp -m tcp --tcp-flags FIN,SYN,RST,ACK SYN -d 10.0.0.0/8
-A DOCKER-USER -j ufw-docker-logging-deny -p tcp -m tcp --tcp-flags FIN,SYN,RST,ACK SYN -d 172.16.0.0/12
-A DOCKER-USER -j ufw-docker-logging-deny -p udp -m udp --dport 0:32767 -d 192.168.0.0/16
-A DOCKER-USER -j ufw-docker-logging-deny -p udp -m udp --dport 0:32767 -d 10.0.0.0/8
-A DOCKER-USER -j ufw-docker-logging-deny -p udp -m udp --dport 0:32767 -d 172.16.0.0/12

-A DOCKER-USER -j RETURN

-A ufw-docker-logging-deny -m limit --limit 3/min --limit-burst 10 -j LOG --log-prefix "[UFW DOCKER BLOCK] "
-A ufw-docker-logging-deny -j DROP

COMMIT
# UFW UND DOCKER BEENDEN

Drücken Sie Crtl + X, Y und Return, um die Datei zu speichern. Laden Sie anschließend die UFW-Anwendung neu, indem Sie diesen Befehl ausführen (möglicherweise müssen Sie ihn zweimal ausführen):

sudo systemctl restart ufw

Abschließend müssen Sie Ihren Computer neu starten, damit alle Upgrades und Änderungen vollständig wirksam werden. Führen Sie den folgenden Befehl aus, um Ihren Rechner neu zu starten:

sudo Neustart

An diesem Punkt wird die SSH-Verbindung zu Ihrem Rechner geschlossen. Warten Sie etwa 60 Sekunden und melden Sie sich dann wieder an, indem Sie die ${USER} mit dem Nicht-Root-Benutzer, den Sie zuvor erstellt haben, und der IP-Adresse für Ihren Server:

ssh -A ${BENUTZER}@ihrip

Bevor Sie mit Docker fortfahren, müssen Sie zunächst einige andere Dienste und Systeme konfigurieren. Das tun Sie jetzt und kehren später im Lehrgang zu Docker zurück.

Konfigurieren von Subdomain-DNS-Einträgen, Nginx und Let's Encrypt

DNS-Einträge

Wie ich bereits erwähnt habe, verwalte ich meine DNS-Einträge mit Cloudflare. Sie müssen die IP-Adresse Ihres neuen Digital Ocean-Droplets übernehmen und einen neuen A-Eintrag erstellen, der auf eine Subdomain Ihrer Wahl verweist.

Fügen Sie Ihren neuen A-Eintrag hinzu und aktualisieren Sie Ihre DNS-Einträge. Ich habe meine Subdomain wie folgt gewählt outlineSie können also meine selbst gehostete Outline-Installation sehen unter https://outline.thomasgriffin.com. Wenn Sie Cloudflare verwenden, schalten Sie die Proxy-Einstellung vorerst aus. Sie können sie wieder einschalten, sobald Sie das Tutorial beendet haben.

Nachdem Sie den Zugriff auf die Subdomain konfiguriert haben, müssen Sie einen Webserver und ein SSL-Zertifikat hinzufügen, um öffentliche Anfragen zu bearbeiten.

In diesem Tutorial verwenden Sie Nginx als Reverse-Proxy, um in Ihrem Docker-Container auf Outline zuzugreifen, und Sie verwenden Let's Encrypt, um die Erstellung und Verwaltung von SSL-Zertifikaten zu verwalten.

Nginx

Ubuntu wird standardmäßig mit einer älteren Version von Nginx ausgeliefert, so dass Sie die neueste Version verwenden sollten.

Führen Sie die folgenden Befehle nacheinander in Ihrem Terminal aus:

curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor \
	| sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null

Wenn es so aussieht, als ob der Prozess an diesem Schritt hängen bleibt, müssen Sie wahrscheinlich Ihre sudo Benutzerkennwort, um fortzufahren.

echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg arch=amd64] \
http://nginx.org/packages/ubuntu `lsb_release -cs` nginx" \
    | sudo tee /etc/apt/sources.list.d/nginx.list

sudo apt update && sudo apt install nginx

Nginx ist nun auf Ihrem Server installiert. Lassen wir nun den Webverkehr auf dem Server zu. Führen Sie den folgenden Befehl in Ihrem Terminal aus:

sudo ufw allow 80 && sudo ufw allow 443

Das ist alles, was Sie im Moment tun müssen. Sie werden zu Nginx zurückkehren, um eingehenden Datenverkehr zu empfangen und ordnungsgemäß zu verarbeiten, später im Tutorial.

Let's Encrypt

Let's Encrypt ist ein Server-Dienstprogramm zur Verwaltung von SSL-Zertifikaten. Sie verwenden es, um das SSL-Zertifikat für Ihre Outline-Installation zu erstellen und zu verwalten.

Führen Sie die folgenden Befehle aus, um Let's Encrypt auf Ihrem Server zu installieren:

sudo apt install snapd && sudo snap install core && sudo snap refresh core

sudo snap install --classic certbot

Verknüpfen wir die certbot Befehl an die /usr/bin Verzeichnis, damit Sie die certbot Befehl ohne das Präfix snap:

sudo ln -s /snap/bin/certbot /usr/bin/certbot

Jetzt können Sie Ihr SSL-Zertifikat für die gewählte Subdomain erstellen. Meine Subdomain ist outlinez.B. outline.thomasgriffin.com. Führen Sie den folgenden Befehl aus und ersetzen Sie dabei ${DOMAIN} mit der Subdomain/Domain-Kombination, die Sie für Ihre selbst gehostete Outline-Installation gewählt haben.

sudo certbot certonly --standalone --agree-tos --no-eff-email --staple-ocsp --preferred-challenges http -m noreply@${DOMAIN} -d ${DOMAIN} --pre-hook="systemctl stop nginx" --post-hook="systemctl start nginx"

Ihr neues SSL-Zertifikat sollte nun unter folgender Adresse gespeichert sein /etc/letsencrypt/live.

Da Sie das SSL-Zertifikat mit dem Certbot Snap-Tool erstellt haben, erstellt Certbot automatisch einen Timer, um das Zertifikat für Sie zu erneuern. Schön!

Einrichten von AWS IAM und S3

Dieser Abschnitt ist optional. Seit Outline v0.72.0 unterstützt Outline die lokale Speicherung von Assets auf dem Server. Wenn Sie nur lokal speichern möchten, können Sie diesen gesamten Abschnitt überspringen.

Outline kann verschiedene Arten von Dateianhängen für seine Dokumente akzeptieren. Aus diesem Grund benötigen Sie eine Dateispeicherlösung, um diese Anhänge zu hosten und bereitzustellen.

Richten wir einen speziellen IAM-Benutzer und ein S3-Bucket für Ihre Outline-Installation ein. Notieren Sie sich beim Erstellen dieser Elemente die zugehörigen Zonen, Schlüssel, Geheimnisse und Namen. Sie werden sie später bei der Konfiguration Ihrer docker-compose.yml Datei.

Wenn Sie noch kein AWS-Konto haben, sollten Sie jetzt eines erstellen.

In diesem Tutorial verwende ich die folgenden Namen für den Benutzernamen und den Bucket-Namen:

• Benutzername: Outline
• Name des Eimers: tg-outline-assets

Da S3 Bucket-Namen eindeutig sind, müssen Sie einen eigenen Bucket-Namen erstellen. Die Bereiche, in denen Sie dies tun müssen, werden in den folgenden Schritten erwähnt.

Erstellen des S3 Buckets

Erstellen Sie Ihren S3-Bucket, um Gliederungsanhänge und Assets zu speichern.

Wie ich bereits erwähnt habe, werde ich den Eimernamen tg-outline-assets. Sie müssen diesen Namen in Ihren eigenen eindeutigen Bucket-Namen ändern.

Navigieren Sie in der AWS-Konsole zu S3 und klicken Sie auf "Bucket erstellen", um zu beginnen.

Geben Sie den Namen des Eimers ein (in diesem Tutorial lautet er tg-outline-assets) und wählen Sie die gewünschte Region aus. Sie müssen sich die Region Ihres Eimers notieren, da Sie diese später beim Einrichten Ihrer docker-compose.yml Datei.

Wählen Sie im Abschnitt Objektbesitz die Option ACLs aktiviert und lassen Sie die Option Bucketbesitzer bevorzugt aktiviert.

Deaktivieren Sie im Abschnitt Block Public Access die Einstellung Block all public access und aktivieren Sie das Kontrollkästchen, um die Warnungen zu bestätigen. Dies ist erforderlich, damit bestimmte Bilder hochgeladen und in Ihrer Outline-Installation angezeigt werden können.

Die übrigen Bucket-Einstellungen lassen Sie so, wie sie voreingestellt sind. Scrollen Sie nach unten und klicken Sie auf "Bucket erstellen", um Ihren neuen S3-Bucket zu erstellen.

Suchen Sie auf dem Hauptbildschirm für den S3-Bucket Ihren neuen Bucket und klicken Sie ihn an. Klicken Sie dann auf die Registerkarte "Berechtigungen".

Scrollen Sie zum Ende der Registerkarte Berechtigungen und klicken Sie auf die Schaltfläche CORS (Cross-origin resource sharing), um diese zu bearbeiten.

Fügen Sie die folgende Richtlinienkonfiguration in den Editor ein und speichern Sie sie, wobei Sie Folgendes ersetzen ${DOMAIN} mit der Domäne, die Sie für Ihre Outline-Installation gewählt haben. In diesem Beispiel verwende ich https://outline.thomasgriffin.com (einschließlich der https:// Protokoll).

[
    {
        "AllowedHeaders": [
            "*"
        ],
        "AllowedMethods": [
            "PUT",
            "POST",
            "DELETE"
        ],
        "AllowedOrigins": [
            "${DOMAIN}"
        ],
        "ExposeHeaders": []
    },
    {
        "AllowedHeaders": [],
        "AllowedMethods": [
            "GET"
        ],
        "AllowedOrigins": [
            "*"
        ],
        "ExposeHeaders": []
    }
]

Erstellen des IAM-Benutzers und der Richtlinie

Suchen Sie nach "IAM" und beginnen Sie, indem Sie auf "Benutzer hinzufügen" klicken.

Legen Sie den Benutzernamen als Outline und wählen Sie als Berechtigungstyp "Zugangsschlüssel - Programmatischer Zugang". Wenn es keine Option zur Auswahl des programmatischen Zugriffs gibt, ist dieser standardmäßig aktiviert.

Wählen Sie auf dem nächsten Bildschirm "Vorhandene Richtlinien direkt anhängen" und klicken Sie dann auf die Schaltfläche "Richtlinie erstellen", um eine benutzerdefinierte Zugangsrichtlinie für diesen Benutzer zu erstellen.

Wählen Sie auf dem nächsten Bildschirm die Registerkarte "JSON" und fügen Sie den folgenden Richtliniencode in den Editor ein, wobei Sie Folgendes ersetzen ${BUCKET} mit dem Namen des gerade erstellten S3-Buckets:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor",
            "Effect": "Allow",
            "Action": [
                "s3:GetObjectAcl",
                "s3:DeleteObject",
                "s3:PutObject",
                "s3:GetObject",
                "s3:PutObjectAcl"
            ],
            "Resource": "arn:aws:s3:::${BUCKET}/*"
        }
    ]
}

Fahren Sie mit dem Hinzufügen der gewünschten Tags fort und fahren Sie dann mit dem nächsten Bildschirm fort, um der Richtlinie einen Namen und eine optionale Beschreibung zu geben. Ich habe mich für den Namen der Richtlinie entschieden OutlineS3. Klicken Sie nach der Überprüfung auf "Richtlinie erstellen", um die neue Zugangsrichtlinie zu erstellen.

Nachdem Sie nun die neue benutzerdefinierte Richtlinie erstellt haben, müssen Sie sie Ihrem neuen IAM-Benutzer zuordnen. Klicken Sie wieder auf die andere IAM-Registerkarte und klicken Sie auf das Symbol Aktualisieren direkt über der Tabelle mit den Richtlinienergebnissen. Geben Sie "Gliederung" in die Suchleiste ein und wählen Sie dann Ihre neue benutzerdefinierte Richtlinie aus.

Fahren Sie mit dem nächsten Bildschirm fort und fügen Sie alle gewünschten Tags hinzu. Überprüfen Sie dann die Änderungen und klicken Sie auf "Benutzer erstellen", um den neuen Outline IAM-Benutzer zu erstellen.

Nachdem Sie den neuen Benutzer angelegt haben, Ich schlage vor, dass Sie die Zugangsdaten zur sicheren Aufbewahrung herunterladen oder irgendwo notierenda Sie sie bei der Konfiguration Ihres Systems verwenden werden. docker-compose.yml Datei im weiteren Verlauf des Tutorials. Sie können sie finden, indem Sie zu IAM zurückkehren, auf den neu erstellten Benutzer klicken, dann zur Registerkarte "Sicherheitsberechtigungen" gehen und entweder neue Zugangsschlüssel herunterladen oder erstellen.

(Wenn AWS eine andere Methode empfiehlt, ignorieren Sie diese, wählen Sie eine Option wie z. B. Verwendung für CLI und erstellen Sie dann die Zugangsschlüssel).

Erstellen einer Google Workspace Oauth-App

Als nächstes müssen Sie die Authentifizierung in Outline aktivieren. Es gibt zwar viele Authentifizierungsmethoden, aber ich habe mich für Google entschieden, weil ich über ein Google Workspace-Konto verfüge, das über meine Domain verfügbar ist.

Wenn die Verwendung von Google bei Ihnen nicht funktioniert, können Sie auch andere Authentifizierungsmethoden ausprobieren, die in der Dokumentation aufgeführt sind. Ich kann nicht garantieren, dass sie funktionieren, da ich den Prozess nur mit Google getestet und überprüft habe.

Erstellen des Cloud-Projekts

Gehen Sie zur Google Developers Console und wechseln Sie ggf. zum entsprechenden Google Workspace-Nutzerkonto.

Wählen Sie das Dropdown-Menü "Projekt" in der Kopfzeile und klicken Sie auf "Neues Projekt", um zu beginnen.

Geben Sie dem Projekt einen Namen (ich habe es Outline Auth genannt), wählen Sie die Standorte aus und klicken Sie auf "Erstellen", um das neue Projekt zu erstellen.

Hinzufügen von Authentifizierungs-APIs

Vergewissern Sie sich, dass Ihr neues Projekt im Kopfmenü ausgewählt ist (an der gleichen Stelle, an der Sie zum Start auf das Dropdown-Symbol geklickt haben), und klicken Sie dann auf die Schaltfläche "APIs und Dienste aktivieren", um die erforderlichen Authentifizierungs-APIs zu Ihrem Projekt hinzuzufügen.

Geben Sie in der Suchleiste "google+" ein und wählen Sie dann die Option Google+ API. Klicken Sie nach der Auswahl auf "Aktivieren", um die API für Ihr Projekt zu aktivieren.

Konfigurieren des Oauth-Zustimmungsflusses

Als nächstes müssen Sie den Oauth-Zustimmungsfluss für Authentifizierungsanfragen konfigurieren.

Klicken Sie auf den Link "Oauth-Zustimmungsbildschirm" in der linken Seitenleiste. Wählen Sie die Option "Intern" und klicken Sie dann auf "Erstellen".

Geben Sie der App einen Namen (ich habe meine Outline Auth genannt) und füllen Sie die Benutzer-Support-E-Mail aus. Fügen Sie unter Autorisierte Domains Ihre Top-Level-Domain hinzu.

Da sich meine Gliederungsinstanz für dieses Tutorial unter https://outline.thomasgriffin.comfüge ich hinzu thomasgriffin.com als eine autorisierte Domäne.

Geben Sie abschließend die E-Mail-Adresse eines Entwicklers ein und klicken Sie auf "Speichern und weiter".

Klicken Sie auf dem Bildschirm "Bereiche" auf "Bereiche hinzufügen oder entfernen" und wählen Sie die erste, zweite und dritte Option in der Liste. Scrollen Sie dann zum unteren Ende des Flyout-Fensters und klicken Sie auf "Aktualisieren".

Blättern Sie bis zum Ende des Bildschirms und klicken Sie auf "Speichern und weiter".

Erzeugen von Oauth-Zugangsdaten

Schließlich müssen Sie Oauth-Anmeldeinformationen für das von Ihnen erstellte Google Cloud-Projekt generieren.

Klicken Sie auf den Link "Berechtigungsnachweise" in der linken Seitenleiste. Klicken Sie auf die Schaltfläche "Berechtigungsnachweise erstellen" und wählen Sie dann "Oauth-Client-ID" als Berechtigungstyp.

Wählen Sie auf dem nächsten Bildschirm "Webanwendung" als Anwendungstyp aus und geben Sie ihr einen Namen. Für dieses Lernprogramm habe ich meiner Anwendung den Namen Outline Oauth Client.

Geben Sie unter "Autorisierte JavaScript-Ursprünge" die URL Ihrer Subdomain ein. Für dieses Lernprogramm lautet meine https://outline.thomasgriffin.com.

Geben Sie unter Authorized redirect URIs die folgende URL ein und ersetzen Sie ${DOMAIN} mit Ihrem Subdomain-/Domainnamen:

https://${DOMAIN}/auth/google.callback

Klicken Sie auf "Erstellen", um Ihre neuen Projektanmeldedaten zu erstellen. Kopieren Sie die Client-ID und das Geheimnis und notieren Sie sie an einem sicheren Ort, da Sie sie bei der Konfiguration Ihres Projekts verwenden werden. docker-compose.yml Datei im nächsten Schritt.

Erstellen und Ausführen des Outline-Docker-Images

Jetzt können Sie Ihre benutzerdefinierte docker-compose.yml Datei, die die Dienste definiert, die für den Betrieb von Outline auf Ihrem Droplet erforderlich sind.

Als Erstes müssen Sie auf dem Server ein neues Verzeichnis als "Home" für Ihr Outline-Projekt erstellen. Erinnern Sie sich an den Nicht-Root-Benutzer, den Sie im Digital Ocean-Tutorial am Anfang dieses Artikels erstellt haben? Sie werden das Home-Verzeichnis dieses Benutzers verwenden, um Ihre Dateien zu speichern. Führen Sie den folgenden Befehl aus und ersetzen Sie dabei ${USER} mit dem Namen des Benutzers, den Sie zuvor erstellt haben.

mkdir -p /home/${USER}/docker && mkdir -p /home/${USER}/docker/logs && cd /home/${USER}/docker && touch docker.env && touch docker-compose.yml

Bevor Sie Docker booten, müssen Sie einige notwendige Umgebungsvariablen zu Ihrem neuen docker.env Datei. Ich verwende nicht alle verfügbaren Variablen für dieses Tutorial. Wenn Sie also mehr wissen wollen, klicken Sie hier, um alle verfügbaren Umgebungsvariablen zu sehen.

Hier sind die Variablen, die Sie in Ihrem docker.env Datei:

## Erforderliche Variablen
SECRET_KEY=
UTILS_SECRET=
FORCE_HTTPS=
ENABLE_UPDATES=
WEB_CONCURRENCY=

## Postgres-Variablen
POSTGRES_USER=
POSTGRES_PASSWORT=
POSTGRES_DB=
DATABASE_URL=
PGSSLMODE=

## Redis-Variablen
REDIS_URL=

## Domain-Variablen
URL=
PORT=

## Ratenbegrenzungsvariablen
RATE_LIMITER_ENABLED=
RATE_LIMITER_DURATION_WINDOW=
RATE_LIMITER_REQUESTS=

## Lokale Dateispeichervariablen - NUR VERWENDEN, WENN ASSETS LOKAL GESPEICHERT WERDEN
FILE_STORAGE=
FILE_STORAGE_LOCAL_ROOT_DIR=
FILE_STORAGE_UPLOAD_MAX_SIZE=

## AWS-Variablen - OPTIONAL, ENTFERNEN, wenn AWS nicht für die ASSET-SPEICHERUNG verwendet wird
AWS_REGION=
AWS_S3_FORCE_PATH_STYLE=
AWS_S3_UPLOAD_BUCKET_NAME=
AWS_S3_UPLOAD_BUCKET_URL=
AWS_S3_UPLOAD_MAX_SIZE=
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=

## Google Login Authentifizierungsvariablen
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=

Einige Informationen zu den oben aufgeführten Variablen:

• Wir generieren 3 eindeutige Schlüssel für die ${SECRET_KEY}, ${UTILS_SECRET} und ${POSTGRES_PASSWORD} Variablen.
• Da wir SSL beenden werden, können wir die Option ${FORCE_HTTPS} Variable zu false.
• Für die ${URL} durch die HTTPS-URL für Ihre Outline-Installation, z. B. https://outline.thomasgriffin.com
• Schnappen Sie sich die Zugriffsschlüssel, Client-IDs und andere Schlüssel, die Sie beim Durchgehen der AWS- und Google Workspace-Teile des Tutorials erstellt haben. Sie müssen sie in Ihr docker.env Datei.
• Wo immer Sie sonst sehen ${VARIABLE} im docker.env Datei, stellen Sie sicher, dass Sie ihn durch den entsprechenden Wert ersetzen.
• Wenn Sie die lokale Dateispeicherung verwenden möchten, setzen Sie die ${FILE_STORAGE} Variable zu local. Wenn Sie AWS S3 verwenden möchten, setzen Sie den Wert auf s3.

Um die eindeutigen Schlüssel zu erzeugen, führen Sie den folgenden Befehl dreimal aus. Kopieren Sie nach jedem Mal die Ausgabe und ersetzen Sie ${SECRET_KEY}, ${UTILS_SECRET} und ${POSTGRES_PASSWORD} Variablen jeweils in der docker.env Dateiinhalt unten.

openssl rand -hex 32

Um die Datei im Terminal zu bearbeiten, führen Sie den folgenden Befehl aus:

nano docker.env

Hier ist der Code, der eingefügt wird docker.env. Vergessen Sie nicht, die Befehle auszuführen und die entsprechenden Variablen zu ersetzen!

## Required Variables
SECRET_KEY=${SECRET_KEY}
UTILS_SECRET=${UTILS_SECRET}
FORCE_HTTPS=false
ENABLE_UPDATES=true
WEB_CONCURRENCY=2

## Postgres Variables
POSTGRES_USER=outline_user
POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
POSTGRES_DB=outline
DATABASE_URL=postgres://outline_user:${POSTGRES_PASSWORD}@postgres:5432/outline
PGSSLMODE=disable

## Redis Variables
REDIS_URL=redis://redis:6379

## Domain Variables
URL=${URL}
PORT=3000

## Rate Limiting Variables
RATE_LIMITER_ENABLED=true
RATE_LIMITER_DURATION_WINDOW=60
RATE_LIMITER_REQUESTS=600

## Local File Storage Variables - IF USING AWS, CHANGE VALUE TO s3
FILE_STORAGE=local
FILE_STORAGE_LOCAL_ROOT_DIR=/var/lib/outline/data
FILE_STORAGE_UPLOAD_MAX_SIZE=26214400

## AWS Variables
AWS_REGION=${AWS_BUCKET_REGION}
AWS_S3_FORCE_PATH_STYLE=false
AWS_S3_UPLOAD_BUCKET_NAME=${AWS_BUCKET_NAME}
AWS_S3_UPLOAD_BUCKET_URL=https://${AWS_BUCKET_NAME}.s3.${AWS_BUCKET_REGION}.amazonaws.com
AWS_S3_UPLOAD_MAX_SIZE=26214400
AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY}
AWS_SECRET_ACCESS_KEY=${AWS_SECRET_KEY}

## Google Login Authentication Variables
GOOGLE_CLIENT_ID=${GOOGLE_CLIENT_ID}
GOOGLE_CLIENT_SECRET=${GOOGLE_CLIENT_SECRET}

Als nächstes werden Sie die docker-compose.yml Datei, um die Bilder zu definieren, die Sie für die Ausführung von Outline benötigen:

nano docker-compose.yml

Fügen Sie den folgenden Code in die Eingabeaufforderung ein:

Version: "3"
Dienstleistungen:
  outline:
    Bild: outlinewiki/outline:latest
    neustart: immer
    env_file: docker.env
    Befehl: sh -c "yarn --env=production-ssl-disabled && yarn start --env=production-ssl-disabled"
    ports:
      - "3000:3000"
    Volumes:
      - storage-data:/var/lib/outline/data
    depends_on:
      - postgres
      - redis
  
  redis:
    image: redis:7
    restart: immer
    env_file: docker.env
    expose:
      - "6379"
    volumes:
      - ./redis.conf:/redis.conf
    command: ["redis-server", "/redis.conf"]
  
  postgres:
    image: postgres:14
    restart: immer
    env_file: docker.env
    expose:
      - "5432"
    Volumes:
      - datenbank-daten:/var/lib/postgresql/data
Volumes:
  storage-data:
  datenbank-daten:

Zum Schluss speichern Sie die Datei (Strg + X, Y und dann Return). Jetzt sind Sie bereit, Outline mit Docker zum Laufen zu bringen!

Führen Sie den folgenden Befehl aus, um Ihren neuen Outline-Docker-Container zu starten:

docker-compose up -d

Sie sollten einige Informationen in Ihrem Terminal angezeigt bekommen. Sie wird in etwa so aussehen:

Wenn Sie einen Fehler sehen, liegt das häufig daran, dass docker-compose mag keine Tabs. Sie müssen Tabulatoren in Leerzeichen umwandeln im docker-compose.yml Datei.

Sie können überprüfen, ob die Dinge im Container funktionieren, indem Sie diesen Befehl ausführen:

docker ps

Außerdem ist es hilfreich, die Docker-Protokolle zu überprüfen, um sicherzustellen, dass keine Fehler aufgetreten sind. Sie können diese Protokolle überprüfen, indem Sie den folgenden Befehl ausführen:

docker-compose-Protokolle

Wenn Sie Fehler in den Protokollen sehen, machen Sie eine Pause vom Lernprogramm, um diese zu beheben.

Wenn Sie Probleme haben, diese zu lösen, können Sie einen Kommentar zu diesem Artikel hinterlassen, mich über mein Kontaktformular kontaktieren oder mich auf Twitter anpingen. Ich helfe Ihnen gerne!

Jetzt können Sie den Nginx-Serverblock so konfigurieren, dass Ihre neue Outline-Wissensdatenbank und Ihr Team-Wiki öffentlich zugänglich sind.

Konfigurieren des Nginx-Server-Blocks

Dies ist der letzte Schritt zum Zugriff auf Ihre neue Outline-Wissensdatenbank und Ihr Team-Wiki. Sie müssen in der Lage sein, eingehenden Webverkehr von Ihrer neuen Subdomäne zu empfangen und zu verarbeiten, z. B. https://outline.thomasgriffin.com.

Da Outline in Docker ausgeführt wird, muss Nginx als Reverse-Proxy für den Webverkehr fungieren. Diese Details werden Sie jetzt konfigurieren.

Zunächst müssen Sie Ihren SSL-Sicherheitsaustausch verbessern, indem Sie einen Diffie-Helman-Austauschschlüssel erstellen. Führen Sie den folgenden Befehl in Ihrem Terminal aus:

sudo openssl dhparam -out /etc/ssl/certs/dhparam.pem 2048

Führen Sie anschließend den folgenden Befehl aus, um eine neue Konfigurationsdatei für Ihre Outline-Anwendung zu erstellen:

sudo nano /etc/nginx/conf.d/outline.conf

Kopieren Sie im Bearbeitungsbildschirm den unten stehenden Code und fügen Sie ihn ein, indem Sie die folgenden Variablen ersetzen:

• Ersetzen Sie ${DOMAIN} mit der von Ihnen gewählten Domäne, z. B. outline.thomasgriffin.com
• Ersetzen Sie ${USER} mit dem Nicht-Root-Benutzer, den Sie in der Anleitung für die Ersteinrichtung von Ubuntu auf Digital Ocean erstellt haben, z. B. thomas

server {
	listen 80;
	listen [::]:80;

	server_name ${DOMAIN};

	return 301 https://$host$request_uri;
}

server {
	listen 443 ssl http2;
	listen [::]:443 ssl http2;

	server_name ${DOMAIN};

	access_log off;
	error_log /home/${USER}/docker/logs/error.log;

	ssl_protocols TLSv1.2 TLSv1.3;
	ssl_ciphers ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-RSA-AES256-SHA:ECDHE-ECDSA-DES-CBC3-SHA:ECDHE-RSA-DES-CBC3-SHA:EDH-RSA-DES-CBC3-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:DES-CBC3-SHA:!DSS;
	ssl_prefer_server_ciphers on;
	ssl_session_timeout 24h;
	ssl_stapling on;
	ssl_stapling_verify on;
	ssl_certificate /etc/letsencrypt/live/${DOMAIN}/fullchain.pem;
	ssl_certificate_key /etc/letsencrypt/live/${DOMAIN}/privkey.pem;
	ssl_trusted_certificate /etc/letsencrypt/live/${DOMAIN}/chain.pem;
	ssl_dhparam /etc/ssl/certs/dhparam.pem;
	ssl_session_cache shared:OutlineSSL:10m;
	ssl_session_tickets off;

	location / {
		proxy_pass http://127.0.0.1:3000;
		
		proxy_set_header Upgrade $http_upgrade;
		proxy_set_header Connection "Upgrade";
		proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
		proxy_set_header Host $host;
		proxy_set_header X-Real-IP $remote_addr;
		proxy_set_header X-Scheme $scheme;
		proxy_set_header X-Forwarded-Proto $scheme;

		proxy_redirect off;
	}
}

Wenn Sie mit der Bearbeitung fertig sind, drücken Sie Strg + X, dann Y und Return, um die Datei zu speichern.

Sie können Ihre Nginx-Serverblöcke später weiter optimieren. Dies sind einige grundlegende Konfigurationseinstellungen, mit denen Sie auf sichere Weise arbeiten können.

Um zu überprüfen, ob alles in Ordnung ist, führen Sie den folgenden Befehl aus:

sudo nginx -t

Wenn Sie Fehler erhalten haben, überprüfen Sie diese und bearbeiten Sie Ihre outline.conf Datei, um die Fehler zu beheben, und führen Sie dann den obigen Befehl erneut aus, um die Korrekturen zu überprüfen.

Wenn alles gut aussieht, führen Sie den folgenden Befehl aus, um Nginx neu zu laden und die Konfigurationsänderungen anzuwenden:

sudo systemctl neu starten nginx

Anzeigen und Authentifizieren in Ihrer Gliederung Selbst gehostete Installation

Sie sollten in der Lage sein, Ihre URL, z. B. https://outline. thomasgriffin.com, aufzurufen und einen Bildschirm zu sehen, der wie folgt aussieht:

Klicken Sie auf die Schaltfläche, um sich bei Google anzumelden, und melden Sie sich dann mit der E-Mail-Adressdomäne an, die mit dem zuvor erstellten benutzerdefinierten Oauth-Client verknüpft ist.

Herzlichen Glückwunsch! Viel Spaß mit Ihrer neuen, selbst gehosteten Outline-Installation! 🎉

Von hier aus werde ich einige zusätzliche Konfigurationen mit Ihnen teilen, z. B. die Einrichtung von SMTP, damit E-Mails von Ihrem Server aus funktionieren, sowie die Konfiguration von Outline, um einmal im Monat automatisch nach Updates zu suchen und diese anzuwenden.

Ich habe unzählige Stunden damit verbracht, herauszufinden, wie ich Outline für mich selbst installieren kann, sowie dieses Tutorial zu schreiben, zu testen und zu validieren. Wenn es für Sie hilfreich war, teilen Sie es bitte mit anderen, indem Sie die mit diesem Tutorial verbundenen sozialen Schaltflächen verwenden.

Vielen Dank im Voraus für Ihre Unterstützung, wenn Sie dies tun!

Fahren wir mit dem Lernprogramm fort.

SMTP konfigurieren

Wenn Sie Teammitglieder zu Ihrer selbst gehosteten Outline-Installation einladen möchten, müssen Sie SMTP-Unterstützung konfigurieren. Andernfalls werden Ihre E-Mails den Server nie verlassen.

Hierfür benötigen Sie einen Transaktions-E-Mail-Dienst. Ich empfehle SendLayer. Es ist eines der Produkte meines Unternehmens und es gibt einen kostenlosen Plan für Ihre ersten 500 E-Mails.

Melden Sie sich für einen kostenlosen Tarif an. Fügen Sie anschließend eine Domain für den E-Mail-Versand hinzu. Ich empfehle die Verwendung einer separaten Subdomain für Transaktions-E-Mails. Meine lautet zum Beispiel outlinemail.thomasgriffin.com.

Nachdem Sie Ihre Domain hinzugefügt haben, werden Sie aufgefordert, einige neue DNS-Einträge hinzuzufügen, um den Einrichtungsprozess abzuschließen. Genau wie bei den obigen Schritten zum Hinzufügen Ihrer Subdomain für Ihre Outline-Installation werden Sie hier die gleiche Arbeit verrichten.

Hier ist ein Beispiel für die Datensätze, die Sie konfigurieren müssen:

Sobald Sie Ihre DNS-Einträge konfiguriert und überprüft haben, wechseln Sie zur Registerkarte SMTP-Zugangsdaten. Sie müssen die Anmeldeinformationen zu Ihrem docker.env Datei.

Sobald Sie die SMTP-Zugangsdaten haben, kehren Sie zu Ihrem docker.env Datei (zu finden unter /home/${USER}/docker) und fügen Sie unten Folgendes hinzu, wobei Sie die SMTP-Variablen durch die Anmeldedaten von SendLayer ersetzen. Die ${FROM_EMAIL} sollte von der Subdomain sein, die Sie für SMTP eingerichtet haben, und die Variable ${REPLY_EMAIL} Die Variable kann sein, was immer Sie wollen.

## SMTP-Variablen
SMTP_HOST=smtp.sendlayer.net
SMTP_PORT=587
SMTP_BENUTZERNAME=${SMTP_BENUTZERNAME}
SMTP_PASSWORD=${SMTP_PASSWORD}
SMTP_FROM_EMAIL=${FROM_EMAIL}
SMTP_REPLY_EMAIL=${REPLY_EMAIL}
SMTP_SECURE=false

Sobald Sie die Datei gespeichert haben, müssen Sie die Änderungen auf Ihre Docker-Container anwenden. Führen Sie den folgenden Befehl in Ihrem Terminal aus:

docker-compose down --remove-orphans && docker-compose up -d

Vielleicht bemerken Sie eine kurze 502 Bad Gateway Fehler von Nginx, nachdem Sie Docker neu geladen haben. Normalerweise ist er in weniger als 30 Sekunden behoben.

Sie können jetzt Ihre Teammitglieder einladen, an Ihrer neuen Gliederungsinstallation mitzuarbeiten... und sie werden Ihre E-Mail-Einladungen tatsächlich erhalten!

Konfigurieren von automatischen Updates für Ihre selbst gehostete Outline-Installation

Wenn es Ihnen so geht wie mir, finden Sie es mühsam, etwas einmal eingerichtet zu haben und es mit rudimentären Aktualisierungen zu pflegen.

Glücklicherweise können Sie diese Aufgabe mit dem System-Cron leicht automatisieren. Lassen Sie uns zwei Aufträge erstellen: einen, der täglich geplante Outline-Aufträge auslöst, und einen, der einmal im Monat automatisch nach Aktualisierungen sucht (und wenn eine Aktualisierung für Outline gefunden wird, wird sie automatisch installiert, angewendet und neu gestartet).

Täglich geplante Aufträge

Führen Sie diesen Befehl in Ihrem Terminal aus, um den neuen täglichen Cron-Job zu erstellen, der die geplanten Outline-Jobs auslöst:

sudo nano /etc/cron.daily/outline-daily

Fügen Sie den folgenden Code ein, wenn Sie dazu aufgefordert werden, und ersetzen Sie dabei die ${DOMAIN} mit der Domain, die Sie für Ihre Outline-Installation gewählt haben (z. B. outline.thomasgriffin.com) und ${UTILS_SECRET} mit dem UTILS_SECRET Variable aus Ihrer docker.env Datei:

#!/bin/sh
curl https://${DOMAIN}/api/cron.daily?token=${UTILS_SECRET}

Speichern Sie die Datei (Strg + X, Y und dann Return). Machen Sie die Datei dann mit dem folgenden Befehl ausführbar:

sudo chmod +x /etc/cron.daily/outline-daily

Der Cron wird nun einmal täglich ausgeführt und löst alle von Outline geplanten Aufträge aus.

Monatliche Updates

Führen Sie diesen Befehl in Ihrem Terminal aus, um den neuen monatlichen Cron-Job zur Aktualisierung von Outline zu erstellen:

sudo nano /etc/cron.monthly/outline-update

Fügen Sie den folgenden Code ein, wenn Sie dazu aufgefordert werden, und ersetzen Sie dabei die ${USER} mit dem Nicht-Root-Benutzer, den Sie zu Beginn des Tutorials angelegt haben:

#!/bin/sh
cd /home/${USER}/docker
docker-compose down --remove-orphans
docker pull outlinewiki/outline
docker pull redis:7
docker pull postgres:14
docker-compose run --rm outline yarn --env=production-ssl-disabled
docker-compose up -d

Speichern Sie die Datei (Strg + X, Y und dann Return).

Als Nächstes müssen Sie sicherstellen, dass der monatliche Cron ausgeführt werden kann. Führen Sie diesen Befehl in Ihrem Terminal aus:

sudo chmod +x /etc/cron.monthly/outline-update

Der Cron wird nun einmal im Monat ausgeführt und aktualisiert Outline automatisch auf die neueste Version. Er führt auch alle neuen Datenbankmigrationen aus, die Teil der Outline-Aktualisierung sein könnten.

Noch einmal: Herzlichen Glückwunsch! Sie haben die Wissensdatenbank und das Wiki des Outline-Teams erfolgreich auf Ubuntu installiert!

Wenn Sie diese Anleitung hilfreich fanden, lassen Sie es bitte die Welt wissen. Ich habe viel Zeit damit verbracht, diese Anleitung für Sie zu verfassen und zum Laufen zu bringen. Über die Schaltflächen für soziale Netzwerke in diesem Artikel können Sie es schnell teilen.

Außerdem würde ich gerne wissen, ob Sie es erfolgreich eingerichtet haben oder ob Sie Hilfe brauchen. Hinterlassen Sie unten einen Kommentar, nutzen Sie mein Kontaktformular oder schreiben Sie mir auf Twitter.

Hilfreiche Befehle, Tipps und Tricks

Bei der Arbeit mit komplexen Systemen wie diesem ist es hilfreich, eine Liste von Befehlen/Tipps/Tricks zu haben, um die Verwaltung und Fehlersuche zu erleichtern.

Im Folgenden finden Sie einige hilfreiche Dinge, die ich bei der Einführung von Outline auf meiner eigenen Website verwendet habe.

Alte Datenbank-Volumes entfernen

Wenn Postgres sich aus irgendeinem Grund beim ersten Start von Docker nicht verhält, kann es sein, dass Sie am Ende ein schlechtes Datenvolumen haben.

Aufgrund der Funktionsweise von Docker werden beim anschließenden Herunterfahren und Starten Schritte zur Bereitstellung von Datenbanken und Benutzern übersprungen. Wenn Sie feststellen, dass eine Datenbank- oder Benutzerrolle in den Protokollen fehlt (docker-compose logs), können Sie die folgenden beiden Befehle ausführen, um alte Datenbank-Volumes zu entfernen, damit sie vollständig neu erstellt werden können:

docker volume ls
docker volume rm <volume_name>

Beachten Sie, dass Sie dabei alle Ihre Daten verlieren. Dies ist vor allem bei der Ersteinrichtung Ihrer Outline-Installation hilfreich.

Normalerweise ist das postgres-Volume offensichtlich, da es postgres in seinem Namen enthält. Entfernen Sie es, dann können Sie die Docker-Container herunterfahren (docker-compose down) und wieder nach oben (docker-compose up -d).

Vollständiges Löschen von Docker

Es ist nicht schwer, aber es war schwierig, die richtigen Befehle zu finden, um es einfach zu machen.

Um alle Container und Volumes zu entfernen, führen Sie diesen Befehl aus:

docker rm -vf $(docker ps -aq)

Um alle Bilder zu entfernen, führen Sie diesen Befehl aus:

docker rmi -f $(docker images -aq)

Dann sind Sie frei zu laufen docker-compose up -d und zwar auf eine völlig neue Art und Weise.

Einpacken

Ich danke Ihnen für Ihre Zeit. Ich hoffe, Sie erleben die Vision der Ergebnisse so, wie ich sie vorhin beschrieben habe.

Wenn Sie dies als hilfreich empfunden haben, teilen Sie es bitte mit anderen. Ich habe zahlreiche Stunden damit verbracht, dies zum Laufen zu bringen und für Sie zu dokumentieren. Über die Schaltflächen für soziale Netzwerke in diesem Artikel können Sie ihn schnell teilen.

Außerdem würde ich gerne wissen, ob Sie es erfolgreich eingerichtet haben oder ob Sie Hilfe benötigen. Hinterlassen Sie unten einen Kommentar, nutzen Sie mein Kontaktformular oder schreiben Sie mir auf Twitter.

Und wenn Sie sich für mehr von mir Geschriebenes interessieren, finden Sie hier ein paar gute Anlaufstellen:

• Überlegungen zur Größe (und wie man großartig wird) Jeder möchte in irgendetwas großartig sein. Aber was braucht es eigentlich, um großartig zu sein? Die Antwort mag überraschen, und ich zeige eine interessante Grafik, die erklärt, warum.
• Wie man effektiv kommuniziert (in jeder Situation) Wirksame Kommunikation ist eine wichtige Fähigkeit, die jeder entwickeln muss. In diesem Artikel definiere ich die Anforderungen, gebe Kommentare ab und zeige hilfreiche Beispiele, wie Sie Ihre Kommunikation effektiver gestalten können.
• Willkommen bei Leadership Blühen Sie als Führungskraft mit kampferprobten Führungsprinzipien, Erkenntnissen und Taktiken auf.

Ich wünsche Ihnen einen schönen Tag!
Thomas

Geschrieben von: Thomas Griffin

Hallo! Ich bin Thomas und ich bin ein Tech-Unternehmer, ein erfahrener Geschäftsinhaber, ein erfahrener Investor und eine Führungspersönlichkeit. Meine Software unterstützt den organisatorischen Erfolg von mehr als 25 Millionen Websites auf der ganzen Welt, und meine Inhalte werden jeden Monat von Tausenden gelesen.

Abonnieren Sie meinen Newsletter-Letzte Ausgabe lesen →

Laden Sie mein kostenloses Ebook herunter

Durchbruch in der Führung

5 Überraschend einfache Qualitäten einer außergewöhnlichen Führungskraft von heute

Große Führungspersönlichkeiten haben gemeinsame Eigenschaften, die sie von der Masse abheben. Laden Sie Ihr Exemplar meines Ebooks absolut KOSTENLOS herunter, wenn Sie unten Ihren Namen und Ihre E-Mail-Adresse eingeben.

Ihr richtiger Name Ihre beste E-Mail Adresse