Installation
In diesem Kampitel geht es um die Installation und Update der Software

Windows
Vorraussetungen
Docker Dektop installiert (Anleitungen gibt es auf der Offiziellen Website oder im Internet)
Projektdateien und Software
Docker-Compose Datei
Benötigtes Material
Anzahl
Art
Link
1
Notebook
Anleitung - Start/Installation der Steuerung
1. Docker Desktop starten
Die Ampelsteuerung ist in einzelne Module aufgeteilt. Diese kommunizieren miteinander über eine ValKey/Redis Datenbank. Um die Benutzung der Software möglichst einfach zu gestalten sind alle Module in Docker Container geschachtelt. Um diese starten zu können, müssen wir in Docker Desktop die einzelnen Container miteinander starten. Dies funktioniert am einfachsten über eine Docker Compose Datei. Hierfür muss starten wir als erstes Docker Desktop. Unsere Oberfläche für das starten und stopen von Docker Container.
2. Docker Compose Stack starten
Um Docker Desktop unsere Container und wie sie miteinander arbeiten sollen beizubrigen benötigen wir die bereitgestellte Docker-Compose Datei. Bei dem Compose module von Docker handelt es sich um eine automatisch installierte erweiterung, welche uns anhand einer .yaml Datei mehrere Container als einen zusammenhängenden Dienst starten lassen. Weiterhin können wir darin abhängigkeiten und Konfigurationen mitgeben. Da diese Datei nicht in der Oberfläche hinzugefügt werden kann müssen wir diese in einen Ordner legen und über die CMD einen Befehl absetzen. 
Lege die Datei in einem Ordner mit dem Namen "FNA-Steuerung" auf deinem PC ab.
Starte eine Kommandozeile in diesem ordner. Rechtsklick in dem Ordner und "In Terminal öffnen" auswählen
In der Komandozeile geben wir folgenden Befehl ein 
docker compose up -d, dieser startet anhand der "docker-compose.yaml" Datei die entsprechenden Container im Hintergrund. (ohne -d würden wir die Ausgabe der Container sehen und beim schließen der Kommandozeile würde die Steuerng beendet werden)
Es werden nun die benötigten Docker Images heruntergeladen und dannach gestartet
Nun ist wird dieser auch in Docker Desktop angezeigt und kann dort gestartet und gestoppt werden
3. WebUI öffnen
Nachdem die Container nun laufen kann auf die Weboberfläche (WebUI) der Steuerng zugegriffen werden. Diese läuft auf Port 80. Im Browser die URL http://127.0.0.1 eingeben.
Eine Detailierte Anleitung, wie die Steuerung bedient werden kann gibt es in anderen Kapitel.
Anleitung - Stoppen der Steuerung
Die Steuerung kann über den Docker Desktop einfach gestoppt und gestartet werden. Hierzu unter Container bei der fna-steuerung unter Aktionen Starten bzw. stoppen. Solltest du die Software nicht manuell stoppen, wird sie beim nächsten Start von Docker Desktop, oder deinem PC automatisch gestartet.
WICHTIG: Im Netzwerk darf nur eine Steuerung gleichzeitig laufen, da sonst die Anzeigegeräte unterschiedliche Informationen erhalten.
Anleitung - Update der Steuerung
Um die Steuerung auf den aktuellen Stan zu bringen müssen die Container gestoppt werden. Im Anschluss wechselt man auf den Reiter Images, wählt bei Actions die 3 Punkte aus und klickt auf Pull. Dadurch wird die neuste Version der Software heruntergeladen. Du musst dies für alle 4 Images machen einzeln machen.

Linux
Vorraussetungen
Docker und Docker Compose installiert (Anleitungen für deine Distribution gibt es meist auf der offiziellen Docker Website)
Diese Anleitung legt eine Debianbasierte Distribution zu grunde.
Projektdateien und Software
Docker Compose YAML Datei
Benötigtes Material
Anzahl
Art
Link
1
Linux PC / Raspberry Pi / o.ä.
Anleitung - Start/Installation der Steuerung
1. Ordner anlegen und Docker Compose Datei ablegen
Als erstes erstellen wir im Home Verzeichnis einen Ordner namens fna-steuerung
## Optional, wenn wget nicht installiert ist
sudo apt install wget -y
## Erstellen des Ordners fna-steuerung
cd ~
mkdir fna-steuerung
cd fna-steuerung
## Downloaden der docker-compose.yaml
wget https://gitlab.gras-it.de/bsapp/fieldnet-ampel/fna-docker-infrastructur/-/blob/e561a872b02b854c72ce75088ba0750fe36b8028/docker-compose.yaml
2. Starten des Docker Compose Service
Nachdem wir die docker-compose.yaml Datei heruntergeladen haben können wir den Service starten
## Springen in den Ordner fna-steuerung
cd ~/fna-steuerung
## Starten des Services
#Je nach dem ob der Benutzer in der docker Gruppe ist mit oder ohne SUDO
#Ist der Benutzer in der docker gruppe kann das sudo weggelassen werden
sudo docker compose up -d
3. Öffnen der WebUI
Nachdem die Container nun laufen kann auf die Weboberfläche (WebUI) der Steuerng zugegriffen werden. Diese läuft auf Port 80. Im Browser die URL http://127.0.0.1 eingeben. Alternativ, wenn die Steuerung ohne Bildschirm betrieben wird, dann auf dem Gerät mit Bildschirm (Notebook / Smartphone / Tablet) die IP Adresse oder der DNS Name des "Servers" eingeben. z.B. http://10.0.1.10 oder http://sv-ampel 
Anleitung - Stoppen der Steuerung
Die steuerung kann über ein docker compose down gestoppt werden.  Solltest du die Software nicht manuell stoppen, wird sie beim nächsten Start von deinem PC automatisch gestartet.
## Springen in den Ordner fna-steuerung
cd ~/fna-steuerung
## Stoppen des Services
#Je nach dem ob der Benutzer in der docker Gruppe ist mit oder ohne SUDO
#Ist der Benutzer in der docker gruppe kann das sudo weggelassen werden
sudo docker compose down
WICHTIG: Im Netzwerk darf nur eine Steuerung gleichzeitig laufen, da sonst die Anzeigegeräte unterschiedliche Informationen erhalten.
Anleitung - Update der Steuerung
Die steuerung kann mit einem einfachen docker compose pull und einem neuerstellen beim Start durchgeführt werden. Hierzu muss der Servie auf jeden fall gestoppt sein.
## Springen in den Ordner fna-steuerung
cd ~/fna-steuerung
## Stoppen des Services
sudo docker compose down
## Starten des Services
#Je nach dem ob der Benutzer in der docker Gruppe ist mit oder ohne SUDO
#Ist der Benutzer in der docker gruppe kann das sudo weggelassen werden
sudo docker compose pull
sudo docker compose up --force-recreate -d
sudo docker image prune -f

