README.md aktualisiert
This commit is contained in:
parent
c6f8a9fb8d
commit
d509db4bde
94
README.md
94
README.md
@ -1,19 +1,65 @@
|
|||||||
# PHP_AdminTool_Projekt
|
# PHP_AdminTool_Projekt
|
||||||
Admin Tool Projekt für das Fach PHP
|
|
||||||
|
|
||||||
---
|
Dieses Repository enthält das gemeinsame PHP AdminTool, das auf IIS unter Windows betrieben wird und über LDAP/AD, SNMP und PowerShell administrative Aufgaben ermöglicht. Das Projekt wird von mehreren Entwicklern gepflegt und folgt einem klar definierten Workflow, um Qualität, Stabilität und Nachvollziehbarkeit sicherzustellen.
|
||||||
Ich (@blaerf) habe mich mal hingesetzt und einen Windows Server 2025 als VM aufgesetzt. Darauf habe ich die Active Directory und IIS Rolle installiert.
|
|
||||||
Zudem habe ich alles so konfiguriert, dass wir PHP mit IIS nutzen können und per LDAPS auf das AD per PHP zugreifen können.
|
|
||||||
|
|
||||||
Ich habe mir auch noch Gedanken zum Git-Workflow gemacht und es nieder geschrieben. So können wir sauber und sicher arbeiten.
|
Ein zentraler Bestandteil der Arbeit mit diesem Repository ist der verbindliche Gitea-Workflow im Wiki.
|
||||||
Eine Ordner Struktur habe ich mir auch überlegt und schon mal angelegt. Alle Infos habe ich soweit im Wiki zusammen getragen.
|
|
||||||
Meine Tests habe ich, wie im Git-workflow beschrieben, in ein eigenes branch (structure/first-structure) gepackt.
|
|
||||||
|
|
||||||
Bitte auch das Wiki beachten und durchlesen!
|
|
||||||
|
**Hinweis:** Der [Gitea-Workflow](https://git.eckertplayground.de/taarly/PHP_AdminTool_Projekt/wiki) ist zwingend zu lesen und einzuhalten. Er legt fest, wie Branches erstellt, gemerged und getestet werden.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Aufgaben: ##
|
## Überblick
|
||||||
|
|
||||||
|
Das Projekt dient als webbasiertes Administrationswerkzeug und umfasst unter anderem:
|
||||||
|
|
||||||
|
- LDAP/AD‑Anbindung (LDAPS)
|
||||||
|
- Benutzer- und Gruppenverwaltung
|
||||||
|
- SNMP‑Auswertungen
|
||||||
|
- PowerShell‑Integration
|
||||||
|
- Weboberfläche zur zentralen Administration
|
||||||
|
|
||||||
|
Die Anwendung läuft in zwei Umgebungen:
|
||||||
|
|
||||||
|
- Produktion (`main`): https://itfa.schraubenfuzzi.de
|
||||||
|
- Test (`develop`): https://test.itfa.schraubenfuzzi.de
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Ordnerstruktur (Auszug)
|
||||||
|
|
||||||
|
- `app/` – Anwendungscode
|
||||||
|
- `public/` – Webroot
|
||||||
|
- `config/` – Konfigurationen für LDAP, Systemvariablen usw.
|
||||||
|
- `scripts/` – Hilfs- und Bereitstellungsskripte
|
||||||
|
- `docs/` – interne Dokumente
|
||||||
|
- `.gitignore` – ausgeschlossene Dateien
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workflow
|
||||||
|
|
||||||
|
Die Entwicklung folgt einem strengen, verbindlichen Ablauf:
|
||||||
|
|
||||||
|
1. **Feature‑Branch erstellen** (`feature/name`)
|
||||||
|
2. Feature entwickeln, committen, pushen
|
||||||
|
3. **PR nach `develop`** für Tests auf der Testinstanz
|
||||||
|
- wird vom Autor selbst gemerged
|
||||||
|
- Branch bleibt bestehen
|
||||||
|
4. Nach bestandenem Test: **PR nach `main`**
|
||||||
|
- mit Review
|
||||||
|
- Merge per Squash
|
||||||
|
- danach wird der Feature‑Branch gelöscht
|
||||||
|
|
||||||
|
Details stehen im Wiki.
|
||||||
|
|
||||||
|
**Wichtiger Hinweis:**
|
||||||
|
Der komplette Ablauf ist im [Gitea-Workflow](https://git.eckertplayground.de/taarly/PHP_AdminTool_Projekt/wiki) beschrieben und muss befolgt werden.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Aufgaben
|
||||||
|
|
||||||
| Aufgabe | Benutzer |
|
| Aufgabe | Benutzer |
|
||||||
| :---- | :---- |
|
| :---- | :---- |
|
||||||
| Benutzer und Gruppen über LDAP anzeigen | Jens E (@blaerf), Stefan W (@viperion) |
|
| Benutzer und Gruppen über LDAP anzeigen | Jens E (@blaerf), Stefan W (@viperion) |
|
||||||
@ -23,4 +69,32 @@ Bitte auch das Wiki beachten und durchlesen!
|
|||||||
| UI/UX anpassen | Yasin B (@Muchentuchen), Alexander M (@Alexander), Torsten J (@tojacobs) |
|
| UI/UX anpassen | Yasin B (@Muchentuchen), Alexander M (@Alexander), Torsten J (@tojacobs) |
|
||||||
|
|
||||||
---
|
---
|
||||||
## Infos gibt es im [Wiki](https://git.eckertplayground.de/taarly/PHP_AdminTool_Projekt/wiki)
|
|
||||||
|
## Dokumentation
|
||||||
|
|
||||||
|
Alle weiteren Informationen wie Regeln, technische Details, Konzepte und Anleitungen befinden sich im Wiki:
|
||||||
|
|
||||||
|
`Wiki → Gitea‑Workflow`
|
||||||
|
`Wiki → Implementierung / LDAP / IIS / Setup`
|
||||||
|
|
||||||
|
Dieser Bereich muss von allen Entwicklern gelesen werden, bevor am Projekt gearbeitet wird.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Mitwirken
|
||||||
|
|
||||||
|
Wer etwas ändern oder erweitern möchte:
|
||||||
|
|
||||||
|
- Branch vom aktuellen Stand erstellen
|
||||||
|
- Entwickeln, Committen, Pushen
|
||||||
|
- PR zuerst nach `develop`, später nach bestandenen Tests nach `main`
|
||||||
|
- Reviewer zuweisen (für `main`)
|
||||||
|
|
||||||
|
Nur tested und reviewed Code gelangt in die Produktion.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Ziel
|
||||||
|
|
||||||
|
Das AdminTool soll eine wartbare, erweiterbare und zuverlässige Verwaltungsoberfläche bieten, die zentrale Aufgaben des AD‑Umfelds über eine moderne Weboberfläche ermöglicht.
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user