cschulz/rd13_copilot_setup
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
rd13_copilot_setup/git-templates/docs/ADMIN.md
Conrad Schulz 045e2e7202 feat: add data/, history/, 3-target-group docs, pre-commit quality gate 
- New repo convention: /data/<service>/ for all persistent service data (gitignored)
- New repo convention: /history/prompts/ (gitignored) + /history/summary/PROJECT_CONTEXT.md
  for agent session logging and compressed project context
- git-templates/hooks/pre-commit: quality gate checking tests + docs on every commit
- git-templates/docs/: USER.md, ADMIN.md, MAINTAINER.md templates (3 target groups)
- git-templates/history/summary/PROJECT_CONTEXT.md: agent context template
- prompts/history.prompt.md: /history prompt for logging sessions + updating summary
- copilot-bootstrap.sh: creates all new folders, .gitignore entries, installs hook
- deploy.sh + deploy.fish: deploy hooks, doc templates, history template
- docs/ADMIN.md: new admin handbook for this project
- docs/USER.md + docs/MAINTAINER.md: updated with new conventions
- git-templates/.github/copilot-instructions.md: extended DoD + new conventions
- README.md: updated structure overview + prompt table
2026-05-30 17:19:52 +00:00

2 KiB
Raw Blame History

Administrator-Handbuch – [PROJEKT_NAME]

Zielgruppe: Administratoren – Menschen, die das System betreiben, deployen und konfigurieren. Voraussetzung: Grundkenntnisse in Linux, Docker und dem eingesetzten Stack.

Systemvoraussetzungen

Komponente Mindestanforderung Empfohlen
OS … …
RAM … …
Disk … …
Dependencies … …

Deployment

Erstes Aufsetzen

# Beispiel
git clone <repo> /opt/service
cd /opt/service
cp .env.example .env
# .env ausfüllen!
docker compose up -d

Updates einspielen

git pull
docker compose pull
docker compose up -d --force-recreate

Konfiguration

Umgebungsvariablen (.env)

Variable Pflicht Default Beschreibung
EXAMPLE_VAR ✓ – Beschreibung

Persistente Daten (/data/)

Alle persistenten Daten liegen unter /data/<service>/ im Repo-Root:

Pfad Inhalt Backup-Priorität
data/<service>/ … hoch/mittel/niedrig

Backup-Hinweise:

  • /data/ komplett sichern vor jedem Update
  • Empfehlung: tägliches Backup via Cron / Restic / rsync

Monitoring & Logs

# Logs ansehen
docker compose logs -f <service>

# Status prüfen
docker compose ps

Sicherheit

  • Offene Ports: …
  • TLS: …
  • Zugriffskontrolle: …

Troubleshooting

Symptom Ursache Lösung
… … …

Disaster Recovery

  1. Dienst stoppen: docker compose down
  2. Backup einspielen: …
  3. Dienst neu starten: docker compose up -d