Update README design and documentation

2026-08-16 20:28:28 +02:00
1 parent f3e3ff0282
commit 3148acc2df
@@ -6,33 +6,64 @@

 Sammlung eigener Plugins und Erweiterungen für **Checkmk Community 2.5.x**.

+Die Erweiterungen werden für die eigene Monitoring-Umgebung entwickelt und getestet. Jedes Plugin besitzt einen eigenen Ordner mit Dokumentation, Source-Code und installierbarem MKP-Paket.
+
 ## 📦 Verfügbare Plugins

 ### 🔗 Remote Access
-Direkter SSH- und RDP-Zugriff aus der Checkmk-Weboberfläche. **Version:** `1.4.4`

- 🐧 SSH für Linux-/Unix-Systeme
- 🪟 RDP für Windows
- automatische Erkennung über Checkmk Host Labels
- Integration in `Setup → Hosts` und Monitoring Views
- eigene SSH-/RDP-Icons
+Direkter SSH- und RDP-Zugriff auf überwachte Hosts aus der Checkmk-Weboberfläche.

-➡️ [Dokumentation](remote_access/README.md) · 📦 [MKP](remote_access/packages/remote_access-1.4.4.mkp)
+**Aktuelle Version:** `1.4.4`
+
+<p>
+  <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/linux.svg" width="22" height="22" alt="Linux"> SSH für Linux-/Unix-Systeme&nbsp;&nbsp;
+  <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/windows.svg" width="22" height="22" alt="Windows"> RDP für Windows-Systeme
+</p>
+
+- Automatische Betriebssystemerkennung über Checkmk Host Labels
+- Verwendung der von Checkmk ermittelten Host-IP
+- Integration in `Setup → Hosts`
+- Integration in Checkmk Monitoring Views
+- Eigene SSH- und RDP-Icons
+- Direkter SSH-Aufruf über `ssh://`
+- Direkter RDP-Aufruf über `rdpadmin://`
+
+➡️ [Dokumentation](remote_access/README.md)  
+📦 [MKP-Paket](remote_access/packages/remote_access-1.4.4.mkp)

 ### 🖥️ OS Info
-Zeigt Betriebssysteminformationen als eigenen Checkmk-Service. **Version:** `1.0.0`

- 🐧 Linux · 🪟 Windows · 🍎 macOS
- Betriebssystem / Distribution und Version
- Windows-Build, Architektur und Kernel-Version
+Zeigt Betriebssysteminformationen eines überwachten Hosts als eigenen Checkmk-Service an.

-➡️ [Dokumentation](os-info/README.md) · 📦 [MKP](os-info/dist/os_info-1.0.0.mkp)
+**Aktuelle Version:** `1.0.0`
+
+<p>
+  <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/linux.svg" width="24" height="24" alt="Linux"> <strong>Linux</strong>&nbsp;&nbsp;
+  <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/windows.svg" width="24" height="24" alt="Windows"> <strong>Windows</strong>&nbsp;&nbsp;
+  <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/apple.svg" width="24" height="24" alt="macOS"> <strong>macOS</strong>
+</p>
+
+- Betriebssystem bzw. Distribution
+- Version / Windows-Build
+- Architektur
+- Kernel-Version
+- OS-ID und Version-ID
+
+➡️ [Dokumentation](os-info/README.md)  
+📦 [MKP-Paket](os-info/dist/os_info-1.0.0.mkp)

 ## 🛠️ Umgebung und Kompatibilität

-Primär entwickelt und getestet mit Checkmk Community Edition 2.5.x, Checkmk Agent 2.5 sowie Linux- und Windows-Hosts.
+Primär entwickelt und getestet mit:

-> Andere Checkmk-Versionen oder Editionen können funktionieren, werden aber nicht zwingend getestet.
+- Checkmk Community Edition
+- Checkmk 2.5.x
+- Checkmk Agent 2.5
+- Linux-Hosts
+- Windows-Hosts
+
+> Die Kompatibilität mit anderen Checkmk-Versionen oder Editionen ist nicht grundsätzlich ausgeschlossen, wird aber nicht zwingend getestet.

 ## 📂 Repository-Struktur

@@ -53,22 +84,59 @@ cmk-plugins/
    └── src/
 ```

+Jedes Plugin wird unabhängig versioniert und dokumentiert.
+
 ## 📥 Installation von MKP-Paketen

+Das gewünschte `.mkp`-Paket auf den Checkmk-Server übertragen und als Site-Benutzer installieren:
+
 ```bash
 mkp add /pfad/zum/plugin.mkp
 mkp enable PLUGIN_NAME VERSION
 ```

-Je nach Plugin anschließend `cmk -R` oder bei Web-Erweiterungen `omd restart apache`. Details stehen in der jeweiligen Plugin-README.
+Je nach Plugin anschließend beispielsweise:
+
+```bash
+cmk -R
+```
+
+oder bei Web-Erweiterungen:
+
+```bash
+omd restart apache
+```
+
+Installierte Pakete anzeigen:
+
+```bash
+mkp list
+```
+
+Die plugin-spezifischen Installationsschritte stehen in der jeweiligen README.

 ## 🏷️ Releases und Versionierung

-Plugins werden unabhängig versioniert. Git-Tags verwenden das Schema `PLUGIN_NAME-vVERSION`, z. B. `remote_access-v1.4.4` oder `os_info-v1.0.0`.
+Die Plugins werden unabhängig voneinander versioniert. Git-Tags verwenden das Schema:
+
+```text
+PLUGIN_NAME-vVERSION
+```
+
+Beispiele:
+
+```text
+remote_access-v1.4.4
+os_info-v1.0.0
+```
+
+## 🧑‍💻 Entwicklung
+
+Der Source-Code befindet sich im jeweiligen Plugin-Verzeichnis unter `src/`. Die Verzeichnisstruktur orientiert sich möglichst an der späteren Struktur innerhalb der Checkmk-Site.

 ## ⚠️ Hinweise

-Vor dem produktiven Einsatz sollte jede Erweiterung zunächst in einer Testumgebung geprüft werden.
+Die Plugins wurden primär für die eigene Checkmk-Umgebung entwickelt. Vor dem Einsatz in produktiven Umgebungen sollte die jeweilige Erweiterung zunächst in einer Testumgebung geprüft werden.

 ## 👤 Autor