Update README.md
This commit is contained in:
77
README.md
77
README.md
@@ -1,15 +1,31 @@
|
|||||||
# KMU Server Infrastructure
|
# KMU Server Infrastructure (On-Premise)
|
||||||
|
|
||||||
Dieses Repository verwaltet die komplette Infrastruktur-Konfiguration und -Dokumentation für die KMU-Organisation.
|
Dieses Repository verwaltet die komplette Infrastruktur-Konfiguration und -Dokumentation für die KMU-Organisation.
|
||||||
|
|
||||||
|
Dieses Muster geht davon aus, dass ein **Headless-Server**, also ein (Mini-)PC ohne eigenen Bildschirm, Tastatur und Maus, in einem
|
||||||
|
*Home-Office-LAN* betrieben wird. Dies ist die zentrale Stütze für das **Unternehmen** (***KMU*** - **K**leine und **M**ittlere **U**nternehmen), das seinen Betrieb weitestgehend **autark**
|
||||||
|
und **On-Premise** betreibt.
|
||||||
|
|
||||||
|
Weil es so gut passt, nutzen wir den Namen ***KMU***, bei den Namen in unserem Muster-Aufbau.
|
||||||
|
|
||||||
|
Lediglich der unvermeidbare **Internet-Anschluss** schafft Abhängigkeit vom *Internet Service Provider* (**ISP**) und es wird üblicherweise
|
||||||
|
ein Router als Zugangspunkt verwendet.
|
||||||
|
|
||||||
|
In den Mustern gehen wir von einer **AVM Fritz!Box** aus, die wir für den Übergang zum Internet nutzen.
|
||||||
|
|
||||||
|
```
|
||||||
|
⚠️ Wir sind im Aufbau. Also, ist diese Arbeit im Moment noch nicht als abgeschlossen zu betrachten. 🔄
|
||||||
|
```
|
||||||
|
|
||||||
## 📋 Übersicht
|
## 📋 Übersicht
|
||||||
|
|
||||||
Das `server-infra` Repository dient als zentrale Verwaltungseinheit für:
|
Das `server-infra` Repository dient als zentrale Verwaltungseinheit für:
|
||||||
- Server-Konfigurationsdateien
|
|
||||||
- Automatisierungs- und Deployment-Skripte
|
* Server-Konfigurationsdateien
|
||||||
- Infrastruktur-Dokumentation
|
* Automatisierungs- und Deployment-Skripte
|
||||||
- Service-Konfigurationen
|
* Infrastruktur-Dokumentation
|
||||||
- Systemd-Units und Service-Definitionen
|
* Service-Konfigurationen
|
||||||
|
* Systemd-Units und Service-Definitionen
|
||||||
|
|
||||||
## 🏗️ Repository-Struktur
|
## 🏗️ Repository-Struktur
|
||||||
|
|
||||||
@@ -28,7 +44,8 @@ server-infra/
|
|||||||
│ └── maintenance/ # Wartungs-Skripte
|
│ └── maintenance/ # Wartungs-Skripte
|
||||||
├── configs/ # Service-Konfigurationen
|
├── configs/ # Service-Konfigurationen
|
||||||
│ ├── gitea/ # Gitea-Konfiguration
|
│ ├── gitea/ # Gitea-Konfiguration
|
||||||
│ ├── nginx/ # Nginx-Konfiguration
|
│ ├── caddy/ # Caddy-Konfiguration
|
||||||
|
│ ├── nginx/ # Nginx-Konfiguration (optional|alternativ)
|
||||||
│ ├── postgresql/ # PostgreSQL-Konfiguration
|
│ ├── postgresql/ # PostgreSQL-Konfiguration
|
||||||
│ └── ssl/ # SSL/TLS-Zertifikate (ohne Private Keys)
|
│ └── ssl/ # SSL/TLS-Zertifikate (ohne Private Keys)
|
||||||
├── systemd/ # Systemd-Service-Units
|
├── systemd/ # Systemd-Service-Units
|
||||||
@@ -43,35 +60,40 @@ server-infra/
|
|||||||
## 🚀 Erste Schritte
|
## 🚀 Erste Schritte
|
||||||
|
|
||||||
### 1. Repository klonen
|
### 1. Repository klonen
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://git.gitcover.de/KMU/server-infra.git
|
git clone https://git.gitcover.de/KMU/server-infra.git
|
||||||
cd server-infra
|
cd server-infra
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Dokumentation lesen
|
### 2. Dokumentation lesen
|
||||||
|
|
||||||
Beginnen Sie mit der Dokumentation im `docs/` Verzeichnis:
|
Beginnen Sie mit der Dokumentation im `docs/` Verzeichnis:
|
||||||
- **architecture.md**: System-Übersicht und Komponenten
|
|
||||||
- **installation.md**: Schritt-für-Schritt Installationsanleitung
|
* **architecture.md**: System-Übersicht und Komponenten
|
||||||
- **maintenance.md**: Wartungs- und Update-Prozeduren
|
* **installation.md**: Schritt-für-Schritt Installationsanleitung
|
||||||
|
* **maintenance.md**: Wartungs- und Update-Prozeduren
|
||||||
|
|
||||||
### 3. Skripte verwenden
|
### 3. Skripte verwenden
|
||||||
|
|
||||||
Alle Automatisierungs-Skripte befinden sich im `scripts/` Verzeichnis und sind nach Kategorien organisiert.
|
Alle Automatisierungs-Skripte befinden sich im `scripts/` Verzeichnis und sind nach Kategorien organisiert.
|
||||||
|
|
||||||
## 🔧 Server-Spezifikationen
|
## 🔧 Server-Spezifikationen
|
||||||
|
|
||||||
- **Betriebssystem**: Ubuntu Server LTS (neueste Version)
|
* **Betriebssystem**: Ubuntu Server LTS (neueste Version)
|
||||||
- **Git-Server**: Gitea
|
* **Git-Server**: Gitea
|
||||||
- **Webserver**: Nginx
|
* **Webserver**: Nginx
|
||||||
- **Datenbank**: PostgreSQL
|
* **Datenbank**: PostgreSQL
|
||||||
- **Backup-Strategie**: Automatisierte tägliche Backups
|
* **Backup-Strategie**: Automatisierte tägliche Backups
|
||||||
|
|
||||||
## ⚠️ Sicherheitshinweise
|
## ⚠️ Sicherheitshinweise
|
||||||
|
|
||||||
**WICHTIG**: Dieses Repository enthält KEINE sensiblen Daten wie:
|
**WICHTIG**: Dieses Repository enthält KEINE sensiblen Daten wie:
|
||||||
- Private SSH-Schlüssel
|
|
||||||
- Passwörter oder API-Keys
|
* Private SSH-Schlüssel
|
||||||
- Private SSL-Zertifikate
|
* Passwörter oder API-Keys
|
||||||
- Datenbank-Credentials
|
* Private SSL-Zertifikate
|
||||||
|
* Datenbank-Credentials
|
||||||
|
|
||||||
Sensible Daten werden über Umgebungsvariablen oder externe Secret-Management-Systeme verwaltet.
|
Sensible Daten werden über Umgebungsvariablen oder externe Secret-Management-Systeme verwaltet.
|
||||||
|
|
||||||
@@ -87,11 +109,13 @@ Sensible Daten werden über Umgebungsvariablen oder externe Secret-Management-Sy
|
|||||||
## 🔄 Workflow und Versionierung
|
## 🔄 Workflow und Versionierung
|
||||||
|
|
||||||
### Branch-Strategie
|
### Branch-Strategie
|
||||||
- **main**: Produktive Konfiguration (nur getestete Änderungen)
|
|
||||||
- **development**: Entwicklungs- und Test-Konfigurationen
|
* **main**: Produktive Konfiguration (nur getestete Änderungen)
|
||||||
- **feature/[name]**: Feature-Branches für größere Änderungen
|
* **development**: Entwicklungs- und Test-Konfigurationen
|
||||||
|
* **feature/\[name]**: Feature-Branches für größere Änderungen
|
||||||
|
|
||||||
### Commit-Konventionen
|
### Commit-Konventionen
|
||||||
|
|
||||||
```
|
```
|
||||||
[Typ]: Kurze Beschreibung
|
[Typ]: Kurze Beschreibung
|
||||||
|
|
||||||
@@ -112,9 +136,9 @@ Typen:
|
|||||||
|
|
||||||
## 📞 Kontakt und Support
|
## 📞 Kontakt und Support
|
||||||
|
|
||||||
- **Repository**: https://git.gitcover.de/KMU/server-infra
|
* **Repository**: https://git.gitcover.de/KMU/server-infra
|
||||||
- **Organisation**: KMU
|
* **Organisation**: KMU
|
||||||
- **Maintainer**: [Ihr Name]
|
* **Maintainer**: \[Ihr Name]
|
||||||
|
|
||||||
## 📄 Lizenz
|
## 📄 Lizenz
|
||||||
|
|
||||||
@@ -124,4 +148,5 @@ Nicht für externe Verwendung bestimmt.
|
|||||||
---
|
---
|
||||||
|
|
||||||
**Letzte Aktualisierung**: $(date +"%Y-%m-%d")
|
**Letzte Aktualisierung**: $(date +"%Y-%m-%d")
|
||||||
**Version**: 1.0.0
|
**Version**: 0.1.0
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user