update

update
Zweck / Funktion
Befehl zur Aktualisierung der FHEM-Installation
Allgemein
Typ	Befehl
Details
Dokumentation	EN / DE
Support (Forum)	Sonstiges
Modulname	98_update.pm
Ersteller	rudolfkoenig (Forum / Wiki)
Wichtig: sofern vorhanden, gilt im Zweifel immer die (englische) Beschreibung in der commandref!

update ist ein Befehl zur Aktualisierung der FHEM-Installation direkt über das FHEM Webfrontend. Von den Entwicklern bis zu einem bestimmten Zeitpunkt freigegebene Änderungen sind jeweils morgens ab 8:00 Uhr über die Update Funktion verfügbar. Änderungen, die später freigegeben werden, werden dementsprechend erst am nächsten Tag verfügbar.

Syntax

update [<fileName>|all|check|force] [http://.../controlfile]

oder

update [add source|delete source|list|reset]

Hinweise:

• FHEM sichert mit den Standardeinstellungen während des Updates "nur" die aktualisierten Modul(Installations-)dateien und beispielsweise nicht die Konfiguration, Plots oder FileLogs. Soll vor dem Update ein vollständiges Backup von FHEM erstellt werden, muss das mit dem Attribut backup_before_update eingeschaltet werden.
• Lesen Sie aufmerksam die nach dem Update auf dem Monitor erscheinenden Meldungen zu Neuerungen und Änderungen.
• Nach einem Update ist immer ein shutdown restart erforderlich.
• geänderte und neu eingecheckte Module werden grundsätzlich erst am Folgetag ab ca. 8.00 Uhr durch den Update-Befehl verteilt.
• Mit dem Befehl version lässt sich die Version einzelner oder aller benutzten Module bestimmen.

Parameter

Details zu Parametern des update Befehls:

Standardaufrufe

update

Die ganze FHEM-Installation wird auf die neueste Version gebracht. Vorhandene Module werden akualisiert und neue Module installiert.

update check

Es werden alle Module aufgelistet, von denen eine neuere als die bereits installierte Version verfügbar ist. Es wird nicht installiert.

update force

Das Update wird erzwungen (falls es beim regulären update Probleme geben sollte). Dieser Befehl ist nur mit Bedacht und im Notfall einzusetzen. Sollte ein reproduzierbares Problem existieren, dies bitte im FHEM-Forum berichten, damit dem nachgegangen werden kann.

update <Dateiname>

Mit z.B. update 02_HTTPSRV.pm wird nur von der Datei 02_HTTPSRV.pm eine neue Version installiert. Alle anderen FHEM-Dateien werden nicht angetastet.

update all <controlfile>

Alle von den FHEM "offiziell" unterstützten Module sind in einem gemeinsamen Repository gespeichert. Nur diese Module werden im Standard nach der FHEM-Installation bei Aufruf des update-Befehls mit den bisher aufgeführten Parametern ohne Zusatzangaben aktualisiert bzw. installiert. Einige Entwickler stellen ihre Module aus verschiedensten Gründen nicht im gemeinsamen Repository zur Verfügung, sondern nutzen eigene, separate Repositorys. Diese sogenannten "Thirdparty-Module" können über update installiert und aktualisiert werden, wenn der Entwickler die notwendige Kontrolldatei (controlfile) zur Verfügung stellt.

Zur Installation bzw. Update ist jeweils immer nachfolgender Befehl aufzurufen (Webadresse und Kontrolldateiname sind selbstverständlich passend zu ersetzen): update all http://thirdparty.com/controls_funnymodule.txt

Repository-Verwaltung

update add <controlfile>

Fügt ein zusätzliches Repository zur Nutzung über die #Standardparameter hinzu. Ein Aufruf von update <Dateiname>|all|check|force berücksichtigt dann automatisch neben dem FHEM-eigenen Repository auch das "Thirdparty-Repository".

Nach dem Hinzufügen durch beispielsweise update add http://thirdparty.com/controls_funnymodule.txt entfällt der manuelle Aufruf der Form update all http://thirdparty.com/controls_funnymodule.txt zur Aktualiserung. Er kann aber weiterhin genutzt werden, um ausschließlich für ein bestimmtes Repositorys ein Update zu erhalten und und nicht für alle.

Die Liste der Repositorys wird in der Verwaltungsdatei FHEM/controls.txt gespeichert.

update delete <controlfile>

Entfernt eine Repository aus der Verwaltungsdatei

update list

Listet alle in der Verwaltungsdatei enthaltenen Repositorys auf.

update reset

Entfernt alle Fremd-Repositorys aus der Verwaltungsdatei. Nur das eigene Repository von FHEM wird noch von den Standardparametern berücksichtigt.

Attribute

Zur weiteren Beeinflussung der Funktionsweise des update Befehls können Attribute verwendet werden. Diese müssen für das Objekt global gesetzt werden, also mit einem Konfigurationsbefehl der Art

attr global ...

backup_before_update

siehe auch backup

restoreDirs

siehe Rücksichern beim Update überschriebener Dateien

exclude_from_update

Mit der Definition

attr global exclude_from_update ...

kann eine Liste von Dateien spezifiziert werden, die bei der Ausführung des update Befehls nicht aktualisiert werden sollen. Dateien können auch über reguläre Ausdrücke definiert werden, die einzelnen Einträge werden durch Leerzeichen voneinander getrennt.

Einen Spezialfall stellt die commandref dar, die seit einer Modifikation des Update Prozesses (März 2015, beschrieben in dieser Forendiskusion) nicht mehr heruntergeladen wird, sondern auf dem Benutzersystem durch Extraktion der Dokumentation aus den einzelnen Modulen generiert wird, angezeigt durch die Meldung im fhem.log:

Calling /usr/bin/perl ./contrib/commandref_join.pl, this may take a while.

Sollte dieser Prozess (z.B. auf einem langsamen Rechner) zu lange dauern, bleibt die Meldung

update finished, "shutdown restart" is needed to activate the changes.

aus. Wird commandref in das exclude_from_update Attribut eingetragen, entfällt dieser Schritt, die lokale commandref wird allerdings dann auch nicht mehr aktualisiert. Die modulspezifische Hilfe, die z.B. über help modulname aufgerufen werden kann, ist davon nicht betroffen.

Anwendungsbeispiel

Durchführung eines Updates

Zunächst kann mit dem Befehl

update check

überprüft werden, ob es überhaupt ein neues Update gibt und welche Dateien hierbei ausgetauscht würden (die angezeigten Infos sollten in einer Textdatei gesichert werden. Mit diesen Infos kann gezielter nach Problemen, die vielleicht nach einem Update auftreten, gesucht werden). Anschließend kann mittels:

update

das Update eingespielt werden. Hierbei ist zu beachten, dass die Befehle auf der FHEM Webseite oben (Befehls-Eingabefeld) eingegeben werden und anschließend die "Enter" Taste auf der Tastatur gedrückt werden muss.

Gibt es kein Update für FHEM, sieht die Ausgabe z.B. nach "update check" wie folgt aus:

List of new / modified files since last update:

nothing to do...

Rücksichern beim Update überschriebener Dateien

Per default werden vor dem Überschreiben alle Dateien in einem neuen Verzeichnis (restoreDir/Datum) gesichert. Diese Dateien kann man einzeln oder komplett mit dem Befehl restore zuruecksichern (z.Bsp.: restore 2014-08-19 oder restore 2014-08-19/fhem.pl). Mit dem restoreDirs Attribut kann man die Anzahl der aufgehobenen Sicherungen (== Datum-Verzeichnisse) bestimmen, die Voreinstellung ist 3. Mit 0 kann man das Feature komplett abschalten.