So installieren Sie Raneto unter Ubuntu 17.10

• Voraussetzungen
• Einloggen
• Installieren von Node.js & PM2
• Raneto installieren
• Weitere Konfiguration
• Seiten hinzufügen
• Kategorien hinzufügen

Raneto ist eine kostenlose Open-Source-Wissensdatenbank, die auf Node.js basiert und einfach einzurichten und zu verwenden sowie einfach zu verwalten ist. Kategorien und Seiten sind in Markdown geschrieben, was die Bearbeitung erleichtert. Wenn Markdown nicht Ihr Ding ist, können Sie mit Raneto auch HTML verwenden.

Voraussetzungen

• Ein VPS mit Ubuntu 17.10 installiert.
• SSH-Zugriff auf Ihren VPS.
• Grundlegendes Verständnis des Linux-Terminals.

Einloggen

Zuerst müssen wir uns mit SSH bei unserem Server anmelden. Öffnen Sie dazu Ihren bevorzugten SSH-Client.

ssh root@SERVER_IP

Nachdem Sie Ihr Passwort eingegeben haben (Sie können es über das Vultr-Dashboard abrufen), werden Sie bei Ihrem VPS angemeldet.

Installieren von Node.js & PM2

Raneto läuft auf Node.js, einer Javascript-Laufzeit und einem Framework. In diesem Tutorial verwenden wir Node.js v8 aufgrund seiner langfristigen Unterstützung. Starten Sie die Installation, indem Sie den folgenden Befehl eingeben.

curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -

Nachdem dieses Skript ausgeführt wurde, können Sie die Hauptinstallation ausführen.

sudo apt-get install -y nodejs

Sobald dieses Installationsprogramm abgeschlossen ist, wird auf Ihrem VPS eine aktuelle Kopie von Node.js installiert. Als Nächstes installieren wir PM2, einen Prozessmanager für Node.js, der das Ausführen von Raneto (und vielen anderen Node.js-Anwendungen) erleichtert.

npm install pm2 -g

Wir haben jetzt die gesamte Software, die wir zur Installation von Raneto benötigen.

Raneto installieren

Wir werden Git verwenden, um das Raneto-Repository auf unseren Server zu klonen.

git clone https://github.com/gilbitron/Raneto.git

Dadurch wird ein Ordner mit dem Namen erstellt Raneto. Geben Sie den Ordner ein.

cd Raneto

Installieren Sie NPM.

npm install

Führen Sie Gulp aus, indem Sie Folgendes eingeben.

npm run gulp

Sobald Gulp ausgeführt wurde, können wir unsere Anwendung mit einem der beiden folgenden Befehle starten.

npm start
# or
npm example/server.js

Sie können jetzt auf Ihre neue Raneto-Installation zugreifen, indem Sie zu navigieren SERVER_IP:3000. Im Rest dieses Tutorials erfahren Sie, wie Sie Raneto weiter konfigurieren, neue Seiten erstellen, Kategorien hinzufügen, die Sortierung anpassen, eine benutzerdefinierte Startseite hinzufügen und die Vorlage bearbeiten.

Weitere Konfiguration

Sie haben jetzt eine Standard-Raneto-Installation auf Ihrem VPS gehostet. Bevor Sie etwas anderes tun, empfehle ich Ihnen, einige Änderungen an der Standardkonfiguration und -einstellung vorzunehmen.

Werfen wir einen Blick darauf config.default.js, was sich im exampleOrdner befindet. Diese Konfigurationsdatei ist ziemlich lang, aber bitte nicht überfordert, da sie stark kommentiert ist. Hier sind die Eigenschaften, die Sie bearbeiten sollten:

• site_title - Ändern Sie dies in Ihren Website-Titel.
• base_url- Dies sollte auf die URL Ihrer Site eingestellt sein. Es kann als Variable beim Bearbeiten von Seiten verwendet werden.
• support_email- Ändern Sie dies in eine gültige E-Mail. Es wird in der Fußzeile der Site angezeigt.
• copyright - Fusszeile.
• analytics - Fügen Sie hier einen Google Analytics-Tracking-Code hinzu.
• allow_editing - Möchten Sie Dateien mit dem Web-Editor bearbeiten können?
• authentication_for_read - Möchten Sie, dass sich Personen anmelden, um die Website anzuzeigen?
• credentials - Fügen Sie hier Benutzer hinzu, wenn die Anmeldung aktiviert ist.
• locale - Sprache.
• datetime_format - Format von Datum und Uhrzeit.
• home_meta - Bearbeiten Sie dies, um die Metainformationen Ihrer Homepage zu ändern.
• table_of_content - Sollte Raneto ein Inhaltsverzeichnis anzeigen?