Mac OS
Voraussetzungen
Docker Desktop installiert (Anleitungen gibt es auf der offiziellen Website oder im Internet)
Projektdateien und Software
Docker-Compose Datei
Benötigtes Material
Anzahl
Art
Link
1
Mac
 
Anleitung - Start/Installation der Steuerung
1. Docker Desktop starten
Die Ampelsteuerung ist in einzelne Module aufgeteilt. Diese kommunizieren miteinander über eine ValKey/Redis Datenbank. Um die Benutzung der Software möglichst einfach zu gestalten sind alle Module in Docker Container geschachtelt. Um diese starten zu können, müssen wir in Docker Desktop die einzelnen Container miteinander starten. Dies funktioniert am einfachsten über eine Docker Compose Datei. Hierfür starten wir als erstes Docker Desktop. Unsere Oberfläche für das Starten und Stoppen von Docker Container.
2. Docker Compose Stack starten
Um Docker Desktop unsere Container und wie sie miteinander arbeiten sollen beizubringen benötigen wir die bereitgestellte Docker-Compose Datei. Bei dem Compose Modul von Docker handelt es sich um eine automatisch installierte Erweiterung, welche uns anhand einer .yaml Datei mehrere Container als einen zusammenhängenden Dienst starten lassen. Weiterhin können wir darin Abhängigkeiten und Konfigurationen mitgeben. Da diese Datei nicht in der Oberfläche hinzugefügt werden kann müssen wir diese in einen Ordner legen und über das Terminal einen Befehl absetzen.
Lege die Datei in einem Ordner mit dem Namen "FNA-Steuerung" auf deinem Mac ab.
Starte ein Terminal in diesem Ordner. Rechtsklick in dem Ordner im Finder und "Neues Terminal beim Ordner" auswählen oder öffne das Terminal und navigiere mit cd zum entsprechenden Ordner
Im Terminal geben wir folgenden Befehl ein: docker compose up -d, dieser startet anhand der "docker-compose.yaml" Datei die entsprechenden Container im Hintergrund. (ohne -d würden wir die Ausgabe der Container sehen und beim Schließen des Terminals würde die Steuerung beendet werden)
Es werden nun die benötigten Docker Images heruntergeladen und danach gestartet
Nun wird dieser auch in Docker Desktop angezeigt und kann dort gestartet und gestoppt werden
3. WebUI öffnen
Nachdem die Container nun laufen kann auf die Weboberfläche (WebUI) der Steuerung zugegriffen werden. Diese läuft auf Port 80. Im Browser die URL http://127.0.0.1 eingeben.
Eine detaillierte Anleitung, wie die Steuerung bedient werden kann gibt es in anderen Kapiteln.
Anleitung - Stoppen der Steuerung
Die Steuerung kann über Docker Desktop einfach gestoppt und gestartet werden. Hierzu unter Container bei der fna-steuerung unter Aktionen Starten bzw. Stoppen. Solltest du die Software nicht manuell stoppen, wird sie beim nächsten Start von Docker Desktop, oder deinem Mac automatisch gestartet.
WICHTIG: Im Netzwerk darf nur eine Steuerung gleichzeitig laufen, da sonst die Anzeigegeräte unterschiedliche Informationen erhalten.
Anleitung - Update der Steuerung
Um die Steuerung auf den aktuellen Stand zu bringen müssen die Container gestoppt werden. Im Anschluss wechselt man auf den Reiter Images, wählt bei Actions die 3 Punkte aus und klickt auf Pull. Dadurch wird die neueste Version der Software heruntergeladen. Du musst dies für alle 4 Images einzeln machen.