Skip to content

Latest commit

 

History

History
109 lines (81 loc) · 3.61 KB

README.md

File metadata and controls

109 lines (81 loc) · 3.61 KB
Raw

vplan-viso

Vertretungsplan-Visualisierungssoftware für den Einsatz an öffentlichen Monitoren in Schulen

Installation

  • Docker (stable: >19.03.12)

  • docker-compose (>1.26.2)

    Hinweis: Docker sollte nicht mit root-Rechten genutzt werden!
    Damit ein normaler User auf Docker zugreifen kann, muss er zur Docker-Gruppe hinzugefügt werden:

    $ sudo usermod -aG docker <user>

  1. docker-compose.vplan-viso.yml aus dem aktuellsten Release herunterladen (in ein eigenes Verzeichnis!)

  2. Eine .env-Datei im gleichen Verzeichnis erstellen:

    VPLAN_VISO_PORT=8080
VPLAN_VISO_VOLUME=/opt/vplan-viso/share
    Umgebungsvariable Erklärung
    VPLAN_VISO_PORT Port, auf welchem vplan-viso erreichbar sein soll
    VPLAN_VISO_VOLUME Pfad, wo das Docker Volume eingebunden wird

    Für diesen Pfad müssen die Zugriffrechte richtig gesetzt sein:

    $ chown -R <user> /opt/vplan-viso

  3. Mit docker-compose starten

    $ docker-compose -f docker-compose.vplan-viso.yml up -d

    Das fertige Docker-Image wird von DockerHub heruntergeladen und gestartet.

    Falls der Zugriff auf DockerHub nicht möglich ist, sind exportierte Docker-Images im komprimierten Tarball-Format jedem Release beigefügt. Das zur Prozessorarchitektur passende Image kann zuvor heruntergeladen und mit

    $ docker image load -i <docker-image-tarball>

    reingeladen werden.

  4. Fertigstellung

    $ docker logs vplan-viso

    Im Log kann man sehen, ob das Starten geklappt hat. vplan-viso ist jetzt unter der lokalen IP-Adresse des Servers und Port VPLAN_VISO_PORT erreichbar. Die Monitoransichten befinden sich bei /display/students bzw. /display/teachers.

    Das Datenverzeichnis share/ befindet sich im Volume des Docker Containers und ist im definierten Pfad, ersichtlich aus der docker-compose.yml, eingebunden. Darin befinden sich:

    • upload/ - Vetretungsplandateien werden hier hochgeladen.

    • display/ - Gespeicherte VPlan-Dateien. Können gelöscht werden.

    • logs/ - Weitere Logs (falls aktiviert)

    • config.json - Programm-Konfiguration. Damit Änderungen wirksam werden, muss vplan-viso neugestartet werden.

      $ docker restart vplan-viso

Upgrade

Schritte 1 bis 3 der Installation ausführen.

Deinstallation

$ docker-compose -f docker-compose.vplan-viso.yml down

Project structure

.
├── src             # NodeJS source (backend)
│   ├── endpoints/      # HTTP-Endpoint router modules
│   ├── frontend/       # VueJS frontend
│   ├── handlers/       # Independent abstracted modules for main duties
│   ├── helpers/        # Helper modules for dev environment
│   ├── lib/            # Own stateless libraries
│   ├── services/       # Common used modules
│   ├── util/           # Small utility functions
│   └── index.js        # Entry module (async)
├── test/           # Resources for testing
└── share/          # Data files and config during operation

Roadmap

  • Docker support
  • VueJS based frontend
  • Display page progress
  • Internal FTP Support
  • Secure Updater
  • Ticker
  • Changes highlight
  • Animate display paging