Update README design and documentation

This commit is contained in:
dbildhauer committed 2026-08-16 20:28:28 +02:00
1 parent f3e3ff0282
commit 3148acc2df
3 files changed
+220 -55

No files matched your search

+68 -10
View File
@@ -13,21 +13,58 @@ Direkter **SSH- und RDP-Zugriff** auf überwachte Hosts aus der Checkmk-Weboberf
## ✨ Funktionen
### 🐧 Linux / Unix
Das Plugin erweitert Checkmk um Remote-Access-Funktionen für Linux-/Unix- und Windows-Hosts.
Automatischer SSH-Zugriff, z. B. `ssh://192.168.188.125`. Unterstützt werden Linux, Unix, FreeBSD, OpenBSD, Solaris und AIX.
### <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/linux.svg" width="24" height="24" alt="Linux"> Linux / Unix
### 🪟 Windows
Für Linux- und Unix-Systeme wird automatisch ein SSH-Zugriff angeboten:
RDP über `rdpadmin://192.168.188.122`. Der eigene Windows Protocol Handler startet anschließend `mstsc.exe`.
```text
ssh://192.168.188.125
```
Unterstützt werden Linux, Unix, FreeBSD, OpenBSD, Solaris und AIX.
### <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/windows.svg" width="24" height="24" alt="Windows"> Windows
Für Windows-Systeme wird ein RDP-Zugriff angeboten:
```text
rdpadmin://192.168.188.122
```
`rdpadmin://` verwendet einen eigenen Windows Protocol Handler, der `mstsc.exe` startet.
## 🔌 Checkmk-Integration
In `Setup → Hosts` erscheinen abhängig vom Betriebssystem SSH- bzw. RDP-Aktionen. Zusätzlich werden die Aktionen in die Icons-Spalte der Monitoring Views integriert.
### Setup → Hosts
Abhängig vom Betriebssystem werden ein SSH- bzw. RDP-Icon sowie `Open SSH ↗` oder `Open RDP ↗` angezeigt.
### Monitoring
SSH und RDP werden zusätzlich in die Icons-Spalte der Checkmk Monitoring Views integriert.
## 🔎 Automatische Betriebssystemerkennung
Die Auswahl von SSH oder RDP erfolgt anhand der Checkmk Host Labels, insbesondere `cmk/os_family`. Als Ziel wird bevorzugt `host_address` verwendet.
Die Entscheidung zwischen SSH und RDP erfolgt anhand der von Checkmk ermittelten Host-Labels.
Linux:
```text
cmk/os_family: linux
cmk/os_platform: ubuntu
cmk/os_name: Ubuntu
cmk/os_version: 22.04
```
Windows:
```text
cmk/os_family: windows
```
Als Ziel verwendet das Plugin bevorzugt `host_address`.
## 📥 Installation
@@ -49,7 +86,7 @@ mkp enable remote_access 1.4.4
omd restart apache
```
Danach gegebenenfalls einen Hard-Reload im Browser durchführen.
Anschließend im Browser gegebenenfalls einen Hard-Reload durchführen.
## 🧑‍💻 Source-Code
@@ -60,9 +97,27 @@ src/local/share/check_mk/web/htdocs/images/icons/remote_access_ssh.svg
src/local/share/check_mk/web/htdocs/images/icons/remote_access_rdp.svg
```
## 🖥️ Windows SSH / RDP
`remote_access_setup.py` integriert die Funktionen in `Setup → Hosts`.
Für `ssh://` muss unter Windows ein geeigneter SSH-Client zugeordnet sein; getestet wurde PuTTY. Für RDP startet der `rdpadmin://`-Handler `mstsc.exe`, ohne `.rdp`-Dateien herunterzuladen.
`remote_access_views.py` integriert die Remote-Access-Icons in die Monitoring Views über `multisite_icons_and_actions`.
## <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/windows.svg" width="24" height="24" alt="Windows"> Windows SSH
Damit `ssh://` unter Windows funktioniert, muss das Protokoll einem geeigneten SSH-Client zugeordnet sein. Getestet wurde PuTTY.
```text
putty.exe 192.168.188.125
```
## <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/windows.svg" width="24" height="24" alt="Windows"> Windows RDP
Für RDP wird `rdpadmin://` verwendet:
```text
rdpadmin://192.168.188.122
```
Der Protocol Handler startet `mstsc.exe`; dadurch müssen keine `.rdp`-Dateien heruntergeladen werden.
## 🧰 Fehlerdiagnose
@@ -70,6 +125,7 @@ Für `ssh://` muss unter Windows ein geeigneter SSH-Client zugeordnet sein; gete
tail -n 50 ~/var/log/web.log
: > ~/var/log/web.log
omd restart apache
cat ~/var/log/web.log
```
## ✅ Status 1.4.4
@@ -99,4 +155,6 @@ remote_access/
## ⚖️ Lizenz
Dieses Plugin wurde für den Einsatz mit Checkmk Community entwickelt. Checkmk ist eine Marke der Checkmk GmbH.
Dieses Plugin wurde für den Einsatz mit Checkmk Community entwickelt.
Checkmk ist eine Marke der Checkmk GmbH.