Installation
============

Client
------

Auf dem Client muss neben dem Webbrowser keine weitere Software installiert werden.

Installation mit Docker
-----------------------

.. todo:: Containerlayout und Docker-PlexMap-Installation allgemein

Windows Server
--------------

Windows Server 2008 R2

* Docker Toolbox installieren

    https://docs.docker.com/toolbox/overview/

* Projekt Ordner erstellen
* Inhalt der *PlexmapBundle.zip* in den Projekt Ordner entpacken
* QuickStart Docker Kommandozeile starten

    .. code-block:: bash

        cd PROJEKTORDNER

    .. note::

          Hier befinden sich die *docker-compose.yml*-Datei und die Docker Images

* Docker Images laden

    .. code-block:: bash

        for image in images/*.tar.gz; do docker load -i $image; done

* Docker Volumes erstellen

    Für die *named volumes* in der *docker-compose.yml*-Datei unter *volumes* mit
    Hilfe der QuickStart Kommandozeile den Befehl ausführen

    .. code-block:: bash

        docker volume create --name NAME_DES_VOLUME -d local

* Plexmap spezifische Umgebungsvariablen

    * App-Name angeben

        .. code-block:: bash

            PLEXMAP_WEB_APP_NAME=plexmap_web_name

    * externe PostgreSQL Datenbank ip/host + port angeben

        .. code-block:: bash

            DB_NAME=pm_db
            DB_USER=postgres_user
            DB_PWD=postgres_pass
            DB_PORT=5432
            POSTGRES_EXTERNAL_IP=192.168.99.1

    * mit Hilfe einer Datei laden

        .. code-block:: bash

            source env.txt

* Plexmap Services starten

    .. code-block:: bash

        docker-compose up -d

    .. note::

        dem *docker-compose* befehl können die oben aufgelisteten Variablen auch voran gestellt werden

            .. code-block:: bash

                PLEXMAP_WEB_APP_NAME=plexmap_web_name DB_NAME=pm_db \
                DB_USER=postgres_user DB_PWD=postgres_pass \
                DB_PORT=5432 POSTGRES_EXTERNAL_IP=192.168.99.1 \
                docker-compose up -d


* Plexmap Services Status abfragen

    .. code-block:: bash

        docker-compose ps

* Konfiguartion ändern

    config.yaml anpassen und anschließend die betroffene Services neustarten

    .. code-block:: bash

        docker-compose restart plexmap celery_worker celery_beat

* Administrator Benutzer erstellen

    Eingabeaufforderung des *plexmap* Service öffnen

    .. code-block:: bash

        docker-compose exec plexmap bash

    Befehl zum Erstellen des Benutzers im Container ausführen

    .. code-block:: bash

        /sbin/entrypoint.sh manage createsuperuser


Berechtigungen
--------------

Bei Problemen mit der Zugriffsberechtigungen auf Container Volumes


* Mit dem Docker Befehl den Plexmap Container identifizieren

    .. code-block:: bash
        docker ps

    *PROJEKTORDNER_plexmap_1*

* Kommandozeile im Container

    .. code-block:: bash

        docker exec -it -u root PROJEKTORDNER_plexmap_1 bash

* Verzeichnis Berechtigung setzen (im Container)

    .. code-block:: bash

        chown -R plexmap:plexmapgroup /data/file_storage

    .. note::

        Im Container sind die Volumes unter */data* eingebunden.

        *plexmap*, *plexmapgroup* ist der Benutzer und die Benutzergruppe im Container


VBoxVmService
-------------

VBoxVmService ist eine Windows-Anwendung, mit der Sie die VirtualBox-VMs innerhalb einer systemeigenen Windows-Serviceeinheit ausführen können.



* Projekt Seite

    http://vboxvmservice.sourceforge.net/

* Download Bereich

    https://sourceforge.net/projects/vboxvmservice/files/vboxvmservice/

    .. note::

        Der Status der VMs, die von VBoxVmService gestartet wurden, kann nicht mit der GUI von VirtualBox geteilt werden.

        Wenn Sie die VM-Einstellungen in der GUI ändern und die VM in VBoxVmService ausgeführt wird, wird die Änderung möglicherweise verworfen.

Beispiel *VBoxVmService.ini* Datei um die VM mit dem Name *default* zu starten.

.. code-block:: ini

    [Settings]
    VBOX_USER_HOME=C:\Users\John\.VirtualBox
    RunWebService=no
    PauseShutdown=5000

    [Vm0]
    VmName=default
    ShutdownMethod=savestate
    AutoStart=yes