Die große SWARM Anleitung

  • SWARM wurde entwickelt, um Betreibern von Hornet oder Goshimmer Nodes die Möglichkeit zu geben, eine Node einfach zu installieren und zu verwalten. Es bietet auch die Möglichkeit, automatisch einen Reverse-Proxy für die SSL-Verschlüsselung zu installieren oder den Status der Node zu überwachen und automatische Updates (Hornet) durchzuführen.


    Zu diesem Zweck stehen zusätzlich die Dienste Watchdog und DBPruner zur Verfügung. Über die Konfiguration kann die Überwachung von neuen Updates, Sync-Problemen, Serviceausfällen eingestellt werden. Für den DBPruner kann die maximale Speichergröße in Megabyte definiert werden. Der DBPruner versucht, das Wachstum auf ein Minimum zu begrenzen. Durch die Verwendung von Multiplikatoren wird entweder mehr oder weniger Historie aus der Nodedatenbank gelöscht.





    1. Was wird benötigt?

    • Ein Raspberry Pi 4 oder ein VPS
    • Linux Betriebssystem 64Bit (vorzugsweise Ubuntu)
    • Ausreichende Speicherplatz > 40GB

    2. SWARM von Github herunterladen

    Zuerst müssen wir sicherstellen, dass bereits GIT auf eurem System installiert ist. Führt dafür einfach folgenden Befehl aus:

    Shell session
    sudo apt update && sudo apt install git -y

    Sobald das System die überprüfung durchgeführt hat, können wir auch schon das Repository mit folgendem Befehl herunterladen:

    Shell session
    sudo git clone https://github.com/TangleBay/swarm.git /var/lib/swarm

    Anschließend müssen wir dafür sorgen, dass das Hauptskript gestartet werden kann. Dafür passen wir mit folgendem Befehl die Berechtigung der Datei an:

    Shell session
    sudo chmod +x /var/lib/swarm/swarm

    3. SWARM starten!

    Nun starten wir das erste mal SWARM, damit man es in Zukunft etwas bequemer hat, legen wir zuvor für die Anwendung noch einen Alias an. Dieser sorgt dafür, dass ihr zukünftig nur noch swarm in die Konsole eingeben müsst um das Skript zu starten. Gebt dafür folgenden Befehl ein, achtet aber darauf das ihr in dem Moment der normaler User (Raspberry Pi) seid:

    Shell session
    echo "alias swarm='sudo /var/lib/swarm/swarm'" >> ~/.bashrc && . ~/.bashrc

    Jetzt starten wir das erste mal SWARM, dafür gebt wie eben schon beschrieben einfach nur swarm in die Konsole ein und das Skript startet:

    Code
    swarm

    Nach dem ersten Start installiert SWARM alle für sich notwendigen Pakete und startet das System anschließend neu...


    Loggt euch wieder in eure System ein und startet SWARM mittels des zuvor angelegten Alias swarm!


    Nachdem die Installation der Pakete abgeschlossen ist, werdet ihr gefragt, ob ihr SWARM für eine Hornet oder GoShimmer Node nutzen wollt. Tragt bitte entsprechend hornet oder goshimmer in das Eingabefeld ein.


    Sobald ihr eure Auswahl getroffen habt, landen wir das erste Mal im SWARM-Dashboard. Die Menüs richten sich direkt an die einzelnen Funktionen wie z.B.Hornet, GoShimmer oder SWARM selbst.



    4. Node installieren

    Nun kommen wir zur Installation der Node. Im folgenden geht bitte zu dem Schritt 4.1, falls ihr Hornet installieren möchtet oder Schritt 4.2, falls ihr GoShimmer installieren wollt.

    4.1. Hornet installieren

    Zunächst wechseln wir in das 2) Hornet Menü



    Anschließend wählen wir 1) Simple Config Editor



    Bearbeite nun die Konfiguration entsprechend deiner eigenen Präferenzen und speichere anschließend die Datei mit STRG+O und schließe den Editor mit STRG+X


    Du landest nun automatisch wieder im Hornet Hauptmenü und dort wählen wir jetzt 3) Hornet Intaller



    Im nachfolgenden Menü wählen wir jetzt 2) Install Hornet



    Sobald ihr den Punkt ausgewählt habt, startet sofort die Installation der Hornet Node (dies nimmt ggf. einige Zeit in Anspruch)


    Wenn die Installation erfolgreich war, solltet ihr nun folgende Ausgabe erhalten haben... bestätigt anschließend den Screen mit OK.


    Damit habt ihr Hornet erfolgreich installiert. Über das Hauptmenü von SWARM, könnt ihr beim Punkt SWARM Info euch einige kleine Details anzeigen lassen. Bitte beachtet, dass beim ersten Start von Hornet das einlesen der Snapshot-Datei einige Zeit in Anspruch nehmen kann. Damit Hornet nach außen funktioniert, müsst ihr noch sicherstellen, dass die Ports 14626/UDP und 15600/TCP geöffnet sind.


    4.2. GoShimmer installieren

    Um GoShimmer zu installieren, wählen wir nun zuerst im SWARM Hauptmenü 3) GoShimmer Menu


    Aktuell bekommt ihr folgenden Hinweis angezeigt, da die Installation von GoShimmer unter SWARM derzeit nur mit Ubuntu 20.04 und Dietpi funktioniert!


    Im GoShimmer Menü wählen wir dann 1) GoShimmer Configuration


    Im Konfigurationsmenü wählen wir anschließend 1) Simple Config Editor


    Passe nun die Ports je nach Bedarf an (es wird empfohlen die Standardports zu verwenden). Speichert die Konfigurationsdatei mit STRG+O und schließt anschließend den Editor mit STRG+X


    Nachdem die Konfiguration bearbeitet wurde und wir wieder im GoShimmer Menü sind, wechseln wir in 3) GoShimmer Installer


    Anschließend starten wir die Installation mit dem Punkt 2) Install GoShimmer (die Installation nimmt einige Zeit in Anspruch)


    Nach erfolgreicher Installation, solltet ihr folgende Anzeige sehen:


    Damit ist die Installation von GoShimmer erfolgreich abgeschlossen und eure Node läuft nun im Hintergrund. Bitte beachtet, dass ihr die folgenden Ports geöffnet sein müssen 14626/UDP und 14666/TCP.


    5. Proxy installieren

    Der (reverse-) Proxy ist für eine sichere Verbindung notwendig, wenn ihre eure Node über das Internet erreichen wollt. Standardmäßig erfolgt dieser Aufruf unverschlüsselt und ist somit nicht sicher. Auch hier übernimmt SWARM wieder für euch die Konfiguration. Beachtet bitte, dass dafür der Port 80/TCP geöffnet sein muss!


    Wählt dafür im SWARM Hauptmenü den Punkt 4) Proxy Menu


    Im Proxy Menü müssen wir nun zuerst die Konfiguration anpassen und wählen daher 1) Proxy Configuration


    Mit der Auswahl 1) Edit Nginx.cfg bearbeiten wir die Konfiguration


    Anschließend passt ihr die Konfiguration an, indem ihr eure Domain, sowie den gewünschten Port eintragt. Zusätzlich wählt ihr, ob eure Node-API mit oder ohne Authentifizierung installiert werden...


    Nun wechseln wir in 3) Proxy Installer um fortzufahren...


    Wir starten die Installation mit der Option 1) Install/Deploy the proxy.

    (Solltet ihr an der Konfiguration später etwas ändern, könnt ihr mit dieser Option ebenfalls die Konfiguration anpassen)


    Nachdem die Installation gestartet ist, wird man gebeten einen neuen Benutzer für die Authentifizierung anzulegen. Es empfiehlt sich hier 3) Add new user for Dash/API zu wählen


    Wählt nun einen Benutzernamen aus...


    Anschließend legt ein Passwort für den neuen Benutzer fest


    Nachdem nun der Benutzer angelegt wurde, wird versucht ein Zertifikat auszustellen. Zuerst muss man seine E-Mail Adresse angeben, diese wird verwendet um euch zu informieren, wenn euer Zertifikat ausläuft. Dank Certbot wird dieses aber automatisch erneuert!


    Wir bestätigen die Bestimmungen mit A


    Anschließend gebt nun N ein, da wir diese Option nicht wünschen...


    Zuletzt wählen wir Option 1

    (die Auswahl spielt hier eigentlich keine Rolle, da die Konfiguration von SWARM anschließend überschrieben wird)



    Wenn das Zertifikat erfolgreich ausgestellt worden ist, erhaltet ihr von SWARM folgende Meldung


    Abschließend erhaltet ihr noch eine kurze Anzeige über die URLs

    (Die URLs findet ihr auch im Hauptmenü unter SWARM Info)



    Damit ist die Installation des reverse Proxy abgeschlossen!


    6. SWARM Plugins

    SWARM verfügt über aktuell zwei Plugins Watchdog & DBPruner (nur bei Hornet). Diese vereinfachen die Wartung der Nodes unter bieten somit weitere Funktionen.


    Zuerst wählen wir im Hauptmenü 5) SWARM Menu



    Nun müssen wir zuerst wieder die Konfiguration anpassen und wählen daher 1) SWARM Configuration



    Legt entsprechend eure Wunschkonfiguration fest, welche Module ihr nutzen möchtest und speichert die Konfiguration mit STRG+O und beendet den Editor mit STRG+X



    Danach wechseln wir zu 2) Manage Plugins



    Wir wählen zuerst 1) Manage Watchdog

    (Manage DBPruner funktioniert nachfolgend genauso!)


    Mit der mit der Auswahl 1) Enable Watchdog wird das Plugin aktiviert



    Im Hauptmenü unter 1) SWARM Info kann man nun eine Übersicht der aktuell aktivierten Plugins und Module finden



    7. SWARM aktualisieren

    Man kann SWARM auf zwei Arten aktualisieren, einmal mit der Update-Benachrichtigung oder manuell ausgeführt.

    7.1 Update-Benachrichtigung

    Die erste Variante ist die automatische Update-Benachrichtigung beim Start von SWARM (erfordert in der SWARM.cfg den Wert updatenotifier=true)



    7.2 Manuelle Aktualisierung


    Wählt im Hauptmenü zuerst wieder 5) SWARM Menü



    Anschließend im SWARM Menü wählt ihr den Punkt 3) Manage SWARM



    Jetzt wählt man 1) Update SWARM aus und bestätigt anschließend, dass SWARM aktualisiert werden soll


    Damit habt ihr SWARM auf den letzten verfügbaren Stand aktualisiert!


    8. Hilfe bei Problemen

    Solltet ihr Probleme oder Hilfe bei der Benutzung von SWARM haben, dann könnt ihr einfach im einfachIOTA Forum, in dem Board SWARM einen Beitrag erstellen.


    Bitte beachtet das es keinen offiziellen Support für SWARM gibt und dies immer auf freiwilliger Basis der jeweiligen Nutzer geschieht!




    Bilder

    Mit den unten aufgeführten Adressen kann man mir ein kleines Trinkgeld zukommen lassen, vielen Dank im voraus!

    IOTA: M9CGJRCFSEPEDJULUOCHXMLYQLRYNXYLSDCRMYG9GWLMYLJGET9IYBRLOWIR99KMXQW9WR9WMBPXZNIGXAA999DGUB

    BTC (N-Segwit): bc1qfc9vxj3kzavcmk7tejfe5d82mcpcvyk6lqapzm

    BTC (Segwit): 3DTvyYrM2uXxT7D1APQkigmMQPHcVchgqi

Jetzt mitmachen!

Sie haben noch kein Benutzerkonto auf unserer Seite? Registrieren Sie sich kostenlos und nehmen Sie an unserer Community teil!