Verwenden des Online-Editors

Raneto verfügt über eine benutzerfreundliche Online-Oberfläche zum Verwalten von Seiten, Kategorien und mehr. Es erlaubt Ihnen zwar nicht, alles zu tun, aber es ist sicherlich hilfreich, wenn Sie unterwegs eine schnelle Bearbeitung vornehmen müssen.

Sie können darauf zugreifen, indem Sie die Einstellung in config.default.js(wie oben erwähnt) aktivieren, dann Ihren VPS besuchen und auf die Anmeldeschaltfläche in der oberen rechten Ecke klicken. Geben Sie Ihren Benutzernamen und Ihr Passwort ein (Sie können diese ändern config.default.js) und klicken Sie auf Anmelden. Klicken Sie einfach auf die Seite, die Sie bearbeiten Actionsmöchten , klicken Sie auf das Dropdown-Menü und wählen Sie die Aktion aus, die Sie ausführen möchten. Sie können Seiten hinzufügen, indem Sie auf die +Schaltfläche neben dem Kategorienamen klicken, und Sie können Kategorien über das Eingabefeld in der oberen linken Ecke erstellen.

Seiten hinzufügen

Das Hinzufügen von Seiten ist so einfach wie das Erstellen eines neuen Markdown ( .md) -Dokuments im example/contentOrdner.

Sobald Sie eine neue Markdown-Datei erstellt haben, ist es wichtig, dass Sie einige grundlegende Informationen oben in die Datei einfügen. Öffnen Sie die Datei in Ihrem bevorzugten Texteditor. Wir müssen Folgendes oben in die Datei einfügen.

/*
 Title: Enter your page title here, if none is added, the file-name will be used
 Description: Enter your page's description here (for search engines and the site search feature)
 ShowOnHome: true/false
 */

Bei Bedarf können Sie auf Ihren Seiten auch die folgenden Variablen verwenden:

• %base_url% - Hier können Sie die URL Ihrer Website angeben.
• %image_url% - Auf diese Weise können Sie die Basis-URL Ihres Bildverzeichnisses abrufen.

Kategorien hinzufügen

Sie können Ihrer Wissensdatenbank ganz einfach Kategorien hinzufügen. Erstellen Sie einfach einen neuen Ordner im example/contentVerzeichnis und legen Sie die Seiten, die Sie in dieser Kategorie haben möchten, in diesem Ordner ab. Zum Beispiel, sagen wir eine Kategorie namens wollten helpmit Seiten genannt contact, help-meund awesome. Die Dateien würden folgendermaßen aussehen:

/example/content/help/contact.md
/example/content/help/help-me.md
/example/content/help/awesome.md

Sie können innerhalb von Kategorien so viele Unterordner hinzufügen, wie Sie möchten.

Kategorien können auch Metainformationen enthalten. Erstellen Sie eine Datei mit dem Namen metaim Kategorieordner. Die folgenden Attribute werden unterstützt (alle optional):

• Titel - Überschreibt den Titel basierend auf dem Ordnernamen.
• Sortieren - Ermöglicht das Sortieren der Reihenfolge von Kategorien und funktioniert genauso wie das Sortieren von Seiten.
• ShowOnHome - wahr / falsch.

Benutzerdefinierte Homepage

Wenn Sie eine benutzerdefinierte Startseite hinzufügen möchten, müssen Sie lediglich eine Markdown-Datei hinzufügen index.md, die Ihrem example/contentOrdner aufgerufen wird .

Seiten sortieren

Raneto sortiert Seiten automatisch alphabetisch, aber Sie können eine manuelle Sortierung anwenden, indem Sie dem Seitenmeta ein SortElement hinzufügen . Der Wert von sort muss eine Ganzzahl sein, zum Beispiel:

Sort: 7

Diese Seite wird jetzt vor Seiten mit einem Sortierwert von 8 oder mehr angezeigt, jedoch nach Seiten mit einem Wert von 6 oder weniger.

Ändern der Vorlage

Wenn Sie mit HTML oder CSS vertraut sind, können Sie das Aussehen Ihrer Raneto-Installation leicht ändern. Raneto verwendet Handlebars, eine JavaScript-Vorlagensprache, die die HTML-Bearbeitung modularisiert. Sie finden die Themendateien im themes/defaultOrdner. Wenn Sie weitere Informationen zum Bearbeiten von Renato-Vorlagen wünschen, können Sie deren Hilfeabschnitt besuchen . Stellen Sie nach dem Bearbeiten der Vorlage sicher, dass Sie die Anwendung neu starten.