====== Yacht Management Software (YMS) ======

Freie Software zur Verwaltung einer oder mehrerer Segelyachten.

Die Software läuft auf einem [[Bordcomputer]], vorzugeweise einem Raspberry Pi.
Das System kann über einen zugehörigen Bildschirm bedient werden oder
eine Browserschnittstelle (Web-GUI).

Die Datenspeicherung erfolgt in einer MariaDB-Datenbank,
die Dokumentablage auf Dateisystemebene.

Der externe Betrieb auf einem Webserver im Internet ist ebenfalls möglich.

Features (für Version 1.0):
  * Daten
    * Stammdaten
    * Stauraum
    * Ausrüstung
    * Inventar
    * Proviant
    * Projekte
    * Aufgaben
    * Wartungen
    * Maße/Meßwerte
    * Dokumentation
    * Checklisten
    * Marker (Tags)
  * Frontend
    * Native Bedienoberfläche auf dem Bordcomputer
    * Web-GUI

Weiterführende Informationen:
  * Ankündigung im [[https://www.segeln-forum.de/thread/90714-yacht-management-software-yms/?postID=2628207|Segeln-Forum]]
  * Quelltext herunterladen aus Git
    * sobald in einem veröffentlichungswürdigem Zustand
    * vorab möglich nach persönlicher Anfrage
  * Demosystem unter https://www.hoogi.de/yms
  * [[yms_handbuch|Anwendungshinweise]]
  * [[yms_openplotter|Integration in OpenPlotter]]



===== Installation =====

Die aktuell gültige Installationsanleitung befindet sich in der Datei ''INSTALL''.
Diese bezieht sich allerdings nur auf die Anwendung an sich. Eine funktionsfähige
Systemumgebung mit Datenbank- und Webserver wird vorausgesetzt.

Hier die Schritte die aufbauend auf einem frisch installiertem RaspiOS erforderlich
sind:

  * MariaDB Datenbank: ''apt-get install mariadb-server''
  * Webserver, entweder Apache oder Lighttpd
    * Apache mit PHP-Modul<code>
apt-get install apache2 libapache2-mod-php
</code>
    * Lighttpd mit php-fpm:<code>
apt-get install lighttpd php-fpm 
lighty-enable-mod fastcgi-php-fpm
</code>
      * Socket-Adresse einstellen in Pool ''www'': ''listen = /run/php/php-fpm.sock''
      * Die Dateien für die GUI können einfach in ein Verzeichnis des Webservers kopiert werden. Falls das YMS die einzige Anwendung ist, kann das Basisverzeichnis z.B. ''/var/www/html'' verwendet werden. Teilt sich YMS den Server mit anderen Anwendungen, kann einfach ein Unterverzeichnis verwendet werden z.B.  ''/var/www/html/yms''.
  * PHP-Module<code>
apt-get install php-mysql php-xml
</code>
  * PDF Werkzeuge (MuPDF)
    * '' apt-get install mupdf-tools''
  * Lokales, natives Frontend
    * Python
    * GTK

==== Entwicklungsversion ====

Momentan ist das Programm noch in der Version 0.1 und nicht für den öffentlichen
Download verfügbar. Bei Interesse gerne Nachfragen, Freischaltung ist möglich.

Vorsicht: die nachfolgende Befehlskette gent davon aus, daß sich noch nichts 
im Standard-Webserver-Verzeichnis befindet. Soll YMS zu einer bereits vorhandenen
Installation hinzugefügt werden, so sind die Dateien aus dem verzeichnis ''webgui''
manuell zu kopieren.

<code>
apt-get install git
cd /tmp
git clone https://git.hoogi.de/thooge/YMS
cd YMS
./inst_apache.sh
</code>

===== Konfiguration =====

Das System bzw. die Oberfläche ist grundsätzlich mehrsprachig ausgelegt.
Die Nutzdaten sind allerdings nur in einer Sprache zu erfassen.
Deshalb muß beim Aufsetzen des Systems eine Entscheidung bzgl. der Sprache
getroffen werden.

Datenbankstruktur anlegen, sprachunabhängig:
  mariadb yms < mariadb.sql

Anlegen nur der absolut minimalen Daten. Dabei handelt es sich um den
initialen Benutzer //captain//, sowie die Vorbelegung von Auswahllisten
welche im Programmcode referenziert werden.
  mariadb yms < minimal.sql

Einstellen des Kennworts für den ersten Benutzer
  python3 genpass.py

==== Web-GUI ====

Als einziger Konfigurationsschritt muß die Konfigurationsdatei ''config.inc'' angelegt 
werden. Am einfachsten durch Umbenennen von ''config.inc-sample''.
Mindestens die Datenbank-Zugangsdaten müssen angepaßt werden.

In YMS können Dokumente und Bilder an verschiedenen Stellen hinterlegt werden.
Die maximale Dokumentgröße muß in ''g_doc_maxsize'' angegeben, sowie
zusätzlich in der PHP-Konfiguration (''php.ini'') eingestellt werden.