Merge pull request 'Readme' (#50) from documentation/readme into development

Reviewed-on: daniel-hbn/Watcher#50
This commit is contained in:
2025-06-28 20:17:18 +00:00

View File

@@ -1,3 +1,34 @@
# Watcher
# 🖥️ Server Monitoring Software
Monitoring Tool für Server, VMs und Docker Container.
Dieses Projekt ist eine umfassende Monitoring-Lösung für Server und Host-Geräte.
Die Software besteht aus zwei Teilen:
- **Host Agent**: Sammelt Hardware-Daten von den Hosts
- **Zentrale Monitoring-Software**: Visualisiert und verwaltet die gesammelten Daten
Die Lösung unterstützt moderne Authentifizierungsverfahren und flexible Datenbankanbindungen alles bequem verteilt als Docker Image.
---
## ✨ Features
- Erfassung von Hardware-Daten aller wichtigen Komponenten
- Lokale Authentifizierung oder OIDC (OpenID Connect)
- Wahlweise Speicherung der Daten in:
- Lokaler SQLite-Datenbank
- Remote MySQL-Datenbank
- Einfache Bereitstellung via Docker & docker-compose
---
## ⚙️ Installation & Start
Voraussetzung:
- [Docker](https://www.docker.com/)
- [docker-compose](https://docs.docker.com/compose/)
1. Image herunterladen:
```bash
docker pull git.triggermeelmo.com/daniel-hbn/watcher/watcher:latest
2. Docker Container starten
```bash
docker compose up -d