SiYuan
Beschreibung
SiYuan ist ein praktisches Werkzeug zum Erstellen, Bearbeiten und Organisieren von Notizen mit Unterstützung für Text, Bilder, Diagramme und viele weitere Funktionen, die die Arbeit mit Informationen vereinfachen. Unterstützt die Auszeichnungssprache Markdown.
Die vorinstallierte Version der Software unterstützt keine Synchronisierung zwischen Geräten. Die Software kann nur über einen Browser verwendet werden.
Erste Schritte
SiYuan wird mit einem Image installiert und startet automatisch, wenn der Server hochfährt.
Nach der Installation des Images ist die SiYuan-Weboberfläche unter https://example.com/ erreichbar, wobei example.com der Hostname Ihres Servers ist.
Um auf die Weboberfläche zuzugreifen, verwenden Sie die Zugangsdaten, die Ihnen per E-Mail zugesandt wurden.
Zusätzlich finden Sie die Anmeldedaten auf dem Server in der Datei:
/root/.app_credentials
Um auf diese Datei zuzugreifen, müssen Sie sich per SSH am Server anmelden. Sie können sich per SSH mit dem Server verbinden:
- Mit einem SSH-Schlüssel, wenn diese Option vor der Erstellung des Servers aktiviert wurde
- Mit dem per E-Mail gesendeten Passwort des Benutzers
root, das bei der Aktivierung des Servers versendet wurde
Domain ändern
Wenn Sie Ihre eigene Domain oder Subdomain verwenden möchten, um auf die SiYuan-Weboberfläche zuzugreifen, müssen Sie sich per SSH als Benutzer root am Server anmelden und den folgenden Befehl ausführen:
add_domain
Sie werden aufgefordert, eine Domain oder Subdomain im Format subdomain.example.com einzugeben.
Stellen Sie sicher, dass Ihre Domain existiert und auf die IPv4-Adresse Ihres Servers verweist!
Sobald der Befehl abgeschlossen ist, wird für die angegebene Domain oder Subdomain ein Let’s Encrypt-Zertifikat ausgestellt, und die Weboberfläche ist unter https://example.com/ erreichbar, wobei example.com die zuvor angegebene Domain (Subdomain) ist.
Dokumente erstellen
Bei der ersten Anmeldung gelangen Sie in den Dokumentenbaum SiYuan User Guide, der eine kurze Benutzerdokumentation darstellt.
Wir empfehlen Ihnen, sich mit dem Abschnitt Please Start Here vertraut zu machen, in dem die Möglichkeiten des Editors beschrieben werden.
Um einen neuen Dokumentenbaum zu erstellen, klicken Sie in der Symbolleiste auf die drei Punkte und wählen New notebook, geben einen beliebigen Namen ein und klicken auf Create.
Um ein verschachteltes Dokument zu erstellen, klicken Sie auf die Schaltfläche + gegenüber dem übergeordneten Dokument.
Plugins installieren
SiYuan unterstützt Plugins, die im Plugin-Store gefunden werden können.
Um auf den Plugin-Store zuzugreifen, öffnen Sie das Einstellungsmenü, indem Sie oben links auf der Seite auf workspace klicken und Settings auswählen, dann den Unterabschnitt Marketplace.
Prüfen Sie die potenziellen Sicherheitsrisiken und akzeptieren Sie sie, um fortzufahren, durch Klicken auf Trust.
Der Plugin-Store wird auf der Registerkarte Plugins verfügbar sein.
Softwareaktualisierung
Um die SiYuan-Installation zu aktualisieren, müssen Sie sich per SSH als Benutzer root am Server anmelden und zwei Befehle ausführen:
cd /siyuan/ && docker compose pull
systemctl restart siyuan.service
Installierte Software
| Name | Lizenz |
|---|---|
| SiYuan | AGPL-3.0-Lizenz |
| Caddy | Apache-Lizenz 2.0 |
Nützliche Links
Weitere Informationen zu den installierten Paketen finden Sie in deren offizieller Dokumentation: