Installationsanweisungen

Dokumentation.md

@@ -2,26 +2,110 @@
 
 # -- Die Dokumentation ist noch in Arbeit --
 
+## Systemanforderungen
+
+Zum Ausführen von Zeiterfassung wird eine Python-Installtion mit den Paketen nicegui, segno und python-dateutils
+benötigt. Unter Linux kann das Programm auch als Docker Container ausgeführt werden. Hierfür wird docker und benötigt.
+Die Verwendung von docker-compose wird empfohlen. ADas Programm stellt keine hohen Anforderungen an die Hardware.
+Alle Systeme, die die oben genannten Programme ausführen können, reichen für den Betrieb des Systems aus.
+
 ## Installation
-- ### per Source Code
+
-- ### mittels Docker
+Aktuell gibt es zwei Möglichkeiten das Programm auszuführen. Sie können den Quellcode herunterladen
+und mittels Python Interpreter ausführen lassen. Dazu müssen Sie die notwendigen Pythonpakete installieren.
+Alternativ können Sie ein Dockerimage erstellen oder herunterladen, dass alle notwendigen Programmbestandteile
+enthält.
+
+### Quellcode ausführen
+
+Klonen Sie das Repository für den Quellcode in ein für sie passendes Verzeichnis. Dazu können Sie den folgenden
+Befehl verwenden
+
+    git clone https://gitea.am-td.de/alexander/zeiterfassung
+
+Zum Ausführen des Programms benötigen Sie eine Installation von Python 3.11 oder höher. Für das Ausführen werden
+zusätzlich die Python-Pakete nicegui, segno und python-dateutils benötigt. Diese können Sie mittels pip installieren
+
+    pip install nicegui segno python-dateutils
+
+oder nutzen Sie die requirements.txt aus dem Repository
+
+    pip install -r requirements.txt
+
+### Installation mit Docker
+
+Wenn Sie nicht vorhaben, den Quellcode zu verändern, geht die Installation mittels [Docker](https://www.docker.com/) deutlich schneller und
+einfacher. Sie können das Docker Image mittels 
+
+    docker pull gitea.am-td.de/alexander/zeiterfassung:beta-2025.0.1
+
+herunterladen.
 
 ## Inbetriebnahme
-- ### Programm starten
+### Programm starten
-- ### Erster Administratorlogin
+#### Quellcode
+
+Führen Sie die Datei *main.py* aus dem Installationsverzeichnis aus. 
+
+#### Docker
+
+Bei der Verwendung von docker-compose kopieren Sie die Datei
+[docker-compose.yml](https://gitea.am-td.de/alexander/zeiterfassung/src/branch/release/docker-compose.yml) aus dem Repository
+in ein Verzeichnis ihrer Wahl. Mit dem Befehl
+
+    docker compose up
+
+starten wird das Image geladen und das Programm gestartet. Je nach Konfiguration Ihres Systems benötigen Sie
+Administratorrechte, um den Docker Container zu starten.
+
+Mittels 
+
+    docker compose up -d
+
+wird der Container im Hintergrund ausgeführt.
+
+#### Beide Varianten
+
+In der Kommandozeile werden die Adressen
+angezeigt, unter der die Weboberfläche erreicht werden kann. Sollten Sie die Portkonfiguration nicht verändert haben,
+ist diese
+
+    http://[IP-Adresse des Computers]:8090
+
+### Erster Administratorlogin
+
+Rufen Sie in einem Webbrowser die oben genannten Adresse auf. Beim ersten Start wird eine Einstellungsdatei mit
+Standardeinstellungen erzeugt. Der Standardlogin für die Administration ist
+
+    Benutzer: admin
+    Passwort: admin
+
+![Loginmaske](login.jpg)
+
+### Standardbenutzer
+
+Beim Start, oder wenn alle Benutzerdaten gelöscht werden, wird automatisch ein Benutzerkonto mit folgenden Informationen
+angelegt:
+
+    Benutzer: default
+    Passwort: default
 
 ## Administration
-- ### Einstellungen vornehmen
+
-- ### Benutzer anlegen
+Wenn Sie die Administrationszugangsdaten im Loginbereich eingeben, werden Sie automatisch auf die Administrationseite
-- ### Backups erzeugen und einspielen
+umgeleitet.
-- ### Arbeitszeiteinträge ändern
+
-- ### Abwesenheitszeiten eintragen
+### Einstellungen vornehmen
-- ### Urlaubsanträge bearbeiten
+### Benutzer anlegen
+### Backups erzeugen und einspielen
+### Arbeitszeiteinträge ändern
+### Abwesenheitszeiten eintragen
+### Urlaubsanträge bearbeiten
 
 ## Benutzerfunktionen
-- ### Ein- und Ausstempeln
+### Ein- und Ausstempeln
-- ### Urlaubsanträge
+### Urlaubsanträge
-- ### Zeitübersichten
+### Zeitübersichten
-- ### Abwesenheitsübersichten
+### Abwesenheitsübersichten
-- ### Urlaubsanspruch
+### Urlaubsanspruch
-- ### Passwort ändern
+### Passwort ändern