Diese Seite bearbeiten Links hierher Zu Buch hinzufügen PDF exportieren Buch erstellen Diese Seite zum Buch hinzufügen Buch erstellen Diese Seite aus Buch entfernen Buch anzeigen, ändern (0 Seite/n) Hilfe Installation von Codabix Codabix ist für folgende Betriebssysteme und Hardwarekonfigurationen verfügbar: Codabix für Windows (x64, Arm64) Codabix für Linux (x64, Arm64, Arm32) Codabix für Windows Die aktuelle Version von Codabix für Windows benötigt eine 64-Bit-Version (x64, Arm64) von Windows 10 Version 1607 bzw. Windows Server 2016 oder höher. Systemanforderungen Unterstützte Betriebssysteme Codabix für Windows wird auf folgenden Betriebssystemen unterstützt (Architekturen x64 und Arm64): Windows-Version Workstation-Betriebssystem Server-Betriebssystem 10.0.14393 Windows 10 [IoT] Enterprise 2016 LTSB Windows Server 2016 (Option „Server mit Desktopdarstellung“) 10.0.17763 Windows 10 [IoT] Enterprise LTSC 2019 Windows Server 2019 (Option „Server mit Desktopdarstellung“, oder „Server Core“ mit installiertem Server Core App Compatibility FOD) 10.0.19044 Windows 10 Version 21H2 (November 2021 Update) 10.0.19045 Windows 10 Version 22H2 (2022 Update) 10.0.20348 Windows Server 2022 (Option „Server mit Desktopdarstellung“, oder „Server Core“ mit installiertem Server Core App Compatibility FOD) 10.0.22000 Windows 11 Version 21H2 10.0.22621 Windows 11 Version 22H2 (2022 Update) 10.0.22631 Windows 11 Version 23H2 (2023 Update) Hardwareanforderungen Empfohlen: 64-Bit Quad-Core CPU, 8 GB RAM Anforderungen für die Backend-Datenbank Standardmäßig benutzt Codabix eine eingebettete Datenbank (SQLite), welche keine weiteren Anforderungen stellt. Wenn Sie hingegen planen, MySQL, MariaDB oder Microsoft SQL Server als Backend-Datenbank zu nutzen, stellen Sie bitte sicher, dass Sie MySQL 8.0 oder höher, MariaDB 10.3 oder höher, bzw. Microsoft SQL Server 2014 oder höher verwenden. Wir empfehlen, MySQL, MariaDB bzw. MSSQL auf der selben Maschine wie Codabix auszuführen. Codabix Setup und erster Start Codabix Setup Um Codabix zu installieren, laden Sie bitte den Codabix Installer (MSI-Datei) herunter und führen ihn aus. Sie können dabei auswählen, welche Devices und Plugins mit Codabix installiert werden sollen. Um Codabix zu installieren, laden Sie bitte den Codabix Installer (MSI-Datei) herunter und führen ihn aus. Sie können dabei auswählen, welche Devices und Plugins mit Codabix installiert werden sollen. Installieren und Deinstallieren von Plugins Wenn Sie Ihre Codabix-Installation zu einem späteren Zeitpunkt ändern möchten (z. B. um Plugins hinzuzufügen oder zu entfernen), starten Sie einfach den Codabix Installer erneut (alternativ können Sie auch in der Windows-Systemsteuerung auf „Programme und Features“ gehen, dann „Codabix“ wählen und auf „Ändern“ klicken). Sie können dann im Installer auf „Change“ klicken, um die Plugins von Codabix auszuwählen, die installiert oder deinstalliert werden sollen. Codabix updaten Wenn Sie bereits Codabix installiert haben und auf eine neuere Version updaten möchten, müssen Sie nicht extra die alte Version deinstallieren. Führen Sie einfach den Codabix Installer der neueren Version aus und dieser wird automatisch Codabix auf die neue Version updaten. Hinweis: Wenn Sie Codabix als Dienst installiert hatten, müssen Sie nach dem Update den Dienst im Codabix Settings-Dialog erneut installieren. Erster StartSie können Codabix starten, indem Sie auf die Codabix-Verknüpfung am Desktop doppelklicken, oder folgendes Kommando auf der Kommandozeile ausführen (z.B. unter Windows Server Core): "%ProgramFiles%\TIS\Codabix\codabix-ui.exe" "%ProgramFiles%\Traeger\Codabix\codabix-ui.exe" Wenn Sie Codabix das erste Mal starten, werden Sie zur Auswahl eines Projektverzeichnisses aufgefordert (idealerweise ein leerer Ordner), in welchem Codabix seine Daten (Einstellungen, Datenbank, Konfiguration, Logdateien usw.) abspeichern soll. Nachdem Sie die Auswahl bestätigt haben, erscheint der Settings-Dialog (siehe nächster Abschnitt). Klicken Sie bitte auf OK, um die Einstellungen anzuwenden. Nun werden Sie aufgefordert, ein Admin-Passwort zu setzen. Dieses benötigen Sie später für die Webkonfiguration. Hinweis: Möglicherweise wird ein Dialog der Windows Firewall angezeigt, in dem Sie gefragt werden, ob der Zugriff auf Codabix erlaubt werden soll. Dies kommt vom OPC UA Server Plugin, welches standardmäßig einen OPC UA Server auf Port 4840 erstellt. Wenn Sie auf „Zugriff erlauben“ klicken, können andere Geräte im Netzwerk auf den OPC-Server zugreifen. Nachdem Sie das Passwort gesetzt haben und Codabix gestartet ist, erscheint der Login-Dialog der Webkonfiguration. Hier können Sie sich nun mit dem Benutzernamen admin und Ihrem zuvor gesetzten Passwort einloggen. Codabix Projekteinstellungen Codabix bietet Einstellungen für das ausgewählte Projekt an, die Sie konfigurieren können. Um diese zu editieren, klicken Sie auf das Zahnrad-Icon in der Symbolleiste oben rechts (), über das sich der Codabix Settings-Dialog öffnet. Basic Settings Name Beschreibung Project Directory Das Projektverzeichnis ist das Verzeichnis, in dem Codabix die Projekteinstellungen (alle der folgenden Einstellungen), die Backend-Datenbank (wenn Back-end Database Mode auf „Embedded (SQLite)“ eingestellt ist), Logdateien und Konfigurationsdateien für die Plugins ablegt. Es kann über die Umgebungsvariable %CodabixProjectDir% abgerufen werden, z.B. in Scripts. Es enthält folgende Ordner: • log: Enthält die Codabix Runtime-Logdateien und Logdateien des Entity Models. • plugins: Enthält Konfigurationsdateien für Plugins. • webfiles: In diesem Ordner können Sie statische Dateien ablegen, die über den Codabix Webserver für mit /webfiles/ anfangende URLs abrufbar sein sollen, falls die Einstellung Serve Static Web Files aktiviert ist. • dashboard: Ähnlich wie webfiles, aber für URLs die mit /dashboard/ anfangen, wodurch das eingebettete Dashboard außer Kraft gesetzt und ein eigenes verwendet werden kann. • userdata: In diesem Ordner können Sie benutzerdefinierte Dateien ablegen (z.B. für die Verwendung in Scripts). Bei diesem Ordner ist garantiert, dass er in zukünftigen Codabix-Versionen nicht anderweitig verwendet wird. Beim Erstellen eines Backups werden die Inhalte dieser Unterordner im Backup mit abgelegt. Project Name Ermöglicht Ihnen, einen Namen für das aktuelle Projekt festzulegen, welcher in der Titelleiste der Codabix-Anwendung angezeigt wird und für den Standard-Dateinamen beim Erstellen eines Backups verwendet wird. Access Security Innerhalb von Codabix kann die Projektlogik auf Dateien Ihres Systems zugreifen, z.B. durch die Verwendung von File Nodes (auf die dann per HTTP-Access-URL oder über einen OPC UA Client zugegriffen werden kann), oder durch ein Script , das die io.file- und io.directory-Namespaces benutzt. Um einen Benutzer, der das Codabix-Adminpasswort hat (oder Scripts oder File-Nodes in Codabix erstellen kann), daran zu hindern, auf beliebige Dateien zuzugreifen (vor allem wenn Codabix als Dienst läuft), können Sie Zugriff auf bestimmte Pfade erlauben oder verweigern. Außerdem können Sie alternative Zugangsdaten angeben, die beim Zugriff auf den Pfad benutzt werden sollen (dies geschieht über Impersonation), oder alternativ den Pfad als Netzwerkresource hinzufügen. Standardmäßig ist der Level Normal gesetzt, welcher die Unterordner plugins, log, userdata, webfiles, dashboard innerhalb des Projektverzeichnisses für Lese- und Schreibzugriff zulässt. Sie können zusätzliche Verzeichnis-/Dateipfade definieren, auf die lesender oder schreibender Zugriff erlaubt sein soll. Log Level Gibt das Logging-Detaillevel an, das Codabix beim Schreiben von Logdateien benutzen soll. Es werden nur solche Einträge geschrieben, deren Schweregrad mindestens so hoch ist wie das angegebene Level. 'No' bedeutet, dass keine Logdateien erstellt werden. Back-end Database Mode Gibt an, welche Backend-Datenbank benutzt werden soll. Standardmäßig verwendet Codabix eine eingebettete Datenbank (SQLite), welche keine Konfiguration benötigt. Die eingebettete Datenbank wird in den Dateien codabix.db und codabixhistorydb.db im eingestellten Projektverzeichnis gespeichert. Sie können für bessere Performance jedoch auch MySQL 8.0 oder höher, MariaDB 10.3 oder höher bzw. Microsoft SQL Server 2014 oder höher (mit SQL-Server-Authentifizierung) als Backend-Datenbank verwenden. Wenn Sie dementsprechend „MySQL/MariaDB“ oder „Microsoft SQL Server“ auswählen, müssen Sie die weiteren Einstellungen unter der Kategorie „MySQL/MariaDB/MSSQL Settings“ ausfüllen. Beim Erstellen eines Backups werden die Inhalte der Backend-Datenbank im Backup mit abgelegt. Sie können auch die aktuelle Backend-Datenbank von SQLite nach MySQL/MariaDB/MSSQL (oder von MySQL/MariaDB/MSSQL nach SQLite) migrieren, indem Sie ein Backup erstellen, den Database Mode umstellen und anschließend das Backup wiederherstellen. Web Server Settings Name Beschreibung Web Server Mode Gibt den Modus des eingebetteten Webservers an, den Codabix zum Bereitstellen der Webkonfiguration, der Dashboards-App, des REST/SignalR Interfaces, der registrierten Script-HTTP-Handler sowie optional vom Benutzer bereitgestellter statischer Dateien verwendet. Kestrel ist über Socket-APIs implementiert und wird standardmäßig verwendet, da dieser generell die beste Performance bietet. Bei der Verwendung von HTTPS müssen SSL-Zertifikate als PFX- (PKCS #12)-Dateien (.pfx, .p12) bereitgestellt werden und werden in der Codabix-Settings-Datei abgelegt (verschlüsselt mit dem Password-Key des Projekts). Die Windows HTTP Server API (HTTP.sys) wird unter Windows unterstützt, und ermöglicht das Teilen von Ports mit anderen IIS-Websites. Bei der Verwendung von HTTPS müssen SSL-Zertifikate im Windows-Zertifikatsspeicher abgelegt werden (siehe unten). Um Remote HTTP Bindings nutzen zu können, muss Codabix als Dienst installiert werden. Local HTTP Port Gibt den Port an, den der eingebettete Webserver zum Lauschen auf lokale Verbindungen verwendet. Standardmäßig benutzt Codabix den Port 8181. Dieser Port kann optional auch als Remote HTTP Binding verwendet werden. Hinweis: Wenn Sie Windows HTTP Server API als Web Server Mode verwenden und Ports ≤ 1024 (z. B. Port 80) verwenden möchten oder die Codabix Webkonfiguration, die Dashboards-App oder das REST/SignalR Interface auf anderen Geräten im Netzwerk aufrufen möchten (und Sie dafür die Option „Use the Local Port as remote HTTP Binding“ in den „HTTP(S) Bindings“-Optionen aktiviert haben), müssen Sie Codabix als Dienst installieren (siehe unten). Anderenfalls sind nur Ports > 1024 möglich und auf Codabix kann über HTTP nur vom lokalen PC aus zugegriffen werden. HTTP(S) Bindings Sie können HTTP- und HTTPS-Bindings, bestehend aus Hostnamen, Port und SSL-Zertifikat (für HTTPS), für Remoteverbindungen aktivieren. Dies ermöglicht Ihnen, eine Verbindung zu Codabix von fremden Geräten herzustellen, optional über eine authentifizierte und verschlüsselte TLS-Verbindung. Hinweis: Um ein SSL-Zertifikat für den Webserver-Modus Windows HTTP Server API verwenden zu können, muss dieses im Personal- oder im Web Hosting-Zertifikatsspeicher des Kontos Lokaler Computer in Windows gespeichert sein und Sie müssen einen privaten Schlüssel für das Zertifikat besitzen. Zwischenzertifikate (auch CA-Zertifikat genannt) müssen im Intermediate Certificate Authorities-Zertifikatsspeicher gespeichert sein. Um Zertifikate unter Windows zu verwalten, können Sie MMC verwenden, indem Sie certlm.msc starten und dann den Ordner Eigene Zertifikate (bzw. Webhosting) für Ihr Zertifikat sowie Zwischenzertifizierungsstellen für Ihre Zwischenzertifikate öffnen; oder Sie können Powershell verwenden, wenn Sie zum Pfad Cert:\LocalMachine\My (oder Cert:\LocalMachine\WebHosting) für Ihr Zertifikat sowie Cert:\LocalMachine\CA für Ihre Zwischenzertifikate wechseln. Serve Static Web Files Falls aktiviert, liefert der eingebettete Webserver statische Dateien aus, die in dem webfiles-Ordner des Projektverzeichnisses platziert werden. Dies ermöglicht Ihnen in Kombination mit dem neuen Script-HTTP-Handler-Feature (siehe unten), Webapps zu entwickeln, die durch Codabix ausgeliefert werden (z.B. zur Visualisierung). Custom HTTP Redirect URL Wenn nicht angegeben, werden Request für den Root-Pfad (/) zur Codabix Webkonfiguration weitergeleitet. Alternativ können Sie eine eigene Weiterleitungs-URL angeben. Das ist nützlich, wenn Ihre Benutzer beim Aufruf der Codabix-Adresse im Browser direkt Ihre eigene Webapp zu sehen bekommen sollen, die durch den eingebetteten Webserver ausgeliefert wird. MySQL/MariaDB/MSSQL Settings (nur anwendbar wenn Back-end Database Mode auf „MySQL/MariaDB“ oder „Microsoft SQL Server“ gestellt ist) Name Beschreibung Hostname Gibt den Hostnamen des MySQL-/MariaDB-/MSSQL-Servers an. Wenn MSSQL verwendet wird und der Port leer ist, wird der Hostname als Data Source interpretiert (z.B. <ComputerName>\<InstanceName>). Andernfalls ist dies der Hostname für TCP-Verbindungen. Port Gibt den TCP-Port des MySQL-/MariaDB-/MSSQL-Servers an. Dieser kann leer sein, wodurch der Standard-Port verwendet wird (für MySQL/MariaDB), oder um den Hostnamen als Data Source zu verwenden (für MSSQL). Database Name Gibt den Namen der Datenbank an, welche Codabix auf dem MySQL-/MariaDB-/MSSQL-Server benutzen soll. Wenn die angegebene Datenbank nicht existiert, legt Codabix diese sowie alle dazugehörigen Tabellen automatisch beim Übernehmen der Project Settings an. User Name Gibt den Benutzernamen an, unter welchem Codabix die Datenbankverbindung herstellen soll. Password Gibt das zugehörige Passwort des Benutzers an. Codabix als Dienst installieren Sie können Codabix als Dienst installieren. Dadurch wird Codabix automatisch und dauerhaft im Hintergrund (wie auf einem Server) ausgeführt, ohne dass explizit die Codabix-Anwendung gestartet werden muss. Nachdem Sie den Codabix Settings-Dialog über das Zahnrad-Icon in der Symbolleiste oben rechts () geöffnet haben, zeigt dieser unten den Abschnitt „Service Management“ an, über den Sie Codabix als Dienst installieren, starten, stoppen und deinstallieren können: Sie können Codabix als Dienst installieren und starten, indem Sie auf den Button „Install + Start Service“ klicken. In diesem Fall wird ein Dialog der Benutzerkontensteuerung (UAC) angezeigt, da für das Installieren von Diensten Administratorrechte erforderlich sind. Um den Dienst wieder zu deinstallieren, klicken Sie auf den „Uninstall Service“-Button. Hinweis: Wenn Sie eine Einstellung wie das Projektverzeichnis oder den HTTP-Port ändern, während Codabix als Dienst läuft, muss der Dienst neugestartet (oder neu installiert) werden, um die neuen Einstellungen anzuwenden. Dies wird durch den folgenden Dialog angezeigt, über den Sie den Dienst neustarten/neu installieren lassen können: Hinweis: Der Dienst ist so konfiguriert, dass er im Fehlerfall automatisch neustartet. Dadurch wird sichergestellt, dass Codabix in einen sauberen, definierten Zustand neustarten kann, nachdem ein schwerwiegender Fehler aufgetreten ist. Backup erstellen Beim Klick auf erscheint folgender Dialog: Backup wiederherstellen Beim Klick auf erscheint folgender Dialog: Lizenzverwaltung Maschinencode Wenn Sie eine Lizenz für Codabix bestellen, ist es notwendig, den Maschinencode derjenigen Maschine bereitzustellen, auf der Codabix läuft. Um den Maschinencode zu erhalten, klicken Sie in der Codabix-Anwendung auf das Schlüsselsymbol (), um den Lizenzdialog zu öffnen. Klicken Sie anschließend auf den Button „Copy Machine Code“, um den lokalen Maschinencode in die Zwischenablage zu kopieren. Codabix für Linux Systemanforderungen Unterstützte Betriebssysteme Codabix für Linux wird auf den folgenden Linux-Distributionen unterstützt: Debian 11 (Bullseye) oder höher (x64, Arm64, Arm32) inklusive Derivate wie Raspberry Pi OS (für Raspberry Pi) Ubuntu 20.04 oder höher (x64, Arm64) Fedora 37 oder höher (x64) OpenSUSE Leap 15.0 oder höher (x64) Hardwareanforderungen Raspberry Pi: Codabix für Linux (Arm64) kann auf einem Raspberry Pi 4 oder neuer (mit 64-Bit OS, mit mindestens 2 GB RAM) ausgeführt werden. Codabix für Linux (Arm32) kann auf einem Raspberry Pi 3 oder neuer ausgeführt werden. Für optimale Performance empfehlen wir, Codabix (Arm64) auf einem Raspberry Pi 4 (oder neuer) mit 4 GB oder 8 GB auf einem 64-Bit OS auszuführen. Andere Maschinen: Empfohlen: 64-Bit Quad-Core CPU (x64/Arm64), 8 GB RAM, 64-Bit OS und Codabix Anforderungen für die Backend-Datenbank Standardmäßig benutzt Codabix eine eingebettete Datenbank (SQLite), welche keine weiteren Anforderungen stellt. Wenn Sie hingegen planen, MySQL, MariaDB oder Microsoft SQL Server als Backend-Datenbank zu nutzen, stellen Sie bitte sicher, dass Sie MySQL 8.0 oder höher, MariaDB 10.3 oder höher, bzw. Microsoft SQL Server 2014 oder höher verwenden. Nicht unterstützte Features Einige Features sind in Codabix für Linux nicht verfügbar. Dies beinhaltet: Windows-spezifische Plugins wie Melsec QJ Device Plugin, H1 Device Plugin, AKLAN Device Plugin Zugriff auf OPC Classic (COM)-Server über das OPC UA Client Device Plugin Benutzerauthentifizierung über Active Directory Impersonation für Dateien mit anderen Credentials (oder das Herstellen einer SMB-Netzwerkverbindung), z.B. für File-Nodes oder bei Benutzung des CSV Exchange Plugins GUI-Fenster (Sie können die Codabix Webkonfiguration in einem Browser öffnen, aber administrative Aufgaben wie das Einstellen des Projektverzeichnisses, Installieren des Dienstes usw. müssen in der Codabix-Shell-Konsolenanwendung ausgeführt werden) Installieren von Codabix und erster Start Installieren von Codabix für LinuxUm Codabix für Linux zu installieren, laden Sie die .setup-Datei herunter und führen Sie folgendes Kommando aus, um die Datei ausführbar zu machen: chmod +x codabix-<platform>-<release-date>-<release-version>.setup Starten Sie im nächsten Schritt das Setup: sudo ./codabix-<platform>-<release-date>-<release-version>.setup Das Setup leitet Sie durch die Installation. Alte Installationen von Codabix werden nicht gelöscht, um bei Bedarf ein Roll-Back durchführen zu können. Das Backup, das für einen solchen Roll-Back notwendig ist, kann während des Setups erstellt werden. Erster StartUm die konsolenbasierte Codabix Shell zu starten, führen Sie das folgende Kommando aus: codabix Codabix sollte nun starten und nach einem Projektverzeichnis fragen: Geben den vollständigen Pfad ein, unter dem Sie das Codabix-Projektverzeichnis ablegen wollen (normalerweise ein Ordner in Ihrem Home-Verzeichnis) (siehe Codabix Projekteinstellungen). Drücken Sie anschließend zweimal Enter, um die Einstellungen anzuwenden und Codabix neuzustarten. Codabix bittet Sie nun darum, ein neues Admin-Passwort zu setzen; bitte geben Sie hier ein neues Passwort ein: Anschließend können Sie http://localhost:8181/config/ in einem Browser auf Ihrer Maschine (wenn Ihre Linux-Distribution mit einer GUI installiert wurde) aufrufen, um die Codabix-Webkonfiguration zu öffnen, oder rufen Sie http://<IP-Addresse>:8181/config/ in einem Browser auf einer anderen Maschine auf, um die Web-Konfiguration übers Netzwerk zu öffnen. Verwenden von Codabix als Service Codabix als Service installierenUm Codabix als Service zu installieren, starten Sie die Codabix Shell mit folgendem Kommando:codabix Wählen Sie im Kommandozeilen-Menü die Option 6, um das Service-Management aufzurufen: Mit der Option 1 installieren und starten Sie im Service-Management Codabix als Service: Nach erfolgreichem Start des Services wird der Status Service is running in der Kommandozeile angezeigt: Sie können nun die Codabix Shell mit 9 beenden und der Service läuft im Hintergrund weiter. Bei Neustart des Betriebssystems wird der Service zukünftig automatisch gestartet. Status des Codabix ServiceUm den aktuellen Status des Codabix Service (Running, Stopped) abzurufen, starten Sie die Codabix Shell:codabix Nach dem Start wird der aktuelle Status des Services angezeigt: Codabix Service (neu)starten, stoppen und deinstallierenUm den Codabix Service zu starten, stoppen oder deinstallieren, öffnen Sie die Codabix Shell:codabix Hier rufen Sie mit 6 das Service-Management auf Wählen Sie nun die gewünschte Funktion: Lizenzverwaltung Maschinencode Wenn Sie eine Lizenz für Codabix bestellen, ist es notwendig, den Maschinencode derjenigen Maschine bereitzustellen, auf der Codabix läuft. Um den Maschinencode zu erhalten, führen Sie das folgende Kommando auf der Kommandozeile (bash) aus: codabix --machinecode Dies gibt den lokalen Maschinencode auf dem Terminal aus, z.B.: $ codabix --machinecode U7f3lqK5bG04fIVUNX5yhWgNlG6PnSKbvHuY6Ml610gAAgAA9+w5OG0p0AFgKyfQPVjBO9rId87pLs29nC+CHQ== Alternativ können Sie den Maschinencode in der Codabix-Shell-Anwendung anzeigen, indem Sie license im Hauptmenü eingeben, um die Lizenzverwaltung zu öffnen. Dort wird der lokale Maschinencode oben angezeigt: Inhaltsverzeichnis Codabix für Windows Systemanforderungen Codabix Setup und erster Start Codabix Projekteinstellungen Basic Settings Web Server Settings MySQL/MariaDB/MSSQL Settings Codabix als Dienst installieren Backup erstellen Backup wiederherstellen Lizenzverwaltung Maschinencode Codabix für Linux Systemanforderungen Installieren von Codabix und erster Start Verwenden von Codabix als Service Lizenzverwaltung Maschinencode