ioBroker – Node.js update

Kurzfassung:

cd /opt/iobroker
iobroker backup
iobroker stop
sudo apt-get update && sudo apt-get upgrade
curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt-get install -y nodejs
node -v
curl -sL https://iobroker.net/fix.sh | bash -
npm rebuild
iobroker start

Quelle:

https://forum.iobroker.net/topic/22867/how-to-node-js-für-iobroker-richtig-updaten

1. Einleitung

Node.js ist die Laufzeitumgebung der Programmiersprache JavaScript, in der ioBroker geschrieben ist. Ohne Node.js funktioniert ioBroker nicht.

Wie bei vielen Open-Source-Technologien üblich, entwickelt sich Node.js schnell weiter. Kleinere Updates, die die Stabilität und Sicherheit steigern oder gar neue Funktionen hinzufügen, erscheinen fast wöchentlich.

Node.js-Versionen mit gerader Hauptversionsnummer werden als LTS-Versionen (Long Term Support) bezeichnet und einige Jahre gepflegt (z.B. 8.x). In 2017 war das Node.js 8, 2018 kam Node.js 10 hinzu und im Oktober 2019 wird Node.js 12 den LTS-Status erhalten.

Im gleichem Zug erreichen frühere LTS-Versionen ihr Lebensende (EOL, End oLife). So hat Node.js 6 im April 2019 den EOL-Status erhalten und bekommt damit keine Updates mehr.

Alle Node.js-Versionen mit ungeraden Versionsnummern sind Entwicklungsversionen und sollten nicht produktiv genutzt werden.

Auch ioBroker wird stetig weiterentwickelt und nutzt die neuen Funktionen aktueller Node.js-Versionen. Obwohl der ioBroker js-controller mit Versionen 1.4.x bzw. 1.5.x noch Node.js 4 unterstützt, fordern neue Adapter immer häufiger mindestens Node.js 8 als Grundvoraussetzung.

Ab der kommenden Version 2.0 des js-controllers (das Freigabedatum ist noch nicht bekannt) sind die Anpassungen so tiefgreifend, dass die Node.js-Versionen 4 und 6 nicht mehr unterstützt werden können.

Alle paar Jahre steht also für eine ioBroker-Installation ein Update von Node.js an. Dieser Artikel soll zusammenfassen wir man dazu am besten vorgeht.

2. Wer sollte updaten?

Aktuell empfehlen wir, bei ioBroker-Neuinstallationen mindestens Node.js 10. zu verwenden. Es sind zwei Adapter bekannt, die nicht mit Node 10 funktionieren: sma-em und wetty. Sollen diese installiert werden, ist Node 8.16 die richtige Wahl. Der Einsatz von Node.js 12 ist vorerst nur für ioBroker-Testsystemen sinnvoll.

Windows-Anwendern empfehlen wir, auf jeden Fall am Test des neuen Windows-Installers teilzunehmen: https://forum.iobroker.net/post/266623
Der zukünftige Windows-Installer für ioBroker wird eine Funktion erhalten, bestehende Installationen automatisch auf aktuelle js-controller- und Node.js-Versionen zu migrieren, ohne dass man die Kommandozeile bemühen muss.

Bevor man beginnt, sollte man in der Befehlszeile mit dem Befehl

node -v

überprüfen, welche Version von Node.js gerade installiert ist. Eine gute Idee ist es, diese Versionsangabe auch mit der Node.js-Version im Übersichts-Fenster des ioBroker-Admins für diesen Host zu vergleichen. Sollten sich die Versionen unterscheiden, sind mehrere Node.js-Varianten installiert, was zu Problemen führen kann.

Grundsätzlich gilt: Sollte das ioBroker-System stabil laufen, muss Node.js auch nicht auf Gedeih und Verderb upgedated werden. Wenn aber die Installation bestimmter Adapter fehlschlägt (wohlmöglich sogar mit entsprechender Fehlermeldung) oder eine Node-Version < 4 für einen js-controller > Version 1.4.x eingesetzt wird, sollte über ein Node.js-Update nachgedacht werden. Es sind auch Probleme für die Node.js-Versionen 8.0 – 8.12 mit volllaufendem RAM bekannt, so dass wir auch hier ein Update empfehlen.

Wie bereits gesagt: Sollte das ioBroker-System stabil laufen und ist die Installation technisch nicht gefordert, muss Node.js auch nicht auf Gedeih und Verderb upgedated werden.

3. Was sollte ich vor dem Update tun?

