Wie funktioniert die weclappOn Installation?

Hier findest du unsere weclappON Installationsanleitung.

Du möchtest über zukünftige weclappON Versionen informiert werden? Dann trage dich hier zum weclappON Newsletter ein.

Initiale Installation

Alle folgenden Befehle müssen als root ausgeführt werden.

Schritt 1: Docker installieren

siehe https://docs.docker.com/engine/installation/ je nach Distribution (neueste Version)

Schritt 2: Docker Compose installieren

Die eigentliche Docker Installation sollte Docker Compose enthalten.

Dies kannst du prüfen in dem du “docker compose –v” ohne Anführungsstriche ausführst, um die installierte Version zu prüfen.

Solltest du kein Ergebnis erhalten, führe bitte die ergänzende Installation von Docker Compose anhand der folgenden Dokumentation durch: https://docs.docker.com/compose/install/linux/

Schritt 3: weclapp Datenverzeichnisse anlegen

weclapp benötigt 3 Verzeichnisse in denen die Daten gespeichert werden, die bei einem Versionsupdate erhalten bleiben.

Wir empfehlen folgende 3 Verzeichnisse zu verwenden:

• /opt/weclapp-data/db
• /opt/weclapp-data/blobs
• /opt/weclapp-data/solr

Diese Verzeichnisse können mit den folgenden Befehlen angelegt werden

cd /opt
mkdir -p weclapp-data/db weclapp-data/blobs weclapp-data/solr
chmod 777 weclapp-data/db weclapp-data/blobs weclapp-data/solr

Falls nötig können diese Verzeichnisse auch an beliebigen anderen Stellen im Dateisystem liegen, dann müssen aber die Pfade in docker-compose.yml angepasst werden (siehe nächster Schritt).

Schritt 4: Verzeichnis für docker-compose.yml anlegen

weclappOn verwendet Docker Compose, um das Ausführen der Container zu vereinfachen. Die Konfiguration welche Container ausgeführt werden sollen und wie sie verbunden werden ist in einer docker-compose.yml Datei definiert. Auf Basis dieser Datei erzeugt und konfiguriert Docker Compose dann die Container.

Die empfohlene docker-compose.yml Basis-Datei für weclapp steht hier zum download bereit.
Sollte weclappOS zum drucken eingesetzt werden, wird die Erweiterte-Datei benötigt. Diese erhält weitere Komponenten (“Service-Hub”), welcher zum drucken benötigt wird.
Die Erweiterte-Datei steht hier zum Download bereit.
Diese Datei sollte immer in einem eigenen Verzeichnis liegen in dem sonst nichts anderes ist. Wir empfehlen diese Datei in das Verzeichnis /opt/weclapp zu legen:

mkdir -p /opt/weclapp
curl -L https://support.weclapp.com/webapp/document/52b51d99-3651-47b6-b1d2-04147b583e3b/kuxclekzjhrrvoax/docker-compose.yml > /opt/weclapp/docker-compose.yml

Falls in Schritt 3 andere Verzeichnisse verwendet wurden, dann müssen diese in docker-compose.yml entsprechend angepasst werden.

Schritt 5: weclappOn starten

Wenn alle vorherigen Schritte korrekt ausgeführt wurden, dann lässt sich weclappOn durch ein einfaches “docker compose up -d” (in dem Verzeichnis in dem die docker-compose.yml Datei liegt) starten:

cd /opt/weclapp
docker compose up -d

Dadurch werden die benötigten Images heruntergeladen und die Container gestartet. Sobald die Container starten kann man das Log mit folgendem Befehl verfolgen (optional):

docker logs -f weclapp_app

(mit Ctrl-C wieder beenden)

Nach einiger Zeit (circa eine Minute) ist weclappOn gestartet, dann einfach http://<deine IP>:8080 im Browser eingeben. Man kommt dann auf die Anmeldeseite auf der man den ersten Benutzer anlegt. Nach dem Login kommt der Einrichtungsassistent für die Einstellung der wichtigsten Parameter. Unter anderem muss ein SMTP Server zum Versand der Systemmails konfiguriert werden (kann später geändert werden), es kann z.B. der Firmen SMTP Server verwendet werden, aber auch gmail oder ein anderer Freemail Anbieter.

Weitere Hinweise zur täglichen Arbeit mit weclappON

Stoppen und Neustarten der Anwendung

Die Anwendung läuft als “Dienst” und startet auch nach einem Neustart des Servers automatisch wieder.

Zum Stoppen der Anwendung wird “docker compose stop” verwendet:

cd /opt/weclapp
docker compose stop

Um auch noch die Container zu löschen kann “docker compose down” verwendet werden (wobei das nur bei einer kompletten Deinstallation nötig sein sollte):

cd /opt/weclapp
docker *compose down

In beiden Fällen bleiben die Daten erhalten.

Die Anwendung kann jederzeit wieder per “docker compose up -d” gestartet werden (siehe oben).

Updaten der weclappON Installation

Um weclappOn auf die neueste Version zu aktualisieren, einfach folgende Befehle ausführen:

cd /opt/weclapp
docker compose pull
docker compose up -d

“docker compose pull” lädt zunächst die aktuellste Version herunter (falls eine neuere Version vorhanden ist), zu diesem Zeitpunkt läuft die alte Version weiter. Durch das Ausführen von “docker compose up -d” wird dann die alte Version gestoppt und die neue gestartet.

Über unseren Newsletter informieren wir dich, sobald eine neue weclappOn Version zum Download bereit steht. Trage dich für den weclappON Newsletter ein!