From f1c5d0b7d603960b51393d9c8e47992d96597f8f Mon Sep 17 00:00:00 2001 From: daniel-hbn Date: Sat, 28 Jun 2025 22:16:58 +0200 Subject: [PATCH] Readme --- README.md | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a48d1cc..7fc7e09 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,34 @@ -# Watcher +# 🖥️ Server Monitoring Software -Monitoring Tool für Server, VMs und Docker Container. \ No newline at end of file +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 \ No newline at end of file