Hinweis: Falls die Version des js-controllers <= 1.5.12 ist, muss VOR dem Update in den Einstellungen der Admin-Instanz "Verschlüsselung (https) benutzen" ausgeschaltet werden. Das in ioBroker bis dahin integrierte Zertifikat kann zu Problemen beim Starten des Admin bei Node.js-Versionen >= 10 führen.

Damit es nach dem Update zu keinen Inkompatibilitäten oder Probleme kommt sollte man alle Adapter prüfen und aktualisieren. Vor allem Adapter mit nativen Bestandteilen, wie alles mit Serialport oder Bluetooth können Probleme bereiten. Hier am besten die Adapter-Readme’s per Admin oder im GitHub prüfen, ob neue Versionen zur Verfügung stehen die die geplante Node.js Version explizit erst unterstützen. Auch wenn diese Versionen ggf. noch im „Latest“ Repository sind muss man diese vorher aktualisieren. Alternativ wartet man mit der ganzen Update-Aktion bis die neuen Versionen im „Stable“ Repository sind, schreibt den Entwickler dazu an oder fragt im Forum nach.

Wenn man diesen Schritt nicht durchführt kann es zu unnötigen Problemen beim update der Adapter kommen!

4. Step-by-step-Anleitung für Unix-Systeme

  • Zuerst muss natürlich unbedingt ein Backup erstellt werden. Dazu kann z.B. der BackItUp-Adapter genutzt oder der Kommandozeilenbefehlcd /opt/iobroker iobroker backup ausgeführt werden. Das Backup sollte aktuell sein, damit möglichst keine Daten verloren gehen.
  • Anschließend ioBroker stoppen, damit Updates keine Nebeneffekte oder Abstürze verursachen.iobroker stop Bitte anschließend im Webbrowser prüfen, dass der ioBroker-Admin danach wirklich nicht mehr startet. Sollte er weiterhin aufrufbar sein, dann den Rechner neu starten und nochmals „iobroker stop“ ausführen und erneut testen. Für die Techniker unter uns: Man kann auch mit einem Tool wie „top“ prüfen, ob noch Prozesse existieren, die mit „io.“ beginnen. Die dann mit einem beherzten „sudo kill -9 <ProzessID>“ zwangsbeenden.
  • Jetzt aktualisiert man Node.js auf die gewünschte neue Version.Unter Linux reicht es, dazu den Nodesource-Installationsbefehl für das jeweilige Betriebssystem auszuführen. Verschiedene Varianten sind unter https://github.com/nodesource/distributions#debinstall gelistet.Zum Beispiel lauten die Befehle für einen Raspberry Pi der ein Debian bzw. Raspbian-Image verwendet wie folgt, wenn man nicht als root-User (z.B. richtig mit dem User „pi“) angemeldet ist:curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash - sudo apt-get install -y nodejs Für macOS gibt einen Installer auf https://nodejs.org/en/download/ , den man einfach ausführt.Ob die Aktualisierung geklappt hat, kann man wieder mit dem Befehlnode -v überprüfen.
  • Da die Installation von Node.js einige Einstellungen am System verändert haben kann, ist es jetzt ratsam, den ioBroker-Installationsfixer aufzurufen. Das geschieht mit dem Befehlcurl -sL https://iobroker.net/fix.sh | bash - Er stellt unter anderem die für den Betrieb von ioBroker notwendigen Sicherheitseinstellungen wieder her.
  • Bei einer Aktualisierung von Node.js müssen bereits installierte JavaScript- Module im ioBroker-Ordner aktualisiert werden, da sonst Fehler bei deren Ausführung auftreten.Um diese zu aktualisieren gibt es mehrere Möglichkeiten:a) npm rebuild
    Der erste Versuch sollte immer mit dem Befehl „npm rebuild“ im ioBroker Verzeichnis stattfinden, weil dies am saubersten funktioniert und direkt von der Paketverwaltung ausgeführt wird. Im Idealfall dauert das ein paar Minuten und es könnten ein paar Warnungen gelistet werden.
    Falls es aber Fehler gibt, werden wir zusammen versuchen im nächsten Post alle bekannten Fälle mit Ihren Lösungsansätzen zu sammeln. Wenn das funktioniert ist dies der schnellste und sauberste Weg.b) reinstall-Skript
    Sollte das nicht klappen, beinhaltet der js-Controller ein reinstall-Skript („reinstall.sh“ bzw. ab js-controller 1.5.x „reinstall.js“). Dieses Skript erkennt alle installierten ioBroker-Adapter, löscht diese dann aus dem node_modules-Verzeichnis und installiert sie neu. Dieser Ansatz ist etwas aufwändiger als „npm rebuild“, erfüllt aber den gleichen Zweck. Das funktioniert generell gut, man sollte den Prozess aber nicht abbrechen. Falls es doch passiert oder es Probleme beim Starten nach dieser Prozedur gibt, dann am besten den Weg im nächsten Punkt wählen.
    Das reinstall.sh-Skript welches im js-controller 1.4 mitgeliefert wurde hat ein Formatierungsproblem und muss vorher noch für Linux mit den Befehlencd /opt/iobrokersudo mv reinstall.sh reinstall.dossudo tr -d '\r' < reinstall.dos > reinstall.shsudo chmod +x reinstall.shkorrigiert werden, damit es funktioniert.c) Reset aller Module in node_modules
    Eine weitere Variante, die gründlich ist, aber etwas Zeit kostet, ist der Ansatz einfach alles Alte unter Beibehaltung der Daten und Einstellungen neu zu installieren. Wichtig ist, das iobroker-data Verzeichnis nicht zu verändern. Häufig können mit dieser Vorgehensweise auch andere (verborgene) Installationsfehler repariert werden.Dazu löscht man zuerst das gesamte node_modules Verzeichnis im ioBroker-Verzeichnis.cd /opt/iobroker sudo rm -r node_modules/ Nachdem der Befehl abgesetzt wurde, fragt das Programm, ob in den Ordner „hinabgestiegen“ werden soll (sofern es ein tieferer Unterordner ist) und ob der (schreibgeschützte) Ordner wirklich gelöscht werden soll – beides bestätigt man mit „Ja“ (j) oder „Yes“ (y).Danach installiert man den Controller in der relevanten Version (hier z.B. 1.5.11 der aktuell die „Stable“-Version ist):npm install iobroker.js-controller@1.5.11 --productionAnschließend startet man ioBroker.iobroker start ioBroker wird korrekterweise feststellen, dass die Adapter, die er starten will, nicht installiert sind – und diese einfach automatisch nachinstallieren. Je nach System kann dies einige Zeit dauern – gern auch ein paar Stunden (oder bei langsamen SD-Karten die ganze Nacht). Aber danach ist alles aktualisiert. Der Installationsfortschritt ist im Admin im Log-Fenster zu sehen.Zu beachten ist, dass Adapter, die man manuell von GitHub installiert hat, den Fehler Can not parse null/io-package.json:Error: ENOENT: no suche file or directory ... im ioBroker-Log erzeugen.
    Diese Adapter nach Abschluss der automatischen Installationssequenz wie gehabt über das Adapterfenster manuell von GitHub nachinstallieren und nach der Installation die bestehende diesbezügliche Instanz von Hand starten.Ratsam ist es auch, im Log nach der Installation nach dem Wort yourself zu suchen. Hier werden ggf. npm-Module angezeigt, die nicht automatisch installiert wurden. Sie können/sollten manuell über die Kommandozeile mit npm i <Packetname>@<version>, ausgeführt im iobroker-Ordner, nachinstalliert werden. Dazu zuerst den ioBroker stoppen, npm ausführen und dann den ioBroker wieder starten.Wenn man dabei npm als root-User per Hand in der Kommandozeile ausgeführt hat, schlage ich zur Korrektur eventueller Berechtigungsfehler vor, vor dem Start von ioBroker das Fixerscript laufen zu lassen.cd /opt/iobrokeriobroker stopnpm i <Packetname>@<version>curl -sL https://iobroker.net/fix.sh | bash -iobroker startd) Neuinstallation mit Restore
    Eine kleine Abwandlung der letzten Variante ist eine Neuinstallation. Hierbei sichert man das „iobroker-data“ Verzeichnis (oder nutzt das Backup von oben). Dann löscht man das gesamte ioBroker-Verzeichnis und nutzt den Installer.cp -r /opt/iobroker/iobroker-data <Pfad_zum_sicheren_Ort> sudo rm -r /opt/iobroker/ sudo mkdir /opt/iobroker cd /opt/iobroker curl -sL https://iobroker.net/install.sh | bash - Direkt danach stoppt man ioBroker wieder (der ja nach der Installation automatisch gestartet wird).iobroker stop Dann löscht man den neu erstellen „iobroker-data“- Ordner und kopiert anschließend das gesicherte alte „iobroker-data“-Verzeichnis mit den darin enthaltenen Datenbanken und Dateien dorthin zurück.rm -r /opt/iobroker/iobroker-datacp -r <Pfad_zum_sicheren_Ort> /opt/iobroker/iobroker-data Anschließend wieder ioBroker starten. Der Rest läuft dann wie bei c) und dauert seine Zeit.