Hostsharing Wiki - Benutzerbeiträge [de]

Container

2026-01-27T14:30:00Z

Hsh-milanihl: /* In eine tenporäre Subshell wechseln */

== Übersicht ==

Es gibt die Möglichkeit, einen Container Server mit Docker oder mit Podman zu buchen.

Dies ist eine Managed Umgebung, also ohne Root-Rechte, wo Docker bzw. Podman rootless ausgeführt werden.

Falls vom Installationsskript einer Anwendung Root-Rechte erforderlich sind, kann entweder versucht werden, dies anzupassen, oder es kann ein Cloud Server gebucht werden, wo der Benutzer Root-Rechte hat.

== Erste Schritte ==

Bei der Bestellung des Container Servers sollte direkt der Public SSH Key mitgegeben werden, am besten bereits nach dem Ed25519-Standard, siehe auch [https://www.heise.de/tipps-tricks/SSH-Key-erstellen-so-geht-s-4400280.html].

Der Zugriff erfolgt über den Benutzer tallyman über SSH auf den Container Server.

<syntaxhighlight lang=shell>
ssh tallyman@vm4xxx.hostsharing.net
</syntaxhighlight>

Um einen "Hello World" Docker Container zu starten:

<syntaxhighlight lang=shell>
tallyman@vm4xxx:~$ docker run hello-world
</syntaxhighlight>

Entsprechend sieht der Befehl für Podman aus:

<syntaxhighlight lang=shell>
tallyman@vm4xxx:~$ podman run hello-world
</syntaxhighlight>

=== Hilfreiche Befehle für Docker ===

<syntaxhighlight lang=shell>
# in einem Ordner ausführen, wo eine Datei mit dem Namen docker-compose.yml liegt, um die Umgebung zu bauen und zu starten:
docker compose up --detach

# zeige alle laufenden Container
docker ps -a

# zeige die Logs eines Containers
docker logs mein-container

# wechsle in eine Shell im Container
docker exec -t -i mein-container /bin/sh

# Images aktualisieren
docker compose pull

# Containerumgebung stoppen und löschen
docker compose down
</syntaxhighlight>

=== Hilfreiche Befehle für Podman ===

TODO

== Integration in Hostsharing Managed Platform ==

=== Subdomain einrichten ===

Wir haben bereits die Hauptdomain bei Hostsharing gebucht.

Nun soll unsere Anwendung auf dem Container Server auf einer Subdomain laufen.

Wir benutzen einen Caddy Container, um Letsencrypt bereitszustellen (siehe in den Beispielen unten).

Auf der Managed Umgebung müssen wir das Zonefile anpassen, um die Subdomain per A und AAAA Eintrag auf den Container Server zu verweisen.

Mit dem Befehl <code>dig</code> ermitteln wir die ipv4 und ipv6 Adressen unseres Container Servers:

<syntaxhighlight lang=shell>
dig -t A +short vm4xxx.hostsharing.net
dig -t AAAA +short vm4xxx.hostsharing.net
</syntaxhighlight>

Auf der Managed Umgebung, legen wir ein Zonefile an. Siehe auch die Anleitung im Handbuch: https://www.hostsharing.net/doc/managed-operations-platform/zonefile/

<code>doms/meinedomain.de/etc/pri.meinedomain.de</code>:

<syntaxhighlight lang=text>
{DEFAULT_ZONEFILE}

meinesubdomain IN A 83.223.xx.xxx
meinesubdomain IN AAAA 2a01:xx:xxxx::xxxx:xxxx:0
</syntaxhighlight>

=== Tunnel zur Managed Datenbank einrichten ===

Wir lassen die Anwendung auf dem Container Server laufen. Dort kann natürlich auch die Datenbank laufen, in einem eigenen Container.

Wir haben aber auch Datenbanken in der Managed Umgebung von Hostsharing, mit allen Vorteilen (regelmäßiges Backup, usw.).

Wenn wir eine managed Datenbank aus der Managed Umgebung auf dem Container Server einbinden wollen, sind folgende Schritte notwendig:

* TODO Es muss ein Tunnel eingerichtet werden, damit die Datenbank vom Container Server aus erreichbar ist.
* TODO: Anpassungen an Docker Compose. Beispiel

== Docker fernsteuern ==
Es besteht die Möglichkeit, über SSH den Docker Socket von außen zu erreichen. Damit wird es möglich, über eine IDE wie z.B. Intellij IDEA die Docker Container zu starten und zu stoppen.

Um das auszuprobieren, können diese Befehle ausgeführt werden:

<syntaxhighlight lang="bash">
ssh -nNT -L $(pwd)/docker.sock:/var/run/docker.sock tallyman@vmxxxx.hostsharing.net
export DOCKER_HOST=unix://$(pwd)/docker.sock
docker ps -a
</syntaxhighlight>

Nun sollten die aktuell laufenden Container gelistet werden.

== Beispiel Anwendungen ==
=== Container Umgebung mit Nginx und Certbot ===
TODO siehe https://codeberg.org/tpokorra/hs.compose/src/branch/main/nginx-certbot
=== Container Umgebung mit Caddy und Python Anwendung ===
TODO siehe https://codeberg.org/tpokorra/hs.compose/src/branch/main/caddy-test

=== Nextcloud High Performance Backend mit Caddy ===
* Docker Compose: siehe https://codeberg.org/tpokorra/hs.compose/src/branch/main/nextcloud-high_performance_backend
* Siehe auch dort die [https://codeberg.org/tpokorra/hs.compose/src/branch/main/nextcloud-high_performance_backend#readme README Datei], was für die Einrichtung erforderlich ist.

=== OnlyOffice Documentserver ===
TODO siehe https://codeberg.org/tpokorra/hs.compose/src/branch/main/onlyoffice-document_server

== Backups in Volumes einpflegen ==

Auf Anfrage stellen wir einen read-only Snapshot bereit, der unter anderem Docker-Volumes, Container und Compose-Dateien enthält.

Da Docker nicht direkt mit den User- und Gruppen-IDs des tallyman-Users arbeitet, sondern interne Sub-User- und Sub-Group-IDs verwendet, können diese Daten nicht unmittelbar zurückkopiert werden. Für die Wiederherstellung ist daher ein kurzer Zwischenschritt erforderlich.

Hinweis: selbstverständlich helfen wir auf Anfrage auch dabei, die Dateien wieder in das laufende System zu migrieren.

=== Beispiel: das pgdata Verzeichnis eines PostgreSQL Containers tauschen ===

==== Wo liegt das Volume auf dem Dateisystem? ====

<syntaxhighlight lang=bash>
docker ps -a # wie lautet der Containername?
docker inspect --format '{{ range .Mounts }}{{ if eq .Type "volume" }}{{ .Source }}{{ "\n" }}{{ end }}{{ end }}' postgres-1
</syntaxhighlight>

In unserem Fall sehen wir den Pfad: <code>/home/tallyman/.local/share/docker/volumes/8c73a862eaf1fc3dee55a2f29b6f3d3dd68e3049da58a21a5f73010e7233190c/_data</code>

==== Den betroffenen Container abschalten ====

In diesem Beispiel entscheiden wir uns dafür, die Container vollständig zu stoppen.
Der Grund dafür ist, dass es je nach Image nicht immer eindeutig ist, wie der darin laufende Prozess korrekt gestoppt und wieder gestartet werden sollte.

Alternativ könnten wir das Backup also auch direkt in das Volume kopieren und im bestehenden Container eine Shell öffnen, um die Dateien an die richtige Stelle zu verschieben.

<syntaxhighlight lang=bash>
docker ps -a # wie lautet der Containername?
docker stop app-1
docker stop postgres-1

# oder über die Service-Namen aus der compose.yaml
docker compose stop app
docker compose stop postgres
</syntaxhighlight>

==== In eine temporäre Subshell wechseln ====
Hier nutzen wir eine Abkürzung und lassen Docker einen temporären Container starten, der unseren Ordner als Volume einbindet.
So erhalten wir eine Shell im passenden Userid/Gruppenid-Kontext und können direkt mit den Dateien im Volume arbeiten, ohne den eigentlichen Service-Container starten, oder als root arbeiten zu müssen.

<syntaxhighlight lang=bash>
export VOL=".local/share/docker/volumes"
docker run --rm -it -v "$VOL:/data" bash
</syntaxhighlight>

Wir wechseln nun in das oben definierte Volume. Das Beispiel geht davon aus, dass das bereitgestellte Backupverzeichnis "pgdata2" genannt wurde.

<syntaxhighlight lang=bash>
cd data
mv pgdata pgdata.old
mv pgdata2 pgdata
</syntaxhighlight>

Hinweis: Falls wir zusätzliche Pakete brauchen, nutzt das – auf Alpine basierte – Bash image den Paketmanager `apk`. Beispiel: ncdu installieren:

<syntaxhighlight lang=bash>
~$ apk add ncdu
(1/1) Installing ncdu (1.22-r0)
Executing busybox-1.37.0-r30.trigger
OK: 8726 KiB in 20 packages
</syntaxhighlight>

==== Den Container wieder starten ====

Wir verlassen den Container mittels <code>exit</code> <code>Enter</code> oder über die Tastenkombination <code>STRG+D</code>.

<syntaxhighlight lang=bash>
docker start postgres-1
docker start app-1

# oder über die Service-Namen aus der compose.yaml
docker compose start app
docker compose start postgres
</syntaxhighlight>

=== Beispiel: eine Subshell mit Hilfe eine Containerprozesses starten ===
Für Debugging kann es nützlich sein, direkt mit allen vorinstallierten Tools im Containerserver mit Daten der Volumes zu agieren. Hier sind zwei Wege um eine Subshell ohne extra(!) Container zu starten:

==== Mit Hilfe eines beliebigen laufenden Containers: ====
<syntaxhighlight lang=bash>
docker ps
docker inspect --format '{{.State.Pid}}' app-1
nsenter -U -t 2586740 -- bash
</syntaxhighlight>

==== TODO ====
Funktionierende subshell (mit nötigen Berechtigungen) mittels unshare oder nsenter

Container

2026-01-27T14:29:28Z

Hsh-milanihl: restore

== Übersicht ==

Es gibt die Möglichkeit, einen Container Server mit Docker oder mit Podman zu buchen.

Dies ist eine Managed Umgebung, also ohne Root-Rechte, wo Docker bzw. Podman rootless ausgeführt werden.

Falls vom Installationsskript einer Anwendung Root-Rechte erforderlich sind, kann entweder versucht werden, dies anzupassen, oder es kann ein Cloud Server gebucht werden, wo der Benutzer Root-Rechte hat.

== Erste Schritte ==

Bei der Bestellung des Container Servers sollte direkt der Public SSH Key mitgegeben werden, am besten bereits nach dem Ed25519-Standard, siehe auch [https://www.heise.de/tipps-tricks/SSH-Key-erstellen-so-geht-s-4400280.html].

Der Zugriff erfolgt über den Benutzer tallyman über SSH auf den Container Server.

<syntaxhighlight lang=shell>
ssh tallyman@vm4xxx.hostsharing.net
</syntaxhighlight>

Um einen "Hello World" Docker Container zu starten:

<syntaxhighlight lang=shell>
tallyman@vm4xxx:~$ docker run hello-world
</syntaxhighlight>

Entsprechend sieht der Befehl für Podman aus:

<syntaxhighlight lang=shell>
tallyman@vm4xxx:~$ podman run hello-world
</syntaxhighlight>

=== Hilfreiche Befehle für Docker ===

<syntaxhighlight lang=shell>
# in einem Ordner ausführen, wo eine Datei mit dem Namen docker-compose.yml liegt, um die Umgebung zu bauen und zu starten:
docker compose up --detach

# zeige alle laufenden Container
docker ps -a

# zeige die Logs eines Containers
docker logs mein-container

# wechsle in eine Shell im Container
docker exec -t -i mein-container /bin/sh

# Images aktualisieren
docker compose pull

# Containerumgebung stoppen und löschen
docker compose down
</syntaxhighlight>

=== Hilfreiche Befehle für Podman ===

TODO

== Integration in Hostsharing Managed Platform ==

=== Subdomain einrichten ===

Wir haben bereits die Hauptdomain bei Hostsharing gebucht.

Nun soll unsere Anwendung auf dem Container Server auf einer Subdomain laufen.

Wir benutzen einen Caddy Container, um Letsencrypt bereitszustellen (siehe in den Beispielen unten).

Auf der Managed Umgebung müssen wir das Zonefile anpassen, um die Subdomain per A und AAAA Eintrag auf den Container Server zu verweisen.

Mit dem Befehl <code>dig</code> ermitteln wir die ipv4 und ipv6 Adressen unseres Container Servers:

<syntaxhighlight lang=shell>
dig -t A +short vm4xxx.hostsharing.net
dig -t AAAA +short vm4xxx.hostsharing.net
</syntaxhighlight>

Auf der Managed Umgebung, legen wir ein Zonefile an. Siehe auch die Anleitung im Handbuch: https://www.hostsharing.net/doc/managed-operations-platform/zonefile/

<code>doms/meinedomain.de/etc/pri.meinedomain.de</code>:

<syntaxhighlight lang=text>
{DEFAULT_ZONEFILE}

meinesubdomain IN A 83.223.xx.xxx
meinesubdomain IN AAAA 2a01:xx:xxxx::xxxx:xxxx:0
</syntaxhighlight>

=== Tunnel zur Managed Datenbank einrichten ===

Wir lassen die Anwendung auf dem Container Server laufen. Dort kann natürlich auch die Datenbank laufen, in einem eigenen Container.

Wir haben aber auch Datenbanken in der Managed Umgebung von Hostsharing, mit allen Vorteilen (regelmäßiges Backup, usw.).

Wenn wir eine managed Datenbank aus der Managed Umgebung auf dem Container Server einbinden wollen, sind folgende Schritte notwendig:

* TODO Es muss ein Tunnel eingerichtet werden, damit die Datenbank vom Container Server aus erreichbar ist.
* TODO: Anpassungen an Docker Compose. Beispiel

== Docker fernsteuern ==
Es besteht die Möglichkeit, über SSH den Docker Socket von außen zu erreichen. Damit wird es möglich, über eine IDE wie z.B. Intellij IDEA die Docker Container zu starten und zu stoppen.

Um das auszuprobieren, können diese Befehle ausgeführt werden:

<syntaxhighlight lang="bash">
ssh -nNT -L $(pwd)/docker.sock:/var/run/docker.sock tallyman@vmxxxx.hostsharing.net
export DOCKER_HOST=unix://$(pwd)/docker.sock
docker ps -a
</syntaxhighlight>

Nun sollten die aktuell laufenden Container gelistet werden.

== Beispiel Anwendungen ==
=== Container Umgebung mit Nginx und Certbot ===
TODO siehe https://codeberg.org/tpokorra/hs.compose/src/branch/main/nginx-certbot
=== Container Umgebung mit Caddy und Python Anwendung ===
TODO siehe https://codeberg.org/tpokorra/hs.compose/src/branch/main/caddy-test

=== Nextcloud High Performance Backend mit Caddy ===
* Docker Compose: siehe https://codeberg.org/tpokorra/hs.compose/src/branch/main/nextcloud-high_performance_backend
* Siehe auch dort die [https://codeberg.org/tpokorra/hs.compose/src/branch/main/nextcloud-high_performance_backend#readme README Datei], was für die Einrichtung erforderlich ist.

=== OnlyOffice Documentserver ===
TODO siehe https://codeberg.org/tpokorra/hs.compose/src/branch/main/onlyoffice-document_server

== Backups in Volumes einpflegen ==

Auf Anfrage stellen wir einen read-only Snapshot bereit, der unter anderem Docker-Volumes, Container und Compose-Dateien enthält.

Da Docker nicht direkt mit den User- und Gruppen-IDs des tallyman-Users arbeitet, sondern interne Sub-User- und Sub-Group-IDs verwendet, können diese Daten nicht unmittelbar zurückkopiert werden. Für die Wiederherstellung ist daher ein kurzer Zwischenschritt erforderlich.

Hinweis: selbstverständlich helfen wir auf Anfrage auch dabei, die Dateien wieder in das laufende System zu migrieren.

=== Beispiel: das pgdata Verzeichnis eines PostgreSQL Containers tauschen ===

==== Wo liegt das Volume auf dem Dateisystem? ====

<syntaxhighlight lang=bash>
docker ps -a # wie lautet der Containername?
docker inspect --format '{{ range .Mounts }}{{ if eq .Type "volume" }}{{ .Source }}{{ "\n" }}{{ end }}{{ end }}' postgres-1
</syntaxhighlight>

In unserem Fall sehen wir den Pfad: <code>/home/tallyman/.local/share/docker/volumes/8c73a862eaf1fc3dee55a2f29b6f3d3dd68e3049da58a21a5f73010e7233190c/_data</code>

==== Den betroffenen Container abschalten ====

In diesem Beispiel entscheiden wir uns dafür, die Container vollständig zu stoppen.
Der Grund dafür ist, dass es je nach Image nicht immer eindeutig ist, wie der darin laufende Prozess korrekt gestoppt und wieder gestartet werden sollte.

Alternativ könnten wir das Backup also auch direkt in das Volume kopieren und im bestehenden Container eine Shell öffnen, um die Dateien an die richtige Stelle zu verschieben.

<syntaxhighlight lang=bash>
docker ps -a # wie lautet der Containername?
docker stop app-1
docker stop postgres-1

# oder über die Service-Namen aus der compose.yaml
docker compose stop app
docker compose stop postgres
</syntaxhighlight>

==== In eine tenporäre Subshell wechseln ====
Hier nutzen wir eine Abkürzung und lassen Docker einen temporären Container starten, der unseren Ordner als Volume einbindet.
So erhalten wir eine Shell im passenden Userid/Gruppenid-Kontext und können direkt mit den Dateien im Volume arbeiten, ohne den eigentlichen Service-Container starten, oder als root arbeiten zu müssen.

<syntaxhighlight lang=bash>
export VOL=".local/share/docker/volumes"
docker run --rm -it -v "$VOL:/data" bash
</syntaxhighlight>

Wir wechseln nun in das oben definierte Volume. Das Beispiel geht davon aus, dass das bereitgestellte Backupverzeichnis "pgdata2" genannt wurde.

<syntaxhighlight lang=bash>
cd data
mv pgdata pgdata.old
mv pgdata2 pgdata
</syntaxhighlight>

Hinweis: Falls wir zusätzliche Pakete brauchen, nutzt das – auf Alpine basierte – Bash image den Paketmanager `apk`. Beispiel: ncdu installieren:

<syntaxhighlight lang=bash>
~$ apk add ncdu
(1/1) Installing ncdu (1.22-r0)
Executing busybox-1.37.0-r30.trigger
OK: 8726 KiB in 20 packages
</syntaxhighlight>

==== Den Container wieder starten ====

Wir verlassen den Container mittels <code>exit</code> <code>Enter</code> oder über die Tastenkombination <code>STRG+D</code>.

<syntaxhighlight lang=bash>
docker start postgres-1
docker start app-1

# oder über die Service-Namen aus der compose.yaml
docker compose start app
docker compose start postgres
</syntaxhighlight>

=== Beispiel: eine Subshell mit Hilfe eine Containerprozesses starten ===
Für Debugging kann es nützlich sein, direkt mit allen vorinstallierten Tools im Containerserver mit Daten der Volumes zu agieren. Hier sind zwei Wege um eine Subshell ohne extra(!) Container zu starten:

==== Mit Hilfe eines beliebigen laufenden Containers: ====
<syntaxhighlight lang=bash>
docker ps
docker inspect --format '{{.State.Pid}}' app-1
nsenter -U -t 2586740 -- bash
</syntaxhighlight>

==== TODO ====
Funktionierende subshell (mit nötigen Berechtigungen) mittels unshare oder nsenter

Keycloak installieren

2025-09-08T09:23:45Z

Hsh-milanihl: /* Plugin-Installation */

== Allgemein ==

Keycloak [http://www.keycloak.org/] ist eine Open Source Lösung, die ein Single Sign On für verschiedene Anwendungen ermöglicht. Dabei ermöglicht es sowohl die Identitätsverwaltung als auch Zugriffsmanagement.

Es kann die Benutzer entweder aus einem existierenden Verzeichnisdienst (LDAP, Active Directory) auslesen, oder die Gruppen und Benutzer auch selber verwalten.

== Technische Details ==
Keycloak ist in Java geschrieben. Bisher lief es in einem Wildfly Server, aber seit Version 17 (Februar 2022) benutzt es Quarkus, welches ein leichtgewichtiges Java Framework ist.

Es gibt ein Ansible Skript, das die Installationsschritte für Keycloak automatisiert durchführt.

Die Quellen für das Ansible Skript können hier eingesehen werden: [https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/keycloak]

== Installation ==
Was das Ansible Skript macht, lässt sich mit diesen Worten beschreiben:

* Es wird ein Linux Benutzer eingerichtet.
* Es wird eine Postgresql Datenbank eingerichtet.
* Es wird eine Domain aufgeschaltet.
* Es wird Keycloak als Zip Datei heruntergeladen, z.B. [https://github.com/keycloak/keycloak/releases/download/17.0.0/keycloak-17.0.0.zip], und ins Verzeichnis $HOME/keycloak-17.0.0 entpackt.
* Dann werden ein paar Konfigurationen an der Datei <code>keycloak/conf/keycloak.conf</code> vorgenommen, um die Postgresql Datenbank einzurichten, und um den Proxymodus auf edge zu setzen und den Hostname zu setzen.
* Nun wird die Keycloak Instanz initialisiert, mit dem Befehl: <code>keycloak/bin/kc.sh --cache=local --profile=prod build</code>. Hierbei verhindert die Einstellung für den Cache, dass Keycloak versucht über das Netzwerk Verbindungen zu anderen Instanzen herzustellen.
* Es muss der Server einmal gestartet werden, während der Admin Benutzer mit Passwort in einer Umgebungsvariable gesetzt ist, damit der Benutzer eingerichtet wird.
* Es wird Monit konfiguriert, um den Keycloak Service zu starten, der auf einem internen Port lauscht.
* Es wird der Apache in der htaccess Datei konfiguriert, damit die aufgeschaltete Domain über Proxy auf den Keycloak Dienst verweist. Dabei ist wichtig, dass der Java Prozess mitbekommt, dass die Seite über https läuft. Dazu wird in der htaccess Datei der Wert X-Forwarded-Proto auf https gesetzt.

=== Keycloak mit Systemd ===

Sofern <code>linger</code> für den User schon verfügbar ist, kann auch Systemd verwendet werden. Zudem sollte im Vorfeld <code>export XDG_RUNTIME_DIR=/run/user/$UID</code> ausgeführt werden um Zugriff auf die Befehle zu erhalten.

Beispiel einer Systemd Konfiguration in <code>.config/systemd/user/keycloak.service</code>
<syntaxhighlight lang=ini line>
[Unit]
Description=Keycloak

[Service]
Type=simple
Restart=on-abort
WorkingDirectory=/home/pacs/xyz00/users/login/keycloak
Environment=PROXY_ADDRESS_FORWARDING=true

# Für den ersten Start, um den Adminuser zu setzen
#Environment=KEYCLOAK_ADMIN=changeme
#Environment=KEYCLOAK_ADMIN_PASSWORD=changeme

# Die Option cache=local kann auch an anderer Stelle gesetzt werden.
# Hauptsache sie taucht auf, da es sonst zu Performance-Problemen wie
# Timeouts kommen kann.
ExecStart=/home/pacs/xyz00/users/login/keycloak/latest/bin/kc.sh start --cache=local

[Install]
# Achtung: multiuser.target würde hier zu Problemen führen
WantedBy=default.target
</syntaxhighlight>
== Beispiel einer Einrichtung ==
Diese Anleitung steht auch als [https://youtu.be/bmOp8epgxsM Video auf Youtube] zur Verfügung.

* Auf https://keycloak.example.org/admin anmelden.

=== Admin User einrichten ===
* Der auf der Kommandozeile angelegte Benutzer ist nur vorübergehend gültig.
* Bitte einen permanenten Admin User anlegen, mit den entsprechenden Rollen (role_admin und role_default-roles) ausstatten
* Login mit permanentem Admin durchführen
* Dann den temporären Benutzer löschen.

=== Realm einrichten ===
* Es soll nicht mit der master Realm gearbeitet werden, sondern sollte eine weitere Realm eingerichtet werden, z.B. "MeineFirma"
* Diese neue Realm wird dann ausgewählt

=== Benutzer einrichten ===
* Innerhalb der neuen Realm wird dann ein neuer Benutzer angelegt.
* Beim neuen Benutzer kann ausgewählt werden, dass die E-Mail bereits bestätigt ist.
* Nach dem Speichern des Benutzers kann man dann auch bei Credentials das Passwort setzen. Wenn es nur temporär ist, muss der Benutzer es bei der ersten Anmeldung ändern.
* Nun kann man sich als Administrator abmelden und sich als der Benutzer anmelden, auf https://keycloak.example.org/realms/MeineFirma/account/#/
** Achtung: in anderen Anleitungen heißen die URLs /auth/realms usw, aber auth scheint nicht mehr Teil der Standardeinrichtung zu sein.
* Als Benutzer kann man sein Passwort ändern.
* Wieder abmelden, und wieder als Administrator anmelden.

=== Client einrichten ===
* Achtung: erst aus der Master Realm in die vorher angelegte Realm wechseln, z.B. "MeineFirma"
* Nun sollte ein Client hinzugefügt werden, also eine beliebige Anwendung, die mit Keycloak zusammenarbeiten soll
** Als Client-Protokoll wählt man "OpenID Connect"
** Die Client-ID kann so aussehen: my-nextcloud
** Anwählen: 'Client Authentication', um den OID Typ auf 'Confidential Access Type' zu setzen.
** Anwählen: 'Standard Flow', 'Implicit Flow' und 'Direct Access Grants'
* Eine Root Url eingeben, z.B. https://nextcloud.example.org
* Eine Valid Redirect URI eingeben, z.B. https://nextcloud.example.org/*
* Gültige Web Origins eingeben, z.B. https://nextcloud.example.org
* Speichern
* Unter Roles eine neue Rolle mit Namen admin anlegen.
* Wieder unter den Client Nextcloud gehen, und bei "Client Scopes" klicke auf "my-nextcloud-dedicated", und wähle dort "Add predefined Mapper". Wähle "client roles", und klicke auf "Add". Dann diesen neuen Mapper "client roles" Bearbeiten, und Client ID auf "my-nextcloud" setzen, und "Token Claim Name" mit "roles" setzen, und "Add to userinfo" auf "ON" stellen. Dann Speichern.
* Dann zu nochmal zu Client Scopes (im Client) gehen, und auf "my-nextcloud-dedicated" klicken, und dort im Reiter "Scope" die Option "Full Scope Allowed" abschalten.

* Dann unter Configure / Realm Settings, in General, bei Endpoints auf "OpenID Endpoint Configuration" klicken, dann wird eine Seite geöffnet, auf dieser URL: https://keycloak.example.org/realms/MeineFirma/.well-known/openid-configuration; diese Seite offen halten, wir brauchen daraus die Daten für die Nextcloud Einrichtung

=== Nextcloud einrichten (Einfach) ===
* Als Administrator anmelden, und bei den Apps die App [https://apps.nextcloud.com/apps/sociallogin "Social Login"] installieren.
* Dann bei Einstellungen, unter Verwaltung, Social Login, die gewünschten Einstellungen vornehmen.
* Es sollte ein Kreuz sein bei: Anlegen eines Kontos verhindern, wenn die E-Mail-Adresse bereits von einem anderen Konto verwendet wird.
* Es sollte ein Kreuz sein bei: Verhindern, dass sich Benutzer ohne gemappte Gruppe anmelden können.
* Speichern
* Dann bei "Benutzerdefinierte OpenID Connect Anbindung" auf das Plus klicken
* Nun die Daten aus der "OpenID Endpoint Configuration" (siehe oben) übernehmen: Authorize URL, Token URL, User info URL, Logout URL
* Client ID: nc (Name des Clients in Keycloak)
* Client Secret: hier kommt das Secret hinein, das in Keycloak im Client unter Credentials "Client Secret" zu finden ist. Das kann über die Zwischenablage kopiert werden.
* Scope: openid
* Speichern

=== Nextcloud einrichten (Fortgeschritten) ===
Die folgende App wird mit Rücksicht auf Keycloak entwickelt und hat daher eine <strong>bessere Kompatibilität</strong> als das Beispiel oben. Allerdings gibt es hierfür keine Optionen in der Cloud, stattdessen wird die <code>config.php</code> direkt bearbeitet.

==== Plugin-Installation ====

# Als Administrator die App [https://github.com/pulsejet/nextcloud-oidc-login "Nextcloud OIDC Login"] installieren
# Die Nextcloud Konfigurationsdatei unter <code>pfad/zur/nextcloud/config/config.php</code> öffnen und basierend auf dem Readme der App (Link aus Schritt #1) befüllen. Das könnte so aussehen:
<syntaxhighlight lang=php line>
'oidc_login_client_id' => 'nextcloud',
'oidc_login_client_secret' => 'bSIPDNUyTQpxmfOpXdwyoBP8nZDQZVuL', // Client Reiter "Credentials" in Keycloak
'oidc_login_provider_url' => 'https://login.mydomain.de/realms/myrealm',
'oidc_login_end_session_redirect' => true,
'oidc_login_logout_url' => 'https://cloud.mydomain.de/index.php/apps/oidc_login/oidc',
'oidc_login_auto_redirect' => true, // hiermit wird das Login-Formular übergangen um Leute weniger zu verwirren
'oidc_login_redir_fallback' => false,
'oidc_login_disable_registration' => false, // Nextcloud soll neue Keycloak Accounts akzeptieren
'oidc_create_groups' => true,
'oidc_login_attributes' => array(
'id' => 'preferred_username',
'mail' => 'email',
'groups' => 'ownCloudGroups',
'is_admin' => 'ownCloudAdmin',
),
</syntaxhighlight>

==== In Keycloak nochmal alles kontrollieren ====
# Client ID stimmt überein
# unter <code>Capability config</code> ist <code>Client authentication</code> aktiv (damit wir ua. unser Secret bekommen)
# <code>Valid redirect URIs</code> erlaubt </code>https://cloud.mydomain.de/*</code> – oder eine konkretere Adresse. Das Plus übernimmt die Einstellung aus <code>Valid redirect URIs</code>
# <code>Valid post logout redirect URIs</code> erlaubt <code>+</code> oder </code>https://cloud.mydomain.de/*</code> – oder eine konkretere Adresse
# <code>Fine Grain OpenID Connect Configuration</code> steht unter <code>ID Token Signature Algorithm</code> auf <code>RS256</code> (Achtung, hier verrutscht man schnell weil die Einträge sich ähneln)

==== Gruppen Synchronisation über Rollen ermöglichen ====
Hierfür legen wir einen Mapper in <code>nextcloud</code> Client an. Anschließend müssen die tatsächlichen Gruppen mit Roles verknüpft werden. Hintergrund ist, dass Roles eigentlich für Berechtigungsmanagement gedacht sind, und Gruppen eigentlich nur User gruppieren sollen.
# wir wechseln im Client <code>nextcloud</code> auf den Reiter <code>Client scopes</code>
# wir wählen <code>nextcloud-dedicated</code>
# Add mapper -> by configuration
## Type: <code>User Client Role</code>
## Name: <code>ownCloudGroups</code>
## Client ID
### <strong>Option #1:</strong> <code>none</code> – es werden alle <code>Realm roles</code> abgerufen. Das umfasst allerdings auch die Defaults wie <code>uma_authorization</code>, <code>offline_access</code>, <code>default-user-roles</code> und ist nicht immer gewünscht.
### <strong>Option #2:</strong> <code>nextcloud</code> hier können im Anschluss roles im Client angelegt und mit <code>Groups</code> oder <code>Realm roles</code> verknüpft werden.
## Multivalued: <code>On</code>
## Token Claim Name: <code>ownCloudGroups</code>
## Claim JSON Type: <code>String</code>
## die folgenden drei Optionen: <code>On</code>

==== Gruppen Synchronisation in der Praxis ====

<strong>Option #2:</strong> Client ID <code>nextcloud</code>
# wir wechseln im Client <code>nextcloud</code> auf den Reiter <code>Roles</code>
# Create role
## Wunschname
# wir wechseln in <code>Groups</code> (Sidebar)
# Create group
## Wunschname
# In der Gruppe wechseln wir auf den Reiter <code>Role mapping</code>
## Assign role
## Im Dropdown welchseln wir auf den Filter <code>by clients</code>
## Wir wählen die gewünschte Rolle
## Unten Links, button <code>Assign</code>

Ab hier können wir die Gruppe normal zuweisen.

=== Benutzer einrichten ===
* Einen Benutzer im Keycloak einrichten, in der Realm "MeineFirma".
* Den Benutzer bearbeiten, und unter "Role Mappings", "Assign Role", "Filter by Clients", wähle "my-nextcloud admin" und klicke auf "Assign".

== Fehler beheben ==

Problem: Gerade beim Experimentieren kommt schon mal die Meldung: "expected expression, got end of script"
* Lösung: Webseite aus der Firefox Chronik komplett löschen, oder in einem privaten Fenster öffnen, dann geht es wieder.

Generell kann es zu verwirrenden Fehlermeldungen kommen, wenn man sich versucht in einer verknüpften Anwendung einzuloggen aber beispielsweise noch als Admin im Master-Realm eingeloggt ist.

=== Logging ===
Um Fehler besser verstehen zu können, kann das Logging angeschaltet werden, siehe auch [https://www.keycloak.org/server/logging].

Dazu müssen im Start Skript <code>bin/start-keycloak.sh</code> folgende Parameter hinzugefügt werden:
<syntaxhighlight lang=shell>
--log-level=ERROR --log=file
</syntaxhighlight>
Also sieht es z.B. so aus:
<syntaxhighlight lang=shell>
./bin/kc.sh start --http-port [...] --proxy edge --log-level=ERROR --log=file &
</syntaxhighlight>
Nach dem Neustart von Keycloak gibt es dann die Datei <code>keycloak/data/log/keycloak.log</code>.

== Links ==
*[http://www.keycloak.org/ Webseite von Keycloak]
*[https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/keycloak Ansible Playbook für Hostsharing]
*[https://robferguson.org/blog/2019/12/24/getting-started-with-keycloak/ Getting started with Keycloak]
*[https://janikvonrotz.ch/2020/10/20/openid-connect-with-nextcloud-and-keycloak/ OpenID Connect with Nextcloud and Keycloak] von Janik Vonrotz, Oktober 2020
* [https://www.muehlencord.de/wordpress/2019/12/14/nextcloud-sso-using-keycloak/ Nextcloud SSO using Keycloak] von Jörns Blog, Dezember 2019
* [https://youtu.be/bmOp8epgxsM Erklärvideo auf Youtube] zum Einrichten von Keycloak und Nextcloud
* [https://apps.nextcloud.com/apps/sociallogin Nextcloud App Social Login]

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Ansible Playbook]]
[[Kategorie:Software]]
[[Kategorie:SSO]]
[[Kategorie:Java]]

Matrix Authentication Service

2025-05-12T13:59:02Z

Hsh-milanihl:

'''Achtung: diese Info-Seite erfordert einen Hostmaster mit Zugriff auf die [[Apache]]-Domain-Konfigurationsdatei, mit leichter Abänderung sollte die [[.htaccess]] allerdings genauso funktionieren.'''

MAS beginnt die alte Authentifizierung direkt über [[Synapse]] zu ersetzen. Schon heute fällt es langsam auf, wenn der Dienst fehlt – beispielsweise weil ElementX diesen für SSO benötigt oder weil sonst der Login via QR-Code nicht unterstützt wird.

== Offizielle Dokumentation ==

Die offizielle Dokumentation befindet sich unter [https://element-hq.github.io/matrix-authentication-service/ element-hq.github.io/matrix-authentication-service].

== Vorbereitung im Userspace ==

=== Verzeichnisstruktur (Vorschlag) ===

<syntaxhighlight lang=shell>
├── bin
│   ├── mas
│   └── mas-cli -> /home/pacs/xyz00/users/mas/bin/mas/mas-cli # optional
├── doms
│   └── auth.matrix.domain.de
├── etc
│   └── config.yaml
├── readme.md
├── scripts
│   └── update.sh
└── var
└── log
</syntaxhighlight>

=== Updatescript ===

Dieses Script ist auch schon zur Vorbereitung nützlich. Es basiert auf og. Wiki und holt sich die neueste Release und entpackt diese in bin/.

<syntaxhighlight lang=shell>
ARCH=x86_64
OS=linux
VERSION=latest

# URL to the right archive
URL="https://github.com/element-hq/matrix-authentication-service/releases/${VERSION}/download/mas-cli-${ARCH}-${OS}.tar.gz"

curl -sL "$URL" | tar xzC $HOME/bin/mas
ln -s $HOME/bin/mas/mas-cli $HOME/bin/ # optional

systemctl restart --user mas.service
</syntaxhighlight>

=== Config ===

In Sachen Konfiguration, können wir einfach den offiziellen Anweisung des Projekts folgen. Einzig die default Ports, können bei Hostsharing so nicht genutzt werden. Als Beispiel für den http web-listener könnte sich <code>32802</code> anbieten, sofern dieser frei ist.

=== Systemd ===

<syntaxhighlight lang=ini>
[Unit]
Description=Matrix Authentication Service
After=network-online.target
After=postgresql.target

[Service]
Type=simple
WorkingDirectory=%h/bin/mas
ExecStart=%h/bin/mas/mas-cli server -c %h/etc/config.yaml

[Install]
WantedBy=default.target
</syntaxhighlight>

<syntaxhighlight lang=shell>
# wenn alles bereit:
systemctl enable --now --user mas
# dies aktiviert den dienst für starten nach reboot und startet den dienst sofort (now)
</syntaxhighlight>

== QR Code Support in Synapse ==

Leicht zu übersehen ist ein zu aktivierendes MSC in Synapse um QR-Code Login zu unterstützen:

<syntaxhighlight lang=yaml>
experimental_features:
msc4108_enabled: true
</syntaxhighlight>

Achtung! Zum testen muss Keystorage für den User aktiv sein!

== Apache ==

Außerhalb der .htaccess (Hostmaster, FIXME), '''für die Domain des Synapse homeservers(!)'''.
<syntaxhighlight lang=apache>
# Wichtig, da sonst dieser Endpoint nicht funktioniert, und es zu verwirrenden Fehlern kommt.
SetEnvIf request_Uri "/_synapse/client/rendezvous" no-gzip
# FIXME: retry in .htaccess
ProxyPassMatch "^/(_matrix/client/[^/]+/(login|logout|refresh).*)" "http://127.0.0.1:32802/$1"
ProxyPassReverse "^/(_matrix/client/[^/]+/(login|logout|refresh).*)" "http://127.0.0.1:32802/$1"
</syntaxhighlight>

.htaccess für MAS:

<syntaxhighlight lang=apache>
DirectoryIndex disabled
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-l
RewriteRule .* http://localhost:32802%{REQUEST_URI} [NE,proxy]
RequestHeader set X-Forwarded-Proto "https"
</syntaxhighlight>

== Weitere Tipps ==

=== Migration ===
Laut Wiki benötigt MAS Zugriff auf die <code>homeserver.yaml</code>, es reicht aber einfach eine Datei mit den nötigsten Einstellungen bereitzulegen: Evtl der federation listener, Datenbank und falls vorhanden, der OIDC Provider.

=== Beispiel Keycloak ===

Um die Provider-ID für Keycloak zu matchen, kann <code>upstream_oauth2.providers.synapse_idp_id</code> genutzt werden. MAS unterstützt Benennungen wie in unserem Fall <code>oidc-keycloak</code> nicht mehr, aber muss das für die Migration matchen.

Matrix Authentication Service

2025-05-12T13:54:34Z

Hsh-milanihl: /* Apache */

Matrix Authentication Service

2025-05-12T13:54:02Z

Hsh-milanihl: /* Apache */

'''Achtung: diese Info-Seite erfordert einen Hostmaster mit Zugriff auf die [[Apache]]-Domain-Konfigurationsdatei, mit leichter Abänderung sollte die [[.htaccess]] allerdings genauso funktionieren.'''

MAS beginnt die alte Authentifizierung direkt über [[Synapse]] zu ersetzen. Schon heute fällt es langsam auf, wenn der Dienst fehlt – beispielsweise weil ElementX diesen für SSO benötigt oder weil sonst der Login via QR-Code nicht unterstützt wird.

== Offizielle Dokumentation ==

Die offizielle Dokumentation befindet sich unter [https://element-hq.github.io/matrix-authentication-service/ element-hq.github.io/matrix-authentication-service].

== Vorbereitung im Userspace ==

=== Verzeichnisstruktur (Vorschlag) ===

<syntaxhighlight lang=shell>
├── bin
│   ├── mas
│   └── mas-cli -> /home/pacs/xyz00/users/mas/bin/mas/mas-cli # optional
├── doms
│   └── auth.matrix.domain.de
├── etc
│   └── config.yaml
├── readme.md
├── scripts
│   └── update.sh
└── var
└── log
</syntaxhighlight>

=== Updatescript ===

Dieses Script ist auch schon zur Vorbereitung nützlich. Es basiert auf og. Wiki und holt sich die neueste Release und entpackt diese in bin/.

<syntaxhighlight lang=shell>
ARCH=x86_64
OS=linux
VERSION=latest

# URL to the right archive
URL="https://github.com/element-hq/matrix-authentication-service/releases/${VERSION}/download/mas-cli-${ARCH}-${OS}.tar.gz"

curl -sL "$URL" | tar xzC $HOME/bin/mas
ln -s $HOME/bin/mas/mas-cli $HOME/bin/ # optional

systemctl restart --user mas.service
</syntaxhighlight>

=== Config ===

In Sachen Konfiguration, können wir einfach den offiziellen Anweisung des Projekts folgen. Einzig die default Ports, können bei Hostsharing so nicht genutzt werden. Als Beispiel für den http web-listener könnte sich <code>32802</code> anbieten, sofern dieser frei ist.

=== Systemd ===

<syntaxhighlight lang=ini>
[Unit]
Description=Matrix Authentication Service
After=network-online.target
After=postgresql.target

[Service]
Type=simple
WorkingDirectory=%h/bin/mas
ExecStart=%h/bin/mas/mas-cli server -c %h/etc/config.yaml

[Install]
WantedBy=default.target
</syntaxhighlight>

<syntaxhighlight lang=shell>
# wenn alles bereit:
systemctl enable --now --user mas
# dies aktiviert den dienst für starten nach reboot und startet den dienst sofort (now)
</syntaxhighlight>

== QR Code Support in Synapse ==

Leicht zu übersehen ist ein zu aktivierendes MSC in Synapse um QR-Code Login zu unterstützen:

<syntaxhighlight lang=yaml>
experimental_features:
msc4108_enabled: true
</syntaxhighlight>

Achtung! Zum testen muss Keystorage für den User aktiv sein!

== Apache ==

Außerhalb der .htaccess (Hostmaster, FIXME), '''für die Domain des Synapse homeservers(!)'''.
<syntaxhighlight lang=apache>
# Wichtig, da sonst dieser Endpoint nicht funktioniert, und es zu verwirrenden Fehlern kommt.
SetEnvIf request_Uri "/_synapse/client/rendezvous" no-gzip
# FIXME: retry in .htaccess
ProxyPassMatch "^/(_matrix/client/[^/]+/(login|logout|refresh).*)" "http://127.0.0.1:32802/$1"
ProxyPassReverse "^/(_matrix/client/[^/]+/(login|logout|refresh).*)" "http://127.0.0.1:32802/$1"
</syntaxhighlight>

.htaccess
<syntaxhighlight lang=apache>
DirectoryIndex disabled
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-l
RewriteRule .* http://localhost:32802%{REQUEST_URI} [NE,proxy]
RequestHeader set X-Forwarded-Proto "https"
</syntaxhighlight>

Matrix Authentication Service

2025-05-12T13:52:57Z

Hsh-milanihl: /* Systemd */

'''Achtung: diese Info-Seite erfordert einen Hostmaster mit Zugriff auf die [[Apache]]-Domain-Konfigurationsdatei, mit leichter Abänderung sollte die [[.htaccess]] allerdings genauso funktionieren.'''

MAS beginnt die alte Authentifizierung direkt über [[Synapse]] zu ersetzen. Schon heute fällt es langsam auf, wenn der Dienst fehlt – beispielsweise weil ElementX diesen für SSO benötigt oder weil sonst der Login via QR-Code nicht unterstützt wird.

== Offizielle Dokumentation ==

Die offizielle Dokumentation befindet sich unter [https://element-hq.github.io/matrix-authentication-service/ element-hq.github.io/matrix-authentication-service].

== Vorbereitung im Userspace ==

=== Verzeichnisstruktur (Vorschlag) ===

<syntaxhighlight lang=shell>
├── bin
│   ├── mas
│   └── mas-cli -> /home/pacs/xyz00/users/mas/bin/mas/mas-cli # optional
├── doms
│   └── auth.matrix.domain.de
├── etc
│   └── config.yaml
├── readme.md
├── scripts
│   └── update.sh
└── var
└── log
</syntaxhighlight>

=== Updatescript ===

Dieses Script ist auch schon zur Vorbereitung nützlich. Es basiert auf og. Wiki und holt sich die neueste Release und entpackt diese in bin/.

<syntaxhighlight lang=shell>
ARCH=x86_64
OS=linux
VERSION=latest

# URL to the right archive
URL="https://github.com/element-hq/matrix-authentication-service/releases/${VERSION}/download/mas-cli-${ARCH}-${OS}.tar.gz"

curl -sL "$URL" | tar xzC $HOME/bin/mas
ln -s $HOME/bin/mas/mas-cli $HOME/bin/ # optional

systemctl restart --user mas.service
</syntaxhighlight>

=== Config ===

In Sachen Konfiguration, können wir einfach den offiziellen Anweisung des Projekts folgen. Einzig die default Ports, können bei Hostsharing so nicht genutzt werden. Als Beispiel für den http web-listener könnte sich <code>32802</code> anbieten, sofern dieser frei ist.

=== Systemd ===

<syntaxhighlight lang=ini>
[Unit]
Description=Matrix Authentication Service
After=network-online.target
After=postgresql.target

[Service]
Type=simple
WorkingDirectory=%h/bin/mas
ExecStart=%h/bin/mas/mas-cli server -c %h/etc/config.yaml

[Install]
WantedBy=default.target
</syntaxhighlight>

<syntaxhighlight lang=shell>
# wenn alles bereit:
systemctl enable --now --user mas
# dies aktiviert den dienst für starten nach reboot und startet den dienst sofort (now)
</syntaxhighlight>

== QR Code Support in Synapse ==

Leicht zu übersehen ist ein zu aktivierendes MSC in Synapse um QR-Code Login zu unterstützen:

<syntaxhighlight lang=yaml>
experimental_features:
msc4108_enabled: true
</syntaxhighlight>

Achtung! Zum testen muss Keystorage für den User aktiv sein!

== Apache ==

Außerhalb der .htaccess (Hostmaster, FIXME)
<syntaxhighlight lang=apache>
# Wichtig, da sonst dieser Endpoint nicht funktioniert, und es zu verwirrenden Fehlern kommt.
SetEnvIf request_Uri "/_synapse/client/rendezvous" no-gzip
# FIXME: retry in .htaccess
ProxyPassMatch "^/(_matrix/client/[^/]+/(login|logout|refresh).*)" "http://127.0.0.1:32802/$1"
ProxyPassReverse "^/(_matrix/client/[^/]+/(login|logout|refresh).*)" "http://127.0.0.1:32802/$1"
</syntaxhighlight>

.htaccess
<syntaxhighlight lang=apache>
DirectoryIndex disabled
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-l
RewriteRule .* http://localhost:32802%{REQUEST_URI} [NE,proxy]
RequestHeader set X-Forwarded-Proto "https"
</syntaxhighlight>

Matrix Authentication Service

2025-05-12T13:50:24Z

Hsh-milanihl: initital commit

'''Achtung: diese Info-Seite erfordert einen Hostmaster mit Zugriff auf die [[Apache]]-Domain-Konfigurationsdatei, mit leichter Abänderung sollte die [[.htaccess]] allerdings genauso funktionieren.'''

MAS beginnt die alte Authentifizierung direkt über [[Synapse]] zu ersetzen. Schon heute fällt es langsam auf, wenn der Dienst fehlt – beispielsweise weil ElementX diesen für SSO benötigt oder weil sonst der Login via QR-Code nicht unterstützt wird.

== Offizielle Dokumentation ==

Die offizielle Dokumentation befindet sich unter [https://element-hq.github.io/matrix-authentication-service/ element-hq.github.io/matrix-authentication-service].

== Vorbereitung im Userspace ==

=== Verzeichnisstruktur (Vorschlag) ===

<syntaxhighlight lang=shell>
├── bin
│   ├── mas
│   └── mas-cli -> /home/pacs/xyz00/users/mas/bin/mas/mas-cli # optional
├── doms
│   └── auth.matrix.domain.de
├── etc
│   └── config.yaml
├── readme.md
├── scripts
│   └── update.sh
└── var
└── log
</syntaxhighlight>

=== Updatescript ===

Dieses Script ist auch schon zur Vorbereitung nützlich. Es basiert auf og. Wiki und holt sich die neueste Release und entpackt diese in bin/.

<syntaxhighlight lang=shell>
ARCH=x86_64
OS=linux
VERSION=latest

# URL to the right archive
URL="https://github.com/element-hq/matrix-authentication-service/releases/${VERSION}/download/mas-cli-${ARCH}-${OS}.tar.gz"

curl -sL "$URL" | tar xzC $HOME/bin/mas
ln -s $HOME/bin/mas/mas-cli $HOME/bin/ # optional

systemctl restart --user mas.service
</syntaxhighlight>

=== Config ===

In Sachen Konfiguration, können wir einfach den offiziellen Anweisung des Projekts folgen. Einzig die default Ports, können bei Hostsharing so nicht genutzt werden. Als Beispiel für den http web-listener könnte sich <code>32802</code> anbieten, sofern dieser frei ist.

=== Systemd ===

<syntaxhighlight lang=ini>
[Unit]
Description=Matrix Authentication Service
After=network-online.target
After=postgresql.target

[Service]
Type=simple
WorkingDirectory=%h/bin/mas
ExecStart=%h/bin/mas/mas-cli server -c %h/etc/config.yaml

[Install]
WantedBy=default.target
</syntaxhighlight>

== QR Code Support in Synapse ==

Leicht zu übersehen ist ein zu aktivierendes MSC in Synapse um QR-Code Login zu unterstützen:

<syntaxhighlight lang=yaml>
experimental_features:
msc4108_enabled: true
</syntaxhighlight>

Achtung! Zum testen muss Keystorage für den User aktiv sein!

== Apache ==

Außerhalb der .htaccess (Hostmaster, FIXME)
<syntaxhighlight lang=apache>
# Wichtig, da sonst dieser Endpoint nicht funktioniert, und es zu verwirrenden Fehlern kommt.
SetEnvIf request_Uri "/_synapse/client/rendezvous" no-gzip
# FIXME: retry in .htaccess
ProxyPassMatch "^/(_matrix/client/[^/]+/(login|logout|refresh).*)" "http://127.0.0.1:32802/$1"
ProxyPassReverse "^/(_matrix/client/[^/]+/(login|logout|refresh).*)" "http://127.0.0.1:32802/$1"
</syntaxhighlight>

.htaccess
<syntaxhighlight lang=apache>
DirectoryIndex disabled
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-l
RewriteRule .* http://localhost:32802%{REQUEST_URI} [NE,proxy]
RequestHeader set X-Forwarded-Proto "https"
</syntaxhighlight>

TLS Zertifikat mit LEGO

2024-12-09T14:28:51Z

Hsh-milanihl: /* regelmäßige Verlängerung */

= TLS Zertifikat mit LEGO =

Für den zentralen Apache Webserver werden bei Hostsharing automatisch TLS Zertifikate über den Dienst "Lets Encrypt" erzeugt und verlängert. Das wird über die Domain-Option "letsencrypt" gesteuert.

Teilweise will man aber eigene Serverdienste betreiben, die nicht über HTTP hinter dem Apache-Proxy erreichbar sind. Beispiele dafür sind ein eigener XMPP Server oder ein Mumble Server. Für diese Server können die Nutzer:innen der Hostsharing Plattform sehr leicht TLS Zertifikate erzeugen, indem sie den zentral installierten LEGO-Bot nutzen.

== Einrichtung ==

Zunächst muss eine Domain vorhanden sein, auf die das Zertifikat ausgestellt werden soll und die im Webspace über HTTP erreichbar ist.

Ich nutze hier den Service-User "xyz00-mumble" als Beispiel. Bei diesem User sei die Domain "mumble.hs-example.de" aufgeschaltet.

Dann lösche ich bei der Domain die HTTP-Weiterleitungen und die www-Subdomain:

<syntaxhighlight lang=shell line>
rm -rf ~/doms/mumble.hs-example.de/subs/www \
~/doms/mumble.hs-example.de/subs-ssl/www \
~/doms/mumble.hs-example.de/htdocs/.htaccess \
~/doms/mumble.hs-example.de/htdocs-ssl/.htaccess
</syntaxhighlight>
Das erste Zertifikat wird mit dem folgenden Befehl erzeugt:
<syntaxhighlight lang=shell line>
/usr/bin/lego -d mumble.hs-example.de -a \
--email webmaster@mumble.hs-example.de -k ec256 \
--http.webroot $HOME/doms/mumble.hs-example.de/htdocs \
--http run
</syntaxhighlight>
Bei der erfolgreichen Ausführung diese Befehls wurde ein verstecktes Verzeichnis ".lego" angelegt. In diesem Verzeichnis befinden sich die Daten zum neu angelegten Letsencrypt-Account und das Zertifikat mit dem zugehörigen private key.

Die Daten des Zertifikates kann man wie folgt auslesen:
<syntaxhighlight lang=shell line>
openssl x509 -in .lego/certificates/mumble.hs-example.de.crt -noout -text
</syntaxhighlight>

== regelmäßige Verlängerung ==

Für die automatische Verlängerung des Zertifikats können wir einen Cronjob aufsetzen, der zum Beispiel täglich oder wöchentlich läuft:

<syntaxhighlight lang=shell line>
$ cat bin/lego-renew
#!/bin/bash
HOME=/home/pacs/xyz00/users/mumble
/usr/bin/lego -d mumble.hs-example.de -a \
--email webmaster@mumble.hs-example.de -k ec256 \
--http.webroot $HOME/doms/mumble.hs-example.de/htdocs \
--http renew
</syntaxhighlight>

Die Ausführung des Skriptes wird über einen systemd timer gesteuert:

''~/.config/systemd/user/lego_certificate.service''

<syntaxhighlight lang=ini line>
[Unit]
Description=renew lego certificate

[Service]
Type=oneshot
ExecStart=php8.2 /home/pacs/xyz00/users/mumble/bin/lego-renew
</syntaxhighlight>

''~/.config/systemd/user/lego_certificate.timer''

<syntaxhighlight lang=ini line>
[Unit]
Description=timer for lego certificate

[Timer]
OnCalendar=Thu 4:34
Persistent=True

[Install]
WantedBy=timers.target
</syntaxhighlight>

Den Timer aktivieren und starten:

<syntaxhighlight lang=shell>
systemctl --user enable lego_certificate.timer
systemctl --user start lego_certificate.timer
</syntaxhighlight>

TLS Zertifikat mit LEGO

2024-12-09T14:27:10Z

Hsh-milanihl: /* Einrichtung */

= TLS Zertifikat mit LEGO =

Für den zentralen Apache Webserver werden bei Hostsharing automatisch TLS Zertifikate über den Dienst "Lets Encrypt" erzeugt und verlängert. Das wird über die Domain-Option "letsencrypt" gesteuert.

Teilweise will man aber eigene Serverdienste betreiben, die nicht über HTTP hinter dem Apache-Proxy erreichbar sind. Beispiele dafür sind ein eigener XMPP Server oder ein Mumble Server. Für diese Server können die Nutzer:innen der Hostsharing Plattform sehr leicht TLS Zertifikate erzeugen, indem sie den zentral installierten LEGO-Bot nutzen.

== Einrichtung ==

Zunächst muss eine Domain vorhanden sein, auf die das Zertifikat ausgestellt werden soll und die im Webspace über HTTP erreichbar ist.

Ich nutze hier den Service-User "xyz00-mumble" als Beispiel. Bei diesem User sei die Domain "mumble.hs-example.de" aufgeschaltet.

Dann lösche ich bei der Domain die HTTP-Weiterleitungen und die www-Subdomain:

<syntaxhighlight lang=shell line>
rm -rf ~/doms/mumble.hs-example.de/subs/www \
~/doms/mumble.hs-example.de/subs-ssl/www \
~/doms/mumble.hs-example.de/htdocs/.htaccess \
~/doms/mumble.hs-example.de/htdocs-ssl/.htaccess
</syntaxhighlight>
Das erste Zertifikat wird mit dem folgenden Befehl erzeugt:
<syntaxhighlight lang=shell line>
/usr/bin/lego -d mumble.hs-example.de -a \
--email webmaster@mumble.hs-example.de -k ec256 \
--http.webroot $HOME/doms/mumble.hs-example.de/htdocs \
--http run
</syntaxhighlight>
Bei der erfolgreichen Ausführung diese Befehls wurde ein verstecktes Verzeichnis ".lego" angelegt. In diesem Verzeichnis befinden sich die Daten zum neu angelegten Letsencrypt-Account und das Zertifikat mit dem zugehörigen private key.

Die Daten des Zertifikates kann man wie folgt auslesen:
<syntaxhighlight lang=shell line>
openssl x509 -in .lego/certificates/mumble.hs-example.de.crt -noout -text
</syntaxhighlight>

== regelmäßige Verlängerung ==

Für die automatische Verlängerung des Zertifikats können wir einen Cronjob aufsetzen, der zum Beispiel täglich oder wöchentlich läuft:

$ cat bin/lego-renew
#!/bin/bash
HOME=/home/pacs/xyz00/users/mumble
/usr/bin/lego -d mumble.hs-example.de -a \
--email webmaster@mumble.hs-example.de -k ec256 \
--http.webroot $HOME/doms/mumble.hs-example.de/htdocs \
--http renew

Die Ausführung des Skriptes wird über einen systemd timer gesteuert:

''~/.config/systemd/user/lego_certificate.service''

[Unit]
Description=renew lego certificate

[Service]
Type=oneshot
ExecStart=php8.2 /home/pacs/xyz00/users/mumble/bin/lego-renew

''~/.config/systemd/user/lego_certificate.timer''

[Unit]
Description=timer for lego certificate

[Timer]
OnCalendar=Thu 4:34
Persistent=True

[Install]
WantedBy=timers.target

Den Timer aktivieren und starten:

$ systemctl --user enable lego_certificate.timer
$ systemctl --user start lego_certificate.timer

TLS Zertifikat mit LEGO

2024-12-09T14:26:43Z

Hsh-milanihl: /* Einrichtung */

= TLS Zertifikat mit LEGO =

Für den zentralen Apache Webserver werden bei Hostsharing automatisch TLS Zertifikate über den Dienst "Lets Encrypt" erzeugt und verlängert. Das wird über die Domain-Option "letsencrypt" gesteuert.

Teilweise will man aber eigene Serverdienste betreiben, die nicht über HTTP hinter dem Apache-Proxy erreichbar sind. Beispiele dafür sind ein eigener XMPP Server oder ein Mumble Server. Für diese Server können die Nutzer:innen der Hostsharing Plattform sehr leicht TLS Zertifikate erzeugen, indem sie den zentral installierten LEGO-Bot nutzen.

== Einrichtung ==

Zunächst muss eine Domain vorhanden sein, auf die das Zertifikat ausgestellt werden soll und die im Webspace über HTTP erreichbar ist.

Ich nutze hier den Service-User "xyz00-mumble" als Beispiel. Bei diesem User sei die Domain "mumble.hs-example.de" aufgeschaltet.

Dann lösche ich bei der Domain die HTTP-Weiterleitungen und die www-Subdomain:

<syntaxhighlight lang=shell line>
rm -rf ~/doms/mumble.hs-example.de/subs/www \
~/doms/mumble.hs-example.de/subs-ssl/www \
~/doms/mumble.hs-example.de/htdocs/.htaccess \
~/doms/mumble.hs-example.de/htdocs-ssl/.htaccess
</syntaxhighlight>
Das erste Zertifikat wird mit dem folgenden Befehl erzeugt:
<syntaxhighlight lang=shell line>
/usr/bin/lego -d mumble.hs-example.de -a \
--email webmaster@mumble.hs-example.de -k ec256 \
--http.webroot $HOME/doms/mumble.hs-example.de/htdocs \
--http run
</syntaxhighlight>
Bei der erfolgreichen Ausführung diese Befehls wurde ein verstecktes Verzeichnis ".lego" angelegt. In diesem Verzeichnis befinden sich die Daten zum neu angelegten Letsencrypt-Account und das Zertifikat mit dem zugehörigen private key.

Die Daten des Zertifikates kann man wie folgt auslesen:

openssl x509 -in .lego/certificates/mumble.hs-example.de.crt -noout -text

== regelmäßige Verlängerung ==

Für die automatische Verlängerung des Zertifikats können wir einen Cronjob aufsetzen, der zum Beispiel täglich oder wöchentlich läuft:

$ cat bin/lego-renew
#!/bin/bash
HOME=/home/pacs/xyz00/users/mumble
/usr/bin/lego -d mumble.hs-example.de -a \
--email webmaster@mumble.hs-example.de -k ec256 \
--http.webroot $HOME/doms/mumble.hs-example.de/htdocs \
--http renew

Die Ausführung des Skriptes wird über einen systemd timer gesteuert:

''~/.config/systemd/user/lego_certificate.service''

[Unit]
Description=renew lego certificate

[Service]
Type=oneshot
ExecStart=php8.2 /home/pacs/xyz00/users/mumble/bin/lego-renew

''~/.config/systemd/user/lego_certificate.timer''

[Unit]
Description=timer for lego certificate

[Timer]
OnCalendar=Thu 4:34
Persistent=True

[Install]
WantedBy=timers.target

Den Timer aktivieren und starten:

$ systemctl --user enable lego_certificate.timer
$ systemctl --user start lego_certificate.timer

Mastodon bei Hostsharing

2024-12-09T14:22:05Z

Hsh-milanihl: /* Einrichten des Apache VHost */

Mastodon ist ein verteilter Microblogging Dienst, der das ActivityPub-Protokoll verwendet.

Wenn man nur wenige Nutzer oder gar nur für sich selbst einen Einstiegspunkt ins "Fediverse" schaffen will, kann sich auch die Ressourcen-schonende Alternative [[Pleroma]] anbieten.

Diese Anleitung beschreibt, wie man Mastodon auf der Managed Hosting Plattform von Hostsharing installieren kann.

Hostsharing selbst nutzt die Hosting Plattform und betreibt zwei Mastodon Instanzen:
* https://geno.social
* https://hostsharing.coop

Der Autor dieser Seite betreibt:
* https://krefeld.life

{{Textkasten|gelb|Für Managed Server|Ein funktionierender Mastodon-Server erfordert mehrere laufende Server-Dienste. Für den Betrieb ist ein Managed Server sinnvoll.}}

== Vorbereitungen ==

Mit Hilfe von HSAdmin wird angelegt:
# Ein User als Service-User mit ''/bin/bash'' als Shell, zum Beispiel Beispiel: ''xyz00-mastodon''
# Eine Domain mit ''xyz00-mastodon'' als Domain-Administrator, zum Beispiel ''beispiel.social''
# Einen Postgresql-User ''xyz00_mastuser'' mit Passwort ''meinPasswort''
# Eine Postgresql-Datenbank ''xyz00_mastdb'' mit Datenbank-Owner ''xyz00_mastuser''

Verwendete IP-Ports der Server-Dienste:
# Redis: localhost:32002
# Mastodon-Web: localhost:32003
# Mastodon-Streaming: localhost:32004

== Konfiguration des Redis Server ==

Anlegen einer Datei ''/home/pacs/xyz00/users/mastodon/redis/etc/redis.conf'' mit folgendem Inhalt:

<syntaxhighlight lang="ini" line>
daemonize yes
pidfile /home/pacs/xyz00/users/mastodon/redis/var/redis-server.pid
requirepass <hierhin-gehoert-ein-redis-passwort>
port 32002
tcp-backlog 128
bind 127.0.0.1
timeout 300
loglevel notice
logfile /home/pacs/xyz00/users/mastodon/redis/var/redis.log
databases 16
save 900 1
save 300 10
save 60 10000
slave-serve-stale-data yes
appendonly no
dbfilename dump.rdb
dir /home/pacs/xyz00/users/mastodon/redis/var
</syntaxhighlight>

== Installation von NodeJS ==

Als User 'xyz00-mastodon'': Installation von ''nvm'' und ''nodejs'' (Version 20) nach der Anleitung [[NodeJS]]

Installation von ''yarn'' mit:

<syntaxhighlight lang="bash">
npm install -g yarn
</syntaxhighlight>

== Installation von Ruby ==

Als User ''xyz00-mastodon'': Installation von Ruby mit ''rbenv'' mit folgenden Befehlen:

Zunächst ''rbenv'' and ''ruby-build'':

<syntaxhighlight lang="bash">
git clone https://github.com/rbenv/rbenv.git ~/.rbenv
cd ~/.rbenv && src/configure && make -C src
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.profile
echo 'eval "$(rbenv init -)"' >> ~/.profile
</syntaxhighlight>

starte neue Shell:

<syntaxhighlight lang="bash">
exec bash
</syntaxhighlight>

Überprüfe rbenv-Installation

<syntaxhighlight lang="bash">
type rbenv
</syntaxhighlight>

Installiere ruby-build als rbenv-Plugin

<syntaxhighlight lang="bash">
git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
</syntaxhighlight>

Nun kann die benötigte Ruby-Version installiert werden:

<syntaxhighlight lang="bash">
rbenv install 3.2.3
</syntaxhighlight>

== Installation der Mastodon Software ==

Weiterhin Als User ''xyz00-mastodon'':

<syntaxhighlight lang="bash">
cd ~
git clone https://github.com/tootsuite/mastodon.git live
cd ~/live
</syntaxhighlight>

Die stabile Version auschecken:

<syntaxhighlight lang="bash">
git checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)
</syntaxhighlight>

Ruby Pakete installieren:

<syntaxhighlight lang="bash">
gem install bundler
bundle install -j$(getconf _NPROCESSORS_ONLN) --deployment --without development test
</syntaxhighlight>

Node.js Pakete installieren:

<syntaxhighlight lang="bash">
yarn install --pure-lockfile
</syntaxhighlight>

== Konfiguration der Mastodon Software ==

Anlegen einer Datei ''/home/pacs/xyz00/users/mastodon/live/.env.production'' mit dem folgenden Inhalt:

<syntaxhighlight lang=ini line>
REDIS_HOST=localhost
REDIS_PORT=32002
REDIS_PASSWORD=<hierhin-gehoert-ein-redis-passwort>
DB_HOST=localhost
DB_USER=xyz00_mastuser
DB_NAME=xyz00_mastdb
DB_PASS=meinPasswort
DB_PORT=5432
LOCAL_DOMAIN=beispiel.social
SECRET_KEY_BASE=12ab..
OTP_SECRET=34ef..
VAPID_PRIVATE_KEY=ABCD..
VAPID_PUBLIC_KEY=EFGH..
DEFAULT_LOCALE=de
SMTP_SERVER=localhost
SMTP_PORT=25
SMTP_FROM_ADDRESS=notifications@beispiel.social
SMTP_AUTH_METHOD=none
SMTP_OPENSSL_VERIFY_MODE=none
STREAMING_CLUSTER_NUM=1
</syntaxhighlight>

Die Zufallswerte für die Variablen SECRET_KEY_BASE und OTP_SECRET erzeugt man durch zwei Aufrufe des Kommandos

<syntaxhighlight lang="bash">
RAILS_ENV=production bundle exec rake secret
</syntaxhighlight>

Die Werte für VAPID_PRIVATE_KEY und VAPID_PUBLIC_KEY erzeugt das Kommando

<syntaxhighlight lang="bash">
RAILS_ENV=production bundle exec rake mastodon:webpush:generate_vapid_key
</syntaxhighlight>

Initialisieren der Datenbank:

<syntaxhighlight lang="bash">
export SAFETY_ASSURED=1
RAILS_ENV=production bundle exec rails db:schema:load
RAILS_ENV=production bundle exec rails db:seed
</syntaxhighlight>

Erzeugen der Web-Resourcen

<syntaxhighlight lang="bash">
yarn set version classic
RAILS_ENV=production bundle exec rails assets:precompile
</syntaxhighlight>

== Starten der Dienste ==

Zum Start aller notwendigen Dienste wird in dieser Anleitung ''systemctl'' benutzt.

Die Datei <code>~/.config/systemd/user/redis.service</code> kann so aussehen:

<syntaxhighlight lang=shell line>
[Unit]
Description=Redis User Service

[Service]
WorkingDirectory=%h/var/redis
Environment="PATH=/usr/local/bin:/usr/bin:/bin"
ExecStart=/usr/bin/redis-server %h/etc/redis.conf
Restart=always
PrivateTmp=true
NoNewPrivileges=true

[Install]
WantedBy=default.target
</syntaxhighlight>

Die Datei <code>~/.config/systemd/user/puma.service</code> kann so aussehen:

<syntaxhighlight lang=shell line>
[Unit]
Description=Mastodon Web Service Puma
After=redis.service

[Service]
WorkingDirectory=%h/live
Environment="RAILS_ENV=production"
ExecStart=%h/.rbenv/shims/bundle exec puma -C config/puma.rb -e production -b tcp://127.0.0.1:32003
StandardError=append:%h/var/log/puma.log
StandardOutput=append:%h/var/log/puma.log
Restart=always
PrivateTmp=true
NoNewPrivileges=true

[Install]
WantedBy=default.target
</syntaxhighlight>

Die Datei <code>~/.config/systemd/user/sidekiq.service</code> kann so aussehen:

<syntaxhighlight lang=shell line>
[Unit]
Description=Mastodon Sidekiq Service
After=redis.service

[Service]
WorkingDirectory=%h/live
Environment="RAILS_ENV=production"
Environment="DB_POOL=5"
ExecStart=%h/.rbenv/shims/bundle exec sidekiq -c 5 -q default -q mailers -q pull -q push -q scheduler
StandardError=append:%h/var/log/sidekiq.log
StandardOutput=append:%h/var/log/sidekiq.log
Restart=always
PrivateTmp=true
NoNewPrivileges=true

[Install]
WantedBy=default.target
</syntaxhighlight>

Die Datei <code>~/.config/systemd/user/streaming.service</code> kann so aussehen:

<syntaxhighlight lang=shell line>
[Unit]
Description=Mastodon Streaming Service
After=redis.service

[Service]
WorkingDirectory=%h/live
Environment="NVM_DIR=%h/.nvm"
Environment="NVM_BIN=%h/.nvm/versions/node/v20.14.0/bin"
Environment="NODE_ENV=production"
Environment="PORT=32004"
Environment="BIND=127.0.0.1"

ExecStart=%h/.nvm/versions/node/v20.14.0/bin/node streaming/index.js
StandardError=append:%h/var/log/streaming.log
StandardOutput=append:%h/var/log/streaming.log
Restart=always
PrivateTmp=true
NoNewPrivileges=true

[Install]
WantedBy=default.target
</syntaxhighlight>

Die Dienste werden dann aktiviert und gestartet:
<syntaxhighlight lang=shell line>
systemctl --user enable redis --now
systemctl --user enable puma --now
systemctl --user enable streaming --now
systemctl --user enable sidekiq --now
</syntaxhighlight>

== Einrichten des Apache VHost ==

<syntaxhighlight lang=shell line>
cd ~/doms/beispiel.social
rm -rf htdocs-ssl subs/www subs-ssl/www
ln -s ~/live/public htdocs-ssl
touch htdocs-ssl/.htaccess
</syntaxhighlight>

Dann die ''htdocs-ssl/.htaccess'' mit dem Editor der Wahl öffnen und
folgende Konfiguration einfügen:

<syntaxhighlight lang=apache line>
DirectoryIndex disabled
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_URI} ^/api/v1/streaming [NC]
RewriteRule .* ws://localhost:32004%{REQUEST_URI} [proxy]
RequestHeader set X-Forwarded-Proto "https"
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-l
RewriteRule .* http://localhost:32003%{REQUEST_URI} [proxy]
RequestHeader set X-Forwarded-Proto "https"
</syntaxhighlight>

== Systemd Timer ==

Mit einem systemd Timer werden alte Ressourcen aufgeräumt.

<code>~/.config/systemd/user/mastodon_cleanup.env</code>
<syntaxhighlight lang=bash line>
HOME=/home/pacs/xyz00/users/mastodon
MAILTO=mastodon@beispiel.social
RAILS_ENV=production
NUM_DAYS=31
</syntaxhighlight>

<code>~/.config/systemd/user/mastodon_cleanup.service</code>
<syntaxhighlight lang=ini line>
[Unit]
Description=fetch mail from remote server

[Service]
EnvironmentFile=/home/pacs/xyz00/users/mastodon/.config/systemd/user/mastodon_cleanup.env
WoringDirectory=/home/pacs/xyz00/users/mastodon/live
Type=oneshot
ExecStart=/home/pacs/xyz00/users/mastodon/live/bin/tootctl media remove
</syntaxhighlight>

<code>~/.config/systemd/user/mastodon_cleanup.timer</code>
<syntaxhighlight lang=ini line>
[Unit]
Description=fetch mail every five minutes

[Timer]
OnCalendar=4:18
Persistent=True

[Install]
WantedBy=timers.target
</syntaxhighlight>

Timer aktivieren und starten:
<syntaxhighlight lang=shell line>
$ systemctl --user enable mastodon_cleanup.timer
$ systemctl --user start mastodon_cleanupl.timer
</syntaxhighlight>

== Volltextsuche ==

In der installierten Version gibt es noch keine Volltextsuche. Es kann lediglich nach Nutzerkennungen und Hastags gesucht werden. Für die Volltextsuche kann optional Elasticsearch installiert werden.

* [[Elasticsearch]] bei Hostsharing
* https://docs.joinmastodon.org/admin/optional/elasticsearch/

== Instanz einrichten ==
Nach der Installation kann man sich auf https://beispiel.social einen Benutzer einrichten.

Auf der Kommandozeile:

<syntaxhighlight lang="bash">
RAILS_ENV=production bin/tootctl accounts create \
alice \
--email alice@example.com \
--confirmed \
--role Admin
</syntaxhighlight>

Weitere Einrichtung sollte vorgenommen werden, z.B. eine Beschreibung der Instanz hinterlegen, siehe https://docs.joinmastodon.org/admin/setup/

== Mastodon Updates ==

siehe:
* https://github.com/tootsuite/mastodon/releases

(hier für das Update auf die Mastodon Version v4.2.9 mit Ruby 3.2.3)

=== Ruby ===

<syntaxhighlight lang="bash">
cd ~/.rbenv
git pull
cd ~/.rbenv/plugins/ruby-build
git pull
cd
rbenv install -l
rbenv install 3.2.3
rbenv global 3.2.3
</syntaxhighlight>

=== Mastodon ===

<syntaxhighlight lang="bash">
cd ~/mastodon/live
git fetch
git checkout v4.2.9
gem update --system
bundle install
yarn install
RAILS_ENV=production bundle exec rails db:migrate
yarn set version classic
RAILS_ENV=production bundle exec rails assets:precompile
</syntaxhighlight>

Restart Mastodon!

== Links ==

* [https://joinmastodon.org/ Offizielle Webseite von Mastodon]
* im Archiv: https://github.com/mastodon/documentation/blob/archive/Running-Mastodon/Production-guide.md
* aktuell: https://docs.joinmastodon.org/admin/install/
* https://krinetzki.de/2017/04/installation-von-mastodon-auf-debian-8-jessie/
* [https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/mastodon Ansible Playbook für Hostsharing]

[[Kategorie:Installationsanleitungen]]
[[Kategorie:Fediverse]]
[[Kategorie:Activitypub]]
[[Kategorie:Ansible Playbook]]

Nextcloud

2024-12-09T14:18:54Z

Hsh-milanihl: /* Volltextsuche */

= Nextcloud =

[https://nextcloud.com/ Nextcloud] ist eine PHP-basierte Open Source Lösung für gängige Cloud-Anwendungen, u.a.:

* Filesharing unter Nutzern derselben Nextcloud, und mit der Öffentlichkeit
* Single-Sign-On Authentifizierung (SSO)
* Videokonferenzen (WebRTC)
* Online-Office Anwendung [https://www.collaboraoffice.com/ Collabora Online]

Beispiel-Funktionalität, die über Plugins, sogenannte [https://apps.nextcloud.com/ "Apps"], bereit gestellt werden kann:

* Kalender, Aufgabenverwaltung, Adressbuch
* Datei-Kollaboration (Kommentare zu Dateien, Verschlagwortung)
* Feedreader
* E-Mail-Programm
* Fotogalerie
* Musik- und Videowiedergabe

= Nextcloud installieren =

== Vorbereitungen ==

In ''hsadmin'', zum Beispiel mit ''hsscript'':

''hsadmin''-Shell starten mit:

<syntaxhighlight lang=shell>
hsscript -u xyz00 -i
Password: ********
</syntaxhighlight>

Dann nacheinander anlegen:

* Linux User als Domain-Administrator
* Subdomain ''cloud.example.org''
* PostgreSQL-User
* PostgreSQL Datenbank

<syntaxhighlight lang=shell>
xyz00@hsadmin> user.add({set:{name:'xyz00-cloud',password:'geheim',shell:'/bin/bash',comment:'Nextcloud'}})
xyz00@hsadmin> domain.add({set:{name:'cloud.example.org',user:'xyz00-cloud'}})
xyz00@hsadmin> postgresqluser.add({set:{name:'xyz00_nextclusr',password:'geheim'}})
xyz00@hsadmin> postgresqldb.add({set:{name:'xyz00_nextcloud',owner:'xyz00_nextclusr'}})
</syntaxhighlight>

== Nextcloud installieren ==

Anmelden als Linux-User ''xyz00-cloud'':

<syntaxhighlight lang=shell>
ssh -l xyz00-cloud xyz00.hostsharing.net
</syntaxhighlight>

''htdocs'' Verzeichnis vorbereiten

<syntaxhighlight lang=shell>
cd
mkdir nextcloud
cd doms/cloud.example.org
rm -rf subs/www subs-ssl/www htdocs-ssl
ln -s $HOME/nextcloud htdocs-ssl
</syntaxhighlight>

Nextcloud herunterladen und entpacken.

<syntaxhighlight lang=shell>
cd
wget https://download.nextcloud.com/server/releases/nextcloud-27.1.2.zip
unzip nextcloud-27.1.2.zip
rm nextcloud-27.1.2.zip
mkdir data tmp
chmod 700 data tmp
</syntaxhighlight>

== Nextcloud konfigurieren ==

Im Verzeichnis "$HOME/doms/cloud.example.org/fastcgi-ssl/" eine Datei "php.ini" anlegen mit folgendem Inhalt:

<syntaxhighlight lang=ini>
memory_limit=512M
session.save_path=/home/pacs/xyz00/users/cloud/tmp
</syntaxhighlight>

Dann mit einem Editor diese Datei bearbeiten: In der zweiten Zeile den korrekten Pfad des vorher angelegten tmp-Verzeichnisses eintragen.

Im Browser auf die Seite
http://cloud.example.org gehen und den Anweisungen folgen.

Auf der ersten Seite sind anzugeben:

* Login und Passwort für den Administrator definieren
* PostgreSQL als Datenbanksystem
* PostgreSQL-User und Passwort aus dem ersten Schritt oben
* Name der PostgreSQL-Datenbank aus dem ersten Schritt
* "localhost" als Datenbankserver (Nextcloud 23.0.2 empfiehlt hier die Angabe des Ports, diesen also lt. [[PostgreSQL]] angeben)
* Das Verzeichnis "/home/pacs/xyz00/users/cloud/data/" als Daten-Verzeichnis (bitte beachten: das im Eingabefeld voreingestellte verweist auf das Verzeichnis "/home/pacs/xyz00/users/cloud/'''nextcloud'''/data/")

'''Achtung!''' Die Felder für die Datenbank sind auf dem Startscreen hinter einem unscheinbaren Link versteckt. Um man das Formular für die Datenbank-Daten zu gelangen, muss man auf den Link klicken. Anschließend kann man die gewünschte Datenbank auswählen und die entsprechenden Daten eintragen. '''Das sollte geschehen, bevor man die Installation abschließt!''' Tut man dies nicht, wird Nextcloud mit SQLite installiert. Eine Änderung der Datenbank soll zwar laut Dokumentation auch später noch möglich sein, ging aber bei einem Test schief.

In der Konfigurationsdatei der Nextcloud (in ''~/nextcloud/config/config.php'') lassen sich weitere Voreinstellungen treffen:

<syntaxhighlight lang=php line>
'maintenance_window_start' => 1, // Wartungsfenster ab 1:00 Uhr
'defaultapp' => 'calendar,files', // bei Start wird der Kalender gezeigt
'default_phone_region' => 'DE', // Format Telefonnummern
'default_language' => 'de', // Sprache deutsch
'force_language' => 'de',
'default_locale' => 'de_DE', // Locale (Formatierung Zeitangaben etc.)
'force_locale' => 'de_DE',
</syntaxhighlight>

== Nextcloud beschleunigen ==

Dieser Teil ist optional.

Wenn regelmäßig '''im Browser''' mit Nextcloud gearbeitet werden soll, ist Nextcloud im Browser oft sehr langsam. Um dies zu verbessern, unterstützt Nextcloud die Anwendung von unterschiedlichen Cache-Verfahren (zum Beispiel Memcache, Redis).

=== Redis Cache ===

Redis ist auf den Hostsharing-Servern vorinstalliert und wird von den Nextcloud-Entwicklern empfohlen. '''In Verbindung mit einem Managed Webspace''' muss für Redis als eigener Serverdienst RAM gebucht werden und ist '''kostenpflichtig'''. Siehe zu Kosten im Webspace Konfigurator unter: https://www.hostsharing.net/angebote/managed-webspace/ – '''Arbeitsspeicher für eigene Serverdienste'''.

Die Konfiguration des Redis-Dientes ist auf der Seite [[Redis]] beschrieben. Hier wird für Nextcloud die Variante mit einem Unixsocket benutzt.

In der Konfiguration der Nextcloud (in ''~/nextcloud/config/config.php'') wird der Redis-Cache wie folgt konfiguriert:

<syntaxhighlight lang=php line>
'memcache.local' => '\\OC\\Memcache\\Redis',
'memcache.distributed' => '\\OC\\Memcache\\Redis',
'memcache.locking' => '\\OC\\Memcache\\Redis',
'redis' =>
array (
'host' => '/home/pacs/xyz00/users/cloud/redis/var/redis-server.sock',
'port' => 0,
'password' => 'mein-redis-passwort',
'timeout' => 1.5,
),
</syntaxhighlight>

Um es perfekt zu machen, nutze ich ''logrotate'' um die Logdateien zu organisieren. Dazu die Konfiguration in ''~/.logrotate''

<syntaxhighlight lang=shell line>
compress
/home/pacs/xyz00/users/cloud/redis/var/redis.log {
rotate 5
daily
missingok
}
</syntaxhighlight>
Mit systemd-Timern werden die Logdateien täglich rotiert:

''~/.config/systemd/user/logrotate.service''
<syntaxhighlight lang=ini line>
[Unit]
Description=rotate log files

[Service]
Type=oneshot
ExecStart=php8.2 /home/pacs/xyz00/users/cloud/nextcloud/cron.php
</syntaxhighlight>

''~/.config/systemd/user/logrotate.timer''
<syntaxhighlight lang=ini line>
[Unit]
Description=timer for nextcloud cleanup job

[Timer]
OnCalendar=1:1
Persistent=True

[Install]
WantedBy=timers.target
</syntaxhighlight>

Den Timer aktivieren und starten:
<syntaxhighlight lang=shell line>
$ systemctl --user enable logrotate.timer
$ systemctl --user start logrotate.timer
</syntaxhighlight>

Mit einem weiteren Timer für die regelmäßigen Hintergrundaufgaben von Nextcloud lässt sie sich noch etwas beschleunigen:

''~/.config/systemd/user/nextcloud_background.service''
<syntaxhighlight lang=ini line>
[Unit]
Description=nextcloud cleanup job

[Service]
Type=oneshot
ExecStart=php8.2 /home/pacs/xyz00/users/cloud/nextcloud/cron.php
</syntaxhighlight>

''~/.config/systemd/user/nextcloud_background.timer''
<syntaxhighlight lang=ini line>
[Unit]
Description=timer for nextcloud cleanup job

[Timer]
OnCalendar=*:0/5
Persistent=True

[Install]
WantedBy=timers.target
</syntaxhighlight>

Den Timer aktivieren und starten:
<syntaxhighlight lang=shell line>
$ systemctl --user enable nextcloud_background.timer
$ systemctl --user start nextcloud_background.timer
</syntaxhighlight>

=== Nextcloud Push ===

Um Vorgänge wie Sync und Benachrichtigungen bei sehr großen Nextcloud Installationen zu beschleunigen, kann der <code>notify_push</code> Dienst hinzuinstalliert werden.

==== Abhängigkeiten und Einschränkungen ====
* <code>notify_push</code> muss Zugriff auf den gleichen Redis-Cache wie die Nextcloud haben
** aufgrund von eingeschränktem Passwort Support sollte ein Redis Socket mit sicheren Berechtigungseinstellungen als Alternative zum Redis Port mit Passwort konfiguriert werden.
* optimaler Weise holt sich <code>notify_push</code> benötigte informationen aus der <code>config.php</code> der bestehenden Nextcloud-Installation
* eine zusätzliche (Sub)domain im gleichen User ist nötig. Andernfalls muss die bestehende <code>.htaccess</code> muss aus o.g. Gründen modifiziert werden, dies könnte bei Nextcloud-Updates verloren gehen(!)
* Bestimmte Portbereiche sind bei Hostsharing eingeschränkt, es empfiehlt sich, direkt beispielsweise Port <code>37867</code> zu nehmen. <strong>aus diesem Grund ist das automatische Setup durch das Plugin bei Hostsharing nicht möglich!</strong>

==== Installation ====
Siehe auch: https://github.com/nextcloud/notify_push#manual-setup

1. Installieren der Nextcloud-App <code>notify_push</code> – (nach Push suchen, "Client Push" wählen)<br>
2. falls noch nicht erstellt: <code>mkdir -p ~/.config/systemd/user</code><br>
3. mit Lieblingseditor die Datei <code>~/.config/systemd/user/notify_push.service</code> anlegen:<br>
<syntaxhighlight lang="ini" line>
[Unit]
Description = Push daemon for Nextcloud clients
Documentation = https://github.com/nextcloud/notify_push

[Service]
# Change if you already have something running on this port
Environment = PORT=37867
# We don't want to bind to 0.0.0.0, hence the --bind
ExecStart = /home/pacs/xyz00/users/cloud/bin/notify_push --bind 127.0.0.1 /home/pacs/xyz00/users/cloud/nextcloud/config/config.php
Type=notify

[Install]
WantedBy = default.target
</syntaxhighlight>
4. das Verzeichnis <code>~/bin</code> anlegen und die aktuellste binary herunterladen und ausführbar machen:
<syntaxhighlight lang="shell" line>release=`curl -L https://api.github.com/repos/nextcloud/notify_push/releases/latest -s | jq -r '.tag_name'` && wget --show-progress -qO ~/bin/notify_push https://github.com/nextcloud/notify_push/releases/download/$release/notify_push-x86_64-unknown-linux-musl && chmod +x ~/bin/notify_push</syntaxhighlight>
5. es könnte die folgende Umgebungsvariable zum Bedienen von systemd notwendig werden:<br><code>export XDG_RUNTIME_DIR=/run/user/$UID</code><br>
6. den neuen systemd-Dienst automatisch bei Systemstart, sowie jetzt sofort starten:<br><code>systemctl enable --now --user notify_push</code><br>
7. nun gehen wir in <code>doms/push.cloud.example.com/htdocs-ssl/.htaccess</code> und ersetzen den Inhalt (bevorzugt), oder wir ergänzen die .htaccess der Nextcloud im unteren Teil um die folgenden Zeilen (letzteres kann bei Updates überschrieben werden!):
<syntaxhighlight lang="apache" line>
# bei eigener (sub)domain ist /push/ nicht erforderlich, aber wer weiß, eventuell ist das mit robuster
RewriteCond %{REQUEST_URI} ^/push/ws [NC,OR]
RewriteCond %{HTTP:UPGRADE} ^WebSocket$ [NC,OR]
RewriteCond %{HTTP:CONNECTION} ^Upgrade$ [NC]
RewriteRule .* ws://127.0.0.1:37867/ws [proxy]

RewriteCond %{REQUEST_URI} ^/push [NC]
RewriteRule .* http://127.0.0.1:37867%{REQUEST_URI} [proxy]
</syntaxhighlight>
8. abschließend im Nextcloud Ordner die Konfiguration des Plugins anstoßen: <code>php occ notify_push:setup https://cloud.example.com/push</code> bzw. <code>php occ notify_push:setup https://push.cloud.example.com/push</code><br>
9. es ist möglich, das die erkannte IP-Adresse des Hives noch nicht vertraut ist. In diesem Fall wird der obige Befehl scheitern und es muss jene aus der Fehlermeldung des Setups unter <code>trusted_proxies</code> in der <code>config.php</code> ergänzt werden. <br><br>

Es wird im Repo außerdem ein Testclient bereitgestellt, der sich testweise mit dem Push-Dienst verbindet

== Nextcloud mit Online Office ==

In Nextcloud können Office-Dokumente (Textverarbeitung, Tabellen und Präsentationen) im Browser bearbeitet werden. Dazu steht bei Hostsharing die Collabora Developer Version zur Verfügung. Bestellung und Konfiguration sind hier im Wiki auf der Seite [[Collabora_Online]] beschrieben.

== Nextcloud mit Nextcloud Talk ==

Über die Nextcloud-App "Talk" können Videokonfererenzen mit Screensharing durchgeführt werden. Für die regelmäßige Nutzung kann es sinnvoll sein einen eigenen TURN Server zu betreiben. Siehe dazu [[Coturn_Installieren]]

== Virenscanner ==

Einige Nutzer wollen die Dateien in Ihrer Nextcloud regelmäßig auf Viren überprüfen. Auf unseren Servern steht dafür der OpenSource-Virenscanner "ClamAV" zur Verfügung. Wenn dieser Scanner benutzt wird, dann sollten die Einstellungen so gewählt sein, dass der ClamAV-Daemon über eine Socket Verbindung angesprochen wird. Die Einstellungen sind im Screenshot dokumentiert.

[[Datei:Nextcloud-ClamAV-Einstellungen.png||nextcloud einstellungen für die virenscanner-app]]

== Volltextsuche ==

Über die Dokumente einer Nextcloud kann ein Volltextindex erstellt werden. Die Volltextsuche ermöglicht über den Index eine Suche über beliebige Begriffe, die in Dokumenten vorkommen.

Voraussetzung ist der Betrieb eines Elasticsearch Servers. Der Betrieb im Managed Webspace erfodert die Buchung von zwei "Serverdiensten". Nutzer eines Managed Server müssen mit einem spürbaren Mehrbedarf an Hauptspeicher rechnen.

Zur Installation von Elasticsearch existiert eine eigene Wikiseite: [[Elasticsearch]].

In der Nextcloud sind folgende ''Apps'' zu installieren:
* Full Text Search
* Full Text Search - Elasticsearch Platform
* Full Text Search - Files

nach der Installation der drei Apps steht in den Einstellungen ein neuer Menüpunkt "Volltextsuche" zur Verfügung.

Hier ist einzustellen:
* Suchplattform: Elasticsearch
* Adresse des Servlets: http://elastic:das-erzeugt-passwort@127.0.0.1:39200
* Index: frei-gewaehlter-name-idx
* Analyzer tokenizer: standard

Die anderen Einstellung nach den eigenen Vorstellungen vornehmen.

Der initiale Aufbau des Suchindex erfolgt über ein "occ"-Kommando auf der Shell:

<syntaxhighlight lang=shell line>
cd nextcloud/
php occ fulltextsearch:index --output
</syntaxhighlight>

Wenn dieser Fehler kommt:
<syntaxhighlight lang=text>
TypeError: Return value of OCA\Files_FullTextSearch\Model\MountPoint::isGlobal()
must be of the type bool, null returned in [...]/apps/files_fulltextsearch/lib/Model/MountPoint.php:103
</syntaxhighlight>
sollte dieser Patch angewendet werden: https://github.com/nextcloud/files_fulltextsearch/issues/125#issuecomment-877789742

Zur Pflege des Indexes wird ein weiterer Hintergrundprozess gestartet:

<syntaxhighlight lang=shell line>
cd nextcloud/
php occ fulltextsearch:live -q
</syntaxhighlight>

Die Monit Konfiguration dafür sieht so aus:

<syntaxhighlight lang=shell line>
#~/bin/start-fulltextsearchlive
#
#!/bin/bash
export HOME=/home/pacs/xyz00/users/cloud
cd $HOME
mkdir -p $HOME/var
cd $HOME/nextcloud
exec php occ fulltextsearch:live -q &
echo $! >$HOME/var/fulltextsearchlive.pid
</syntaxhighlight>

<syntaxhighlight lang=shell line>
#~/bin/stop-fulltextsearchlive
#
#!/bin/bash
export HOME=/home/pacs/xyz00/users/cloud
kill $( cat $HOME/var/fulltextsearchlive.pid )
</syntaxhighlight>

~/.monitrc (siehe oben von der Redis Installation) entsprechend ergänzen:
<syntaxhighlight lang=shell line>
check process fulltextsearchlive with pidfile /home/pacs/xyz00/users/cloud/var/fulltextsearchlive.pid
start program "/home/pacs/xyz00/users/cloud/bin/start-fulltextsearchlive"
stop program "/home/pacs/xyz00/users/cloud/bin/stop-fulltextsearchlive"
</syntaxhighlight>

== Integration mit LDAP ==

Um einheitliche Benutzerzugänge für verschiedene Anwendungen zu ermöglichen, wird oft auf ein zentrales LDAP Verzeichnis gesetzt.

Dieses kann für Nextcloud eingesetzt werden, damit Benutzer nicht lokal in Nextcloud, sondern in LDAP verwaltet werden können.

Siehe auch https://docs.nextcloud.com/server/latest/admin_manual/configuration_user/user_auth_ldap.html

Dazu muss die App "LDAP user and group backend" in den Nextcloud Apps aktiviert werden.

Dann muss die LDAP Anbindung in den Administrationseinstellungen unter "LDAP/AD-Integration" eingerichtet werden.

Der Server mit Port, die BenutzerDN mit Passwort und die BaseDN müssen eingetragen werden.

Es muss auch bestimmt werden, welche Klasse (z.B. inetOrgPerson) die Benutzer brauchen, um Zugriff auf die Nextcloud zu erhalten.

Falls schon Benutzer in der Nextcloud existieren, und diese zu LDAP mitgenommen werden sollen, kann der Anleitung aus diesem Forum Eintrag gefolgt werden: https://help.nextcloud.com/t/migration-to-ldap-keeping-users-and-data/13205

* Voraussetzung ist, dass der Benutzernamen der zu übernehmenden Benutzer in Nextcloud der uid in LDAP entspricht.
* Es wird ein Administrator Benutzer benötigt, der lokal angelegt wurde, und auch lokal bleibt.
* Mit diesem Administrator Benutzer wird die LDAP Anbindung eingerichtet.
* In der Experten Ansicht von LDAP/AD muss bei "Attribut für interne Benutzernamen" eingetragen werden: uid
* Klicke den Schalter "LDAP Benutzernamenzuordnung löschen"
* Klicke den Schalter "LDAP Gruppennamenzuordnung löschen"
* dann in der MySQL Datenbank anmelden, und aus uc_users alle Benutzer bis auf den Administrator Benutzer löschen
* Dann in der Nextcloud Weboberfläche sich alle Benutzer anzeigen lassen
* Nun gelingt die Anmeldung mit den anderen Benutzern mit dem LDAP Passwort, und die Dateien wurden übernommen.

== Optimierung der Geschwindigkeit ==
Manchmal fühlt sich die Nextcloud träge an.

Folgende Änderungen können helfen:

* HTTP/2.0 aktivieren: dem Service von Hostsharing Bescheid geben
* Die App Dashboard deaktivieren, und dafür werden direkt die Dateien angezeigt
* Einblenden der README in den Ordnern abschalten: das kann pro Ordner in der UI geschehen (links unten), oder global: <code>occ config:app:set text workspace_available --value=0</code>. Siehe auch [https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/text_configuration.html#disable-rich-workspaces-globally]

== Default App einstellen ==

In der Datei config.php können wir einstellen, welche App direkt nach der Anmeldung gezeigt wird.

Das ist entweder die Dashboard App, wenn sie aktiviert ist, oder die Dateien App (files).

Falls der Kalender direkt angezeigt werden soll, muss folgende Zeile in der config.php hinzugefügt werden (siehe auch [https://docs.nextcloud.com/server/stable/admin_manual/configuration_server/config_sample_php_parameters.html#defaultapp]):

<syntaxhighlight lang=shell>
'defaultapp' => 'calendar',
</syntaxhighlight>

= Nextcloud Updates =

== Updater über die Shell starten ==

Wenn die NextCloud sich nicht über das Webfrontend updaten lässt, kann der Updater auch per Shell im directory /updater durch ausführen des updater.phar gestartet werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud/updater
xyz00-cloud@h00:~/nextcloud/updater$ chmod u+x updater.phar
xyz00-cloud@h00:~/nextcloud/updater$ ./updater.phar
</syntaxhighlight>

Es sollten außerdem ein paar Routine-Aufräumarbeiten durchgeführt werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-primary-keys --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-columns --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-indices --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:convert-filecache-bigint --no-interaction
</syntaxhighlight>

So können die Apps noch alle aktualisiert werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ app:update --all -n --no-ansi
</syntaxhighlight>

Für weitere Informationen kann auf die offizielle Doku ab Ziffer 2. zurückgegriffen werden.

* [https://docs.nextcloud.com/server/latest/admin_manual/maintenance/update.html#using-the-command-line-based-updater https://docs.nextcloud.com]

Hier gibt es ein kurzes Video, das die Anmeldung über die Kommandozeile mit Putty erklärt und die Aktualisierung von Nextcloud auf der Kommandozeile:

* [https://tube.solidcharity.net/w/0cf5ee97-ba7c-41df-a56f-8d1fea842ab0 Nextcloud auf der Kommandozeile aktualisieren]

== Wartungsmodus per Shell ein- oder ausschalten ==

So kann der Wartungsmodus angeschaltet werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --on
</syntaxhighlight>

So kann der Wartungsmodus wieder ausgeschaltet werden, d.h. die Nextcloud ist dann wieder in Betrieb:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --off
</syntaxhighlight>

== Webfrontend-Updater Probleme / Lösungen ==

=== Datenbank: Indizes | Primärschlüssel | Konvertierungen ===

Aufgetreten nach erfolgtem Versionsupdate Nextcloud 19 auf Nextcloud 20

Nach dem erfolgten Update lädt automatisch die Seite: '''Sicherheits- und Einrichtungswarnungen''' auf dieser wird angemerkt, dass manuelle Schritte für die Datenbank durchzuführen sind. Dies betrifft Indizes, Primärschlüssel und Konvertierungen.

Per Shell in der directory /nextcloud folgende Kommandos ausführen:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-primary-keys --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-columns --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-indices --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:convert-filecache-bigint --no-interaction
</syntaxhighlight>

Wichtig ist hier dem durch Nextcloud angegebenen Kommando ein '''php''' voranzustellen.

== Update per Skript ==

Es ist möglich die regelmäßigen Updates weitgehend zu automatisieren. Ein Skript wäre etwa:

<syntaxhighlight lang=shell line>
#!/bin/bash
if [ -f $HOME/nextcloud/occ ]; then
echo "Nextcloud Update";
cd $HOME/nextcloud;
php updater/updater.phar -vv --no-backup --no-interaction
php occ maintenance:mode --on
php occ db:add-missing-primary-keys --no-interaction
php occ db:add-missing-columns --no-interaction
php occ db:add-missing-indices --no-interaction
php occ db:convert-filecache-bigint --no-interaction
php occ app:update --all
php occ maintenance:mode --off
else
echo "Keine Nextcloud Installation gefunden";
fi
</syntaxhighlight>

== Update: bei old-stable Version bleiben ==

Normalerweise fragt jede Nextcloud Instanz zentral ab, welches Update zur Verfügung steht, abhängig vom Release Channel. Dabei wird aber relativ schnell auf die nächste Version gewechselt, also z.B. von Nextcloud 28 auf Nextcloud 29, obwohl Nextcloud 28 noch mehrere Monate gepflegt wird, und manche Apps noch nicht bereit sind für Nextcloud 29.

Es kann aber auch eine Alternative eingerichtet werden, in der Datei nextcloud/config/config.php, unter dem Eintrag updater.server.url

Hier wird z.B. auf einen Updater von unserem Mitglied Timotheus Pokorra verwiesen:

<syntaxhighlight lang=php line>
updater_server_url: "https://ncupdater.solidcharity.com"
</syntaxhighlight>

Dahinter läuft ein Skript, mit dem wir noch länger eine bestimmte Version anbieten können: https://codeberg.org/tpokorra/ncupdater

= Daten auf HDD Storage =
== Einrichtung des HDD Storage ==

Um den langsameren aber günstigeren HDD Storage von Hostsharing zu nutzen, kann das data Verzeichnis von SSD auf HDD Storage verschoben werden. Ein symbolischer Link reicht nicht aus, man muss den Pfad in der Nextcloud Konfigurationsdatei anpassen.

<syntaxhighlight lang=shell>
# Nextcloud in Wartungsmodus versetzen
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --on
# Daten auf HDD Storage verschieben
xyz00-cloud@h00:~/nextcloud$ mv data /home/storage/xyz00/users/cloud/
# symbolischen Link anlegen
xyz00-cloud@h00:~/nextcloud$ ln -s /home/storage/xyz00/users/cloud/data data
# Pfad in config.php ändern
nano config/config.php
# Die Zeile mit 'datadirectory' finden und entsprechend ändern:
# 'datadirectory' => '/home/storage/xyz00/users/cloud/data',
# Wartungsmodus beenden
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --off
</syntaxhighlight>

= Einschränkende Bemerkungen =
== Nextcloud Sync Client ==

Der Nextcloud Sync Client erfüllt eine Funktion ähnlich wie Dropbox, und synchronisiert ganze Ordnerstrukturen.

Gerade wenn man mit mehreren Menschen in einer Nextcloud arbeitet, ist diese Funktion mit Vorsicht zu benutzen.

* Änderungen an der Ordnerstruktur sollten nicht lokal, sondern im Webbrowser vorgenommen werden.
* Wenn die Gefahr besteht, dass mehrere Menschen gleichzeitig eine Datei bearbeiten, sollte die Datei nicht lokal, sondern im Webbrowser bearbeitet werden.
* Aus Sicht des Datenschutzes und der Daten-Minimierung sollte überlegt werden, ob die Daten wirklich auf jeden Laptop und Rechner synchronisiert werden sollen, oder ob es reicht, ausschließlich über den Webbrowser auf die Daten zuzugreifen.

= weiterführende Links =

* [https://docs.nextcloud.com/ Nextcloud Dokumentation]
* [https://apps.nextcloud.com/ Nextcloud Erweiterungen ("Apps")]
* [https://ownyourbits.com/2019/06/29/understanding-and-improving-nextcloud-previews/ Optimierung des Caches für Previews]
* [https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/nextcloud Ansible Playbook für Hostsharing]

= Nextcloud Reseller bei HS =

[https://nextcloud.ossaas.de OS SaaS]

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Ansible Playbook]]
[[Kategorie:Software]]
[[Kategorie:CalDAV]]
[[Kategorie:Nextcloud]]

Nextcloud

2024-12-09T14:17:48Z

Hsh-milanihl: /* Vorbereitungen */

= Nextcloud =

[https://nextcloud.com/ Nextcloud] ist eine PHP-basierte Open Source Lösung für gängige Cloud-Anwendungen, u.a.:

* Filesharing unter Nutzern derselben Nextcloud, und mit der Öffentlichkeit
* Single-Sign-On Authentifizierung (SSO)
* Videokonferenzen (WebRTC)
* Online-Office Anwendung [https://www.collaboraoffice.com/ Collabora Online]

Beispiel-Funktionalität, die über Plugins, sogenannte [https://apps.nextcloud.com/ "Apps"], bereit gestellt werden kann:

* Kalender, Aufgabenverwaltung, Adressbuch
* Datei-Kollaboration (Kommentare zu Dateien, Verschlagwortung)
* Feedreader
* E-Mail-Programm
* Fotogalerie
* Musik- und Videowiedergabe

= Nextcloud installieren =

== Vorbereitungen ==

In ''hsadmin'', zum Beispiel mit ''hsscript'':

''hsadmin''-Shell starten mit:

<syntaxhighlight lang=shell>
hsscript -u xyz00 -i
Password: ********
</syntaxhighlight>

Dann nacheinander anlegen:

* Linux User als Domain-Administrator
* Subdomain ''cloud.example.org''
* PostgreSQL-User
* PostgreSQL Datenbank

<syntaxhighlight lang=shell>
xyz00@hsadmin> user.add({set:{name:'xyz00-cloud',password:'geheim',shell:'/bin/bash',comment:'Nextcloud'}})
xyz00@hsadmin> domain.add({set:{name:'cloud.example.org',user:'xyz00-cloud'}})
xyz00@hsadmin> postgresqluser.add({set:{name:'xyz00_nextclusr',password:'geheim'}})
xyz00@hsadmin> postgresqldb.add({set:{name:'xyz00_nextcloud',owner:'xyz00_nextclusr'}})
</syntaxhighlight>

== Nextcloud installieren ==

Anmelden als Linux-User ''xyz00-cloud'':

<syntaxhighlight lang=shell>
ssh -l xyz00-cloud xyz00.hostsharing.net
</syntaxhighlight>

''htdocs'' Verzeichnis vorbereiten

<syntaxhighlight lang=shell>
cd
mkdir nextcloud
cd doms/cloud.example.org
rm -rf subs/www subs-ssl/www htdocs-ssl
ln -s $HOME/nextcloud htdocs-ssl
</syntaxhighlight>

Nextcloud herunterladen und entpacken.

<syntaxhighlight lang=shell>
cd
wget https://download.nextcloud.com/server/releases/nextcloud-27.1.2.zip
unzip nextcloud-27.1.2.zip
rm nextcloud-27.1.2.zip
mkdir data tmp
chmod 700 data tmp
</syntaxhighlight>

== Nextcloud konfigurieren ==

Im Verzeichnis "$HOME/doms/cloud.example.org/fastcgi-ssl/" eine Datei "php.ini" anlegen mit folgendem Inhalt:

<syntaxhighlight lang=ini>
memory_limit=512M
session.save_path=/home/pacs/xyz00/users/cloud/tmp
</syntaxhighlight>

Dann mit einem Editor diese Datei bearbeiten: In der zweiten Zeile den korrekten Pfad des vorher angelegten tmp-Verzeichnisses eintragen.

Im Browser auf die Seite
http://cloud.example.org gehen und den Anweisungen folgen.

Auf der ersten Seite sind anzugeben:

* Login und Passwort für den Administrator definieren
* PostgreSQL als Datenbanksystem
* PostgreSQL-User und Passwort aus dem ersten Schritt oben
* Name der PostgreSQL-Datenbank aus dem ersten Schritt
* "localhost" als Datenbankserver (Nextcloud 23.0.2 empfiehlt hier die Angabe des Ports, diesen also lt. [[PostgreSQL]] angeben)
* Das Verzeichnis "/home/pacs/xyz00/users/cloud/data/" als Daten-Verzeichnis (bitte beachten: das im Eingabefeld voreingestellte verweist auf das Verzeichnis "/home/pacs/xyz00/users/cloud/'''nextcloud'''/data/")

'''Achtung!''' Die Felder für die Datenbank sind auf dem Startscreen hinter einem unscheinbaren Link versteckt. Um man das Formular für die Datenbank-Daten zu gelangen, muss man auf den Link klicken. Anschließend kann man die gewünschte Datenbank auswählen und die entsprechenden Daten eintragen. '''Das sollte geschehen, bevor man die Installation abschließt!''' Tut man dies nicht, wird Nextcloud mit SQLite installiert. Eine Änderung der Datenbank soll zwar laut Dokumentation auch später noch möglich sein, ging aber bei einem Test schief.

In der Konfigurationsdatei der Nextcloud (in ''~/nextcloud/config/config.php'') lassen sich weitere Voreinstellungen treffen:

<syntaxhighlight lang=php line>
'maintenance_window_start' => 1, // Wartungsfenster ab 1:00 Uhr
'defaultapp' => 'calendar,files', // bei Start wird der Kalender gezeigt
'default_phone_region' => 'DE', // Format Telefonnummern
'default_language' => 'de', // Sprache deutsch
'force_language' => 'de',
'default_locale' => 'de_DE', // Locale (Formatierung Zeitangaben etc.)
'force_locale' => 'de_DE',
</syntaxhighlight>

== Nextcloud beschleunigen ==

Dieser Teil ist optional.

Wenn regelmäßig '''im Browser''' mit Nextcloud gearbeitet werden soll, ist Nextcloud im Browser oft sehr langsam. Um dies zu verbessern, unterstützt Nextcloud die Anwendung von unterschiedlichen Cache-Verfahren (zum Beispiel Memcache, Redis).

=== Redis Cache ===

Redis ist auf den Hostsharing-Servern vorinstalliert und wird von den Nextcloud-Entwicklern empfohlen. '''In Verbindung mit einem Managed Webspace''' muss für Redis als eigener Serverdienst RAM gebucht werden und ist '''kostenpflichtig'''. Siehe zu Kosten im Webspace Konfigurator unter: https://www.hostsharing.net/angebote/managed-webspace/ – '''Arbeitsspeicher für eigene Serverdienste'''.

Die Konfiguration des Redis-Dientes ist auf der Seite [[Redis]] beschrieben. Hier wird für Nextcloud die Variante mit einem Unixsocket benutzt.

In der Konfiguration der Nextcloud (in ''~/nextcloud/config/config.php'') wird der Redis-Cache wie folgt konfiguriert:

<syntaxhighlight lang=php line>
'memcache.local' => '\\OC\\Memcache\\Redis',
'memcache.distributed' => '\\OC\\Memcache\\Redis',
'memcache.locking' => '\\OC\\Memcache\\Redis',
'redis' =>
array (
'host' => '/home/pacs/xyz00/users/cloud/redis/var/redis-server.sock',
'port' => 0,
'password' => 'mein-redis-passwort',
'timeout' => 1.5,
),
</syntaxhighlight>

Um es perfekt zu machen, nutze ich ''logrotate'' um die Logdateien zu organisieren. Dazu die Konfiguration in ''~/.logrotate''

<syntaxhighlight lang=shell line>
compress
/home/pacs/xyz00/users/cloud/redis/var/redis.log {
rotate 5
daily
missingok
}
</syntaxhighlight>
Mit systemd-Timern werden die Logdateien täglich rotiert:

''~/.config/systemd/user/logrotate.service''
<syntaxhighlight lang=ini line>
[Unit]
Description=rotate log files

[Service]
Type=oneshot
ExecStart=php8.2 /home/pacs/xyz00/users/cloud/nextcloud/cron.php
</syntaxhighlight>

''~/.config/systemd/user/logrotate.timer''
<syntaxhighlight lang=ini line>
[Unit]
Description=timer for nextcloud cleanup job

[Timer]
OnCalendar=1:1
Persistent=True

[Install]
WantedBy=timers.target
</syntaxhighlight>

Den Timer aktivieren und starten:
<syntaxhighlight lang=shell line>
$ systemctl --user enable logrotate.timer
$ systemctl --user start logrotate.timer
</syntaxhighlight>

Mit einem weiteren Timer für die regelmäßigen Hintergrundaufgaben von Nextcloud lässt sie sich noch etwas beschleunigen:

''~/.config/systemd/user/nextcloud_background.service''
<syntaxhighlight lang=ini line>
[Unit]
Description=nextcloud cleanup job

[Service]
Type=oneshot
ExecStart=php8.2 /home/pacs/xyz00/users/cloud/nextcloud/cron.php
</syntaxhighlight>

''~/.config/systemd/user/nextcloud_background.timer''
<syntaxhighlight lang=ini line>
[Unit]
Description=timer for nextcloud cleanup job

[Timer]
OnCalendar=*:0/5
Persistent=True

[Install]
WantedBy=timers.target
</syntaxhighlight>

Den Timer aktivieren und starten:
<syntaxhighlight lang=shell line>
$ systemctl --user enable nextcloud_background.timer
$ systemctl --user start nextcloud_background.timer
</syntaxhighlight>

=== Nextcloud Push ===

Um Vorgänge wie Sync und Benachrichtigungen bei sehr großen Nextcloud Installationen zu beschleunigen, kann der <code>notify_push</code> Dienst hinzuinstalliert werden.

==== Abhängigkeiten und Einschränkungen ====
* <code>notify_push</code> muss Zugriff auf den gleichen Redis-Cache wie die Nextcloud haben
** aufgrund von eingeschränktem Passwort Support sollte ein Redis Socket mit sicheren Berechtigungseinstellungen als Alternative zum Redis Port mit Passwort konfiguriert werden.
* optimaler Weise holt sich <code>notify_push</code> benötigte informationen aus der <code>config.php</code> der bestehenden Nextcloud-Installation
* eine zusätzliche (Sub)domain im gleichen User ist nötig. Andernfalls muss die bestehende <code>.htaccess</code> muss aus o.g. Gründen modifiziert werden, dies könnte bei Nextcloud-Updates verloren gehen(!)
* Bestimmte Portbereiche sind bei Hostsharing eingeschränkt, es empfiehlt sich, direkt beispielsweise Port <code>37867</code> zu nehmen. <strong>aus diesem Grund ist das automatische Setup durch das Plugin bei Hostsharing nicht möglich!</strong>

==== Installation ====
Siehe auch: https://github.com/nextcloud/notify_push#manual-setup

1. Installieren der Nextcloud-App <code>notify_push</code> – (nach Push suchen, "Client Push" wählen)<br>
2. falls noch nicht erstellt: <code>mkdir -p ~/.config/systemd/user</code><br>
3. mit Lieblingseditor die Datei <code>~/.config/systemd/user/notify_push.service</code> anlegen:<br>
<syntaxhighlight lang="ini" line>
[Unit]
Description = Push daemon for Nextcloud clients
Documentation = https://github.com/nextcloud/notify_push

[Service]
# Change if you already have something running on this port
Environment = PORT=37867
# We don't want to bind to 0.0.0.0, hence the --bind
ExecStart = /home/pacs/xyz00/users/cloud/bin/notify_push --bind 127.0.0.1 /home/pacs/xyz00/users/cloud/nextcloud/config/config.php
Type=notify

[Install]
WantedBy = default.target
</syntaxhighlight>
4. das Verzeichnis <code>~/bin</code> anlegen und die aktuellste binary herunterladen und ausführbar machen:
<syntaxhighlight lang="shell" line>release=`curl -L https://api.github.com/repos/nextcloud/notify_push/releases/latest -s | jq -r '.tag_name'` && wget --show-progress -qO ~/bin/notify_push https://github.com/nextcloud/notify_push/releases/download/$release/notify_push-x86_64-unknown-linux-musl && chmod +x ~/bin/notify_push</syntaxhighlight>
5. es könnte die folgende Umgebungsvariable zum Bedienen von systemd notwendig werden:<br><code>export XDG_RUNTIME_DIR=/run/user/$UID</code><br>
6. den neuen systemd-Dienst automatisch bei Systemstart, sowie jetzt sofort starten:<br><code>systemctl enable --now --user notify_push</code><br>
7. nun gehen wir in <code>doms/push.cloud.example.com/htdocs-ssl/.htaccess</code> und ersetzen den Inhalt (bevorzugt), oder wir ergänzen die .htaccess der Nextcloud im unteren Teil um die folgenden Zeilen (letzteres kann bei Updates überschrieben werden!):
<syntaxhighlight lang="apache" line>
# bei eigener (sub)domain ist /push/ nicht erforderlich, aber wer weiß, eventuell ist das mit robuster
RewriteCond %{REQUEST_URI} ^/push/ws [NC,OR]
RewriteCond %{HTTP:UPGRADE} ^WebSocket$ [NC,OR]
RewriteCond %{HTTP:CONNECTION} ^Upgrade$ [NC]
RewriteRule .* ws://127.0.0.1:37867/ws [proxy]

RewriteCond %{REQUEST_URI} ^/push [NC]
RewriteRule .* http://127.0.0.1:37867%{REQUEST_URI} [proxy]
</syntaxhighlight>
8. abschließend im Nextcloud Ordner die Konfiguration des Plugins anstoßen: <code>php occ notify_push:setup https://cloud.example.com/push</code> bzw. <code>php occ notify_push:setup https://push.cloud.example.com/push</code><br>
9. es ist möglich, das die erkannte IP-Adresse des Hives noch nicht vertraut ist. In diesem Fall wird der obige Befehl scheitern und es muss jene aus der Fehlermeldung des Setups unter <code>trusted_proxies</code> in der <code>config.php</code> ergänzt werden. <br><br>

Es wird im Repo außerdem ein Testclient bereitgestellt, der sich testweise mit dem Push-Dienst verbindet

== Nextcloud mit Online Office ==

In Nextcloud können Office-Dokumente (Textverarbeitung, Tabellen und Präsentationen) im Browser bearbeitet werden. Dazu steht bei Hostsharing die Collabora Developer Version zur Verfügung. Bestellung und Konfiguration sind hier im Wiki auf der Seite [[Collabora_Online]] beschrieben.

== Nextcloud mit Nextcloud Talk ==

Über die Nextcloud-App "Talk" können Videokonfererenzen mit Screensharing durchgeführt werden. Für die regelmäßige Nutzung kann es sinnvoll sein einen eigenen TURN Server zu betreiben. Siehe dazu [[Coturn_Installieren]]

== Virenscanner ==

Einige Nutzer wollen die Dateien in Ihrer Nextcloud regelmäßig auf Viren überprüfen. Auf unseren Servern steht dafür der OpenSource-Virenscanner "ClamAV" zur Verfügung. Wenn dieser Scanner benutzt wird, dann sollten die Einstellungen so gewählt sein, dass der ClamAV-Daemon über eine Socket Verbindung angesprochen wird. Die Einstellungen sind im Screenshot dokumentiert.

[[Datei:Nextcloud-ClamAV-Einstellungen.png||nextcloud einstellungen für die virenscanner-app]]

== Volltextsuche ==

Über die Dokumente einer Nextcloud kann ein Volltextindex erstellt werden. Die Volltextsuche ermöglicht über den Index eine Suche über beliebige Begriffe, die in Dokumenten vorkommen.

Voraussetzung ist der Betrieb eines Elasticsearch Servers. Der Betrieb im Managed Webspace erfodert die Buchung von zwei "Serverdiensten". Nutzer eines Managed Server müssen mit einem spürbaren Mehrbedarf an Hauptspeicher rechnen.

Zur Installation von Elasticsearch existiert eine eigene Wikiseite: [[Elasticsearch]].

In der Nextcloud sind folgende ''Apps'' zu installieren:
* Full Text Search
* Full Text Search - Elasticsearch Platform
* Full Text Search - Files

nach der Installation der drei Apps steht in den Einstellungen ein neuer Menüpunkt "Volltextsuche" zur Verfügung.

Hier ist einzustellen:
* Suchplattform: Elasticsearch
* Adresse des Servlets: http://elastic:das-erzeugt-passwort@127.0.0.1:39200
* Index: frei-gewaehlter-name-idx
* Analyzer tokenizer: standard

Die anderen Einstellung nach den eigenen Vorstellungen vornehmen.

Der initiale Aufbau des Suchindex erfolgt über ein "occ"-Kommando auf der Shell:

<syntaxhighlight lang=shell line>
cd nextcloud/
php occ fulltextsearch:index --output
</syntaxhighlight>

Wenn dieser Fehler kommt:
TypeError: Return value of OCA\Files_FullTextSearch\Model\MountPoint::isGlobal()
must be of the type bool, null returned in [...]/apps/files_fulltextsearch/lib/Model/MountPoint.php:103
sollte dieser Patch angewendet werden: https://github.com/nextcloud/files_fulltextsearch/issues/125#issuecomment-877789742

Zur Pflege des Indexes wird ein weiterer Hintergrundprozess gestartet:

<syntaxhighlight lang=shell line>
cd nextcloud/
php occ fulltextsearch:live -q
</syntaxhighlight>

Die Monit Konfiguration dafür sieht so aus:

<syntaxhighlight lang=shell line>
#~/bin/start-fulltextsearchlive
#
#!/bin/bash
export HOME=/home/pacs/xyz00/users/cloud
cd $HOME
mkdir -p $HOME/var
cd $HOME/nextcloud
exec php occ fulltextsearch:live -q &
echo $! >$HOME/var/fulltextsearchlive.pid
</syntaxhighlight>

<syntaxhighlight lang=shell line>
#~/bin/stop-fulltextsearchlive
#
#!/bin/bash
export HOME=/home/pacs/xyz00/users/cloud
kill $( cat $HOME/var/fulltextsearchlive.pid )
</syntaxhighlight>

~/.monitrc (siehe oben von der Redis Installation) entsprechend ergänzen:
<syntaxhighlight lang=shell line>
check process fulltextsearchlive with pidfile /home/pacs/xyz00/users/cloud/var/fulltextsearchlive.pid
start program "/home/pacs/xyz00/users/cloud/bin/start-fulltextsearchlive"
stop program "/home/pacs/xyz00/users/cloud/bin/stop-fulltextsearchlive"
</syntaxhighlight>
== Integration mit LDAP ==

Um einheitliche Benutzerzugänge für verschiedene Anwendungen zu ermöglichen, wird oft auf ein zentrales LDAP Verzeichnis gesetzt.

Dieses kann für Nextcloud eingesetzt werden, damit Benutzer nicht lokal in Nextcloud, sondern in LDAP verwaltet werden können.

Siehe auch https://docs.nextcloud.com/server/latest/admin_manual/configuration_user/user_auth_ldap.html

Dazu muss die App "LDAP user and group backend" in den Nextcloud Apps aktiviert werden.

Dann muss die LDAP Anbindung in den Administrationseinstellungen unter "LDAP/AD-Integration" eingerichtet werden.

Der Server mit Port, die BenutzerDN mit Passwort und die BaseDN müssen eingetragen werden.

Es muss auch bestimmt werden, welche Klasse (z.B. inetOrgPerson) die Benutzer brauchen, um Zugriff auf die Nextcloud zu erhalten.

Falls schon Benutzer in der Nextcloud existieren, und diese zu LDAP mitgenommen werden sollen, kann der Anleitung aus diesem Forum Eintrag gefolgt werden: https://help.nextcloud.com/t/migration-to-ldap-keeping-users-and-data/13205

* Voraussetzung ist, dass der Benutzernamen der zu übernehmenden Benutzer in Nextcloud der uid in LDAP entspricht.
* Es wird ein Administrator Benutzer benötigt, der lokal angelegt wurde, und auch lokal bleibt.
* Mit diesem Administrator Benutzer wird die LDAP Anbindung eingerichtet.
* In der Experten Ansicht von LDAP/AD muss bei "Attribut für interne Benutzernamen" eingetragen werden: uid
* Klicke den Schalter "LDAP Benutzernamenzuordnung löschen"
* Klicke den Schalter "LDAP Gruppennamenzuordnung löschen"
* dann in der MySQL Datenbank anmelden, und aus uc_users alle Benutzer bis auf den Administrator Benutzer löschen
* Dann in der Nextcloud Weboberfläche sich alle Benutzer anzeigen lassen
* Nun gelingt die Anmeldung mit den anderen Benutzern mit dem LDAP Passwort, und die Dateien wurden übernommen.

== Optimierung der Geschwindigkeit ==
Manchmal fühlt sich die Nextcloud träge an.

Folgende Änderungen können helfen:

* HTTP/2.0 aktivieren: dem Service von Hostsharing Bescheid geben
* Die App Dashboard deaktivieren, und dafür werden direkt die Dateien angezeigt
* Einblenden der README in den Ordnern abschalten: das kann pro Ordner in der UI geschehen (links unten), oder global: <code>occ config:app:set text workspace_available --value=0</code>. Siehe auch [https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/text_configuration.html#disable-rich-workspaces-globally]

== Default App einstellen ==

In der Datei config.php können wir einstellen, welche App direkt nach der Anmeldung gezeigt wird.

Das ist entweder die Dashboard App, wenn sie aktiviert ist, oder die Dateien App (files).

Falls der Kalender direkt angezeigt werden soll, muss folgende Zeile in der config.php hinzugefügt werden (siehe auch [https://docs.nextcloud.com/server/stable/admin_manual/configuration_server/config_sample_php_parameters.html#defaultapp]):

<syntaxhighlight lang=shell>
'defaultapp' => 'calendar',
</syntaxhighlight>

= Nextcloud Updates =

== Updater über die Shell starten ==

Wenn die NextCloud sich nicht über das Webfrontend updaten lässt, kann der Updater auch per Shell im directory /updater durch ausführen des updater.phar gestartet werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud/updater
xyz00-cloud@h00:~/nextcloud/updater$ chmod u+x updater.phar
xyz00-cloud@h00:~/nextcloud/updater$ ./updater.phar
</syntaxhighlight>

Es sollten außerdem ein paar Routine-Aufräumarbeiten durchgeführt werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-primary-keys --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-columns --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-indices --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:convert-filecache-bigint --no-interaction
</syntaxhighlight>

So können die Apps noch alle aktualisiert werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ app:update --all -n --no-ansi
</syntaxhighlight>

Für weitere Informationen kann auf die offizielle Doku ab Ziffer 2. zurückgegriffen werden.

* [https://docs.nextcloud.com/server/latest/admin_manual/maintenance/update.html#using-the-command-line-based-updater https://docs.nextcloud.com]

Hier gibt es ein kurzes Video, das die Anmeldung über die Kommandozeile mit Putty erklärt und die Aktualisierung von Nextcloud auf der Kommandozeile:

* [https://tube.solidcharity.net/w/0cf5ee97-ba7c-41df-a56f-8d1fea842ab0 Nextcloud auf der Kommandozeile aktualisieren]

== Wartungsmodus per Shell ein- oder ausschalten ==

So kann der Wartungsmodus angeschaltet werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --on
</syntaxhighlight>

So kann der Wartungsmodus wieder ausgeschaltet werden, d.h. die Nextcloud ist dann wieder in Betrieb:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --off
</syntaxhighlight>

== Webfrontend-Updater Probleme / Lösungen ==

=== Datenbank: Indizes | Primärschlüssel | Konvertierungen ===

Aufgetreten nach erfolgtem Versionsupdate Nextcloud 19 auf Nextcloud 20

Nach dem erfolgten Update lädt automatisch die Seite: '''Sicherheits- und Einrichtungswarnungen''' auf dieser wird angemerkt, dass manuelle Schritte für die Datenbank durchzuführen sind. Dies betrifft Indizes, Primärschlüssel und Konvertierungen.

Per Shell in der directory /nextcloud folgende Kommandos ausführen:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-primary-keys --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-columns --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-indices --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:convert-filecache-bigint --no-interaction
</syntaxhighlight>

Wichtig ist hier dem durch Nextcloud angegebenen Kommando ein '''php''' voranzustellen.

== Update per Skript ==

Es ist möglich die regelmäßigen Updates weitgehend zu automatisieren. Ein Skript wäre etwa:

<syntaxhighlight lang=shell line>
#!/bin/bash
if [ -f $HOME/nextcloud/occ ]; then
echo "Nextcloud Update";
cd $HOME/nextcloud;
php updater/updater.phar -vv --no-backup --no-interaction
php occ maintenance:mode --on
php occ db:add-missing-primary-keys --no-interaction
php occ db:add-missing-columns --no-interaction
php occ db:add-missing-indices --no-interaction
php occ db:convert-filecache-bigint --no-interaction
php occ app:update --all
php occ maintenance:mode --off
else
echo "Keine Nextcloud Installation gefunden";
fi
</syntaxhighlight>

== Update: bei old-stable Version bleiben ==

Normalerweise fragt jede Nextcloud Instanz zentral ab, welches Update zur Verfügung steht, abhängig vom Release Channel. Dabei wird aber relativ schnell auf die nächste Version gewechselt, also z.B. von Nextcloud 28 auf Nextcloud 29, obwohl Nextcloud 28 noch mehrere Monate gepflegt wird, und manche Apps noch nicht bereit sind für Nextcloud 29.

Es kann aber auch eine Alternative eingerichtet werden, in der Datei nextcloud/config/config.php, unter dem Eintrag updater.server.url

Hier wird z.B. auf einen Updater von unserem Mitglied Timotheus Pokorra verwiesen:

<syntaxhighlight lang=php line>
updater_server_url: "https://ncupdater.solidcharity.com"
</syntaxhighlight>

Dahinter läuft ein Skript, mit dem wir noch länger eine bestimmte Version anbieten können: https://codeberg.org/tpokorra/ncupdater

= Daten auf HDD Storage =
== Einrichtung des HDD Storage ==

Um den langsameren aber günstigeren HDD Storage von Hostsharing zu nutzen, kann das data Verzeichnis von SSD auf HDD Storage verschoben werden. Ein symbolischer Link reicht nicht aus, man muss den Pfad in der Nextcloud Konfigurationsdatei anpassen.

<syntaxhighlight lang=shell>
# Nextcloud in Wartungsmodus versetzen
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --on
# Daten auf HDD Storage verschieben
xyz00-cloud@h00:~/nextcloud$ mv data /home/storage/xyz00/users/cloud/
# symbolischen Link anlegen
xyz00-cloud@h00:~/nextcloud$ ln -s /home/storage/xyz00/users/cloud/data data
# Pfad in config.php ändern
nano config/config.php
# Die Zeile mit 'datadirectory' finden und entsprechend ändern:
# 'datadirectory' => '/home/storage/xyz00/users/cloud/data',
# Wartungsmodus beenden
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --off
</syntaxhighlight>

= Einschränkende Bemerkungen =
== Nextcloud Sync Client ==

Der Nextcloud Sync Client erfüllt eine Funktion ähnlich wie Dropbox, und synchronisiert ganze Ordnerstrukturen.

Gerade wenn man mit mehreren Menschen in einer Nextcloud arbeitet, ist diese Funktion mit Vorsicht zu benutzen.

* Änderungen an der Ordnerstruktur sollten nicht lokal, sondern im Webbrowser vorgenommen werden.
* Wenn die Gefahr besteht, dass mehrere Menschen gleichzeitig eine Datei bearbeiten, sollte die Datei nicht lokal, sondern im Webbrowser bearbeitet werden.
* Aus Sicht des Datenschutzes und der Daten-Minimierung sollte überlegt werden, ob die Daten wirklich auf jeden Laptop und Rechner synchronisiert werden sollen, oder ob es reicht, ausschließlich über den Webbrowser auf die Daten zuzugreifen.

= weiterführende Links =

* [https://docs.nextcloud.com/ Nextcloud Dokumentation]
* [https://apps.nextcloud.com/ Nextcloud Erweiterungen ("Apps")]
* [https://ownyourbits.com/2019/06/29/understanding-and-improving-nextcloud-previews/ Optimierung des Caches für Previews]
* [https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/nextcloud Ansible Playbook für Hostsharing]

= Nextcloud Reseller bei HS =

[https://nextcloud.ossaas.de OS SaaS]

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Ansible Playbook]]
[[Kategorie:Software]]
[[Kategorie:CalDAV]]
[[Kategorie:Nextcloud]]

Matrix Synapse installieren

2024-11-18T18:28:57Z

Hsh-milanihl: /* Sliding Sync Proxy */

Der Matrix Server ''Synapse'', der sogenannte 'Homeserver', ist aktuell die einzige vollständige serverseitige Implementierung des Matrix-Protokolls.

{{Textkasten|gelb|Work in Progress|Leider funktioniert die Server-zu-Server-Kommunikation von Synapse hinter dem Apache-Proxy mit den genannten Rewrite-Rules nicht. Bitten Sie dazu den Service, Ihren Apache VHost individuell für den Matrix Server anzupassen.}}

Synapse wird bei Hostsharing als ''eigener Daemon'' betrieben. Der Betrieb ist im Shared Hosting anmelde- und kostenpflichtig. Daher empfehlen wir für den Betrieb einen ''Managed Server''.

Diese Anleitung beschreibt, wie man den Matrix-Homeserver Synapse auf der Managed Hosting Plattform von Hostsharing installieren kann. Dabei sind die User-IDs nach dem Schema @user:beispiel.de aufgebaut, der Homeserver an sich ist unter matrix.beispiel.de erreichbar.

== Vorbereitungen ==

Mit Hilfe von HSAdmin werden angelegt:
# Ein User als Service-User mit ''/bin/bash'' als Shell, zum Beispiel Beispiel: ''xyz00-matrix''
# Eine Domain mit ''xyz00-matrix'' als Domain-Administrator, zum Beispiel ''matrix.beispiel.de''
# Einen Postgresql-User ''xyz00_matrixuser'' mit Passwort ''meinPasswort''
# Eine Postgresql-Datenbank ''xyz00_matrixdb'' mit Datenbank-Owner ''xyz00_matrixuser''

Verwendeter IP-Port für den Server-Dienst:
# Synapse: localhost:32801

== Installation von Synapse ==

Installationsanleitung basierend auf https://matrix-org.github.io/synapse/latest/setup/installation.html#installing-as-a-python-module-from-pypi

Auf Debian Buster muss ein neueres Python, z.B. Python 3.9 installiert werden, siehe [https://wiki.hostsharing.net/index.php?title=Eigenes_Python_installieren#Installation_mit_pyenv Eigenes Python mit pyenv installieren].

Als User ''xyz00-matrix" ein Python3 virtualenv mit Python 3.9 erstellen

<syntaxhighlight lang="shell">
mkdir -p ~/synapse
cd ~/synapse
pipenv install --python 3.9.18
</syntaxhighlight>

Synapse und Postgres-Dependencies installieren

<syntaxhighlight lang="shell">
cd ~/synapse
pipenv shell
pipenv install matrix-synapse[postgres]
</syntaxhighlight>

Initiale Konfiguration mit richtigem server-name "beispiel.de" generieren, außerdem im laufenden Betrieb keine Statistiken an Matrix.org senden

<syntaxhighlight lang="shell">
cd ~/synapse
pipenv run python -m synapse.app.homeserver --server-name beispiel.de --config-path homeserver.yaml --generate-config --report-stats=no
</syntaxhighlight>

== Konfiguration von Synapse ==

In die initial generierte Konfiguration muss noch die Port- und Datenbank-Konfiguration eingetragen werden:

Port: Innerhalb der listener-section den Port 8008 auf 32801 (wie initial definiert) ändern, alles andere beibehalten:

<syntaxhighlight lang=yaml line>
- port: 32801
tls: false
bind_addresses: ['::1', '127.0.0.1']
type: http
x_forwarded: true
</syntaxhighlight>

Postgres-Datenbank:
<syntaxhighlight lang=yaml line>
database:
# The database engine name
name: "psycopg2"
# Arguments to pass to the engine
args:
host: "localhost"
database: "xyz00_matrixdb"
user: "xyz00_matrixuser"
password: "meinPasswort"
cp_min: 5
cp_max: 10
</syntaxhighlight>

== Starten der Dienste ==

Der ''Synapse''-Dienst wird hier als Service-Unit im SystemD des Users eingetragen.

Lege dazu die folgende Datei an: ''~/.config/systemd/user/synapse.service'' mit dem Inhalt:
<syntaxhighlight lang="ini" line>
[Unit]
Description=Synapse

[Service]
Type=simple
WorkingDirectory=%h/synapse
Environment=LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so.2
ExecStart=pipenv run python -m synapse.app.homeserver --config-path=%h/synapse/homeserver.yaml

[Install]
WantedBy=default.target
</syntaxhighlight>

Durch Aufruf der folgenden Kommandos wird der Dienst aktiviert und gestartet:
<syntaxhighlight lang="shell" lines>
systemctl --user daemon-reload
systemctl --user enable synapse.service
systemctl --user start synapse.service
</syntaxhighlight>
== Einrichten des Apache VHost ==

Die ''~/doms/matrix.beispiel.de/.htaccess'' mit dem Editor der Wahl öffnen und
folgende Konfiguration einfügen:
<syntaxhighlight lang=apache line>
DirectoryIndex disabled
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-l
RewriteRule .* http://localhost:32801%{REQUEST_URI} [NE,proxy]
RequestHeader set X-Forwarded-Proto "https"
</syntaxhighlight>
== Well-Known unter beispiel.de ==

Damit die User-Accounts das Format @user:beispiel.de haben, der Server aber unter matrix.beispiel.de erreichbar ist, müssen noch folgende zwei Dateien unter der Domain beispiel.de abgelegt werden:

https://beispiel.de/.well-known/matrix/server
<syntaxhighlight lang=json line>
{
"m.server": "matrix.beispiel.de:443"
}
</syntaxhighlight>

https://beispiel.de/.well-known/matrix/client
<syntaxhighlight lang=json line>
{
"m.homeserver": {
"base_url": "https://matrix.beispiel.de"
},
"m.identity_server": {
"base_url": "https://vector.im"
}
}
</syntaxhighlight>

Für die muss noch der CORS-Header Access-Control-Allow-Origin "*" gesetzt werden, damit die Datei aus beliebigem Riot-Web im Browser abrufbar ist. Dazu in den Ordner .well-known/matrix/ folgende .htaccess anlegen:
<syntaxhighlight lang=apache line>
<IfModule mod_headers.c>
Header set Access-Control-Allow-Origin "*"
</IfModule>
</syntaxhighlight>

Die Dokumentation dazu findet man unter https://matrix.org/docs/spec/server_server/r0.1.2#get-well-known-matrix-server und https://matrix.org/docs/spec/client_server/r0.5.0#get-well-known-matrix-client

== Update von Synapse ==

mit pipenv:
<syntaxhighlight lang=shell>
systemctl --user stop synapse.service
cd ~/synapse
source .venv/bin/activate || pipenv shell
pipenv install update
systemctl --user start synapse.service
</syntaxhighlight>

oder falls Synapse mit pip verwaltet wird:

<syntaxhighlight lang=shell>
systemctl --user stop synapse.service
cd ~/synapse
source venv/bin/activate
pip freeze > requirements.txt
sed -i "s/==.*//g" requirements.txt
pip install -r requirements.txt --upgrade
systemctl --user start synapse.service
</syntaxhighlight>
Falls Monit verwendet wird statt systemctl:

<syntaxhighlight lang=shell>
monit stop synapse
#... updaten ...
monit start synapse
</syntaxhighlight>

Wenn die Föderation für den Synapse Server aktiviert ist, kann mit dem [https://federationtester.matrix.org/ Matrix Federation Tester] die eigene Instanz auf die laufende Version geprüft werden. Als Server nicht matrix.example.org eingeben, sondern den öffentlichen Namen, wo auch die Benutzernamen drauf laufen, z.B. example.org

Ansonsten ist die laufende Version auch über die URL https://matrix.example.org/_synapse/admin/v1/server_version zu erfahren.

== Element-Web ==

Element-Web ist aus Server-Seite eine rein statische html+javascript-Kombination, daher:

* Account und Domain anlegen (separat von der Synapse-Domain)
* [https://github.com/element-hq/element-web/releases/latest aktuelles element-web release] .tgz herunterladen
* Symlink von htdocs-ssl auf entpacktes element-web-Verzeichnis
* config.sample.json in config.json kopieren und Matrix-Homeserver-Einträge anpassen
* Piwik aus config.json entfernen

== SAML mit Synapse ==

Synapse unterstützt mit Version 1.1.0 SAML. Dazu wie folgt vorgehen:

Das Paket xmlsec1 muss installiert sein:

<syntaxhighlight lang=shell>
$ xmlsec1 --version
xmlsec1 1.2.23 (openssl)
</syntaxhighlight>

Das Python-Paket pysaml2 installieren

<syntaxhighlight lang=shell>
cd ~/synapse
pipenv shell
pipenv install pysaml2
</syntaxhighlight>

In der homeserver.yaml die SAML-Direktiven einkommentieren, hier mit dem Beispiel eines SAML IdP unter https://login.beispiel.de/simplesaml/saml2/idp/metadata.php:

<syntaxhighlight lang=yaml line>
# Once SAML support is enabled, a metadata file will be exposed at
# https://<server>:<port>/_matrix/saml2/metadata.xml, which you may be able to
# use to configure your SAML IdP with. Alternatively, you can manually configure
# the IdP to use an ACS location of
# https://<server>:<port>/_matrix/saml2/authn_response.
#
saml2_config:
sp_config:
# point this to the IdP's metadata. You can use either a local file or
# (preferably) a URL.
metadata:
#local: ["saml2/idp.xml"]
remote:
- url: https://login.beispiel.de/simplesaml/saml2/idp/metadata.php
</syntaxhighlight>
Wichtig ist außerdem, dass die public_baseurl in der homeserver.yaml gesetzt ist, damit Synapse weiß, wie es erreichbar ist und dies in seine SP-Metadaten einbauen kann:
<syntaxhighlight lang=yaml line>
public_baseurl: https://matrix.beispiel.de/
</syntaxhighlight>
Die Service-Provider-Konfiguration als XML bekommt man von Synapse dann wie schon in der homeserver.yaml als Kommentar beschrieben, unter https://matrix.beispiel.de/_matrix/saml2/metadata.xml

Diese dann in den SAML-IdP-importieren und dann sollte der Single-Sign-On via SAML funktionieren.

== Federation Sender Worker für Synapse ==

Zur Parallelisierung bietet Synapse das Konzept "Worker" an, die spezifische Aufgaben übernehmen, damit der Hauptprozess diese nicht durchführen muss.

Details dazu: https://github.com/matrix-org/synapse/blob/master/docs/workers.md

Ein einfach einzurichtender Worker, der auch viel Last abfedert, ist der Federation Sender Worker, da das Verschicken des Federation-Traffics 10-50% der Serverlast ausmacht.

In der homeserver.yaml die Worker-Konfiguration aktivieren:
<syntaxhighlight lang=yaml line>
## Worker ##
worker_app: synapse.app.homeserver
daemonize: true
</syntaxhighlight>

und dazugehörige Listener (Abschnitt listener:) aktivieren:
<syntaxhighlight lang=yaml line>
# The TCP replication port
- port: 32892
bind_address: '127.0.0.1'
type: replication
# The HTTP replication port
- port: 32893
bind_address: '127.0.0.1'
type: http
resources:
- names: [replication]
</syntaxhighlight>

Funktionen, die Worker machen sollen, in der homeserver.yaml deaktivieren:
<syntaxhighlight lang=yaml line>
# disable federation sending here, use worker for it
send_federation: False
</syntaxhighlight>
Dann Verzeichnis synapse/workers anlegen, darin federation_sender.yaml:
<syntaxhighlight lang=yaml line>
worker_app: synapse.app.federation_sender

# The replication listener on the synapse to talk to.
worker_replication_host: 127.0.0.1
worker_replication_port: 32892
worker_replication_http_port: 32893

worker_daemonize: True
worker_pid_file: /home/pacs/xyz00/users/matrix/synapse/federation_sender.pid
worker_log_config: /home/pacs/xyz00/users/matrix/synapse/federation_sender.log.config
</syntaxhighlight>
.monitrc um worker erweitern:
<syntaxhighlight lang=shell line>
check process federation_sender with pidfile /home/pacs/xyz00/users/matrix/synapse/federation_sender.pid
start program "/bin/bash -c 'export VIRTUAL_ENV=$HOME/synapse/env && export PATH=$VIRTUAL_ENV/bin:$PATH && cd $HOME/synapse && synctl -w workers/federation_sender.yaml start'"
stop program "/bin/bash -c '/bin/kill $( cat $HOME/synapse/federation_sender.pid )'"
</syntaxhighlight>
Monit neu laden und synapse und federation_sender neustarten:

<syntaxhighlight lang=shell>
monit reload
monit restart all
</syntaxhighlight>

Nach Updates ebenfalls immer Hauptprozess und alle Worker neustarten

<syntaxhighlight lang=shell>
monit restart all
</syntaxhighlight>

== Sliding Sync Proxy ==
Zum Zeitpunkt dieser Anleitung werden aktiv neue Element Anwendungen (Element X) und ein neues Syncverfahren entwickelt um Matrix performanter und weniger ressourcenhungrig zu machen. Bei stärkerer Matrix Nutzung können die neuen Anwendungen besonders mobil schon eine große Entlastung sein.

<strong>Ende 2024 wurden grundlegende Funktionen direkt in Synapse implementiert. Der Proxy wird nicht länger weiterentwickelt und sollte deinstalliert werden (nicht vergessen die .well-known zurück zu ändern).</strong> Auch der 3rdparty Server [[Conduit]] bringt nativ Support für Sliding Sync.</strong>

== Links ==

* https://matrix.org/docs/projects/server/synapse
* https://github.com/element-hq/synapse
* https://github.com/element-hq/synapse/blob/master/INSTALL.md
* https://github.com/matrix-org/sliding-sync
* https://matrix.org/docs/spec/
* https://www.hostsharing.net/loesungen/matrix/
* https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/synapse
* https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/element

[[Kategorie:Messenger]]
[[Kategorie:Software]]
[[Kategorie:Eigene Daemons]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Ansible Playbook]]

DKIM

2024-10-14T10:41:40Z

Hsh-milanihl:

[[Kategorie:HSDoku]][[Kategorie:E-Mail]]
= DomainKeys Identified Mail (DKIM) =

DKIM ist ein Verfahren, dass die Authentizität einer E-Mail sicherstellen kann. Dazu wird die E-Mail auf dem sendenden System mit einer elektronischen Signatur in den unsichtbaren Headerzeilen der E-Mail versehen. Es kommt ein asymmetrisches Schlüsselverfahren zum Einsatz. Der sendende Server verwendet seinen privaten Schlüssel, um die Signatur zu erstellen.

Der öffentliche Schlüssel wird im DNS der E-Mail-Domain veröffentlicht, so dass Empfänger die Authentizität der Signatur prüfen können.

== DKIM bei Hostsharing aktivieren ==

Die Nutzer der Hostsharing-Plattform können E-Mails, die sie über die Hostsharing-Server versenden, mit einer DKIM Signatur versehen lassen. Dazu sind zwei Voraussetzungen notwendig:

# Die Veröffentlichung des öffentlichen Domainkey im DNS der eigenen E-Mail-Domain.
# Das Setzen der Domain-Option "Domain Key – DKIM" mit Hilfe von HSAdmin.

=== Domainkey im DNS ===

==== Wenn ein individuell angepasstes Zonefile existiert ====

Wenn das Zonefile individuell angepasst wurde, muss es entweder den Platzhalter

<code>{DEFAULT_ZONEFILE}</code>

oder den Platzhalter

<code>{DKIM_RR}</code>

enthalten.

Wenn das nicht der Fall ist, muss eine der beiden Zeilen ergänzt werden.

==== Wenn das Zonefile nicht verändert wurde ====

Wenn kein Zonefile im etc-Verzeichnis der Domain vorhanden ist, bedeutet dies, dass das Default-Zonefile mit der Zeile "<code>{DEFAULT_ZONEFILE}</code>" genutzt wird.

Die Veröffentlichung ddes Domainkeys ist dann mit einem einfachen "touch"-Befehl möglich.

<syntaxhighlight lang=shell>
touch doms/hs-example.de/etc/pri.hs-example.de
</syntaxhighlight>

Daraufhin erstellt das System automatisch einen Domain-Key und veröffentlicht ihn.
Etwa drei Minuten nach dem "touch" liefert der Befehl

<syntaxhighlight lang=shell>
dig -t TXT +short default._domainkey.hs-example.de @dns1.hostsharing.net
</syntaxhighlight>

("hs-example.de" durch die eigene Domain ersetzen)

einen Schlüssel in der Form:

<syntaxhighlight lang=ini>
v=DKIM1; h=sha256; k=rsa; s=email; " "p=MIIBIjAN [...]"
</syntaxhighlight>

=== Domainoption DKIM ===

Über die Domainoption "Domain Key – DKIM" wird gesteuert, dass der SMTP-Server, auf dem der Webspace mit der Domain liegt, die ausgehenden E-Mail mit einer DKIM-Signatur ausstattet.

Zum Anpassen der Domainoptionen wählt man in HSAdmin links den Punkt "Web-Paket" und im rechten Bereich im Menü die Auswahl "Domain". Bei Domains, die ab 3. September 2021 eingerichtet wurden, ist die Domainoption per Voreinstellung gesetzt,

[[Datei:dkim-domain.png]]

[[Datei:dkim-option.png]]

== DKIM deaktivieren ==

Das Abstellen der DKIM-Option in folgender Reihenfolge wird funktionieren:

# Die Domainoption deaktivieren
# Abwarten bis alle mit der Option (und damit mit einer Signatur) versendeten E-Mail zugestellt sind
# Den Domainkey im DNS entfernen

== DKIM bei Google ==

Die Server von ''gmail'' sind so eingestellt, dass E-Mails von Domains ohne DKIM oder SPF nicht zugestellt werden. Die Empfängerseite wird nicht informiert. An die Absenderseite geht eine Fehlermeldung in der Art:
<Blockquote>... host gmail-smtp-in.l.google.com[2a00:1450:4010:c0f::1a] said: 550-5.7.26 Your email has been blocked because the sender is unauthenticated. 550-5.7.26 Gmail requires all senders to authenticate with either SPF or DKIM. 550-5.7.26 550-5.7.26 Authentication results: 550-5.7.26 DKIM = did not pass 550-5.7.26 ...</blockquote>
Dieser Google-Support-Artikel: [https://support.google.com/a/answer/81126 Richtlinien für E-Mail-Absender] (abgerufen am 26. Mai 2024) soll das erläutern.

Nach erfolgreicher Umstellung findet sich im Header einer E-Mail in Googles Posteingang Text in der Art:
<syntaxhighlight lang=ini>Authentication-Results: mx.google.com;
dkim=pass ...
spf=pass ...</blockquote>
</syntaxhighlight>

== Links ==

* [https://de.wikipedia.org/wiki/DomainKeys DKIM Artikel der Wikipedia]
* [https://www.hostsharing.net/doc/managed-operations-platform/zonefile/ Hostsharing-Dokumentation zur Anpassung des Zonefile]
* [https://www.hostsharing.net/doc/managed-operations-platform/domain/#kap-domain-optionen Hostsharing-Dokumentation Domain-Optionen]

LLDAP

2024-10-14T10:38:24Z

Hsh-milanihl:

== LDAP Kontoverwaltung mit LLDAP ==

LLDAP ist ein LDAP Server, der in der Programmiersprache Rust implementiert ist. LLDAP verwendet eine relationale Datenbank zum Speichern der Accounts und Gruppen. LLDAP läßt sich als eigener Daemon betreiben. Er bringt ein einfaches Webfrontend für die Verwaltung der Konten und Gruppen und eine Funktion zum Passwort-Rücksetzen mit.

=== Vorbereitungen in HSAdmin ===

Mit Hilfe von HSAdmin werden im ersten Schritt ein Service-User, eine Domain und ein PostgreSQL-User mit PostgreSQL-Datenbank angelegt. Der Service-User heißt im folgenden "''xyz00-lldap''", die Domain "''account.hs-example.de''", PostgreSQL-User und -Datenbank heißen beide "''xyz00_lldap''". Das PostgreSQL-Passwort sei "''pg_password_99''".

=== Download und entpacken ===

Die aktuelle Version von LLDAP ist v0.5.0.

Ich melde mich als User "''xyz00-lldap''" und lade das Binärpaket mit wget:

<syntaxhighlight lang="bash">
wget https://github.com/lldap/lldap/releases/download/v0.5.0/amd64-lldap.tar.gz
tar xzf amd64-lldap.tar.gz
mv amd64-lldap lldap
</syntaxhighlight>

=== Konfiguration ===

Die Konfiguration erfolgt über eine Datei "''lldap_config.toml''" im Verzeichnis "''~/lldap''". die Datei erstelle ich wie folgt:

<syntaxhighlight lang="bash">
cd ~/lldap
touch lldap_config.toml
vim lldap_config.toml
</syntaxhighlight>

der Inhalt nach dem Bearbeiten ist zum Beispiel:

<syntaxhighlight lang="toml">
verbose=true
ldap_host = "127.0.0.1"
ldap_port = 33891
http_host = "127.0.0.1"
http_port= 33881
http_url = "https://account.hs-example.de"
jwt_secret = "generierte-zufallszeichenkett-als-secret"
ldap_base_dn = "dc=hs-example,dc=de"
ldap_user_dn = "admin"
ldap_user_email = "webmaster@hs-example.de"
ldap_user_pass = "ldap-admin-password-generieren"
force_ldap_user_pass_reset = false
database_url = "postgres://xyz00_lldap:pg_password_99@localhost/xyz00_lldap"
key_seed = "generierte-zufallszeichenkette"

[smtp_options]
enable_password_reset = true
server = "localhost"
port = 4025
smtp_encryption = "NONE"
from="LLDAP Admin <webmaster@hs-example.de>"

[ldaps_options]
enabled = false
</syntaxhighlight>

Bei der Installation sollten folgende Einstellungen angepasst werden:
* die Ports für LDAP und HTTP
* Die Domain "''hs-example.de''" bzw. "''account.hs-example.de''"
* Der Account-Präfix "''xyz00''"
* Die Passworte und Secret-Zeichenketten
* "''verbose''" soltle auf "''false''" geändert werden, wenn alles läuft.

Das Anlegen der Datenbank-Tabellen erfolgt und ein ersten Start des Servers erfolgt mit den Befehlen:

<syntaxhighlight lang="bash">
cd ~/lldap
./lldap create_schema
./lldap run
Ctrl-C
</syntaxhighlight>

=== Proxy-Konfiguration ===

Für den Zugriff auf das Admin-Frontend über den Browser konfiguriere ich die Domain:

<syntaxhighlight lang="bash">
cd ~/doms/account.hs-example.de
rm -rf subs/www subs-ssl/www htdocs-ssl
ln -s $HOME/lldap/app htdocs-ssl
touch htdocs-ssl/.htaccess
vim htdocs-ssl/.htaccess
</syntaxhighlight>

Mit dem Inhalt:

<syntaxhighlight lang="apache">
DirectoryIndex disabled
RewriteEngine On
RewriteBase /

RewriteCond %{DOCUMENT_ROOT}/%{REQUEST_FILENAME} !-f
RewriteRule .* http://127.0.0.1:33881%{REQUEST_URI} [proxy]
RequestHeader set X-Forwarded-Proto "https"
</syntaxhighlight>

Achtung: Port 33881 wie in der Konfig-Datei anpassen!

=== LLDAP als Service einrichten ===

LLDAP soll als Service unter Kontrolle von SystemD laufen.

<syntaxhighlight lang="bash">
cd ~
mkdir -p .config/systemd/user
mkdir var
vim .config/systemd/user/lldap.service
</syntaxhighlight>

Inhalt der Datei:

<syntaxhighlight lang="toml">
[Unit]
Description=LLDAP Service

[Service]
WorkingDirectory=%h/lldap
Environment="PATH=/usr/local/bin:/usr/bin:/bin"
ExecStart=%h/lldap/lldap run
StandardOutput=file:%h/var/lldap.log
StandardError=inherit
Restart=always
PrivateTmp=true
NoNewPrivileges=true

[Install]
WantedBy=default.target
</syntaxhighlight>

Aktivieren und Starten des Dienstes:

<syntaxhighlight lang="bash">
cd ~
systemctl --user daemon-reload
systemctl --user enable lldap.service
systemctl --user start lldap.service
</syntaxhighlight>

Wenn alles gut gegangen ist, kann mann sich als "''admin''" mit dem Passwort aus der Zeile "''ldap_user_pass''" unter https://account.hs-exampel.de anmelden.

=== weitere Verbesserungen ===

Bisher ging es darum, schnell einen LDAP-Dienst aufzusetzen. Leider lädt die fertig kompilierte Distribution, die wir hier benutzt haben, ihre Fonts, das CSS und JavaScript aus CDN-Netzwerken und von Google Servern. Das wollte ihr vermutlich nicht. Ich habe dazu den folgenden Issue im Github-Tracker gefunden: https://github.com/lldap/lldap/issues/93 Wenn ich richtig verstehe, kann man selbst eine Distribution erstellen, die die entsprechenden Ressourcen lokal hostet.

=== Links ===

* [https://github.com/lldap/lldap Github Projekt LLDAP]
* [https://github.com/lldap/lldap/tree/main?tab=readme-ov-file#client-configuration Client-Konfigurationsbeispiele]

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Software]]
[[Kategorie:SSO]]

Discourse installieren

2024-08-30T13:26:18Z

Hsh-milanihl:

{{Textkasten|gelb|Für Managed Server|Ein funktionierender Discourse-Server erfordert mehrere laufende Server-Dienste. Für den Betrieb ist ein Managed Server sinnvoll.}}

{{Textkasten|rot|Support von der Discourse-Community|Die Discourse-Entwickler haben sich entschieden, nur eine mehr oder weniger genormte Installationsmethode (via docker) zu unterstützen. Dies ist so auf der hostsharing-Architektur aufgrund mehrerer Bedenken und Überlegungen nicht möglich. Die Community ist durchaus hilfreich, geht aber davon aus, dass quasi alle Nutzer* eine "supported"e Installation durchgeführt haben. Wenn man in entsprechenden Kanälen nach Hilfe fragt, sollte man unbedingt erwähnen, dass man discourse selber anhand dieser hier lesbaren Anleitung installiert hat, um bereits entsprechenden Kommentaren und Nachfragen vorzugreifen.}}

== Über ==

In diesem Artikel wird die Installation von discourse, Version 2.1.0 (September 2018) beschrieben.

== Vorbereitungen ==

Mit Hilfe von HSAdmin wird angelegt:
# Ein User als Service-User mit ''/bin/bash'' als Shell, zum Beispiel Beispiel: ''xyz00-discourse''
# Eine Domain mit ''xyz00-discourse' als Domain-Administrator, zum Beispiel ''beispiel.discussion''
# Einen Postgresql-User ''xyz00_discourseuser'' mit Passwort ''meinPasswort''
# Eine Postgresql-Datenbank ''xyz00_discoursedb'' mit Datenbank-Owner ''xyz00_discourseuser''

Verwendete IP-Ports der Server-Dienste:
# Redis: localhost:32002
# Discourse-Web: localhost:13000

== Konfiguration der PostgreSQL Datenbank ==

{{Textkasten|gelb|PostgreSQL Extensions|Die PostgreSQL-Datenbank braucht die extensions <code>hstore</code>, <code>pg_trgm</code> und <code>unaccent</code>. Diese müssen vom hostsharing-support installiert werden.}}

Ansonsten liefe die Erstellung der Datenbank so:
<syntaxhighlight lang=sql line>
# su - postgres -c psql
CREATE DATABASE discourse;
CREATE USER discourse;
ALTER USER discourse WITH ENCRYPTED PASSWORD 'password';
ALTER DATABASE discourse OWNER TO discourse;
\connect discourse
CREATE EXTENSION hstore;
CREATE EXTENSION pg_trgm;
CREATE EXTENSION unaccent;
</syntaxhighlight>

Entsprechende Funktionalität (von den extensions abgesehen) ist auch über den HSAdmin verfügbar.

== Konfiguration des Redis Server ==

{{Textkasten|gelb|Firewall/Redis Port|Leider unterstützt discourse nicht die Kommunikation mit Redis über Unix-Sockets. Dementsprechend muss der für Redis konfigurierte Port von dem hostsharing-Support in der Firewall freigegeben werden.}}

<syntaxhighlight lang=shell>
cd
mkdir redis/etc redis/lib redis/log redis/run
</syntaxhighlight>

Anlegen einer Datei ''/home/pacs/xyz00/users/discourse/redis/etc/redis.conf'' mit folgendem Inhalt:

<syntaxhighlight lang=shell line>
daemonize no
pidfile /home/pacs/xyz00/users/discourse/redis/run/redis-server.pid
port 32002
tcp-backlog 128
bind 127.0.0.1
timeout 300
loglevel notice
logfile /home/pacs/xyz00/users/discourse/redis/log/redis.log
databases 16
save 900 1
save 300 10
save 60 10000
slave-serve-stale-data yes
appendonly no
dbfilename dump.rdb
dir /home/pacs/xyz00/users/discourse/redis/lib
</syntaxhighlight>

Für Discourse 3.x gilt: "Discourse requires Redis 6.2.0 or up"

Für Debian Buster und Bullseye ist daher das Installieren eines neueren Binaries erforderlich. Bei Debian Bookwork ist bereits Redis 7.0 enthalten (siehe https://packages.debian.org/search?keywords=redis-server).

Hier steht ein entsprechendes Binary für Debian Buster zur Verfügung, das mit dem Public Key von Timotheus geprüft werden kann:

* https://download.solidcharity.com/tarballs/tpokorra/hostsharing/redis-server-6.2.12-debian-buster.tar.gz
* Prüfsignatur: https://download.solidcharity.com/tarballs/tpokorra/hostsharing/redis-server-6.2.12-debian-buster.tar.gz.sig

Prüfen der Signatur:

<syntaxhighlight lang=shell>
gpg --verify redis-server-6.2.12-debian-buster.tar.gz.sig redis-server-6.2.12-debian-buster.tar.gz
</syntaxhighlight>

Das Binary muss nach <code>$HOME/bin</code> verschoben werden, und entsprechend beim Starten des Dienstes eingetragen werden.

== Installation von Ruby ==

Als User ''xyz00-discourse'': Installation von Ruby mit ''rbenv'' mit folgenden Befehlen:

Zunächst ''rbenv'' and ''ruby-build'':

<syntaxhighlight lang=shell line>
git clone https://github.com/rbenv/rbenv.git ~/.rbenv
cd ~/.rbenv && src/configure && make -C src
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.profile
echo 'eval "$(rbenv init -)"' >> ~/.profile
</syntaxhighlight>

starte neue Shell:

<syntaxhighlight lang=shell>
exec bash
</syntaxhighlight>

Überprüfe rbenv-Installation

<syntaxhighlight lang=shell>
type rbenv
</syntaxhighlight>

Installiere ruby-build als rbenv-Plugin

<syntaxhighlight lang=shell>
git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
</syntaxhighlight>

Nun kann die benötigte Ruby-Version installiert werden:

<syntaxhighlight lang=shell>
rbenv install 2.4
</syntaxhighlight>

== Installation von Discourse selber ==

Weiterhin Als User ''xyz00-discourse'':

<syntaxhighlight lang=shell>
cd ~
git clone https://github.com/discourse/discourse.git discourse
cd ~/discourse
</syntaxhighlight>

Die stabile Version auschecken:

<syntaxhighlight lang=shell>
git checkout stable
</syntaxhighlight>

Ruby Pakete installieren:

<syntaxhighlight lang=shell>
gem install bundler
bundle install -j$(getconf _NPROCESSORS_ONLN) --deployment --without development test
</syntaxhighlight>

== Konfiguration der Discourse Software ==

Anlegen einer Datei ''/home/pacs/xyz00/users/discourse/discourse/config/discourse.conf'' anhand der Beispiel-Datei:

<syntaxhighlight lang=shell>
cd ~/discourse
cp config/discourse_defaults.conf config/discourse.conf
</syntaxhighlight>

Anpassen folgender Inhalte:
<syntaxhighlight lang=ini line>
db_host = 127.0.0.1
db_port = 5432
#db_backup_port = 5432 #(auskommentieren)
db_name = xyz00_discoursedb
db_username = xyz00_discourseuser
db_password = "" #db password
hostname = "discourse.xyz00" # hostname
smtp_address = localhost
smtp_enable_start_tls = false
smtp_openssl_verify_mode = 'none'
developer_emails = # your email-address
redis_host = 127.0.0.1
redis_port = 32002
</syntaxhighlight>
===TODO: Secrets setzen! ===
Die Zufallswerte für die Variablen SECRET_KEY_BASE und OTP_SECRET erzeugt man durch zwei Aufrufe des Kommandos

<syntaxhighlight lang=shell>
RAILS_ENV=production bundle exec rake secret
</syntaxhighlight>

=== Sidekiq für Hintergrund-Aufgaben konfigurieren ===

''config/sidekiq.conf''

Wichtig: development auf production ändern.

Mit diesem Dienst werden z.B. die E-Mails zur Aktivierung oder zum Passwort Reset verschickt.

=== Problem mit Content Security Policy ===

Um ein Problem mit Content Security Policy zu lösen, weil manche Dateien über http nachgeladen werden, muss in der Datei <code>config/site_settings.yml</code> der Default Wert für force_https auf True gesetzt werden:
<syntaxhighlight lang=yaml line>
force_https:
default: true
</syntaxhighlight>
=== Problem beim Aufsetzen der Datenbank vermeiden ===

'''→ Notiz Mai 2024:''' dies scheint aktuell nicht aufzutreten.

Aus irgendeinem Grund wird beim Initialisieren der Datenbank versucht, den TYPE hotlinked_media_status zweimal in der Datenbank anzulegen. Der Grund ist nicht ersichtlich.

Es kann folgende Änderung an der Datei <code>db/migrate/20220428094026_create_post_hotlinked_media.rb</code> vorgenommen werden:
<syntaxhighlight lang=ruby line>
reversible do |dir|
dir.up { execute <<~SQL }
DO $$ BEGIN CREATE TYPE hotlinked_media_status AS ENUM('downloaded', 'too_large', 'download_failed', 'upload_create_failed'); EXCEPTION WHEN duplicate_object THEN null; END $$;
SQL
dir.down { execute <<~SQL }
DROP TYPE hotlinked_media_status
SQL
end
</syntaxhighlight>
=== Initialisieren der Datenbank ===

<syntaxhighlight lang=shell>
export SAFETY_ASSURED=1
# In Version 2.0.4 funktioniert db:migrate noch, ansonsten db:schema:load und seed nutzen!
# In Version 3.0.3 funktioniert db:migrate auch noch, db:schema:load ging nicht weil die Datei structure.sql fehlte
#RAILS_ENV=production bundle exec rails db:schema:load
#RAILS_ENV=production bundle exec rails db:seed
RAILS_ENV=production bundle exec rails db:migrate
</syntaxhighlight>

=== Kompilieren der Assets ===

<syntaxhighlight lang=shell>
RAILS_ENV=production bundle exec rails assets:precompile
</syntaxhighlight>

=== Konfiguration des Web-Servers (am Beispiel Puma) ===

Die Datei ''config/puma.conf'' anpassen (hier nur Änderungen angezeigt):

<syntaxhighlight lang=ini>
APP_ROOT = '/home/pacs/xyz00/users/discourse/discourse'
daemonize false
</syntaxhighlight>

== Starten der Dienste ==

Zum Start aller notwendigen Dienste sollte systemd benutzt werden.

Die folgenden Dateien müssen nach <code>.config/systemd/user/</code> kopiert werden (überlange Zeilen werden hier im Wiki umgebrochen)

redis.service:

<syntaxhighlight lang=ini line>
[Unit]
Description=Redis User Service

[Service]
WorkingDirectory=%h/var/redis
Environment="PATH=/usr/local/bin:/usr/bin:/bin"
ExecStart=%h/bin/redis-server %h/etc/redis.conf
Restart=always
PrivateTmp=true
NoNewPrivileges=true

[Install]
WantedBy=default.target
</syntaxhighlight>

sidekiq.service:

<syntaxhighlight lang=ini line>
[Unit]
Description=Discourse Sidekiq Service

[Service]
WorkingDirectory=%h/discourse
Environment="PATH=/usr/local/bin:/usr/bin:/bin"
Environment="RAILS_ENV=production"
Environment="DB_POOL=8"
Environment="MALLOC_ARENA_MAX=2"
ExecStart=%h/.rbenv/shims/bundle exec sidekiq -C %h/discourse/config/sidekiq.yml
StandardOutput=file:%h/var/log/sidekiq.out.log
StandardError=inherit
Restart=always
PrivateTmp=true
NoNewPrivileges=true

[Install]
WantedBy=default.target
After=redis.service
</syntaxhighlight>

discourse.service:

<syntaxhighlight lang=ini line>
[Unit]
Description=Discourse Web Service

[Service]
WorkingDirectory=%h/discourse
Environment="PATH=/usr/local/bin:/usr/bin:/bin"
Environment="RAILS_ENV=production"
Environment="WEB_CONCURRENCY=2"
Environment="MAX_THREADS=5"
Environment="MALLOC_ARENA_MAX=2"
ExecStart=%h/.rbenv/shims/bundle exec puma -C config/puma.rb -e production -b tcp://127.0.0.1:13000
StandardOutput=file:%h/var/log/puma.out.log
StandardError=inherit
Restart=always
PrivateTmp=true
NoNewPrivileges=true

[Install]
WantedBy=default.target
After=redis.service
</syntaxhighlight>

== Einrichten des Apache VHost ==

<syntaxhighlight lang=shell>
cd ~/doms/beispiel.discuss
rm -rf htdocs-ssl subs/www subs-ssl/www
ln -s ~/live/public htdocs-ssl
touch htdocs-ssl/.htaccess
</syntaxhighlight>

Dann die ''htdocs-ssl/.htaccess'' (durch das gelinkte Verzeichnis entspricht das dem Pfad /home/pacs/xyz00/users/discourse/discourse/public/.htaccess ) mit dem Editor der Wahl öffnen und folgende Konfiguration einfügen:

<syntaxhighlight lang=apache line>
DirectoryIndex disabled

RequestHeader set X-Forwarded-Proto "https"

RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-l
RewriteRule .* http://127.0.0.1:13000%{REQUEST_URI} [proxy,last]
</syntaxhighlight>
== Wartung ==
=== Backup ===

Discourse macht selbstätig backups und legt diese unter 'public/backups' ab. Enthalten ist ein Datenbank-Dump und die hochgeladenen Dateien.

Im Admin-Bereich lassen sich backups auch manuell antreten.

=== Admin Benutzer einladen ===

Manchmal brauchen wir einen neuen Admin Benutzer, den wir von der Kommandozeile aus einladen möchten.

<syntaxhighlight lang=shell>
cd /discourse
RAILS_ENV=production rake admin:invite[admin@example.org]
</syntaxhighlight>

=== Import aus mbox Archiven ===

Um zum Beispiel ein Mailman2 Archiv zu importieren, wo die Nachrichten als .mbox Datei vorliegen, sind folgende Schritte nötig:

Vorbereitungen an Discourse:

<syntaxhighlight lang=shell>
source .profile
cd discourse
bundle config set frozen false
IMPORT=1 bundle install
bundle config set frozen true
nano script/import_scripts/mbox/settings.yml
# dort ändern:
# data_dir: /home/pacs/xyz00/users/discourse/list-archiv
</syntaxhighlight>

Hochladen der Mailinglisten-Archive:
<syntaxhighlight lang=shell>
mkdir ~/list-archiv
# dort muss es Unterordner mit dem Namen der gewünschten Kategorie geben,
# und die mbox Datei muss auch diesen Namen haben, z.B.:
# ~/list-archiv/beispiel/beispiel.mbox
# ~/list-archiv/example/example.mbox
# um die Beiträge in den entsprechenden Kategorien beispiel und example einzufügen.
</syntaxhighlight>

Durchführen des Imports:
<syntaxhighlight lang=shell>
source .profile
cd discourse
RAILS_ENV=production IMPORT=1 bundle exec rails runner \
script/import_scripts/mbox.rb script/import_scripts/mbox/settings.yml
</syntaxhighlight>

=== Export ===
* Wenn ein Forum beendet wird, möchte man evtl. eine Sicherung als statische HTML Seiten.
** Das wird hier diskutiert: https://meta.discourse.org/t/how-do-i-export-the-complete-forum-as-static-html-pages/71007/3
* Um ein Forum von Discourse zu Flarum umzuziehen, hat Timotheus ein Skript geschrieben.
** Das Migrations-Skript: https://github.com/SolidCharity/discourse_to_flarum
** siehe auch https://discuss.flarum.org/d/4930-discourse-to-flarum-migration-support/29

=== Updates ===

Discourse wird über update via mail informieren (dies kann man m.W. abschalten).

Achtung: bei größeren Updates auch immer Änderungen an der Datei site_settings.yml (https://github.com/discourse/discourse/blob/main/config/site_settings.yml) beachten!

==== Am Beispiel von 3.0.3 auf 3.0.5 ====

# Im Web-Backend unter Administration->Backups-> Read-Only Mouds setzen (oder Web Server so konfigurieren, dass keine Zugriffe mehr stattfinden können)
# Backup
# Die lokalen Änderungen sichern:
# cd discourse
# git diff v3.0.3 > diff-3.0.3.txt
# git fetch
# git checkout -b hostsharing-deployment-v3.0.5 v3.0.5
# evtl. Änderungen aus diff-3.0.3.txt wieder übernehmen und committen
# patch -p1 < diff-3.0.3.txt
# git commit -a -m "spezifische Änderungen für diese Instanz" --no-verify
# Schauen, ob discourse (endlich :) ) eine neue Ruby-Version nutzt (z.B. in https://github.com/discourse/discourse/blob/stable/.ruby-version.sample)
# Dies ist der Fall, also
# rbenv install 3.2.1
# rbenv rehash
# echo "3.2.1" > .ruby-version
# source ~/.profile
# gem update --system
# bundle
# yarn install
# RAILS_ENV=production bundle exec rake db:migrate
# RAILS_ENV=production bundle exec rake assets:precompile
# Services neu starten
<syntaxhighlight lang=shell>
systemctl --user restart puma
systemctl --user restart sidekiq
systemctl --user restart redis
</syntaxhighlight>
* Zuletzt: Read-Only Modus wieder deaktivieren

=== Debugging ===

Es können folgende Einstellungen in der Datei config/environments/production.rb vorgenommen werden. Danach den Puma Dienst neustarten. Fehlermeldungen und Stacktraces werden dann im Browser ausgegeben.

<syntaxhighlight lang="ini" line>
config.log_level = :debug
config.action_dispatch.show_exceptions = :all
config.action_dispatch.debug_exception_log_level = :error

# Full error reports are enabled and caching is turned off
config.consider_all_requests_local = true
config.action_controller.perform_caching = false
</syntaxhighlight>

=== Erforderliche Anpassungen ===
Weil wir bei Debian Bookworm noch mit ImageMagick 6.9 arbeiten, muss dieser [https://github.com/discourse/discourse/commit/17aa831337e352dfd875f1b4ddc4492bd0835119 Patch] rückgängig gemacht werden:

<syntaxhighlight lang="bash" line>
wget https://github.com/discourse/discourse/commit/17aa831337e352dfd875f1b4ddc4492bd0835119.patch -O ~/imagemagick.patch
patch -p1 --reverse < ~/imagemagick.patch
git commit -a -m "revert imagemagick patch" --no-verify
</syntaxhighlight>

== ToDos ==

* Ein Patch, um Discourse auch via Unix-Socket mit Redis sprechen lassen zu können dürfte relativ einfach sein (es wird ein Wrapper um das redis-gem genutzt).
* Konfiguration von discourse, um mit postgresql via Unix-Socket zu kommunizieren (DISCOURSE_DB_SOCKET environment variable)
* Performance-tuning an diversen Stellen, anhand der discourse_docker-Vorgaben (https://github.com/discourse/discourse_docker), z.B.
** thpoff (huge page settings)
** unicorn (hat eine wesentlich ausgefeiltere Konfigurations-Vorlage, wahrscheinlich bereits ordentlich optimiert)

== Links ==

* https://help.skysilk.com/support/solutions/articles/9000120927-how-to-install-discourse-without-docker-using-skysilk-vps-
* https://github.com/discourse/discourse_docker
* https://github.com/discourse/discourse
* https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/discourse

== Historie ==

* 2018, 14 . September: Initiale Fassung
* 2019, Januar: Update-Informationen ergänzt
* 2022, Juni: systemd Dienste, Discourse 3.0

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:RubyOnRails]]
[[Kategorie:Webforen]]
[[Kategorie:Ansible Playbook]]

CiviCRM installieren

2024-08-27T13:24:24Z

Hsh-milanihl: /* ausblenden des Login-Formulars */

== Allgemein ==

[https://civicrm.org/de CiviCRM] ist eine Verwaltungssoftware für Non-Profit-Organisationen, Verbände, Stiftungen, Vereine usw.

CRM steht für Customer-Relationship-Management bzw. Constituent-Relationship-Management, also das Verwalten der Beziehung zu Spendern, Freiwilligen, Unterstützern, Newsletterabonnenten usw.

CiviCRM ist in PHP geschrieben. Es ist keine eigenständige Anwendung, und muss daher entweder auf Wordpress, Drupal oder Joomla installiert werden. Von den Entwicklern wird Drupal empfohlen.

== Technische Details ==

Es gibt ein Ansible Skript, das die Installationsschritte für Drupal und CiviCRM automatisiert durchführt.

Die Quellen für das Ansible Skript können hier eingesehen werden: https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/civicrm

Es wird zuerst Drupal 9 eingerichtet, und dann die deutsche Version von CiviCRM 5.62 (oder neuer) installiert.

== Installation mit Ansible ==

Folgende Schritte sind auf dem lokalen Rechner auszuführen, um CiviCRM mit Hilfe des Ansible Skripts in den eigenen Hostsharing Benutzer zu installieren:

Klonen des Repositories:

<syntaxhighlight lang=shell line>
git clone https://github.com/tpokorra/Hostsharing-Ansible-CiviCRM-Drupal.git
git clone https://codeberg.org/tpokorra/hs.ansible.git
</syntaxhighlight>

Dann muss die Datei inventory-drupal-sample.yml kopiert werden, und entsprechend angepasst werden:

<syntaxhighlight lang=shell line>
cd hs.ansible
cp playbooks/civicrm/inventory-drupal-sample.yml inventories/my.civicrm.yml
vi inventories/my.civicrm.yml
</syntaxhighlight>

In der my.civicrm.yml müssen die entsprechenden Werte eingerichtet werden.

Eine Fehlerquelle sind zu lange Namen für user, denn dann kommt die Datenbankverwaltung von hsadmin aus dem Tritt. Bei einem Namen mit 13 Zeichen treten zumindest Fehler auf...

Es wird vorausgesetzt, dass auf dem lokalen Rechner Ansible installiert ist.

Dann kann die Installation vom lokalen Rechner aus gestartet werden:

<syntaxhighlight lang=shell line>
ansible-playbook -i inventories/my.civicrm.yml init.yml
ansible-playbook -i inventories/my.civicrm.yml playbooks/civicrm/install.yml
</syntaxhighlight>

== Einrichtung ==

Nach der Installation kann die Seite hier erreicht werden: https://civicrm.example.org

Bitte mit dem Benutzer und dem Passwort anmelden, die in der Datei my.inventory angegeben wurden.

Dann zu CiviCRM gehen, und unter Administration / Verwaltungskonsole auf Systemstatus klicken. Dort wird man auf weitere Dinge hingewiesen, die noch eingerichtet werden müssen, z.B. das Standard-Postfach und die Daten der eigenen Organisation.

[[Datei:Civicrm einrichtung.png|800px]]

=== Keycloak OpenID für Drupal ===

Mit Keycloak erfolgreich getestet wurde das Plugin "Keycloak OpenID Connect" (abhängig von "OpenID Connect").

==== Ausblenden des Login-Formulars ====

Wer primär SSO einsetzt, möchte zur Vereinfachung der Userexperience in der Regel auf das native Loginfeld verzichten. Dies kann unter <strong>OpenID buttons display in user login form</strong> in <code>/admin/config/services/openid-connect</code> bestimmt werden. Hierzu "Ersetzen" anwählen.

Für den Administrator Zugang kann dies mittels <code>?showcore=true</code> am Ende der Login-URI umgangen werden. So sind eventuelle CSS-Hacks zum verstecken der Form nicht mehr notwendig.

== Updates ==

Updates werden hier beschrieben:
* für Drupal: https://www.drupal.org/docs/updating-drupal/updating-drupal-core-via-composer
* für CiviCRM: https://docs.civicrm.org/sysadmin/en/latest/upgrade/drupal8/

Es gibt auch ein Playbook im Ansible Verzeichnis. Dieses sollte aber nur als Anleitung genommen werden.
https://github.com/tpokorra/Hostsharing-Ansible-CiviCRM/blob/main/playbook-update.yml

Updates sollten immer erst auf einem Testsystem durchgeführt werden. Vor der Durchführung eines Updates auf dem Produktivsystem sollte ein Backup erstellt werden, das im Fall eines Problems wiederhergestellt werden kann.

== Links ==
*[https://civicrm.org/ Englische Webseite des CiviCRM Projekts]
*[https://sfe-ev.org/ Software für Engagierte e.V.: CiviCRM Support in Deutschland]
*[https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/civicrm Ansible Playbook für Hostsharing (Drupal bzw. WordPress)]

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Ansible Playbook]]
[[Kategorie:Software]]
[[Kategorie:CRM]]

CiviCRM installieren

2024-08-27T13:24:09Z

Hsh-milanihl: keycloak openid

== Allgemein ==

[https://civicrm.org/de CiviCRM] ist eine Verwaltungssoftware für Non-Profit-Organisationen, Verbände, Stiftungen, Vereine usw.

CRM steht für Customer-Relationship-Management bzw. Constituent-Relationship-Management, also das Verwalten der Beziehung zu Spendern, Freiwilligen, Unterstützern, Newsletterabonnenten usw.

CiviCRM ist in PHP geschrieben. Es ist keine eigenständige Anwendung, und muss daher entweder auf Wordpress, Drupal oder Joomla installiert werden. Von den Entwicklern wird Drupal empfohlen.

== Technische Details ==

Es gibt ein Ansible Skript, das die Installationsschritte für Drupal und CiviCRM automatisiert durchführt.

Die Quellen für das Ansible Skript können hier eingesehen werden: https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/civicrm

Es wird zuerst Drupal 9 eingerichtet, und dann die deutsche Version von CiviCRM 5.62 (oder neuer) installiert.

== Installation mit Ansible ==

Folgende Schritte sind auf dem lokalen Rechner auszuführen, um CiviCRM mit Hilfe des Ansible Skripts in den eigenen Hostsharing Benutzer zu installieren:

Klonen des Repositories:

<syntaxhighlight lang=shell line>
git clone https://github.com/tpokorra/Hostsharing-Ansible-CiviCRM-Drupal.git
git clone https://codeberg.org/tpokorra/hs.ansible.git
</syntaxhighlight>

Dann muss die Datei inventory-drupal-sample.yml kopiert werden, und entsprechend angepasst werden:

<syntaxhighlight lang=shell line>
cd hs.ansible
cp playbooks/civicrm/inventory-drupal-sample.yml inventories/my.civicrm.yml
vi inventories/my.civicrm.yml
</syntaxhighlight>

In der my.civicrm.yml müssen die entsprechenden Werte eingerichtet werden.

Eine Fehlerquelle sind zu lange Namen für user, denn dann kommt die Datenbankverwaltung von hsadmin aus dem Tritt. Bei einem Namen mit 13 Zeichen treten zumindest Fehler auf...

Es wird vorausgesetzt, dass auf dem lokalen Rechner Ansible installiert ist.

Dann kann die Installation vom lokalen Rechner aus gestartet werden:

<syntaxhighlight lang=shell line>
ansible-playbook -i inventories/my.civicrm.yml init.yml
ansible-playbook -i inventories/my.civicrm.yml playbooks/civicrm/install.yml
</syntaxhighlight>

== Einrichtung ==

Nach der Installation kann die Seite hier erreicht werden: https://civicrm.example.org

Bitte mit dem Benutzer und dem Passwort anmelden, die in der Datei my.inventory angegeben wurden.

Dann zu CiviCRM gehen, und unter Administration / Verwaltungskonsole auf Systemstatus klicken. Dort wird man auf weitere Dinge hingewiesen, die noch eingerichtet werden müssen, z.B. das Standard-Postfach und die Daten der eigenen Organisation.

[[Datei:Civicrm einrichtung.png|800px]]

=== Keycloak OpenID für Drupal ===

Mit Keycloak erfolgreich getestet wurde das Plugin "Keycloak OpenID Connect" (abhängig von "OpenID Connect").

==== ausblenden des Login-Formulars ====

Wer primär SSO einsetzt, möchte zur Vereinfachung der Userexperience in der Regel auf das native Loginfeld verzichten. Dies kann unter <strong>OpenID buttons display in user login form</strong> in <code>/admin/config/services/openid-connect</code> bestimmt werden. Hierzu "Ersetzen" anwählen.

Für den Administrator Zugang kann dies mittels <code>?showcore=true</code> am Ende der Login-URI umgangen werden. So sind eventuelle CSS-Hacks zum verstecken der Form nicht mehr notwendig.

== Updates ==

Updates werden hier beschrieben:
* für Drupal: https://www.drupal.org/docs/updating-drupal/updating-drupal-core-via-composer
* für CiviCRM: https://docs.civicrm.org/sysadmin/en/latest/upgrade/drupal8/

Es gibt auch ein Playbook im Ansible Verzeichnis. Dieses sollte aber nur als Anleitung genommen werden.
https://github.com/tpokorra/Hostsharing-Ansible-CiviCRM/blob/main/playbook-update.yml

Updates sollten immer erst auf einem Testsystem durchgeführt werden. Vor der Durchführung eines Updates auf dem Produktivsystem sollte ein Backup erstellt werden, das im Fall eines Problems wiederhergestellt werden kann.

== Links ==
*[https://civicrm.org/ Englische Webseite des CiviCRM Projekts]
*[https://sfe-ev.org/ Software für Engagierte e.V.: CiviCRM Support in Deutschland]
*[https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/civicrm Ansible Playbook für Hostsharing (Drupal bzw. WordPress)]

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Ansible Playbook]]
[[Kategorie:Software]]
[[Kategorie:CRM]]

Nextcloud

2024-08-22T09:38:49Z

Hsh-milanihl: /* Abhängigkeiten und Einschränkungen */

= Nextcloud =

[https://nextcloud.com/ Nextcloud] ist eine PHP-basierte Open Source Lösung für gängige Cloud-Anwendungen, u.a.:

* Filesharing unter Nutzern derselben Nextcloud, und mit der Öffentlichkeit
* Single-Sign-On Authentifizierung (SSO)
* Videokonferenzen (WebRTC)
* Online-Office Anwendung [https://www.collaboraoffice.com/ Collabora Online]

Beispiel-Funktionalität, die über Plugins, sogenannte [https://apps.nextcloud.com/ "Apps"], bereit gestellt werden kann:

* Kalender, Aufgabenverwaltung, Adressbuch
* Datei-Kollaboration (Kommentare zu Dateien, Verschlagwortung)
* Feedreader
* E-Mail-Programm
* Fotogalerie
* Musik- und Videowiedergabe

= Nextcloud installieren =

== Vorbereitungen ==

In ''hsadmin'', zum Beispiel mit ''hsscript'':

''hsadmin''-Shell starten mit:

hsscript -u xyz00 -i
Password: ********

Dann nacheinander anlegen:

* Linux User als Domain-Administrator
* Subdomain ''cloud.example.org''
* PostgreSQL-User
* PostgreSQL Datenbank

<syntaxhighlight lang=shell>
xyz00@hsadmin> user.add({set:{name:'xyz00-cloud',password:'geheim',shell:'/bin/bash',comment:'Nextcloud'}})
xyz00@hsadmin> domain.add({set:{name:'cloud.example.org',user:'xyz00-cloud'}})
xyz00@hsadmin> postgresqluser.add({set:{name:'xyz00_nextclusr',password:'geheim'}})
xyz00@hsadmin> postgresqldb.add({set:{name:'xyz00_nextcloud',owner:'xyz00_nextclusr'}})
</syntaxhighlight>

== Nextcloud installieren ==

Anmelden als Linux-User ''xyz00-cloud'':

<syntaxhighlight lang=shell>
ssh -l xyz00-cloud xyz00.hostsharing.net
</syntaxhighlight>

''htdocs'' Verzeichnis vorbereiten

<syntaxhighlight lang=shell>
cd
mkdir nextcloud
cd doms/cloud.example.org
rm -rf subs/www subs-ssl/www htdocs-ssl
ln -s $HOME/nextcloud htdocs-ssl
</syntaxhighlight>

Nextcloud herunterladen und entpacken.

<syntaxhighlight lang=shell>
cd
wget https://download.nextcloud.com/server/releases/nextcloud-27.1.2.zip
unzip nextcloud-27.1.2.zip
rm nextcloud-27.1.2.zip
mkdir data tmp
chmod 700 data tmp
</syntaxhighlight>

== Nextcloud konfigurieren ==

Im Verzeichnis "$HOME/doms/cloud.example.org/fastcgi-ssl/" eine Datei "php.ini" anlegen mit folgendem Inhalt:

<syntaxhighlight lang=ini>
memory_limit=512M
session.save_path=/home/pacs/xyz00/users/cloud/tmp
</syntaxhighlight>

Dann mit einem Editor diese Datei bearbeiten: In der zweiten Zeile den korrekten Pfad des vorher angelegten tmp-Verzeichnisses eintragen.

Im Browser auf die Seite
http://cloud.example.org gehen und den Anweisungen folgen.

Auf der ersten Seite sind anzugeben:

* Login und Passwort für den Administrator definieren
* PostgreSQL als Datenbanksystem
* PostgreSQL-User und Passwort aus dem ersten Schritt oben
* Name der PostgreSQL-Datenbank aus dem ersten Schritt
* "localhost" als Datenbankserver (Nextcloud 23.0.2 empfiehlt hier die Angabe des Ports, diesen also lt. [[PostgreSQL]] angeben)
* Das Verzeichnis "/home/pacs/xyz00/users/cloud/data/" als Daten-Verzeichnis (bitte beachten: das im Eingabefeld voreingestellte verweist auf das Verzeichnis "/home/pacs/xyz00/users/cloud/'''nextcloud'''/data/")

'''Achtung!''' Die Felder für die Datenbank sind auf dem Startscreen hinter einem unscheinbaren Link versteckt. Um man das Formular für die Datenbank-Daten zu gelangen, muss man auf den Link klicken. Anschließend kann man die gewünschte Datenbank auswählen und die entsprechenden Daten eintragen. '''Das sollte geschehen, bevor man die Installation abschließt!''' Tut man dies nicht, wird Nextcloud mit SQLite installiert. Eine Änderung der Datenbank soll zwar laut Dokumentation auch später noch möglich sein, ging aber bei einem Test schief.

In der Konfigurationsdatei der Nextcloud (in ''~/nextcloud/config/config.php'') lassen sich weitere Voreinstellungen treffen:

<syntaxhighlight lang=php line>
'maintenance_window_start' => 1, // Wartungsfenster ab 1:00 Uhr
'defaultapp' => 'calendar,files', // bei Start wird der Kalender gezeigt
'default_phone_region' => 'DE', // Format Telefonnummern
'default_language' => 'de', // Sprache deutsch
'force_language' => 'de',
'default_locale' => 'de_DE', // Locale (Formatierung Zeitangaben etc.)
'force_locale' => 'de_DE',
</syntaxhighlight>

== Nextcloud beschleunigen ==

Dieser Teil ist optional.

Wenn regelmäßig '''im Browser''' mit Nextcloud gearbeitet werden soll, ist Nextcloud im Browser oft sehr langsam. Um dies zu verbessern, unterstützt Nextcloud die Anwendung von unterschiedlichen Cache-Verfahren (zum Beispiel Memcache, Redis).

=== Redis Cache ===

Redis ist auf den Hostsharing-Servern vorinstalliert und wird von den Nextcloud-Entwicklern empfohlen. '''In Verbindung mit einem Managed Webspace''' muss Redis als eigener Server '''Daemon''' angemeldet werden und ist '''kostenpflichtig'''. Siehe zu Kosten im Webspace Konfigurator unter: https://www.hostsharing.net/angebote/managed-webspace/ – '''1 individueller Serverdienst''' (Daemons).

Die Konfiguration des Redis-Dientes ist auf der Seite [[Redis]] beschrieben. Hier wird für Nextcloud die Variante mit einem Unixsocket benutzt.

In der Konfiguration der Nextcloud (in ''~/nextcloud/config/config.php'') wird der Redis-Cache wie folgt konfiguriert:

<syntaxhighlight lang=php line>
'memcache.local' => '\\OC\\Memcache\\Redis',
'memcache.distributed' => '\\OC\\Memcache\\Redis',
'memcache.locking' => '\\OC\\Memcache\\Redis',
'redis' =>
array (
'host' => '/home/pacs/xyz00/users/cloud/redis/var/redis-server.sock',
'port' => 0,
'password' => 'mein-redis-passwort',
'timeout' => 1.5,
),
</syntaxhighlight>

Um es perfekt zu machen, nutze ich ''logrotate'' um die Logdateien zu organisieren. Dazu die Konfiguration in ''~/.logrotate''

<syntaxhighlight lang=shell line>
compress
/home/pacs/xyz00/users/cloud/redis/var/redis.log {
rotate 5
daily
missingok
}
</syntaxhighlight>
Eine Crontab sorgt für den Start von Monit und das tägliche Rotieren der Logdateien:

<syntaxhighlight lang=shell line>
# m h dom mon dow command
HOME=/home/pacs/xyz00/users/cloud
PATH=/usr/local/bin:/usr/bin:/bin:/usr/local/games:/usr/games
MAILTO=webmaster@example.com
@reboot /usr/bin/monit -c $HOME/.monitrc
1 1 * * * /usr/sbin/logrotate -s $HOME/.logrotate.state $HOME/.logrotate
*/5 * * * * /usr/bin/php $HOME/nextcloud/cron.php
</syntaxhighlight>

Die letzte Zeile der ''crontab'' enthält den Cronjob für die regelmäßigen Hintergrundprozesse der Nextcloud. Durch die Erledigung dieser Aufgaben mit Cron lässt sich die Nextcloud ebenfalls etwas beschleunigen.

=== Nextcloud Push ===

Um Vorgänge wie Sync und Benachrichtigungen bei sehr großen Nextcloud Installationen zu beschleunigen, kann der <code>notify_push</code> Dienst hinzuinstalliert werden.

==== Abhängigkeiten und Einschränkungen ====
* <code>notify_push</code> muss Zugriff auf den gleichen Redis-Cache wie die Nextcloud haben
** aufgrund von eingeschränktem Passwort Support sollte ein Redis Socket mit sicheren Berechtigungseinstellungen als Alternative zum Redis Port mit Passwort konfiguriert werden.
* optimaler Weise holt sich <code>notify_push</code> benötigte informationen aus der <code>config.php</code> der bestehenden Nextcloud-Installation
* eine zusätzliche (Sub)domain im gleichen User ist nötig. Andernfalls muss die bestehende <code>.htaccess</code> muss aus o.g. Gründen modifiziert werden, dies könnte bei Nextcloud-Updates verloren gehen(!)
* Bestimmte Portbereiche sind bei Hostsharing eingeschränkt, es empfiehlt sich, direkt beispielsweise Port <code>37867</code> zu nehmen. <strong>aus diesem Grund ist das automatische Setup durch das Plugin bei Hostsharing nicht möglich!</strong>

==== Installation ====
Siehe auch: https://github.com/nextcloud/notify_push#manual-setup

1. Installieren der Nextcloud-App <code>notify_push</code> – (nach Push suchen, "Client Push" wählen)<br>
2. falls noch nicht erstellt: <code>mkdir -p ~/.config/systemd/user</code><br>
3. mit Lieblingseditor die Datei <code>~/.config/systemd/user/notify_push.service</code> anlegen:<br>
<syntaxhighlight lang="ini" line>
[Unit]
Description = Push daemon for Nextcloud clients
Documentation = https://github.com/nextcloud/notify_push

[Service]
# Change if you already have something running on this port
Environment = PORT=37867
# We don't want to bind to 0.0.0.0, hence the --bind
ExecStart = /home/pacs/xyz00/users/cloud/bin/notify_push --bind 127.0.0.1 /home/pacs/xyz00/users/cloud/nextcloud/config/config.php
Type=notify

[Install]
WantedBy = default.target
</syntaxhighlight>
4. das Verzeichnis <code>~/bin</code> anlegen und die aktuellste binary herunterladen und ausführbar machen:
<syntaxhighlight lang="shell" line>release=`curl -L https://api.github.com/repos/nextcloud/notify_push/releases/latest -s | jq -r '.tag_name'` && wget --show-progress -qO ~/bin/notify_push https://github.com/nextcloud/notify_push/releases/download/$release/notify_push-x86_64-unknown-linux-musl && chmod +x ~/bin/notify_push</syntaxhighlight>
5. es könnte die folgende Umgebungsvariable zum Bedienen von systemd notwendig werden:<br><code>export XDG_RUNTIME_DIR=/run/user/$UID</code><br>
6. den neuen systemd-Dienst automatisch bei Systemstart, sowie jetzt sofort starten:<br><code>systemctl enable --now --user notify_push</code><br>
7. nun gehen wir in <code>doms/push.cloud.example.com/htdocs-ssl/.htaccess</code> und ersetzen den Inhalt (bevorzugt), oder wir ergänzen die .htaccess der Nextcloud im unteren Teil um die folgenden Zeilen (letzteres kann bei Updates überschrieben werden!):
<syntaxhighlight lang="apache" line>
# bei eigener (sub)domain ist /push/ nicht erforderlich, aber wer weiß, eventuell ist das mit robuster
RewriteCond %{REQUEST_URI} ^/push/ws [NC,OR]
RewriteCond %{HTTP:UPGRADE} ^WebSocket$ [NC,OR]
RewriteCond %{HTTP:CONNECTION} ^Upgrade$ [NC]
RewriteRule .* ws://127.0.0.1:37867/ws [proxy]

RewriteCond %{REQUEST_URI} ^/push [NC]
RewriteRule .* http://127.0.0.1:37867%{REQUEST_URI} [proxy]
</syntaxhighlight>
8. abschließend im Nextcloud Ordner die Konfiguration des Plugins anstoßen: <code>php occ notify_push:setup https://cloud.example.com/push</code> bzw. <code>php occ notify_push:setup https://push.cloud.example.com/push</code><br>
9. es ist möglich, das die erkannte IP-Adresse des Hives noch nicht vertraut ist. In diesem Fall wird der obige Befehl scheitern und es muss jene aus der Fehlermeldung des Setups unter <code>trusted_proxies</code> in der <code>config.php</code> ergänzt werden. <br><br>

Es wird im Repo außerdem ein Testclient bereitgestellt, der sich testweise mit dem Push-Dienst verbindet

== Nextcloud mit Online Office ==

In Nextcloud können Office-Dokumente (Textverarbeitung, Tabellen und Präsentationen) im Browser bearbeitet werden. Dazu steht bei Hostsharing die Collabora Developer Version zur Verfügung. Bestellung und Konfiguration sind hier im Wiki auf der Seite [[Collabora_Online]] beschrieben.

== Nextcloud mit Nextcloud Talk ==

Über die Nextcloud-App "Talk" können Videokonfererenzen mit Screensharing durchgeführt werden. Für die regelmäßige Nutzung kann es sinnvoll sein einen eigenen TURN Server zu betreiben. Siehe dazu [[Coturn_Installieren]]

== Virenscanner ==

Einige Nutzer wollen die Dateien in Ihrer Nextcloud regelmäßig auf Viren überprüfen. Auf unseren Servern steht dafür der OpenSource-Virenscanner "ClamAV" zur Verfügung. Wenn dieser Scanner benutzt wird, dann sollten die Einstellungen so gewählt sein, dass der ClamAV-Daemon über eine Socket Verbindung angesprochen wird. Die Einstellungen sind im Screenshot dokumentiert.

[[Datei:Nextcloud-ClamAV-Einstellungen.png||nextcloud einstellungen für die virenscanner-app]]

== Volltextsuche ==

Über die Dokumente einer Nextcloud kann ein Volltextindex erstellt werden. Die Volltextsuche ermöglicht über den Index eine Suche über beliebige Begriffe, die in Dokumenten vorkommen.

Voraussetzung ist der Betrieb eines Elasticsearch Servers. Der Betrieb im Managed Webspace erfodert die Buchung von zwei "Serverdiensten". Nutzer eines Managed Server müssen mit einem spürbaren Mehrbedarf an Hauptspeicher rechnen.

Zur Installation von Elasticsearch existiert eine eigene Wikiseite: [[Elasticsearch]].

In der Nextcloud sind folgende ''Apps'' zu installieren:
* Full Text Search
* Full Text Search - Elasticsearch Platform
* Full Text Search - Files

nach der Installation der drei Apps steht in den Einstellungen ein neuer Menüpunkt "Volltextsuche" zur Verfügung.

Hier ist einzustellen:
* Suchplattform: Elasticsearch
* Adresse des Servlets: http://elastic:das-erzeugt-passwort@127.0.0.1:39200
* Index: frei-gewaehlter-name-idx
* Analyzer tokenizer: standard

Die anderen Einstellung nach den eigenen Vorstellungen vornehmen.

Der initiale Aufbau des Suchindex erfolgt über ein "occ"-Kommando auf der Shell:

<syntaxhighlight lang=shell line>
cd nextcloud/
php occ fulltextsearch:index --output
</syntaxhighlight>

Wenn dieser Fehler kommt:
TypeError: Return value of OCA\Files_FullTextSearch\Model\MountPoint::isGlobal()
must be of the type bool, null returned in [...]/apps/files_fulltextsearch/lib/Model/MountPoint.php:103
sollte dieser Patch angewendet werden: https://github.com/nextcloud/files_fulltextsearch/issues/125#issuecomment-877789742

Zur Pflege des Indexes wird ein weiterer Hintergrundprozess gestartet:

<syntaxhighlight lang=shell line>
cd nextcloud/
php occ fulltextsearch:live -q
</syntaxhighlight>

Die Monit Konfiguration dafür sieht so aus:

<syntaxhighlight lang=shell line>
#~/bin/start-fulltextsearchlive
#
#!/bin/bash
export HOME=/home/pacs/xyz00/users/cloud
cd $HOME
mkdir -p $HOME/var
cd $HOME/nextcloud
exec php occ fulltextsearch:live -q &
echo $! >$HOME/var/fulltextsearchlive.pid
</syntaxhighlight>

<syntaxhighlight lang=shell line>
#~/bin/stop-fulltextsearchlive
#
#!/bin/bash
export HOME=/home/pacs/xyz00/users/cloud
kill $( cat $HOME/var/fulltextsearchlive.pid )
</syntaxhighlight>

~/.monitrc (siehe oben von der Redis Installation) entsprechend ergänzen:
<syntaxhighlight lang=shell line>
check process fulltextsearchlive with pidfile /home/pacs/xyz00/users/cloud/var/fulltextsearchlive.pid
start program "/home/pacs/xyz00/users/cloud/bin/start-fulltextsearchlive"
stop program "/home/pacs/xyz00/users/cloud/bin/stop-fulltextsearchlive"
</syntaxhighlight>
== Integration mit LDAP ==

Um einheitliche Benutzerzugänge für verschiedene Anwendungen zu ermöglichen, wird oft auf ein zentrales LDAP Verzeichnis gesetzt.

Dieses kann für Nextcloud eingesetzt werden, damit Benutzer nicht lokal in Nextcloud, sondern in LDAP verwaltet werden können.

Siehe auch https://docs.nextcloud.com/server/latest/admin_manual/configuration_user/user_auth_ldap.html

Dazu muss die App "LDAP user and group backend" in den Nextcloud Apps aktiviert werden.

Dann muss die LDAP Anbindung in den Administrationseinstellungen unter "LDAP/AD-Integration" eingerichtet werden.

Der Server mit Port, die BenutzerDN mit Passwort und die BaseDN müssen eingetragen werden.

Es muss auch bestimmt werden, welche Klasse (z.B. inetOrgPerson) die Benutzer brauchen, um Zugriff auf die Nextcloud zu erhalten.

Falls schon Benutzer in der Nextcloud existieren, und diese zu LDAP mitgenommen werden sollen, kann der Anleitung aus diesem Forum Eintrag gefolgt werden: https://help.nextcloud.com/t/migration-to-ldap-keeping-users-and-data/13205

* Voraussetzung ist, dass der Benutzernamen der zu übernehmenden Benutzer in Nextcloud der uid in LDAP entspricht.
* Es wird ein Administrator Benutzer benötigt, der lokal angelegt wurde, und auch lokal bleibt.
* Mit diesem Administrator Benutzer wird die LDAP Anbindung eingerichtet.
* In der Experten Ansicht von LDAP/AD muss bei "Attribut für interne Benutzernamen" eingetragen werden: uid
* Klicke den Schalter "LDAP Benutzernamenzuordnung löschen"
* Klicke den Schalter "LDAP Gruppennamenzuordnung löschen"
* dann in der MySQL Datenbank anmelden, und aus uc_users alle Benutzer bis auf den Administrator Benutzer löschen
* Dann in der Nextcloud Weboberfläche sich alle Benutzer anzeigen lassen
* Nun gelingt die Anmeldung mit den anderen Benutzern mit dem LDAP Passwort, und die Dateien wurden übernommen.

== Optimierung der Geschwindigkeit ==
Manchmal fühlt sich die Nextcloud träge an.

Folgende Änderungen können helfen:

* HTTP/2.0 aktivieren: dem Service von Hostsharing Bescheid geben
* Die App Dashboard deaktivieren, und dafür werden direkt die Dateien angezeigt
* Einblenden der README in den Ordnern abschalten: das kann pro Ordner in der UI geschehen (links unten), oder global: <code>occ config:app:set text workspace_available --value=0</code>. Siehe auch [https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/text_configuration.html#disable-rich-workspaces-globally]

== Default App einstellen ==

In der Datei config.php können wir einstellen, welche App direkt nach der Anmeldung gezeigt wird.

Das ist entweder die Dashboard App, wenn sie aktiviert ist, oder die Dateien App (files).

Falls der Kalender direkt angezeigt werden soll, muss folgende Zeile in der config.php hinzugefügt werden (siehe auch [https://docs.nextcloud.com/server/stable/admin_manual/configuration_server/config_sample_php_parameters.html#defaultapp]):

<syntaxhighlight lang=shell>
'defaultapp' => 'calendar',
</syntaxhighlight>

= Nextcloud Updates =

== Updater über die Shell starten ==

Wenn die NextCloud sich nicht über das Webfrontend updaten lässt, kann der Updater auch per Shell im directory /updater durch ausführen des updater.phar gestartet werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud/updater
xyz00-cloud@h00:~/nextcloud/updater$ chmod u+x updater.phar
xyz00-cloud@h00:~/nextcloud/updater$ ./updater.phar
</syntaxhighlight>

Es sollten außerdem ein paar Routine-Aufräumarbeiten durchgeführt werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-primary-keys --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-columns --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-indices --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:convert-filecache-bigint --no-interaction
</syntaxhighlight>

So können die Apps noch alle aktualisiert werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ app:update --all -n --no-ansi
</syntaxhighlight>

Für weitere Informationen kann auf die offizielle Doku ab Ziffer 2. zurückgegriffen werden.

* [https://docs.nextcloud.com/server/latest/admin_manual/maintenance/update.html#using-the-command-line-based-updater https://docs.nextcloud.com]

Hier gibt es ein kurzes Video, das die Anmeldung über die Kommandozeile mit Putty erklärt und die Aktualisierung von Nextcloud auf der Kommandozeile:

* [https://tube.solidcharity.net/w/0cf5ee97-ba7c-41df-a56f-8d1fea842ab0 Nextcloud auf der Kommandozeile aktualisieren]

== Wartungsmodus per Shell ein- oder ausschalten ==

So kann der Wartungsmodus angeschaltet werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --on
</syntaxhighlight>

So kann der Wartungsmodus wieder ausgeschaltet werden, d.h. die Nextcloud ist dann wieder in Betrieb:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --off
</syntaxhighlight>

== Webfrontend-Updater Probleme / Lösungen ==

=== Datenbank: Indizes | Primärschlüssel | Konvertierungen ===

Aufgetreten nach erfolgtem Versionsupdate Nextcloud 19 auf Nextcloud 20

Nach dem erfolgten Update lädt automatisch die Seite: '''Sicherheits- und Einrichtungswarnungen''' auf dieser wird angemerkt, dass manuelle Schritte für die Datenbank durchzuführen sind. Dies betrifft Indizes, Primärschlüssel und Konvertierungen.

Per Shell in der directory /nextcloud folgende Kommandos ausführen:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-primary-keys --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-columns --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-indices --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:convert-filecache-bigint --no-interaction
</syntaxhighlight>

Wichtig ist hier dem durch Nextcloud angegebenen Kommando ein '''php''' voranzustellen.

== Update per Skript ==

Es ist möglich die regelmäßigen Updates weitgehend zu automatisieren. Ein Skript wäre etwa:

<syntaxhighlight lang=shell line>
#!/bin/bash
if [ -f $HOME/nextcloud/occ ]; then
echo "Nextcloud Update";
cd $HOME/nextcloud;
php updater/updater.phar -vv --no-backup --no-interaction
php occ maintenance:mode --on
php occ db:add-missing-primary-keys --no-interaction
php occ db:add-missing-columns --no-interaction
php occ db:add-missing-indices --no-interaction
php occ db:convert-filecache-bigint --no-interaction
php occ app:update --all
php occ maintenance:mode --off
else
echo "Keine Nextcloud Installation gefunden";
fi
</syntaxhighlight>

== Update: bei old-stable Version bleiben ==

Normalerweise fragt jede Nextcloud Instanz zentral ab, welches Update zur Verfügung steht, abhängig vom Release Channel. Dabei wird aber relativ schnell auf die nächste Version gewechselt, also z.B. von Nextcloud 28 auf Nextcloud 29, obwohl Nextcloud 28 noch mehrere Monate gepflegt wird, und manche Apps noch nicht bereit sind für Nextcloud 29.

Es kann aber auch eine Alternative eingerichtet werden, in der Datei nextcloud/config/config.php, unter dem Eintrag updater.server.url

Hier wird z.B. auf einen Updater von unserem Mitglied Timotheus Pokorra verwiesen:

<syntaxhighlight lang=php line>
updater_server_url: "https://ncupdater.solidcharity.com"
</syntaxhighlight>

Dahinter läuft ein Skript, mit dem wir noch länger eine bestimmte Version anbieten können: https://codeberg.org/tpokorra/ncupdater

= Daten auf HDD Storage =
== Einrichtung des HDD Storage ==

Um den langsameren aber günstigeren HDD Storage von Hostsharing zu nutzen, kann das data Verzeichnis von SSD auf HDD Storage verschoben werden. Ein symbolischer Link reicht nicht aus, man muss den Pfad in der Nextcloud Konfigurationsdatei anpassen.

<syntaxhighlight lang=shell>
# Nextcloud in Wartungsmodus versetzen
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --on
# Daten auf HDD Storage verschieben
xyz00-cloud@h00:~/nextcloud$ mv data /home/storage/xyz00/users/cloud/
# symbolischen Link anlegen
xyz00-cloud@h00:~/nextcloud$ ln -s /home/storage/xyz00/users/cloud/data data
# Pfad in config.php ändern
nano config/config.php
# Die Zeile mit 'datadirectory' finden und entsprechend ändern:
# 'datadirectory' => '/home/storage/xyz00/users/cloud/data',
# Wartungsmodus beenden
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --off
</syntaxhighlight>

= Einschränkende Bemerkungen =
== Nextcloud Sync Client ==

Der Nextcloud Sync Client erfüllt eine Funktion ähnlich wie Dropbox, und synchronisiert ganze Ordnerstrukturen.

Gerade wenn man mit mehreren Menschen in einer Nextcloud arbeitet, ist diese Funktion mit Vorsicht zu benutzen.

* Änderungen an der Ordnerstruktur sollten nicht lokal, sondern im Webbrowser vorgenommen werden.
* Wenn die Gefahr besteht, dass mehrere Menschen gleichzeitig eine Datei bearbeiten, sollte die Datei nicht lokal, sondern im Webbrowser bearbeitet werden.
* Aus Sicht des Datenschutzes und der Daten-Minimierung sollte überlegt werden, ob die Daten wirklich auf jeden Laptop und Rechner synchronisiert werden sollen, oder ob es reicht, ausschließlich über den Webbrowser auf die Daten zuzugreifen.

= weiterführende Links =

* [https://docs.nextcloud.com/ Nextcloud Dokumentation]
* [https://apps.nextcloud.com/ Nextcloud Erweiterungen ("Apps")]
* [https://ownyourbits.com/2019/06/29/understanding-and-improving-nextcloud-previews/ Optimierung des Caches für Previews]
* [https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/nextcloud Ansible Playbook für Hostsharing]

= Nextcloud Reseller bei HS =

[https://nextcloud.ossaas.de OS SaaS]

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Ansible Playbook]]
[[Kategorie:Software]]
[[Kategorie:CalDAV]]

Nextcloud

2024-08-21T11:14:28Z

Hsh-milanihl: /* Installation */

= Nextcloud =

[https://nextcloud.com/ Nextcloud] ist eine PHP-basierte Open Source Lösung für gängige Cloud-Anwendungen, u.a.:

* Filesharing unter Nutzern derselben Nextcloud, und mit der Öffentlichkeit
* Single-Sign-On Authentifizierung (SSO)
* Videokonferenzen (WebRTC)
* Online-Office Anwendung [https://www.collaboraoffice.com/ Collabora Online]

Beispiel-Funktionalität, die über Plugins, sogenannte [https://apps.nextcloud.com/ "Apps"], bereit gestellt werden kann:

* Kalender, Aufgabenverwaltung, Adressbuch
* Datei-Kollaboration (Kommentare zu Dateien, Verschlagwortung)
* Feedreader
* E-Mail-Programm
* Fotogalerie
* Musik- und Videowiedergabe

= Nextcloud installieren =

== Vorbereitungen ==

In ''hsadmin'', zum Beispiel mit ''hsscript'':

''hsadmin''-Shell starten mit:

hsscript -u xyz00 -i
Password: ********

Dann nacheinander anlegen:

* Linux User als Domain-Administrator
* Subdomain ''cloud.example.org''
* PostgreSQL-User
* PostgreSQL Datenbank

<syntaxhighlight lang=shell>
xyz00@hsadmin> user.add({set:{name:'xyz00-cloud',password:'geheim',shell:'/bin/bash',comment:'Nextcloud'}})
xyz00@hsadmin> domain.add({set:{name:'cloud.example.org',user:'xyz00-cloud'}})
xyz00@hsadmin> postgresqluser.add({set:{name:'xyz00_nextclusr',password:'geheim'}})
xyz00@hsadmin> postgresqldb.add({set:{name:'xyz00_nextcloud',owner:'xyz00_nextclusr'}})
</syntaxhighlight>

== Nextcloud installieren ==

Anmelden als Linux-User ''xyz00-cloud'':

<syntaxhighlight lang=shell>
ssh -l xyz00-cloud xyz00.hostsharing.net
</syntaxhighlight>

''htdocs'' Verzeichnis vorbereiten

<syntaxhighlight lang=shell>
cd
mkdir nextcloud
cd doms/cloud.example.org
rm -rf subs/www subs-ssl/www htdocs-ssl
ln -s $HOME/nextcloud htdocs-ssl
</syntaxhighlight>

Nextcloud herunterladen und entpacken.

<syntaxhighlight lang=shell>
cd
wget https://download.nextcloud.com/server/releases/nextcloud-27.1.2.zip
unzip nextcloud-27.1.2.zip
rm nextcloud-27.1.2.zip
mkdir data tmp
chmod 700 data tmp
</syntaxhighlight>

== Nextcloud konfigurieren ==

Im Verzeichnis "$HOME/doms/cloud.example.org/fastcgi-ssl/" eine Datei "php.ini" anlegen mit folgendem Inhalt:

<syntaxhighlight lang=ini>
memory_limit=512M
session.save_path=/home/pacs/xyz00/users/cloud/tmp
</syntaxhighlight>

Dann mit einem Editor diese Datei bearbeiten: In der zweiten Zeile den korrekten Pfad des vorher angelegten tmp-Verzeichnisses eintragen.

Im Browser auf die Seite
http://cloud.example.org gehen und den Anweisungen folgen.

Auf der ersten Seite sind anzugeben:

* Login und Passwort für den Administrator definieren
* PostgreSQL als Datenbanksystem
* PostgreSQL-User und Passwort aus dem ersten Schritt oben
* Name der PostgreSQL-Datenbank aus dem ersten Schritt
* "localhost" als Datenbankserver (Nextcloud 23.0.2 empfiehlt hier die Angabe des Ports, diesen also lt. [[PostgreSQL]] angeben)
* Das Verzeichnis "/home/pacs/xyz00/users/cloud/data/" als Daten-Verzeichnis (bitte beachten: das im Eingabefeld voreingestellte verweist auf das Verzeichnis "/home/pacs/xyz00/users/cloud/'''nextcloud'''/data/")

'''Achtung!''' Die Felder für die Datenbank sind auf dem Startscreen hinter einem unscheinbaren Link versteckt. Um man das Formular für die Datenbank-Daten zu gelangen, muss man auf den Link klicken. Anschließend kann man die gewünschte Datenbank auswählen und die entsprechenden Daten eintragen. '''Das sollte geschehen, bevor man die Installation abschließt!''' Tut man dies nicht, wird Nextcloud mit SQLite installiert. Eine Änderung der Datenbank soll zwar laut Dokumentation auch später noch möglich sein, ging aber bei einem Test schief.

In der Konfigurationsdatei der Nextcloud (in ''~/nextcloud/config/config.php'') lassen sich weitere Voreinstellungen treffen:

<syntaxhighlight lang=php line>
'maintenance_window_start' => 1, // Wartungsfenster ab 1:00 Uhr
'defaultapp' => 'calendar,files', // bei Start wird der Kalender gezeigt
'default_phone_region' => 'DE', // Format Telefonnummern
'default_language' => 'de', // Sprache deutsch
'force_language' => 'de',
'default_locale' => 'de_DE', // Locale (Formatierung Zeitangaben etc.)
'force_locale' => 'de_DE',
</syntaxhighlight>

== Nextcloud beschleunigen ==

Dieser Teil ist optional.

Wenn regelmäßig '''im Browser''' mit Nextcloud gearbeitet werden soll, ist Nextcloud im Browser oft sehr langsam. Um dies zu verbessern, unterstützt Nextcloud die Anwendung von unterschiedlichen Cache-Verfahren (zum Beispiel Memcache, Redis).

=== Redis Cache ===

Redis ist auf den Hostsharing-Servern vorinstalliert und wird von den Nextcloud-Entwicklern empfohlen. '''In Verbindung mit einem Managed Webspace''' muss Redis als eigener Server '''Daemon''' angemeldet werden und ist '''kostenpflichtig'''. Siehe zu Kosten im Webspace Konfigurator unter: https://www.hostsharing.net/angebote/managed-webspace/ – '''1 individueller Serverdienst''' (Daemons).

Die Konfiguration des Redis-Dientes ist auf der Seite [[Redis]] beschrieben. Hier wird für Nextcloud die Variante mit einem Unixsocket benutzt.

In der Konfiguration der Nextcloud (in ''~/nextcloud/config/config.php'') wird der Redis-Cache wie folgt konfiguriert:

<syntaxhighlight lang=php line>
'memcache.local' => '\\OC\\Memcache\\Redis',
'memcache.distributed' => '\\OC\\Memcache\\Redis',
'memcache.locking' => '\\OC\\Memcache\\Redis',
'redis' =>
array (
'host' => '/home/pacs/xyz00/users/cloud/redis/var/redis-server.sock',
'port' => 0,
'password' => 'mein-redis-passwort',
'timeout' => 1.5,
),
</syntaxhighlight>

Um es perfekt zu machen, nutze ich ''logrotate'' um die Logdateien zu organisieren. Dazu die Konfiguration in ''~/.logrotate''

<syntaxhighlight lang=shell line>
compress
/home/pacs/xyz00/users/cloud/redis/var/redis.log {
rotate 5
daily
missingok
}
</syntaxhighlight>
Eine Crontab sorgt für den Start von Monit und das tägliche Rotieren der Logdateien:

<syntaxhighlight lang=shell line>
# m h dom mon dow command
HOME=/home/pacs/xyz00/users/cloud
PATH=/usr/local/bin:/usr/bin:/bin:/usr/local/games:/usr/games
MAILTO=webmaster@example.com
@reboot /usr/bin/monit -c $HOME/.monitrc
1 1 * * * /usr/sbin/logrotate -s $HOME/.logrotate.state $HOME/.logrotate
*/5 * * * * /usr/bin/php $HOME/nextcloud/cron.php
</syntaxhighlight>

Die letzte Zeile der ''crontab'' enthält den Cronjob für die regelmäßigen Hintergrundprozesse der Nextcloud. Durch die Erledigung dieser Aufgaben mit Cron lässt sich die Nextcloud ebenfalls etwas beschleunigen.

=== Nextcloud Push ===

Um Vorgänge wie Sync und Benachrichtigungen bei sehr großen Nextcloud Installationen zu beschleunigen, kann der <code>notify_push</code> Dienst hinzuinstalliert werden.

==== Abhängigkeiten und Einschränkungen ====
* <code>notify_push</code> muss Zugriff auf den gleichen Redis-Cache wie die Nextcloud haben
** aufgrund von eingeschränktem Passwort Support sollte ein Redis Socket mit sicheren Berechtigungseinstellungen als Alternative zum Redis Port mit Passwort konfiguriert werden.
* optimaler Weise holt sich <code>notify_push</code> benötigte informationen aus der <code>config.php</code> der bestehenden Nextcloud-Installation
* die bestehende <code>.htaccess</code> muss aus o.g. Gründen modifiziert werden, dies könnte bei Nextcloud-Updates verloren gehen(!)
* Bestimmte Portbereiche sind bei Hostsharing eingeschränkt, es empfiehlt sich, direkt beispielsweise Port <code>37867</code> zu nehmen. <strong>aus diesem Grund ist das automatische Setup durch das Plugin bei Hostsharing nicht möglich!</strong>

==== Installation ====
Siehe auch: https://github.com/nextcloud/notify_push#manual-setup

1. Installieren der Nextcloud-App <code>notify_push</code> – (nach Push suchen, "Client Push" wählen)<br>
2. falls noch nicht erstellt: <code>mkdir -p ~/.config/systemd/user</code><br>
3. mit Lieblingseditor die Datei <code>~/.config/systemd/user/notify_push.service</code> anlegen:<br>
<syntaxhighlight lang="ini" line>
[Unit]
Description = Push daemon for Nextcloud clients
Documentation = https://github.com/nextcloud/notify_push

[Service]
# Change if you already have something running on this port
Environment = PORT=37867
# We don't want to bind to 0.0.0.0, hence the --bind
ExecStart = /home/pacs/xyz00/users/cloud/bin/notify_push --bind 127.0.0.1 /home/pacs/xyz00/users/cloud/nextcloud/config/config.php
Type=notify

[Install]
WantedBy = default.target
</syntaxhighlight>
4. das Verzeichnis <code>~/bin</code> anlegen und die aktuellste binary herunterladen und ausführbar machen:
<syntaxhighlight lang="shell" line>release=`curl -L https://api.github.com/repos/nextcloud/notify_push/releases/latest -s | jq -r '.tag_name'` && wget --show-progress -qO ~/bin/notify_push https://github.com/nextcloud/notify_push/releases/download/$release/notify_push-x86_64-unknown-linux-musl && chmod +x ~/bin/notify_push</syntaxhighlight>
5. es könnte die folgende Umgebungsvariable zum Bedienen von systemd notwendig werden:<br><code>export XDG_RUNTIME_DIR=/run/user/$UID</code><br>
6. den neuen systemd-Dienst automatisch bei Systemstart, sowie jetzt sofort starten:<br><code>systemctl enable --now --user notify_push</code><br>
7. nun gehen wir in <code>doms/push.cloud.example.com/htdocs-ssl/.htaccess</code> und ersetzen den Inhalt (bevorzugt), oder wir ergänzen die .htaccess der Nextcloud im unteren Teil um die folgenden Zeilen (letzteres kann bei Updates überschrieben werden!):
<syntaxhighlight lang="apache" line>
# bei eigener (sub)domain ist /push/ nicht erforderlich, aber wer weiß, eventuell ist das mit robuster
RewriteCond %{REQUEST_URI} ^/push/ws [NC,OR]
RewriteCond %{HTTP:UPGRADE} ^WebSocket$ [NC,OR]
RewriteCond %{HTTP:CONNECTION} ^Upgrade$ [NC]
RewriteRule .* ws://127.0.0.1:37867/ws [proxy]

RewriteCond %{REQUEST_URI} ^/push [NC]
RewriteRule .* http://127.0.0.1:37867%{REQUEST_URI} [proxy]
</syntaxhighlight>
8. abschließend im Nextcloud Ordner die Konfiguration des Plugins anstoßen: <code>php occ notify_push:setup https://cloud.example.com/push</code> bzw. <code>php occ notify_push:setup https://push.cloud.example.com/push</code><br>
9. es ist möglich, das die erkannte IP-Adresse des Hives noch nicht vertraut ist. In diesem Fall wird der obige Befehl scheitern und es muss jene aus der Fehlermeldung des Setups unter <code>trusted_proxies</code> in der <code>config.php</code> ergänzt werden. <br><br>

Es wird im Repo außerdem ein Testclient bereitgestellt, der sich testweise mit dem Push-Dienst verbindet

== Nextcloud mit Online Office ==

In Nextcloud können Office-Dokumente (Textverarbeitung, Tabellen und Präsentationen) im Browser bearbeitet werden. Dazu steht bei Hostsharing die Collabora Developer Version zur Verfügung. Bestellung und Konfiguration sind hier im Wiki auf der Seite [[Collabora_Online]] beschrieben.

== Nextcloud mit Nextcloud Talk ==

Über die Nextcloud-App "Talk" können Videokonfererenzen mit Screensharing durchgeführt werden. Für die regelmäßige Nutzung kann es sinnvoll sein einen eigenen TURN Server zu betreiben. Siehe dazu [[Coturn_Installieren]]

== Virenscanner ==

Einige Nutzer wollen die Dateien in Ihrer Nextcloud regelmäßig auf Viren überprüfen. Auf unseren Servern steht dafür der OpenSource-Virenscanner "ClamAV" zur Verfügung. Wenn dieser Scanner benutzt wird, dann sollten die Einstellungen so gewählt sein, dass der ClamAV-Daemon über eine Socket Verbindung angesprochen wird. Die Einstellungen sind im Screenshot dokumentiert.

[[Datei:Nextcloud-ClamAV-Einstellungen.png||nextcloud einstellungen für die virenscanner-app]]

== Volltextsuche ==

Über die Dokumente einer Nextcloud kann ein Volltextindex erstellt werden. Die Volltextsuche ermöglicht über den Index eine Suche über beliebige Begriffe, die in Dokumenten vorkommen.

Voraussetzung ist der Betrieb eines Elasticsearch Servers. Der Betrieb im Managed Webspace erfodert die Buchung von zwei "Serverdiensten". Nutzer eines Managed Server müssen mit einem spürbaren Mehrbedarf an Hauptspeicher rechnen.

Zur Installation von Elasticsearch existiert eine eigene Wikiseite: [[Elasticsearch]].

In der Nextcloud sind folgende ''Apps'' zu installieren:
* Full Text Search
* Full Text Search - Elasticsearch Platform
* Full Text Search - Files

nach der Installation der drei Apps steht in den Einstellungen ein neuer Menüpunkt "Volltextsuche" zur Verfügung.

Hier ist einzustellen:
* Suchplattform: Elasticsearch
* Adresse des Servlets: http://elastic:das-erzeugt-passwort@127.0.0.1:39200
* Index: frei-gewaehlter-name-idx
* Analyzer tokenizer: standard

Die anderen Einstellung nach den eigenen Vorstellungen vornehmen.

Der initiale Aufbau des Suchindex erfolgt über ein "occ"-Kommando auf der Shell:

<syntaxhighlight lang=shell line>
cd nextcloud/
php occ fulltextsearch:index --output
</syntaxhighlight>

Wenn dieser Fehler kommt:
TypeError: Return value of OCA\Files_FullTextSearch\Model\MountPoint::isGlobal()
must be of the type bool, null returned in [...]/apps/files_fulltextsearch/lib/Model/MountPoint.php:103
sollte dieser Patch angewendet werden: https://github.com/nextcloud/files_fulltextsearch/issues/125#issuecomment-877789742

Zur Pflege des Indexes wird ein weiterer Hintergrundprozess gestartet:

<syntaxhighlight lang=shell line>
cd nextcloud/
php occ fulltextsearch:live -q
</syntaxhighlight>

Die Monit Konfiguration dafür sieht so aus:

<syntaxhighlight lang=shell line>
#~/bin/start-fulltextsearchlive
#
#!/bin/bash
export HOME=/home/pacs/xyz00/users/cloud
cd $HOME
mkdir -p $HOME/var
cd $HOME/nextcloud
exec php occ fulltextsearch:live -q &
echo $! >$HOME/var/fulltextsearchlive.pid
</syntaxhighlight>

<syntaxhighlight lang=shell line>
#~/bin/stop-fulltextsearchlive
#
#!/bin/bash
export HOME=/home/pacs/xyz00/users/cloud
kill $( cat $HOME/var/fulltextsearchlive.pid )
</syntaxhighlight>

~/.monitrc (siehe oben von der Redis Installation) entsprechend ergänzen:
<syntaxhighlight lang=shell line>
check process fulltextsearchlive with pidfile /home/pacs/xyz00/users/cloud/var/fulltextsearchlive.pid
start program "/home/pacs/xyz00/users/cloud/bin/start-fulltextsearchlive"
stop program "/home/pacs/xyz00/users/cloud/bin/stop-fulltextsearchlive"
</syntaxhighlight>
== Integration mit LDAP ==

Um einheitliche Benutzerzugänge für verschiedene Anwendungen zu ermöglichen, wird oft auf ein zentrales LDAP Verzeichnis gesetzt.

Dieses kann für Nextcloud eingesetzt werden, damit Benutzer nicht lokal in Nextcloud, sondern in LDAP verwaltet werden können.

Siehe auch https://docs.nextcloud.com/server/latest/admin_manual/configuration_user/user_auth_ldap.html

Dazu muss die App "LDAP user and group backend" in den Nextcloud Apps aktiviert werden.

Dann muss die LDAP Anbindung in den Administrationseinstellungen unter "LDAP/AD-Integration" eingerichtet werden.

Der Server mit Port, die BenutzerDN mit Passwort und die BaseDN müssen eingetragen werden.

Es muss auch bestimmt werden, welche Klasse (z.B. inetOrgPerson) die Benutzer brauchen, um Zugriff auf die Nextcloud zu erhalten.

Falls schon Benutzer in der Nextcloud existieren, und diese zu LDAP mitgenommen werden sollen, kann der Anleitung aus diesem Forum Eintrag gefolgt werden: https://help.nextcloud.com/t/migration-to-ldap-keeping-users-and-data/13205

* Voraussetzung ist, dass der Benutzernamen der zu übernehmenden Benutzer in Nextcloud der uid in LDAP entspricht.
* Es wird ein Administrator Benutzer benötigt, der lokal angelegt wurde, und auch lokal bleibt.
* Mit diesem Administrator Benutzer wird die LDAP Anbindung eingerichtet.
* In der Experten Ansicht von LDAP/AD muss bei "Attribut für interne Benutzernamen" eingetragen werden: uid
* Klicke den Schalter "LDAP Benutzernamenzuordnung löschen"
* Klicke den Schalter "LDAP Gruppennamenzuordnung löschen"
* dann in der MySQL Datenbank anmelden, und aus uc_users alle Benutzer bis auf den Administrator Benutzer löschen
* Dann in der Nextcloud Weboberfläche sich alle Benutzer anzeigen lassen
* Nun gelingt die Anmeldung mit den anderen Benutzern mit dem LDAP Passwort, und die Dateien wurden übernommen.

== Optimierung der Geschwindigkeit ==
Manchmal fühlt sich die Nextcloud träge an.

Folgende Änderungen können helfen:

* HTTP/2.0 aktivieren: dem Service von Hostsharing Bescheid geben
* Die App Dashboard deaktivieren, und dafür werden direkt die Dateien angezeigt
* Einblenden der README in den Ordnern abschalten: das kann pro Ordner in der UI geschehen (links unten), oder global: <code>occ config:app:set text workspace_available --value=0</code>. Siehe auch [https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/text_configuration.html#disable-rich-workspaces-globally]

== Default App einstellen ==

In der Datei config.php können wir einstellen, welche App direkt nach der Anmeldung gezeigt wird.

Das ist entweder die Dashboard App, wenn sie aktiviert ist, oder die Dateien App (files).

Falls der Kalender direkt angezeigt werden soll, muss folgende Zeile in der config.php hinzugefügt werden (siehe auch [https://docs.nextcloud.com/server/stable/admin_manual/configuration_server/config_sample_php_parameters.html#defaultapp]):

<syntaxhighlight lang=shell>
'defaultapp' => 'calendar',
</syntaxhighlight>

= Nextcloud Updates =

== Updater über die Shell starten ==

Wenn die NextCloud sich nicht über das Webfrontend updaten lässt, kann der Updater auch per Shell im directory /updater durch ausführen des updater.phar gestartet werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud/updater
xyz00-cloud@h00:~/nextcloud/updater$ chmod u+x updater.phar
xyz00-cloud@h00:~/nextcloud/updater$ ./updater.phar
</syntaxhighlight>

Es sollten außerdem ein paar Routine-Aufräumarbeiten durchgeführt werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-primary-keys --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-columns --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-indices --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:convert-filecache-bigint --no-interaction
</syntaxhighlight>

So können die Apps noch alle aktualisiert werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ app:update --all -n --no-ansi
</syntaxhighlight>

Für weitere Informationen kann auf die offizielle Doku ab Ziffer 2. zurückgegriffen werden.

* [https://docs.nextcloud.com/server/latest/admin_manual/maintenance/update.html#using-the-command-line-based-updater https://docs.nextcloud.com]

Hier gibt es ein kurzes Video, das die Anmeldung über die Kommandozeile mit Putty erklärt und die Aktualisierung von Nextcloud auf der Kommandozeile:

* [https://tube.solidcharity.net/w/0cf5ee97-ba7c-41df-a56f-8d1fea842ab0 Nextcloud auf der Kommandozeile aktualisieren]

== Wartungsmodus per Shell ein- oder ausschalten ==

So kann der Wartungsmodus angeschaltet werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --on
</syntaxhighlight>

So kann der Wartungsmodus wieder ausgeschaltet werden, d.h. die Nextcloud ist dann wieder in Betrieb:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --off
</syntaxhighlight>

== Webfrontend-Updater Probleme / Lösungen ==

=== Datenbank: Indizes | Primärschlüssel | Konvertierungen ===

Aufgetreten nach erfolgtem Versionsupdate Nextcloud 19 auf Nextcloud 20

Nach dem erfolgten Update lädt automatisch die Seite: '''Sicherheits- und Einrichtungswarnungen''' auf dieser wird angemerkt, dass manuelle Schritte für die Datenbank durchzuführen sind. Dies betrifft Indizes, Primärschlüssel und Konvertierungen.

Per Shell in der directory /nextcloud folgende Kommandos ausführen:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-primary-keys --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-columns --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-indices --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:convert-filecache-bigint --no-interaction
</syntaxhighlight>

Wichtig ist hier dem durch Nextcloud angegebenen Kommando ein '''php''' voranzustellen.

== Update per Skript ==

Es ist möglich die regelmäßigen Updates weitgehend zu automatisieren. Ein Skript wäre etwa:

<syntaxhighlight lang=shell line>
#!/bin/bash
if [ -f $HOME/nextcloud/occ ]; then
echo "Nextcloud Update";
cd $HOME/nextcloud;
php updater/updater.phar -vv --no-backup --no-interaction
php occ maintenance:mode --on
php occ db:add-missing-primary-keys --no-interaction
php occ db:add-missing-columns --no-interaction
php occ db:add-missing-indices --no-interaction
php occ db:convert-filecache-bigint --no-interaction
php occ app:update --all
php occ maintenance:mode --off
else
echo "Keine Nextcloud Installation gefunden";
fi
</syntaxhighlight>

== Update: bei old-stable Version bleiben ==

Normalerweise fragt jede Nextcloud Instanz zentral ab, welches Update zur Verfügung steht, abhängig vom Release Channel. Dabei wird aber relativ schnell auf die nächste Version gewechselt, also z.B. von Nextcloud 28 auf Nextcloud 29, obwohl Nextcloud 28 noch mehrere Monate gepflegt wird, und manche Apps noch nicht bereit sind für Nextcloud 29.

Es kann aber auch eine Alternative eingerichtet werden, in der Datei nextcloud/config/config.php, unter dem Eintrag updater.server.url

Hier wird z.B. auf einen Updater von unserem Mitglied Timotheus Pokorra verwiesen:

<syntaxhighlight lang=php line>
updater_server_url: "https://ncupdater.solidcharity.com"
</syntaxhighlight>

Dahinter läuft ein Skript, mit dem wir noch länger eine bestimmte Version anbieten können: https://codeberg.org/tpokorra/ncupdater

= Daten auf HDD Storage =
== Einrichtung des HDD Storage ==

Um den langsameren aber günstigeren HDD Storage von Hostsharing zu nutzen, kann das data Verzeichnis von SSD auf HDD Storage verschoben werden. Ein symbolischer Link reicht nicht aus, man muss den Pfad in der Nextcloud Konfigurationsdatei anpassen.

<syntaxhighlight lang=shell>
# Nextcloud in Wartungsmodus versetzen
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --on
# Daten auf HDD Storage verschieben
xyz00-cloud@h00:~/nextcloud$ mv data /home/storage/xyz00/users/cloud/
# symbolischen Link anlegen
xyz00-cloud@h00:~/nextcloud$ ln -s /home/storage/xyz00/users/cloud/data data
# Pfad in config.php ändern
nano config/config.php
# Die Zeile mit 'datadirectory' finden und entsprechend ändern:
# 'datadirectory' => '/home/storage/xyz00/users/cloud/data',
# Wartungsmodus beenden
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --off
</syntaxhighlight>

= Einschränkende Bemerkungen =
== Nextcloud Sync Client ==

Der Nextcloud Sync Client erfüllt eine Funktion ähnlich wie Dropbox, und synchronisiert ganze Ordnerstrukturen.

Gerade wenn man mit mehreren Menschen in einer Nextcloud arbeitet, ist diese Funktion mit Vorsicht zu benutzen.

* Änderungen an der Ordnerstruktur sollten nicht lokal, sondern im Webbrowser vorgenommen werden.
* Wenn die Gefahr besteht, dass mehrere Menschen gleichzeitig eine Datei bearbeiten, sollte die Datei nicht lokal, sondern im Webbrowser bearbeitet werden.
* Aus Sicht des Datenschutzes und der Daten-Minimierung sollte überlegt werden, ob die Daten wirklich auf jeden Laptop und Rechner synchronisiert werden sollen, oder ob es reicht, ausschließlich über den Webbrowser auf die Daten zuzugreifen.

= weiterführende Links =

* [https://docs.nextcloud.com/ Nextcloud Dokumentation]
* [https://apps.nextcloud.com/ Nextcloud Erweiterungen ("Apps")]
* [https://ownyourbits.com/2019/06/29/understanding-and-improving-nextcloud-previews/ Optimierung des Caches für Previews]
* [https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/nextcloud Ansible Playbook für Hostsharing]

= Nextcloud Reseller bei HS =

[https://nextcloud.ossaas.de OS SaaS]

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Ansible Playbook]]
[[Kategorie:Software]]
[[Kategorie:CalDAV]]

Nextcloud

2024-08-21T11:13:24Z

Hsh-milanihl: /* Installation */

= Nextcloud =

[https://nextcloud.com/ Nextcloud] ist eine PHP-basierte Open Source Lösung für gängige Cloud-Anwendungen, u.a.:

* Filesharing unter Nutzern derselben Nextcloud, und mit der Öffentlichkeit
* Single-Sign-On Authentifizierung (SSO)
* Videokonferenzen (WebRTC)
* Online-Office Anwendung [https://www.collaboraoffice.com/ Collabora Online]

Beispiel-Funktionalität, die über Plugins, sogenannte [https://apps.nextcloud.com/ "Apps"], bereit gestellt werden kann:

* Kalender, Aufgabenverwaltung, Adressbuch
* Datei-Kollaboration (Kommentare zu Dateien, Verschlagwortung)
* Feedreader
* E-Mail-Programm
* Fotogalerie
* Musik- und Videowiedergabe

= Nextcloud installieren =

== Vorbereitungen ==

In ''hsadmin'', zum Beispiel mit ''hsscript'':

''hsadmin''-Shell starten mit:

hsscript -u xyz00 -i
Password: ********

Dann nacheinander anlegen:

* Linux User als Domain-Administrator
* Subdomain ''cloud.example.org''
* PostgreSQL-User
* PostgreSQL Datenbank

<syntaxhighlight lang=shell>
xyz00@hsadmin> user.add({set:{name:'xyz00-cloud',password:'geheim',shell:'/bin/bash',comment:'Nextcloud'}})
xyz00@hsadmin> domain.add({set:{name:'cloud.example.org',user:'xyz00-cloud'}})
xyz00@hsadmin> postgresqluser.add({set:{name:'xyz00_nextclusr',password:'geheim'}})
xyz00@hsadmin> postgresqldb.add({set:{name:'xyz00_nextcloud',owner:'xyz00_nextclusr'}})
</syntaxhighlight>

== Nextcloud installieren ==

Anmelden als Linux-User ''xyz00-cloud'':

<syntaxhighlight lang=shell>
ssh -l xyz00-cloud xyz00.hostsharing.net
</syntaxhighlight>

''htdocs'' Verzeichnis vorbereiten

<syntaxhighlight lang=shell>
cd
mkdir nextcloud
cd doms/cloud.example.org
rm -rf subs/www subs-ssl/www htdocs-ssl
ln -s $HOME/nextcloud htdocs-ssl
</syntaxhighlight>

Nextcloud herunterladen und entpacken.

<syntaxhighlight lang=shell>
cd
wget https://download.nextcloud.com/server/releases/nextcloud-27.1.2.zip
unzip nextcloud-27.1.2.zip
rm nextcloud-27.1.2.zip
mkdir data tmp
chmod 700 data tmp
</syntaxhighlight>

== Nextcloud konfigurieren ==

Im Verzeichnis "$HOME/doms/cloud.example.org/fastcgi-ssl/" eine Datei "php.ini" anlegen mit folgendem Inhalt:

<syntaxhighlight lang=ini>
memory_limit=512M
session.save_path=/home/pacs/xyz00/users/cloud/tmp
</syntaxhighlight>

Dann mit einem Editor diese Datei bearbeiten: In der zweiten Zeile den korrekten Pfad des vorher angelegten tmp-Verzeichnisses eintragen.

Im Browser auf die Seite
http://cloud.example.org gehen und den Anweisungen folgen.

Auf der ersten Seite sind anzugeben:

* Login und Passwort für den Administrator definieren
* PostgreSQL als Datenbanksystem
* PostgreSQL-User und Passwort aus dem ersten Schritt oben
* Name der PostgreSQL-Datenbank aus dem ersten Schritt
* "localhost" als Datenbankserver (Nextcloud 23.0.2 empfiehlt hier die Angabe des Ports, diesen also lt. [[PostgreSQL]] angeben)
* Das Verzeichnis "/home/pacs/xyz00/users/cloud/data/" als Daten-Verzeichnis (bitte beachten: das im Eingabefeld voreingestellte verweist auf das Verzeichnis "/home/pacs/xyz00/users/cloud/'''nextcloud'''/data/")

'''Achtung!''' Die Felder für die Datenbank sind auf dem Startscreen hinter einem unscheinbaren Link versteckt. Um man das Formular für die Datenbank-Daten zu gelangen, muss man auf den Link klicken. Anschließend kann man die gewünschte Datenbank auswählen und die entsprechenden Daten eintragen. '''Das sollte geschehen, bevor man die Installation abschließt!''' Tut man dies nicht, wird Nextcloud mit SQLite installiert. Eine Änderung der Datenbank soll zwar laut Dokumentation auch später noch möglich sein, ging aber bei einem Test schief.

In der Konfigurationsdatei der Nextcloud (in ''~/nextcloud/config/config.php'') lassen sich weitere Voreinstellungen treffen:

<syntaxhighlight lang=php line>
'maintenance_window_start' => 1, // Wartungsfenster ab 1:00 Uhr
'defaultapp' => 'calendar,files', // bei Start wird der Kalender gezeigt
'default_phone_region' => 'DE', // Format Telefonnummern
'default_language' => 'de', // Sprache deutsch
'force_language' => 'de',
'default_locale' => 'de_DE', // Locale (Formatierung Zeitangaben etc.)
'force_locale' => 'de_DE',
</syntaxhighlight>

== Nextcloud beschleunigen ==

Dieser Teil ist optional.

Wenn regelmäßig '''im Browser''' mit Nextcloud gearbeitet werden soll, ist Nextcloud im Browser oft sehr langsam. Um dies zu verbessern, unterstützt Nextcloud die Anwendung von unterschiedlichen Cache-Verfahren (zum Beispiel Memcache, Redis).

=== Redis Cache ===

Redis ist auf den Hostsharing-Servern vorinstalliert und wird von den Nextcloud-Entwicklern empfohlen. '''In Verbindung mit einem Managed Webspace''' muss Redis als eigener Server '''Daemon''' angemeldet werden und ist '''kostenpflichtig'''. Siehe zu Kosten im Webspace Konfigurator unter: https://www.hostsharing.net/angebote/managed-webspace/ – '''1 individueller Serverdienst''' (Daemons).

Die Konfiguration des Redis-Dientes ist auf der Seite [[Redis]] beschrieben. Hier wird für Nextcloud die Variante mit einem Unixsocket benutzt.

In der Konfiguration der Nextcloud (in ''~/nextcloud/config/config.php'') wird der Redis-Cache wie folgt konfiguriert:

<syntaxhighlight lang=php line>
'memcache.local' => '\\OC\\Memcache\\Redis',
'memcache.distributed' => '\\OC\\Memcache\\Redis',
'memcache.locking' => '\\OC\\Memcache\\Redis',
'redis' =>
array (
'host' => '/home/pacs/xyz00/users/cloud/redis/var/redis-server.sock',
'port' => 0,
'password' => 'mein-redis-passwort',
'timeout' => 1.5,
),
</syntaxhighlight>

Um es perfekt zu machen, nutze ich ''logrotate'' um die Logdateien zu organisieren. Dazu die Konfiguration in ''~/.logrotate''

<syntaxhighlight lang=shell line>
compress
/home/pacs/xyz00/users/cloud/redis/var/redis.log {
rotate 5
daily
missingok
}
</syntaxhighlight>
Eine Crontab sorgt für den Start von Monit und das tägliche Rotieren der Logdateien:

<syntaxhighlight lang=shell line>
# m h dom mon dow command
HOME=/home/pacs/xyz00/users/cloud
PATH=/usr/local/bin:/usr/bin:/bin:/usr/local/games:/usr/games
MAILTO=webmaster@example.com
@reboot /usr/bin/monit -c $HOME/.monitrc
1 1 * * * /usr/sbin/logrotate -s $HOME/.logrotate.state $HOME/.logrotate
*/5 * * * * /usr/bin/php $HOME/nextcloud/cron.php
</syntaxhighlight>

Die letzte Zeile der ''crontab'' enthält den Cronjob für die regelmäßigen Hintergrundprozesse der Nextcloud. Durch die Erledigung dieser Aufgaben mit Cron lässt sich die Nextcloud ebenfalls etwas beschleunigen.

=== Nextcloud Push ===

Um Vorgänge wie Sync und Benachrichtigungen bei sehr großen Nextcloud Installationen zu beschleunigen, kann der <code>notify_push</code> Dienst hinzuinstalliert werden.

==== Abhängigkeiten und Einschränkungen ====
* <code>notify_push</code> muss Zugriff auf den gleichen Redis-Cache wie die Nextcloud haben
** aufgrund von eingeschränktem Passwort Support sollte ein Redis Socket mit sicheren Berechtigungseinstellungen als Alternative zum Redis Port mit Passwort konfiguriert werden.
* optimaler Weise holt sich <code>notify_push</code> benötigte informationen aus der <code>config.php</code> der bestehenden Nextcloud-Installation
* die bestehende <code>.htaccess</code> muss aus o.g. Gründen modifiziert werden, dies könnte bei Nextcloud-Updates verloren gehen(!)
* Bestimmte Portbereiche sind bei Hostsharing eingeschränkt, es empfiehlt sich, direkt beispielsweise Port <code>37867</code> zu nehmen. <strong>aus diesem Grund ist das automatische Setup durch das Plugin bei Hostsharing nicht möglich!</strong>

==== Installation ====
Siehe auch: https://github.com/nextcloud/notify_push#manual-setup

1. Installieren der Nextcloud-App <code>notify_push</code> – (nach Push suchen, "Client Push" wählen)<br>
2. falls noch nicht erstellt: <code>mkdir -p ~/.config/systemd/user</code><br>
3. mit Lieblingseditor die Datei <code>~/.config/systemd/user/notify_push.service</code> anlegen:<br>
<syntaxhighlight lang="ini" line>
[Unit]
Description = Push daemon for Nextcloud clients
Documentation = https://github.com/nextcloud/notify_push

[Service]
# Change if you already have something running on this port
Environment = PORT=37867
# We don't want to bind to 0.0.0.0, hence the --bind
ExecStart = /home/pacs/xyz00/users/cloud/bin/notify_push --bind 127.0.0.1 /home/pacs/xyz00/users/cloud/nextcloud/config/config.php
Type=notify

[Install]
WantedBy = default.target
</syntaxhighlight>
4. das Verzeichnis <code>~/bin</code> anlegen und die aktuellste binary herunterladen und ausführbar machen:
<syntaxhighlight lang="shell" line>release=`curl -L https://api.github.com/repos/nextcloud/notify_push/releases/latest -s | jq -r '.tag_name'` && wget --show-progress -qO ~/bin/notify_push https://github.com/nextcloud/notify_push/releases/download/$release/notify_push-x86_64-unknown-linux-musl && chmod +x ~/bin/notify_push</syntaxhighlight>
5. es könnte die folgende Umgebungsvariable zum Bedienen von systemd notwendig werden:<br><code>export XDG_RUNTIME_DIR=/run/user/$UID</code><br>
6. den neuen systemd-Dienst automatisch bei Systemstart, sowie jetzt sofort starten:<br><code>systemctl enable --now --user notify_push</code><br>
7. nun gehen wir in <code>doms/push.cloud.beispiel.de/htdocs-ssl/.htaccess</code> und ersetzen den Inhalt (bevorzugt), oder wir ergänzen die .htaccess der Nextcloud im unteren Teil um die folgenden Zeilen (letzteres kann bei Updates überschrieben werden!):
<syntaxhighlight lang="apache" line>
# bei eigener (sub)domain ist /push/ nicht erforderlich, aber wer weiß, eventuell ist das mit robuster
RewriteCond %{REQUEST_URI} ^/push/ws [NC,OR]
RewriteCond %{HTTP:UPGRADE} ^WebSocket$ [NC,OR]
RewriteCond %{HTTP:CONNECTION} ^Upgrade$ [NC]
RewriteRule .* ws://127.0.0.1:37867/ws [proxy]

RewriteCond %{REQUEST_URI} ^/push [NC]
RewriteRule .* http://127.0.0.1:37867%{REQUEST_URI} [proxy]
</syntaxhighlight>
8. abschließend im Nextcloud Ordner die Konfiguration des Plugins anstoßen: <code>php occ notify_push:setup https://cloud.example.com/push</code><br>
9. es ist möglich, das die erkannte IP-Adresse des Hives noch nicht vertraut ist. In diesem Fall wird der obige Befehl scheitern und es muss jene aus der Fehlermeldung des Setups unter <code>trusted_proxies</code> in der <code>config.php</code> ergänzt werden. <br><br>

Es wird im Repo außerdem ein Testclient bereitgestellt, der sich testweise mit dem Push-Dienst verbindet

== Nextcloud mit Online Office ==

In Nextcloud können Office-Dokumente (Textverarbeitung, Tabellen und Präsentationen) im Browser bearbeitet werden. Dazu steht bei Hostsharing die Collabora Developer Version zur Verfügung. Bestellung und Konfiguration sind hier im Wiki auf der Seite [[Collabora_Online]] beschrieben.

== Nextcloud mit Nextcloud Talk ==

Über die Nextcloud-App "Talk" können Videokonfererenzen mit Screensharing durchgeführt werden. Für die regelmäßige Nutzung kann es sinnvoll sein einen eigenen TURN Server zu betreiben. Siehe dazu [[Coturn_Installieren]]

== Virenscanner ==

Einige Nutzer wollen die Dateien in Ihrer Nextcloud regelmäßig auf Viren überprüfen. Auf unseren Servern steht dafür der OpenSource-Virenscanner "ClamAV" zur Verfügung. Wenn dieser Scanner benutzt wird, dann sollten die Einstellungen so gewählt sein, dass der ClamAV-Daemon über eine Socket Verbindung angesprochen wird. Die Einstellungen sind im Screenshot dokumentiert.

[[Datei:Nextcloud-ClamAV-Einstellungen.png||nextcloud einstellungen für die virenscanner-app]]

== Volltextsuche ==

Über die Dokumente einer Nextcloud kann ein Volltextindex erstellt werden. Die Volltextsuche ermöglicht über den Index eine Suche über beliebige Begriffe, die in Dokumenten vorkommen.

Voraussetzung ist der Betrieb eines Elasticsearch Servers. Der Betrieb im Managed Webspace erfodert die Buchung von zwei "Serverdiensten". Nutzer eines Managed Server müssen mit einem spürbaren Mehrbedarf an Hauptspeicher rechnen.

Zur Installation von Elasticsearch existiert eine eigene Wikiseite: [[Elasticsearch]].

In der Nextcloud sind folgende ''Apps'' zu installieren:
* Full Text Search
* Full Text Search - Elasticsearch Platform
* Full Text Search - Files

nach der Installation der drei Apps steht in den Einstellungen ein neuer Menüpunkt "Volltextsuche" zur Verfügung.

Hier ist einzustellen:
* Suchplattform: Elasticsearch
* Adresse des Servlets: http://elastic:das-erzeugt-passwort@127.0.0.1:39200
* Index: frei-gewaehlter-name-idx
* Analyzer tokenizer: standard

Die anderen Einstellung nach den eigenen Vorstellungen vornehmen.

Der initiale Aufbau des Suchindex erfolgt über ein "occ"-Kommando auf der Shell:

<syntaxhighlight lang=shell line>
cd nextcloud/
php occ fulltextsearch:index --output
</syntaxhighlight>

Wenn dieser Fehler kommt:
TypeError: Return value of OCA\Files_FullTextSearch\Model\MountPoint::isGlobal()
must be of the type bool, null returned in [...]/apps/files_fulltextsearch/lib/Model/MountPoint.php:103
sollte dieser Patch angewendet werden: https://github.com/nextcloud/files_fulltextsearch/issues/125#issuecomment-877789742

Zur Pflege des Indexes wird ein weiterer Hintergrundprozess gestartet:

<syntaxhighlight lang=shell line>
cd nextcloud/
php occ fulltextsearch:live -q
</syntaxhighlight>

Die Monit Konfiguration dafür sieht so aus:

<syntaxhighlight lang=shell line>
#~/bin/start-fulltextsearchlive
#
#!/bin/bash
export HOME=/home/pacs/xyz00/users/cloud
cd $HOME
mkdir -p $HOME/var
cd $HOME/nextcloud
exec php occ fulltextsearch:live -q &
echo $! >$HOME/var/fulltextsearchlive.pid
</syntaxhighlight>

<syntaxhighlight lang=shell line>
#~/bin/stop-fulltextsearchlive
#
#!/bin/bash
export HOME=/home/pacs/xyz00/users/cloud
kill $( cat $HOME/var/fulltextsearchlive.pid )
</syntaxhighlight>

~/.monitrc (siehe oben von der Redis Installation) entsprechend ergänzen:
<syntaxhighlight lang=shell line>
check process fulltextsearchlive with pidfile /home/pacs/xyz00/users/cloud/var/fulltextsearchlive.pid
start program "/home/pacs/xyz00/users/cloud/bin/start-fulltextsearchlive"
stop program "/home/pacs/xyz00/users/cloud/bin/stop-fulltextsearchlive"
</syntaxhighlight>
== Integration mit LDAP ==

Um einheitliche Benutzerzugänge für verschiedene Anwendungen zu ermöglichen, wird oft auf ein zentrales LDAP Verzeichnis gesetzt.

Dieses kann für Nextcloud eingesetzt werden, damit Benutzer nicht lokal in Nextcloud, sondern in LDAP verwaltet werden können.

Siehe auch https://docs.nextcloud.com/server/latest/admin_manual/configuration_user/user_auth_ldap.html

Dazu muss die App "LDAP user and group backend" in den Nextcloud Apps aktiviert werden.

Dann muss die LDAP Anbindung in den Administrationseinstellungen unter "LDAP/AD-Integration" eingerichtet werden.

Der Server mit Port, die BenutzerDN mit Passwort und die BaseDN müssen eingetragen werden.

Es muss auch bestimmt werden, welche Klasse (z.B. inetOrgPerson) die Benutzer brauchen, um Zugriff auf die Nextcloud zu erhalten.

Falls schon Benutzer in der Nextcloud existieren, und diese zu LDAP mitgenommen werden sollen, kann der Anleitung aus diesem Forum Eintrag gefolgt werden: https://help.nextcloud.com/t/migration-to-ldap-keeping-users-and-data/13205

* Voraussetzung ist, dass der Benutzernamen der zu übernehmenden Benutzer in Nextcloud der uid in LDAP entspricht.
* Es wird ein Administrator Benutzer benötigt, der lokal angelegt wurde, und auch lokal bleibt.
* Mit diesem Administrator Benutzer wird die LDAP Anbindung eingerichtet.
* In der Experten Ansicht von LDAP/AD muss bei "Attribut für interne Benutzernamen" eingetragen werden: uid
* Klicke den Schalter "LDAP Benutzernamenzuordnung löschen"
* Klicke den Schalter "LDAP Gruppennamenzuordnung löschen"
* dann in der MySQL Datenbank anmelden, und aus uc_users alle Benutzer bis auf den Administrator Benutzer löschen
* Dann in der Nextcloud Weboberfläche sich alle Benutzer anzeigen lassen
* Nun gelingt die Anmeldung mit den anderen Benutzern mit dem LDAP Passwort, und die Dateien wurden übernommen.

== Optimierung der Geschwindigkeit ==
Manchmal fühlt sich die Nextcloud träge an.

Folgende Änderungen können helfen:

* HTTP/2.0 aktivieren: dem Service von Hostsharing Bescheid geben
* Die App Dashboard deaktivieren, und dafür werden direkt die Dateien angezeigt
* Einblenden der README in den Ordnern abschalten: das kann pro Ordner in der UI geschehen (links unten), oder global: <code>occ config:app:set text workspace_available --value=0</code>. Siehe auch [https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/text_configuration.html#disable-rich-workspaces-globally]

== Default App einstellen ==

In der Datei config.php können wir einstellen, welche App direkt nach der Anmeldung gezeigt wird.

Das ist entweder die Dashboard App, wenn sie aktiviert ist, oder die Dateien App (files).

Falls der Kalender direkt angezeigt werden soll, muss folgende Zeile in der config.php hinzugefügt werden (siehe auch [https://docs.nextcloud.com/server/stable/admin_manual/configuration_server/config_sample_php_parameters.html#defaultapp]):

<syntaxhighlight lang=shell>
'defaultapp' => 'calendar',
</syntaxhighlight>

= Nextcloud Updates =

== Updater über die Shell starten ==

Wenn die NextCloud sich nicht über das Webfrontend updaten lässt, kann der Updater auch per Shell im directory /updater durch ausführen des updater.phar gestartet werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud/updater
xyz00-cloud@h00:~/nextcloud/updater$ chmod u+x updater.phar
xyz00-cloud@h00:~/nextcloud/updater$ ./updater.phar
</syntaxhighlight>

Es sollten außerdem ein paar Routine-Aufräumarbeiten durchgeführt werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-primary-keys --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-columns --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-indices --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:convert-filecache-bigint --no-interaction
</syntaxhighlight>

So können die Apps noch alle aktualisiert werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ app:update --all -n --no-ansi
</syntaxhighlight>

Für weitere Informationen kann auf die offizielle Doku ab Ziffer 2. zurückgegriffen werden.

* [https://docs.nextcloud.com/server/latest/admin_manual/maintenance/update.html#using-the-command-line-based-updater https://docs.nextcloud.com]

Hier gibt es ein kurzes Video, das die Anmeldung über die Kommandozeile mit Putty erklärt und die Aktualisierung von Nextcloud auf der Kommandozeile:

* [https://tube.solidcharity.net/w/0cf5ee97-ba7c-41df-a56f-8d1fea842ab0 Nextcloud auf der Kommandozeile aktualisieren]

== Wartungsmodus per Shell ein- oder ausschalten ==

So kann der Wartungsmodus angeschaltet werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --on
</syntaxhighlight>

So kann der Wartungsmodus wieder ausgeschaltet werden, d.h. die Nextcloud ist dann wieder in Betrieb:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --off
</syntaxhighlight>

== Webfrontend-Updater Probleme / Lösungen ==

=== Datenbank: Indizes | Primärschlüssel | Konvertierungen ===

Aufgetreten nach erfolgtem Versionsupdate Nextcloud 19 auf Nextcloud 20

Nach dem erfolgten Update lädt automatisch die Seite: '''Sicherheits- und Einrichtungswarnungen''' auf dieser wird angemerkt, dass manuelle Schritte für die Datenbank durchzuführen sind. Dies betrifft Indizes, Primärschlüssel und Konvertierungen.

Per Shell in der directory /nextcloud folgende Kommandos ausführen:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-primary-keys --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-columns --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-indices --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:convert-filecache-bigint --no-interaction
</syntaxhighlight>

Wichtig ist hier dem durch Nextcloud angegebenen Kommando ein '''php''' voranzustellen.

== Update per Skript ==

Es ist möglich die regelmäßigen Updates weitgehend zu automatisieren. Ein Skript wäre etwa:

<syntaxhighlight lang=shell line>
#!/bin/bash
if [ -f $HOME/nextcloud/occ ]; then
echo "Nextcloud Update";
cd $HOME/nextcloud;
php updater/updater.phar -vv --no-backup --no-interaction
php occ maintenance:mode --on
php occ db:add-missing-primary-keys --no-interaction
php occ db:add-missing-columns --no-interaction
php occ db:add-missing-indices --no-interaction
php occ db:convert-filecache-bigint --no-interaction
php occ app:update --all
php occ maintenance:mode --off
else
echo "Keine Nextcloud Installation gefunden";
fi
</syntaxhighlight>

== Update: bei old-stable Version bleiben ==

Normalerweise fragt jede Nextcloud Instanz zentral ab, welches Update zur Verfügung steht, abhängig vom Release Channel. Dabei wird aber relativ schnell auf die nächste Version gewechselt, also z.B. von Nextcloud 28 auf Nextcloud 29, obwohl Nextcloud 28 noch mehrere Monate gepflegt wird, und manche Apps noch nicht bereit sind für Nextcloud 29.

Es kann aber auch eine Alternative eingerichtet werden, in der Datei nextcloud/config/config.php, unter dem Eintrag updater.server.url

Hier wird z.B. auf einen Updater von unserem Mitglied Timotheus Pokorra verwiesen:

<syntaxhighlight lang=php line>
updater_server_url: "https://ncupdater.solidcharity.com"
</syntaxhighlight>

Dahinter läuft ein Skript, mit dem wir noch länger eine bestimmte Version anbieten können: https://codeberg.org/tpokorra/ncupdater

= Daten auf HDD Storage =
== Einrichtung des HDD Storage ==

Um den langsameren aber günstigeren HDD Storage von Hostsharing zu nutzen, kann das data Verzeichnis von SSD auf HDD Storage verschoben werden. Ein symbolischer Link reicht nicht aus, man muss den Pfad in der Nextcloud Konfigurationsdatei anpassen.

<syntaxhighlight lang=shell>
# Nextcloud in Wartungsmodus versetzen
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --on
# Daten auf HDD Storage verschieben
xyz00-cloud@h00:~/nextcloud$ mv data /home/storage/xyz00/users/cloud/
# symbolischen Link anlegen
xyz00-cloud@h00:~/nextcloud$ ln -s /home/storage/xyz00/users/cloud/data data
# Pfad in config.php ändern
nano config/config.php
# Die Zeile mit 'datadirectory' finden und entsprechend ändern:
# 'datadirectory' => '/home/storage/xyz00/users/cloud/data',
# Wartungsmodus beenden
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --off
</syntaxhighlight>

= Einschränkende Bemerkungen =
== Nextcloud Sync Client ==

Der Nextcloud Sync Client erfüllt eine Funktion ähnlich wie Dropbox, und synchronisiert ganze Ordnerstrukturen.

Gerade wenn man mit mehreren Menschen in einer Nextcloud arbeitet, ist diese Funktion mit Vorsicht zu benutzen.

* Änderungen an der Ordnerstruktur sollten nicht lokal, sondern im Webbrowser vorgenommen werden.
* Wenn die Gefahr besteht, dass mehrere Menschen gleichzeitig eine Datei bearbeiten, sollte die Datei nicht lokal, sondern im Webbrowser bearbeitet werden.
* Aus Sicht des Datenschutzes und der Daten-Minimierung sollte überlegt werden, ob die Daten wirklich auf jeden Laptop und Rechner synchronisiert werden sollen, oder ob es reicht, ausschließlich über den Webbrowser auf die Daten zuzugreifen.

= weiterführende Links =

* [https://docs.nextcloud.com/ Nextcloud Dokumentation]
* [https://apps.nextcloud.com/ Nextcloud Erweiterungen ("Apps")]
* [https://ownyourbits.com/2019/06/29/understanding-and-improving-nextcloud-previews/ Optimierung des Caches für Previews]
* [https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/nextcloud Ansible Playbook für Hostsharing]

= Nextcloud Reseller bei HS =

[https://nextcloud.ossaas.de OS SaaS]

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Ansible Playbook]]
[[Kategorie:Software]]
[[Kategorie:CalDAV]]

Nextcloud

2024-08-21T11:12:23Z

Hsh-milanihl: /* Installation */

= Nextcloud =

[https://nextcloud.com/ Nextcloud] ist eine PHP-basierte Open Source Lösung für gängige Cloud-Anwendungen, u.a.:

* Filesharing unter Nutzern derselben Nextcloud, und mit der Öffentlichkeit
* Single-Sign-On Authentifizierung (SSO)
* Videokonferenzen (WebRTC)
* Online-Office Anwendung [https://www.collaboraoffice.com/ Collabora Online]

Beispiel-Funktionalität, die über Plugins, sogenannte [https://apps.nextcloud.com/ "Apps"], bereit gestellt werden kann:

* Kalender, Aufgabenverwaltung, Adressbuch
* Datei-Kollaboration (Kommentare zu Dateien, Verschlagwortung)
* Feedreader
* E-Mail-Programm
* Fotogalerie
* Musik- und Videowiedergabe

= Nextcloud installieren =

== Vorbereitungen ==

In ''hsadmin'', zum Beispiel mit ''hsscript'':

''hsadmin''-Shell starten mit:

hsscript -u xyz00 -i
Password: ********

Dann nacheinander anlegen:

* Linux User als Domain-Administrator
* Subdomain ''cloud.example.org''
* PostgreSQL-User
* PostgreSQL Datenbank

<syntaxhighlight lang=shell>
xyz00@hsadmin> user.add({set:{name:'xyz00-cloud',password:'geheim',shell:'/bin/bash',comment:'Nextcloud'}})
xyz00@hsadmin> domain.add({set:{name:'cloud.example.org',user:'xyz00-cloud'}})
xyz00@hsadmin> postgresqluser.add({set:{name:'xyz00_nextclusr',password:'geheim'}})
xyz00@hsadmin> postgresqldb.add({set:{name:'xyz00_nextcloud',owner:'xyz00_nextclusr'}})
</syntaxhighlight>

== Nextcloud installieren ==

Anmelden als Linux-User ''xyz00-cloud'':

<syntaxhighlight lang=shell>
ssh -l xyz00-cloud xyz00.hostsharing.net
</syntaxhighlight>

''htdocs'' Verzeichnis vorbereiten

<syntaxhighlight lang=shell>
cd
mkdir nextcloud
cd doms/cloud.example.org
rm -rf subs/www subs-ssl/www htdocs-ssl
ln -s $HOME/nextcloud htdocs-ssl
</syntaxhighlight>

Nextcloud herunterladen und entpacken.

<syntaxhighlight lang=shell>
cd
wget https://download.nextcloud.com/server/releases/nextcloud-27.1.2.zip
unzip nextcloud-27.1.2.zip
rm nextcloud-27.1.2.zip
mkdir data tmp
chmod 700 data tmp
</syntaxhighlight>

== Nextcloud konfigurieren ==

Im Verzeichnis "$HOME/doms/cloud.example.org/fastcgi-ssl/" eine Datei "php.ini" anlegen mit folgendem Inhalt:

<syntaxhighlight lang=ini>
memory_limit=512M
session.save_path=/home/pacs/xyz00/users/cloud/tmp
</syntaxhighlight>

Dann mit einem Editor diese Datei bearbeiten: In der zweiten Zeile den korrekten Pfad des vorher angelegten tmp-Verzeichnisses eintragen.

Im Browser auf die Seite
http://cloud.example.org gehen und den Anweisungen folgen.

Auf der ersten Seite sind anzugeben:

* Login und Passwort für den Administrator definieren
* PostgreSQL als Datenbanksystem
* PostgreSQL-User und Passwort aus dem ersten Schritt oben
* Name der PostgreSQL-Datenbank aus dem ersten Schritt
* "localhost" als Datenbankserver (Nextcloud 23.0.2 empfiehlt hier die Angabe des Ports, diesen also lt. [[PostgreSQL]] angeben)
* Das Verzeichnis "/home/pacs/xyz00/users/cloud/data/" als Daten-Verzeichnis (bitte beachten: das im Eingabefeld voreingestellte verweist auf das Verzeichnis "/home/pacs/xyz00/users/cloud/'''nextcloud'''/data/")

'''Achtung!''' Die Felder für die Datenbank sind auf dem Startscreen hinter einem unscheinbaren Link versteckt. Um man das Formular für die Datenbank-Daten zu gelangen, muss man auf den Link klicken. Anschließend kann man die gewünschte Datenbank auswählen und die entsprechenden Daten eintragen. '''Das sollte geschehen, bevor man die Installation abschließt!''' Tut man dies nicht, wird Nextcloud mit SQLite installiert. Eine Änderung der Datenbank soll zwar laut Dokumentation auch später noch möglich sein, ging aber bei einem Test schief.

In der Konfigurationsdatei der Nextcloud (in ''~/nextcloud/config/config.php'') lassen sich weitere Voreinstellungen treffen:

<syntaxhighlight lang=php line>
'maintenance_window_start' => 1, // Wartungsfenster ab 1:00 Uhr
'defaultapp' => 'calendar,files', // bei Start wird der Kalender gezeigt
'default_phone_region' => 'DE', // Format Telefonnummern
'default_language' => 'de', // Sprache deutsch
'force_language' => 'de',
'default_locale' => 'de_DE', // Locale (Formatierung Zeitangaben etc.)
'force_locale' => 'de_DE',
</syntaxhighlight>

== Nextcloud beschleunigen ==

Dieser Teil ist optional.

Wenn regelmäßig '''im Browser''' mit Nextcloud gearbeitet werden soll, ist Nextcloud im Browser oft sehr langsam. Um dies zu verbessern, unterstützt Nextcloud die Anwendung von unterschiedlichen Cache-Verfahren (zum Beispiel Memcache, Redis).

=== Redis Cache ===

Redis ist auf den Hostsharing-Servern vorinstalliert und wird von den Nextcloud-Entwicklern empfohlen. '''In Verbindung mit einem Managed Webspace''' muss Redis als eigener Server '''Daemon''' angemeldet werden und ist '''kostenpflichtig'''. Siehe zu Kosten im Webspace Konfigurator unter: https://www.hostsharing.net/angebote/managed-webspace/ – '''1 individueller Serverdienst''' (Daemons).

Die Konfiguration des Redis-Dientes ist auf der Seite [[Redis]] beschrieben. Hier wird für Nextcloud die Variante mit einem Unixsocket benutzt.

In der Konfiguration der Nextcloud (in ''~/nextcloud/config/config.php'') wird der Redis-Cache wie folgt konfiguriert:

<syntaxhighlight lang=php line>
'memcache.local' => '\\OC\\Memcache\\Redis',
'memcache.distributed' => '\\OC\\Memcache\\Redis',
'memcache.locking' => '\\OC\\Memcache\\Redis',
'redis' =>
array (
'host' => '/home/pacs/xyz00/users/cloud/redis/var/redis-server.sock',
'port' => 0,
'password' => 'mein-redis-passwort',
'timeout' => 1.5,
),
</syntaxhighlight>

Um es perfekt zu machen, nutze ich ''logrotate'' um die Logdateien zu organisieren. Dazu die Konfiguration in ''~/.logrotate''

<syntaxhighlight lang=shell line>
compress
/home/pacs/xyz00/users/cloud/redis/var/redis.log {
rotate 5
daily
missingok
}
</syntaxhighlight>
Eine Crontab sorgt für den Start von Monit und das tägliche Rotieren der Logdateien:

<syntaxhighlight lang=shell line>
# m h dom mon dow command
HOME=/home/pacs/xyz00/users/cloud
PATH=/usr/local/bin:/usr/bin:/bin:/usr/local/games:/usr/games
MAILTO=webmaster@example.com
@reboot /usr/bin/monit -c $HOME/.monitrc
1 1 * * * /usr/sbin/logrotate -s $HOME/.logrotate.state $HOME/.logrotate
*/5 * * * * /usr/bin/php $HOME/nextcloud/cron.php
</syntaxhighlight>

Die letzte Zeile der ''crontab'' enthält den Cronjob für die regelmäßigen Hintergrundprozesse der Nextcloud. Durch die Erledigung dieser Aufgaben mit Cron lässt sich die Nextcloud ebenfalls etwas beschleunigen.

=== Nextcloud Push ===

Um Vorgänge wie Sync und Benachrichtigungen bei sehr großen Nextcloud Installationen zu beschleunigen, kann der <code>notify_push</code> Dienst hinzuinstalliert werden.

==== Abhängigkeiten und Einschränkungen ====
* <code>notify_push</code> muss Zugriff auf den gleichen Redis-Cache wie die Nextcloud haben
** aufgrund von eingeschränktem Passwort Support sollte ein Redis Socket mit sicheren Berechtigungseinstellungen als Alternative zum Redis Port mit Passwort konfiguriert werden.
* optimaler Weise holt sich <code>notify_push</code> benötigte informationen aus der <code>config.php</code> der bestehenden Nextcloud-Installation
* die bestehende <code>.htaccess</code> muss aus o.g. Gründen modifiziert werden, dies könnte bei Nextcloud-Updates verloren gehen(!)
* Bestimmte Portbereiche sind bei Hostsharing eingeschränkt, es empfiehlt sich, direkt beispielsweise Port <code>37867</code> zu nehmen. <strong>aus diesem Grund ist das automatische Setup durch das Plugin bei Hostsharing nicht möglich!</strong>

==== Installation ====
Siehe auch: https://github.com/nextcloud/notify_push#manual-setup

1. Installieren der Nextcloud-App <code>notify_push</code> – (nach Push suchen, "Client Push" wählen)<br>
2. falls noch nicht erstellt: <code>mkdir -p ~/.config/systemd/user</code><br>
3. mit Lieblingseditor die Datei <code>~/.config/systemd/user/notify_push.service</code> anlegen:<br>
<syntaxhighlight lang="ini" line>
[Unit]
Description = Push daemon for Nextcloud clients
Documentation = https://github.com/nextcloud/notify_push

[Service]
# Change if you already have something running on this port
Environment = PORT=37867
# We don't want to bind to 0.0.0.0, hence the --bind
ExecStart = /home/pacs/xyz00/users/cloud/bin/notify_push --bind 127.0.0.1 /home/pacs/xyz00/users/cloud/nextcloud/config/config.php
Type=notify

[Install]
WantedBy = default.target
</syntaxhighlight>
4. das Verzeichnis <code>~/bin</code> anlegen und die aktuellste binary herunterladen und ausführbar machen:
<syntaxhighlight lang="shell" line>release=`curl -L https://api.github.com/repos/nextcloud/notify_push/releases/latest -s | jq -r '.tag_name'` && wget --show-progress -qO ~/bin/notify_push https://github.com/nextcloud/notify_push/releases/download/$release/notify_push-x86_64-unknown-linux-musl && chmod +x ~/bin/notify_push</syntaxhighlight>
5. es könnte die folgende Umgebungsvariable zum Bedienen von systemd notwendig werden:<br><code>export XDG_RUNTIME_DIR=/run/user/$UID</code><br>
6. den neuen systemd-Dienst automatisch bei Systemstart, sowie jetzt sofort starten:<br><code>systemctl enable --now --user notify_push</code><br>
7. nun gehen wir in <code>doms/push.cloud.beispiel.de/htdocs-ssl/.htaccess</code> und ersetzen den Inhalt (bevorzugt), oder wir ergänzen die .htaccess der Nextcloud im unteren Teil um die folgenden Zeilen:
<syntaxhighlight lang="apache" line>
# bei eigener (sub)domain ist /push/ nicht erforderlich, aber wer weiß, eventuell ist das mit robuster
RewriteCond %{REQUEST_URI} ^/push/ws [NC,OR]
RewriteCond %{HTTP:UPGRADE} ^WebSocket$ [NC,OR]
RewriteCond %{HTTP:CONNECTION} ^Upgrade$ [NC]
RewriteRule .* ws://127.0.0.1:37867/ws [proxy]

RewriteCond %{REQUEST_URI} ^/push [NC]
RewriteRule .* http://127.0.0.1:37867%{REQUEST_URI} [proxy]
</syntaxhighlight>
8. abschließend im Nextcloud Ordner die Konfiguration des Plugins anstoßen: <code>php occ notify_push:setup https://cloud.example.com/push</code><br>
9. es ist möglich, das die erkannte IP-Adresse des Hives noch nicht vertraut ist. In diesem Fall wird der obige Befehl scheitern und es muss jene aus der Fehlermeldung des Setups unter <code>trusted_proxies</code> in der <code>config.php</code> ergänzt werden. <br><br>

Es wird im Repo außerdem ein Testclient bereitgestellt, der sich testweise mit dem Push-Dienst verbindet

== Nextcloud mit Online Office ==

In Nextcloud können Office-Dokumente (Textverarbeitung, Tabellen und Präsentationen) im Browser bearbeitet werden. Dazu steht bei Hostsharing die Collabora Developer Version zur Verfügung. Bestellung und Konfiguration sind hier im Wiki auf der Seite [[Collabora_Online]] beschrieben.

== Nextcloud mit Nextcloud Talk ==

Über die Nextcloud-App "Talk" können Videokonfererenzen mit Screensharing durchgeführt werden. Für die regelmäßige Nutzung kann es sinnvoll sein einen eigenen TURN Server zu betreiben. Siehe dazu [[Coturn_Installieren]]

== Virenscanner ==

Einige Nutzer wollen die Dateien in Ihrer Nextcloud regelmäßig auf Viren überprüfen. Auf unseren Servern steht dafür der OpenSource-Virenscanner "ClamAV" zur Verfügung. Wenn dieser Scanner benutzt wird, dann sollten die Einstellungen so gewählt sein, dass der ClamAV-Daemon über eine Socket Verbindung angesprochen wird. Die Einstellungen sind im Screenshot dokumentiert.

[[Datei:Nextcloud-ClamAV-Einstellungen.png||nextcloud einstellungen für die virenscanner-app]]

== Volltextsuche ==

Über die Dokumente einer Nextcloud kann ein Volltextindex erstellt werden. Die Volltextsuche ermöglicht über den Index eine Suche über beliebige Begriffe, die in Dokumenten vorkommen.

Voraussetzung ist der Betrieb eines Elasticsearch Servers. Der Betrieb im Managed Webspace erfodert die Buchung von zwei "Serverdiensten". Nutzer eines Managed Server müssen mit einem spürbaren Mehrbedarf an Hauptspeicher rechnen.

Zur Installation von Elasticsearch existiert eine eigene Wikiseite: [[Elasticsearch]].

In der Nextcloud sind folgende ''Apps'' zu installieren:
* Full Text Search
* Full Text Search - Elasticsearch Platform
* Full Text Search - Files

nach der Installation der drei Apps steht in den Einstellungen ein neuer Menüpunkt "Volltextsuche" zur Verfügung.

Hier ist einzustellen:
* Suchplattform: Elasticsearch
* Adresse des Servlets: http://elastic:das-erzeugt-passwort@127.0.0.1:39200
* Index: frei-gewaehlter-name-idx
* Analyzer tokenizer: standard

Die anderen Einstellung nach den eigenen Vorstellungen vornehmen.

Der initiale Aufbau des Suchindex erfolgt über ein "occ"-Kommando auf der Shell:

<syntaxhighlight lang=shell line>
cd nextcloud/
php occ fulltextsearch:index --output
</syntaxhighlight>

Wenn dieser Fehler kommt:
TypeError: Return value of OCA\Files_FullTextSearch\Model\MountPoint::isGlobal()
must be of the type bool, null returned in [...]/apps/files_fulltextsearch/lib/Model/MountPoint.php:103
sollte dieser Patch angewendet werden: https://github.com/nextcloud/files_fulltextsearch/issues/125#issuecomment-877789742

Zur Pflege des Indexes wird ein weiterer Hintergrundprozess gestartet:

<syntaxhighlight lang=shell line>
cd nextcloud/
php occ fulltextsearch:live -q
</syntaxhighlight>

Die Monit Konfiguration dafür sieht so aus:

<syntaxhighlight lang=shell line>
#~/bin/start-fulltextsearchlive
#
#!/bin/bash
export HOME=/home/pacs/xyz00/users/cloud
cd $HOME
mkdir -p $HOME/var
cd $HOME/nextcloud
exec php occ fulltextsearch:live -q &
echo $! >$HOME/var/fulltextsearchlive.pid
</syntaxhighlight>

<syntaxhighlight lang=shell line>
#~/bin/stop-fulltextsearchlive
#
#!/bin/bash
export HOME=/home/pacs/xyz00/users/cloud
kill $( cat $HOME/var/fulltextsearchlive.pid )
</syntaxhighlight>

~/.monitrc (siehe oben von der Redis Installation) entsprechend ergänzen:
<syntaxhighlight lang=shell line>
check process fulltextsearchlive with pidfile /home/pacs/xyz00/users/cloud/var/fulltextsearchlive.pid
start program "/home/pacs/xyz00/users/cloud/bin/start-fulltextsearchlive"
stop program "/home/pacs/xyz00/users/cloud/bin/stop-fulltextsearchlive"
</syntaxhighlight>
== Integration mit LDAP ==

Um einheitliche Benutzerzugänge für verschiedene Anwendungen zu ermöglichen, wird oft auf ein zentrales LDAP Verzeichnis gesetzt.

Dieses kann für Nextcloud eingesetzt werden, damit Benutzer nicht lokal in Nextcloud, sondern in LDAP verwaltet werden können.

Siehe auch https://docs.nextcloud.com/server/latest/admin_manual/configuration_user/user_auth_ldap.html

Dazu muss die App "LDAP user and group backend" in den Nextcloud Apps aktiviert werden.

Dann muss die LDAP Anbindung in den Administrationseinstellungen unter "LDAP/AD-Integration" eingerichtet werden.

Der Server mit Port, die BenutzerDN mit Passwort und die BaseDN müssen eingetragen werden.

Es muss auch bestimmt werden, welche Klasse (z.B. inetOrgPerson) die Benutzer brauchen, um Zugriff auf die Nextcloud zu erhalten.

Falls schon Benutzer in der Nextcloud existieren, und diese zu LDAP mitgenommen werden sollen, kann der Anleitung aus diesem Forum Eintrag gefolgt werden: https://help.nextcloud.com/t/migration-to-ldap-keeping-users-and-data/13205

* Voraussetzung ist, dass der Benutzernamen der zu übernehmenden Benutzer in Nextcloud der uid in LDAP entspricht.
* Es wird ein Administrator Benutzer benötigt, der lokal angelegt wurde, und auch lokal bleibt.
* Mit diesem Administrator Benutzer wird die LDAP Anbindung eingerichtet.
* In der Experten Ansicht von LDAP/AD muss bei "Attribut für interne Benutzernamen" eingetragen werden: uid
* Klicke den Schalter "LDAP Benutzernamenzuordnung löschen"
* Klicke den Schalter "LDAP Gruppennamenzuordnung löschen"
* dann in der MySQL Datenbank anmelden, und aus uc_users alle Benutzer bis auf den Administrator Benutzer löschen
* Dann in der Nextcloud Weboberfläche sich alle Benutzer anzeigen lassen
* Nun gelingt die Anmeldung mit den anderen Benutzern mit dem LDAP Passwort, und die Dateien wurden übernommen.

== Optimierung der Geschwindigkeit ==
Manchmal fühlt sich die Nextcloud träge an.

Folgende Änderungen können helfen:

* HTTP/2.0 aktivieren: dem Service von Hostsharing Bescheid geben
* Die App Dashboard deaktivieren, und dafür werden direkt die Dateien angezeigt
* Einblenden der README in den Ordnern abschalten: das kann pro Ordner in der UI geschehen (links unten), oder global: <code>occ config:app:set text workspace_available --value=0</code>. Siehe auch [https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/text_configuration.html#disable-rich-workspaces-globally]

== Default App einstellen ==

In der Datei config.php können wir einstellen, welche App direkt nach der Anmeldung gezeigt wird.

Das ist entweder die Dashboard App, wenn sie aktiviert ist, oder die Dateien App (files).

Falls der Kalender direkt angezeigt werden soll, muss folgende Zeile in der config.php hinzugefügt werden (siehe auch [https://docs.nextcloud.com/server/stable/admin_manual/configuration_server/config_sample_php_parameters.html#defaultapp]):

<syntaxhighlight lang=shell>
'defaultapp' => 'calendar',
</syntaxhighlight>

= Nextcloud Updates =

== Updater über die Shell starten ==

Wenn die NextCloud sich nicht über das Webfrontend updaten lässt, kann der Updater auch per Shell im directory /updater durch ausführen des updater.phar gestartet werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud/updater
xyz00-cloud@h00:~/nextcloud/updater$ chmod u+x updater.phar
xyz00-cloud@h00:~/nextcloud/updater$ ./updater.phar
</syntaxhighlight>

Es sollten außerdem ein paar Routine-Aufräumarbeiten durchgeführt werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-primary-keys --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-columns --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-indices --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:convert-filecache-bigint --no-interaction
</syntaxhighlight>

So können die Apps noch alle aktualisiert werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ app:update --all -n --no-ansi
</syntaxhighlight>

Für weitere Informationen kann auf die offizielle Doku ab Ziffer 2. zurückgegriffen werden.

* [https://docs.nextcloud.com/server/latest/admin_manual/maintenance/update.html#using-the-command-line-based-updater https://docs.nextcloud.com]

Hier gibt es ein kurzes Video, das die Anmeldung über die Kommandozeile mit Putty erklärt und die Aktualisierung von Nextcloud auf der Kommandozeile:

* [https://tube.solidcharity.net/w/0cf5ee97-ba7c-41df-a56f-8d1fea842ab0 Nextcloud auf der Kommandozeile aktualisieren]

== Wartungsmodus per Shell ein- oder ausschalten ==

So kann der Wartungsmodus angeschaltet werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --on
</syntaxhighlight>

So kann der Wartungsmodus wieder ausgeschaltet werden, d.h. die Nextcloud ist dann wieder in Betrieb:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --off
</syntaxhighlight>

== Webfrontend-Updater Probleme / Lösungen ==

=== Datenbank: Indizes | Primärschlüssel | Konvertierungen ===

Aufgetreten nach erfolgtem Versionsupdate Nextcloud 19 auf Nextcloud 20

Nach dem erfolgten Update lädt automatisch die Seite: '''Sicherheits- und Einrichtungswarnungen''' auf dieser wird angemerkt, dass manuelle Schritte für die Datenbank durchzuführen sind. Dies betrifft Indizes, Primärschlüssel und Konvertierungen.

Per Shell in der directory /nextcloud folgende Kommandos ausführen:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-primary-keys --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-columns --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-indices --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:convert-filecache-bigint --no-interaction
</syntaxhighlight>

Wichtig ist hier dem durch Nextcloud angegebenen Kommando ein '''php''' voranzustellen.

== Update per Skript ==

Es ist möglich die regelmäßigen Updates weitgehend zu automatisieren. Ein Skript wäre etwa:

<syntaxhighlight lang=shell line>
#!/bin/bash
if [ -f $HOME/nextcloud/occ ]; then
echo "Nextcloud Update";
cd $HOME/nextcloud;
php updater/updater.phar -vv --no-backup --no-interaction
php occ maintenance:mode --on
php occ db:add-missing-primary-keys --no-interaction
php occ db:add-missing-columns --no-interaction
php occ db:add-missing-indices --no-interaction
php occ db:convert-filecache-bigint --no-interaction
php occ app:update --all
php occ maintenance:mode --off
else
echo "Keine Nextcloud Installation gefunden";
fi
</syntaxhighlight>

== Update: bei old-stable Version bleiben ==

Normalerweise fragt jede Nextcloud Instanz zentral ab, welches Update zur Verfügung steht, abhängig vom Release Channel. Dabei wird aber relativ schnell auf die nächste Version gewechselt, also z.B. von Nextcloud 28 auf Nextcloud 29, obwohl Nextcloud 28 noch mehrere Monate gepflegt wird, und manche Apps noch nicht bereit sind für Nextcloud 29.

Es kann aber auch eine Alternative eingerichtet werden, in der Datei nextcloud/config/config.php, unter dem Eintrag updater.server.url

Hier wird z.B. auf einen Updater von unserem Mitglied Timotheus Pokorra verwiesen:

<syntaxhighlight lang=php line>
updater_server_url: "https://ncupdater.solidcharity.com"
</syntaxhighlight>

Dahinter läuft ein Skript, mit dem wir noch länger eine bestimmte Version anbieten können: https://codeberg.org/tpokorra/ncupdater

= Daten auf HDD Storage =
== Einrichtung des HDD Storage ==

Um den langsameren aber günstigeren HDD Storage von Hostsharing zu nutzen, kann das data Verzeichnis von SSD auf HDD Storage verschoben werden. Ein symbolischer Link reicht nicht aus, man muss den Pfad in der Nextcloud Konfigurationsdatei anpassen.

<syntaxhighlight lang=shell>
# Nextcloud in Wartungsmodus versetzen
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --on
# Daten auf HDD Storage verschieben
xyz00-cloud@h00:~/nextcloud$ mv data /home/storage/xyz00/users/cloud/
# symbolischen Link anlegen
xyz00-cloud@h00:~/nextcloud$ ln -s /home/storage/xyz00/users/cloud/data data
# Pfad in config.php ändern
nano config/config.php
# Die Zeile mit 'datadirectory' finden und entsprechend ändern:
# 'datadirectory' => '/home/storage/xyz00/users/cloud/data',
# Wartungsmodus beenden
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --off
</syntaxhighlight>

= Einschränkende Bemerkungen =
== Nextcloud Sync Client ==

Der Nextcloud Sync Client erfüllt eine Funktion ähnlich wie Dropbox, und synchronisiert ganze Ordnerstrukturen.

Gerade wenn man mit mehreren Menschen in einer Nextcloud arbeitet, ist diese Funktion mit Vorsicht zu benutzen.

* Änderungen an der Ordnerstruktur sollten nicht lokal, sondern im Webbrowser vorgenommen werden.
* Wenn die Gefahr besteht, dass mehrere Menschen gleichzeitig eine Datei bearbeiten, sollte die Datei nicht lokal, sondern im Webbrowser bearbeitet werden.
* Aus Sicht des Datenschutzes und der Daten-Minimierung sollte überlegt werden, ob die Daten wirklich auf jeden Laptop und Rechner synchronisiert werden sollen, oder ob es reicht, ausschließlich über den Webbrowser auf die Daten zuzugreifen.

= weiterführende Links =

* [https://docs.nextcloud.com/ Nextcloud Dokumentation]
* [https://apps.nextcloud.com/ Nextcloud Erweiterungen ("Apps")]
* [https://ownyourbits.com/2019/06/29/understanding-and-improving-nextcloud-previews/ Optimierung des Caches für Previews]
* [https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/nextcloud Ansible Playbook für Hostsharing]

= Nextcloud Reseller bei HS =

[https://nextcloud.ossaas.de OS SaaS]

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Ansible Playbook]]
[[Kategorie:Software]]
[[Kategorie:CalDAV]]

Nextcloud

2024-08-14T11:38:02Z

Hsh-milanihl: notify_push

= Nextcloud =

[https://nextcloud.com/ Nextcloud] ist eine PHP-basierte Open Source Lösung für gängige Cloud-Anwendungen, u.a.:

* Filesharing unter Nutzern derselben Nextcloud, und mit der Öffentlichkeit
* Single-Sign-On Authentifizierung (SSO)
* Videokonferenzen (WebRTC)
* Online-Office Anwendung [https://www.collaboraoffice.com/ Collabora Online]

Beispiel-Funktionalität, die über Plugins, sogenannte [https://apps.nextcloud.com/ "Apps"], bereit gestellt werden kann:

* Kalender, Aufgabenverwaltung, Adressbuch
* Datei-Kollaboration (Kommentare zu Dateien, Verschlagwortung)
* Feedreader
* E-Mail-Programm
* Fotogalerie
* Musik- und Videowiedergabe

= Nextcloud installieren =

== Vorbereitungen ==

In ''hsadmin'', zum Beispiel mit ''hsscript'':

''hsadmin''-Shell starten mit:

hsscript -u xyz00 -i
Password: ********

Dann nacheinander anlegen:

* Linux User als Domain-Administrator
* Subdomain ''cloud.example.org''
* PostgreSQL-User
* PostgreSQL Datenbank

<syntaxhighlight lang=shell>
xyz00@hsadmin> user.add({set:{name:'xyz00-cloud',password:'geheim',shell:'/bin/bash',comment:'Nextcloud'}})
xyz00@hsadmin> domain.add({set:{name:'cloud.example.org',user:'xyz00-cloud'}})
xyz00@hsadmin> postgresqluser.add({set:{name:'xyz00_nextclusr',password:'geheim'}})
xyz00@hsadmin> postgresqldb.add({set:{name:'xyz00_nextcloud',owner:'xyz00_nextclusr'}})
</syntaxhighlight>

== Nextcloud installieren ==

Anmelden als Linux-User ''xyz00-cloud'':

<syntaxhighlight lang=shell>
ssh -l xyz00-cloud xyz00.hostsharing.net
</syntaxhighlight>

''htdocs'' Verzeichnis vorbereiten

<syntaxhighlight lang=shell>
cd
mkdir nextcloud
cd doms/cloud.example.org
rm -rf subs/www subs-ssl/www htdocs-ssl
ln -s $HOME/nextcloud htdocs-ssl
</syntaxhighlight>

Nextcloud herunterladen und entpacken.

<syntaxhighlight lang=shell>
cd
wget https://download.nextcloud.com/server/releases/nextcloud-27.1.2.zip
unzip nextcloud-27.1.2.zip
rm nextcloud-27.1.2.zip
mkdir data tmp
chmod 700 data tmp
</syntaxhighlight>

== Nextcloud konfigurieren ==

Im Verzeichnis "$HOME/doms/cloud.example.org/fastcgi-ssl/" eine Datei "php.ini" anlegen mit folgendem Inhalt:

<syntaxhighlight lang=ini>
memory_limit=512M
session.save_path=/home/pacs/xyz00/users/cloud/tmp
</syntaxhighlight>

Dann mit einem Editor diese Datei bearbeiten: In der zweiten Zeile den korrekten Pfad des vorher angelegten tmp-Verzeichnisses eintragen.

Im Browser auf die Seite
http://cloud.example.org gehen und den Anweisungen folgen.

Auf der ersten Seite sind anzugeben:

* Login und Passwort für den Administrator definieren
* PostgreSQL als Datenbanksystem
* PostgreSQL-User und Passwort aus dem ersten Schritt oben
* Name der PostgreSQL-Datenbank aus dem ersten Schritt
* "localhost" als Datenbankserver (Nextcloud 23.0.2 empfiehlt hier die Angabe des Ports, diesen also lt. [[PostgreSQL]] angeben)
* Das Verzeichnis "/home/pacs/xyz00/users/cloud/data/" als Daten-Verzeichnis (bitte beachten: das im Eingabefeld voreingestellte verweist auf das Verzeichnis "/home/pacs/xyz00/users/cloud/'''nextcloud'''/data/")

'''Achtung!''' Die Felder für die Datenbank sind auf dem Startscreen hinter einem unscheinbaren Link versteckt. Um man das Formular für die Datenbank-Daten zu gelangen, muss man auf den Link klicken. Anschließend kann man die gewünschte Datenbank auswählen und die entsprechenden Daten eintragen. '''Das sollte geschehen, bevor man die Installation abschließt!''' Tut man dies nicht, wird Nextcloud mit SQLite installiert. Eine Änderung der Datenbank soll zwar laut Dokumentation auch später noch möglich sein, ging aber bei einem Test schief.

In der Konfigurationsdatei der Nextcloud (in ''~/nextcloud/config/config.php'') lassen sich weitere Voreinstellungen treffen:

<syntaxhighlight lang=php line>
'maintenance_window_start' => 1, // Wartungsfenster ab 1:00 Uhr
'defaultapp' => 'calendar,files', // bei Start wird der Kalender gezeigt
'default_phone_region' => 'DE', // Format Telefonnummern
'default_language' => 'de', // Sprache deutsch
'force_language' => 'de',
'default_locale' => 'de_DE', // Locale (Formatierung Zeitangaben etc.)
'force_locale' => 'de_DE',
</syntaxhighlight>

== Nextcloud beschleunigen ==

Dieser Teil ist optional.

Wenn regelmäßig '''im Browser''' mit Nextcloud gearbeitet werden soll, ist Nextcloud im Browser oft sehr langsam. Um dies zu verbessern, unterstützt Nextcloud die Anwendung von unterschiedlichen Cache-Verfahren (zum Beispiel Memcache, Redis).

=== Redis Cache ===

Redis ist auf den Hostsharing-Servern vorinstalliert und wird von den Nextcloud-Entwicklern empfohlen. '''In Verbindung mit einem Managed Webspace''' muss Redis als eigener Server '''Daemon''' angemeldet werden und ist '''kostenpflichtig'''. Siehe zu Kosten im Webspace Konfigurator unter: https://www.hostsharing.net/angebote/managed-webspace/ – '''1 individueller Serverdienst''' (Daemons).

Die Konfiguration des Redis-Dientes ist auf der Seite [[Redis]] beschrieben. Hier wird für Nextcloud die Variante mit einem Unixsocket benutzt.

In der Konfiguration der Nextcloud (in ''~/nextcloud/config/config.php'') wird der Redis-Cache wie folgt konfiguriert:

<syntaxhighlight lang=php line>
'memcache.local' => '\\OC\\Memcache\\Redis',
'memcache.distributed' => '\\OC\\Memcache\\Redis',
'memcache.locking' => '\\OC\\Memcache\\Redis',
'redis' =>
array (
'host' => '/home/pacs/xyz00/users/cloud/redis/var/redis-server.sock',
'port' => 0,
'password' => 'mein-redis-passwort',
'timeout' => 1.5,
),
</syntaxhighlight>

Um es perfekt zu machen, nutze ich ''logrotate'' um die Logdateien zu organisieren. Dazu die Konfiguration in ''~/.logrotate''

<syntaxhighlight lang=shell line>
compress
/home/pacs/xyz00/users/cloud/redis/var/redis.log {
rotate 5
daily
missingok
}
</syntaxhighlight>
Eine Crontab sorgt für den Start von Monit und das tägliche Rotieren der Logdateien:

<syntaxhighlight lang=shell line>
# m h dom mon dow command
HOME=/home/pacs/xyz00/users/cloud
PATH=/usr/local/bin:/usr/bin:/bin:/usr/local/games:/usr/games
MAILTO=webmaster@example.com
@reboot /usr/bin/monit -c $HOME/.monitrc
1 1 * * * /usr/sbin/logrotate -s $HOME/.logrotate.state $HOME/.logrotate
*/5 * * * * /usr/bin/php $HOME/nextcloud/cron.php
</syntaxhighlight>

Die letzte Zeile der ''crontab'' enthält den Cronjob für die regelmäßigen Hintergrundprozesse der Nextcloud. Durch die Erledigung dieser Aufgaben mit Cron lässt sich die Nextcloud ebenfalls etwas beschleunigen.

=== Nextcloud Push ===

Um Vorgänge wie Sync und Benachrichtigungen bei sehr großen Nextcloud Installationen zu beschleunigen, kann der <code>notify_push</code> Dienst hinzuinstalliert werden.

==== Abhängigkeiten und Einschränkungen ====
* <code>notify_push</code> muss Zugriff auf den gleichen Redis-Cache wie die Nextcloud haben
** aufgrund von eingeschränktem Passwort Support sollte ein Redis Socket mit sicheren Berechtigungseinstellungen als Alternative zum Redis Port mit Passwort konfiguriert werden.
* optimaler Weise holt sich <code>notify_push</code> benötigte informationen aus der <code>config.php</code> der bestehenden Nextcloud-Installation
* die bestehende <code>.htaccess</code> muss aus o.g. Gründen modifiziert werden, dies könnte bei Nextcloud-Updates verloren gehen(!)
* Bestimmte Portbereiche sind bei Hostsharing eingeschränkt, es empfiehlt sich, direkt beispielsweise Port <code>37867</code> zu nehmen. <strong>aus diesem Grund ist das automatische Setup durch das Plugin bei Hostsharing nicht möglich!</strong>

==== Installation ====
Siehe auch: https://github.com/nextcloud/notify_push#manual-setup

1. Installieren der Nextcloud-App <code>notify_push</code> – (nach Push suchen, "Client Push" wählen)<br>
2. falls noch nicht erstellt: <code>mkdir -p ~/.config/systemd/user</code><br>
3. mit Lieblingseditor die Datei <code>~/.config/systemd/user/notify_push.service</code> anlegen:<br>
<syntaxhighlight lang="ini" line>
[Unit]
Description = Push daemon for Nextcloud clients
Documentation = https://github.com/nextcloud/notify_push

[Service]
# Change if you already have something running on this port
Environment = PORT=37867
# We don't want to bind to 0.0.0.0, hence the --bind
ExecStart = /home/pacs/xyz00/users/cloud/bin/notify_push --bind 127.0.0.1 /home/pacs/xyz00/users/cloud/nextcloud/config/config.php
Type=notify

[Install]
WantedBy = default.target
</syntaxhighlight>
4. das Verzeichnis <code>~/bin</code> anlegen und die aktuellste binary herunterladen und ausführbar machen:
<syntaxhighlight lang="shell" line>release=`curl -L https://api.github.com/repos/nextcloud/notify_push/releases/latest -s | jq -r '.tag_name'` && wget --show-progress -qO ~/bin/notify_push https://github.com/nextcloud/notify_push/releases/download/$release/notify_push-x86_64-unknown-linux-musl && chmod +x ~/bin/notify_push</syntaxhighlight>
5. es könnte die folgende Umgebungsvariable zum Bedienen von systemd notwendig werden:<br><code>export XDG_RUNTIME_DIR=/run/user/$UID</code><br>
6. den neuen systemd-Dienst automatisch bei Systemstart, sowie jetzt sofort starten:<br><code>systemctl enable --now --user notify_push</code><br>
7. nun ergänzen wir um unteren Teil der <code>~/nextcloud/.htaccess</code> die folgenden Zeilen:
<syntaxhighlight lang="apache" line>
RewriteCond %{REQUEST_URI} ^/push/ws [NC,OR]
RewriteCond %{HTTP:UPGRADE} ^WebSocket$ [NC,OR]
RewriteCond %{HTTP:CONNECTION} ^Upgrade$ [NC]
RewriteRule .* ws://127.0.0.1:37867/ws [proxy]

RewriteCond %{REQUEST_URI} ^/push [NC]
RewriteRule .* http://127.0.0.1:37867%{REQUEST_URI} [proxy]
</syntaxhighlight>
8. abschließend im Nextcloud Ordner die Konfiguration des Plugins anstoßen: <code>php occ notify_push:setup https://cloud.example.com/push</code><br>
9. es ist möglich, das die erkannte IP-Adresse des Hives noch nicht vertraut ist. In diesem Fall wird der obige Befehl scheitern und es muss jene aus der Fehlermeldung des Setups unter <code>trusted_proxies</code> in der <code>config.php</code> ergänzt werden. <br><br>

Es wird im Repo außerdem ein Testclient bereitgestellt, der sich testweise mit dem Push-Dienst verbindet

== Nextcloud mit Online Office ==

In Nextcloud können Office-Dokumente (Textverarbeitung, Tabellen und Präsentationen) im Browser bearbeitet werden. Dazu steht bei Hostsharing die Collabora Developer Version zur Verfügung. Bestellung und Konfiguration sind hier im Wiki auf der Seite [[Collabora_Online]] beschrieben.

== Nextcloud mit Nextcloud Talk ==

Über die Nextcloud-App "Talk" können Videokonfererenzen mit Screensharing durchgeführt werden. Für die regelmäßige Nutzung kann es sinnvoll sein einen eigenen TURN Server zu betreiben. Siehe dazu [[Coturn_Installieren]]

== Virenscanner ==

Einige Nutzer wollen die Dateien in Ihrer Nextcloud regelmäßig auf Viren überprüfen. Auf unseren Servern steht dafür der OpenSource-Virenscanner "ClamAV" zur Verfügung. Wenn dieser Scanner benutzt wird, dann sollten die Einstellungen so gewählt sein, dass der ClamAV-Daemon über eine Socket Verbindung angesprochen wird. Die Einstellungen sind im Screenshot dokumentiert.

[[Datei:Nextcloud-ClamAV-Einstellungen.png||nextcloud einstellungen für die virenscanner-app]]

== Volltextsuche ==

Über die Dokumente einer Nextcloud kann ein Volltextindex erstellt werden. Die Volltextsuche ermöglicht über den Index eine Suche über beliebige Begriffe, die in Dokumenten vorkommen.

Voraussetzung ist der Betrieb eines Elasticsearch Servers. Der Betrieb im Managed Webspace erfodert die Buchung von zwei "Serverdiensten". Nutzer eines Managed Server müssen mit einem spürbaren Mehrbedarf an Hauptspeicher rechnen.

Zur Installation von Elasticsearch existiert eine eigene Wikiseite: [[Elasticsearch]].

In der Nextcloud sind folgende ''Apps'' zu installieren:
* Full Text Search
* Full Text Search - Elasticsearch Platform
* Full Text Search - Files

nach der Installation der drei Apps steht in den Einstellungen ein neuer Menüpunkt "Volltextsuche" zur Verfügung.

Hier ist einzustellen:
* Suchplattform: Elasticsearch
* Adresse des Servlets: http://elastic:das-erzeugt-passwort@127.0.0.1:39200
* Index: frei-gewaehlter-name-idx
* Analyzer tokenizer: standard

Die anderen Einstellung nach den eigenen Vorstellungen vornehmen.

Der initiale Aufbau des Suchindex erfolgt über ein "occ"-Kommando auf der Shell:

<syntaxhighlight lang=shell line>
cd nextcloud/
php occ fulltextsearch:index --output
</syntaxhighlight>

Wenn dieser Fehler kommt:
TypeError: Return value of OCA\Files_FullTextSearch\Model\MountPoint::isGlobal()
must be of the type bool, null returned in [...]/apps/files_fulltextsearch/lib/Model/MountPoint.php:103
sollte dieser Patch angewendet werden: https://github.com/nextcloud/files_fulltextsearch/issues/125#issuecomment-877789742

Zur Pflege des Indexes wird ein weiterer Hintergrundprozess gestartet:

<syntaxhighlight lang=shell line>
cd nextcloud/
php occ fulltextsearch:live -q
</syntaxhighlight>

Die Monit Konfiguration dafür sieht so aus:

<syntaxhighlight lang=shell line>
#~/bin/start-fulltextsearchlive
#
#!/bin/bash
export HOME=/home/pacs/xyz00/users/cloud
cd $HOME
mkdir -p $HOME/var
cd $HOME/nextcloud
exec php occ fulltextsearch:live -q &
echo $! >$HOME/var/fulltextsearchlive.pid
</syntaxhighlight>

<syntaxhighlight lang=shell line>
#~/bin/stop-fulltextsearchlive
#
#!/bin/bash
export HOME=/home/pacs/xyz00/users/cloud
kill $( cat $HOME/var/fulltextsearchlive.pid )
</syntaxhighlight>

~/.monitrc (siehe oben von der Redis Installation) entsprechend ergänzen:
<syntaxhighlight lang=shell line>
check process fulltextsearchlive with pidfile /home/pacs/xyz00/users/cloud/var/fulltextsearchlive.pid
start program "/home/pacs/xyz00/users/cloud/bin/start-fulltextsearchlive"
stop program "/home/pacs/xyz00/users/cloud/bin/stop-fulltextsearchlive"
</syntaxhighlight>
== Integration mit LDAP ==

Um einheitliche Benutzerzugänge für verschiedene Anwendungen zu ermöglichen, wird oft auf ein zentrales LDAP Verzeichnis gesetzt.

Dieses kann für Nextcloud eingesetzt werden, damit Benutzer nicht lokal in Nextcloud, sondern in LDAP verwaltet werden können.

Siehe auch https://docs.nextcloud.com/server/latest/admin_manual/configuration_user/user_auth_ldap.html

Dazu muss die App "LDAP user and group backend" in den Nextcloud Apps aktiviert werden.

Dann muss die LDAP Anbindung in den Administrationseinstellungen unter "LDAP/AD-Integration" eingerichtet werden.

Der Server mit Port, die BenutzerDN mit Passwort und die BaseDN müssen eingetragen werden.

Es muss auch bestimmt werden, welche Klasse (z.B. inetOrgPerson) die Benutzer brauchen, um Zugriff auf die Nextcloud zu erhalten.

Falls schon Benutzer in der Nextcloud existieren, und diese zu LDAP mitgenommen werden sollen, kann der Anleitung aus diesem Forum Eintrag gefolgt werden: https://help.nextcloud.com/t/migration-to-ldap-keeping-users-and-data/13205

* Voraussetzung ist, dass der Benutzernamen der zu übernehmenden Benutzer in Nextcloud der uid in LDAP entspricht.
* Es wird ein Administrator Benutzer benötigt, der lokal angelegt wurde, und auch lokal bleibt.
* Mit diesem Administrator Benutzer wird die LDAP Anbindung eingerichtet.
* In der Experten Ansicht von LDAP/AD muss bei "Attribut für interne Benutzernamen" eingetragen werden: uid
* Klicke den Schalter "LDAP Benutzernamenzuordnung löschen"
* Klicke den Schalter "LDAP Gruppennamenzuordnung löschen"
* dann in der MySQL Datenbank anmelden, und aus uc_users alle Benutzer bis auf den Administrator Benutzer löschen
* Dann in der Nextcloud Weboberfläche sich alle Benutzer anzeigen lassen
* Nun gelingt die Anmeldung mit den anderen Benutzern mit dem LDAP Passwort, und die Dateien wurden übernommen.

== Optimierung der Geschwindigkeit ==
Manchmal fühlt sich die Nextcloud träge an.

Folgende Änderungen können helfen:

* HTTP/2.0 aktivieren: dem Service von Hostsharing Bescheid geben
* Die App Dashboard deaktivieren, und dafür werden direkt die Dateien angezeigt
* Einblenden der README in den Ordnern abschalten: das kann pro Ordner in der UI geschehen (links unten), oder global: <code>occ config:app:set text workspace_available --value=0</code>. Siehe auch [https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/text_configuration.html#disable-rich-workspaces-globally]

== Default App einstellen ==

In der Datei config.php können wir einstellen, welche App direkt nach der Anmeldung gezeigt wird.

Das ist entweder die Dashboard App, wenn sie aktiviert ist, oder die Dateien App (files).

Falls der Kalender direkt angezeigt werden soll, muss folgende Zeile in der config.php hinzugefügt werden (siehe auch [https://docs.nextcloud.com/server/stable/admin_manual/configuration_server/config_sample_php_parameters.html#defaultapp]):

<syntaxhighlight lang=shell>
'defaultapp' => 'calendar',
</syntaxhighlight>

= Nextcloud Updates =

== Updater über die Shell starten ==

Wenn die NextCloud sich nicht über das Webfrontend updaten lässt, kann der Updater auch per Shell im directory /updater durch ausführen des updater.phar gestartet werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud/updater
xyz00-cloud@h00:~/nextcloud/updater$ chmod u+x updater.phar
xyz00-cloud@h00:~/nextcloud/updater$ ./updater.phar
</syntaxhighlight>

Es sollten außerdem ein paar Routine-Aufräumarbeiten durchgeführt werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-primary-keys --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-columns --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-indices --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:convert-filecache-bigint --no-interaction
</syntaxhighlight>

So können die Apps noch alle aktualisiert werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ app:update --all -n --no-ansi
</syntaxhighlight>

Für weitere Informationen kann auf die offizielle Doku ab Ziffer 2. zurückgegriffen werden.

* [https://docs.nextcloud.com/server/latest/admin_manual/maintenance/update.html#using-the-command-line-based-updater https://docs.nextcloud.com]

Hier gibt es ein kurzes Video, das die Anmeldung über die Kommandozeile mit Putty erklärt und die Aktualisierung von Nextcloud auf der Kommandozeile:

* [https://tube.solidcharity.net/w/0cf5ee97-ba7c-41df-a56f-8d1fea842ab0 Nextcloud auf der Kommandozeile aktualisieren]

== Wartungsmodus per Shell ein- oder ausschalten ==

So kann der Wartungsmodus angeschaltet werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --on
</syntaxhighlight>

So kann der Wartungsmodus wieder ausgeschaltet werden, d.h. die Nextcloud ist dann wieder in Betrieb:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --off
</syntaxhighlight>

== Webfrontend-Updater Probleme / Lösungen ==

=== Datenbank: Indizes | Primärschlüssel | Konvertierungen ===

Aufgetreten nach erfolgtem Versionsupdate Nextcloud 19 auf Nextcloud 20

Nach dem erfolgten Update lädt automatisch die Seite: '''Sicherheits- und Einrichtungswarnungen''' auf dieser wird angemerkt, dass manuelle Schritte für die Datenbank durchzuführen sind. Dies betrifft Indizes, Primärschlüssel und Konvertierungen.

Per Shell in der directory /nextcloud folgende Kommandos ausführen:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-primary-keys --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-columns --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-indices --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:convert-filecache-bigint --no-interaction
</syntaxhighlight>

Wichtig ist hier dem durch Nextcloud angegebenen Kommando ein '''php''' voranzustellen.

== Update per Skript ==

Es ist möglich die regelmäßigen Updates weitgehend zu automatisieren. Ein Skript wäre etwa:

<syntaxhighlight lang=shell line>
#!/bin/bash
if [ -f $HOME/nextcloud/occ ]; then
echo "Nextcloud Update";
cd $HOME/nextcloud;
php updater/updater.phar -vv --no-backup --no-interaction
php occ maintenance:mode --on
php occ db:add-missing-primary-keys --no-interaction
php occ db:add-missing-columns --no-interaction
php occ db:add-missing-indices --no-interaction
php occ db:convert-filecache-bigint --no-interaction
php occ app:update --all
php occ maintenance:mode --off
else
echo "Keine Nextcloud Installation gefunden";
fi
</syntaxhighlight>

== Update: bei old-stable Version bleiben ==

Normalerweise fragt jede Nextcloud Instanz zentral ab, welches Update zur Verfügung steht, abhängig vom Release Channel. Dabei wird aber relativ schnell auf die nächste Version gewechselt, also z.B. von Nextcloud 28 auf Nextcloud 29, obwohl Nextcloud 28 noch mehrere Monate gepflegt wird, und manche Apps noch nicht bereit sind für Nextcloud 29.

Es kann aber auch eine Alternative eingerichtet werden, in der Datei nextcloud/config/config.php, unter dem Eintrag updater.server.url

Hier wird z.B. auf einen Updater von unserem Mitglied Timotheus Pokorra verwiesen:

<syntaxhighlight lang=php line>
updater_server_url: "https://ncupdater.solidcharity.com"
</syntaxhighlight>

Dahinter läuft ein Skript, mit dem wir noch länger eine bestimmte Version anbieten können: https://codeberg.org/tpokorra/ncupdater

= Daten auf HDD Storage =
== Einrichtung des HDD Storage ==

Um den langsameren aber günstigeren HDD Storage von Hostsharing zu nutzen, kann das data Verzeichnis von SSD auf HDD Storage verschoben werden. Ein symbolischer Link reicht nicht aus, man muss den Pfad in der Nextcloud Konfigurationsdatei anpassen.

<syntaxhighlight lang=shell>
# Nextcloud in Wartungsmodus versetzen
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --on
# Daten auf HDD Storage verschieben
xyz00-cloud@h00:~/nextcloud$ mv data /home/storage/xyz00/users/cloud/
# symbolischen Link anlegen
xyz00-cloud@h00:~/nextcloud$ ln -s /home/storage/xyz00/users/cloud/data data
# Pfad in config.php ändern
nano config/config.php
# Die Zeile mit 'datadirectory' finden und entsprechend ändern:
# 'datadirectory' => '/home/storage/xyz00/users/cloud/data',
# Wartungsmodus beenden
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --off
</syntaxhighlight>

= Einschränkende Bemerkungen =
== Nextcloud Sync Client ==

Der Nextcloud Sync Client erfüllt eine Funktion ähnlich wie Dropbox, und synchronisiert ganze Ordnerstrukturen.

Gerade wenn man mit mehreren Menschen in einer Nextcloud arbeitet, ist diese Funktion mit Vorsicht zu benutzen.

* Änderungen an der Ordnerstruktur sollten nicht lokal, sondern im Webbrowser vorgenommen werden.
* Wenn die Gefahr besteht, dass mehrere Menschen gleichzeitig eine Datei bearbeiten, sollte die Datei nicht lokal, sondern im Webbrowser bearbeitet werden.
* Aus Sicht des Datenschutzes und der Daten-Minimierung sollte überlegt werden, ob die Daten wirklich auf jeden Laptop und Rechner synchronisiert werden sollen, oder ob es reicht, ausschließlich über den Webbrowser auf die Daten zuzugreifen.

= weiterführende Links =

* [https://docs.nextcloud.com/ Nextcloud Dokumentation]
* [https://apps.nextcloud.com/ Nextcloud Erweiterungen ("Apps")]
* [https://ownyourbits.com/2019/06/29/understanding-and-improving-nextcloud-previews/ Optimierung des Caches für Previews]
* [https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/nextcloud Ansible Playbook für Hostsharing]

= Nextcloud Reseller bei HS =

[https://nextcloud.ossaas.de OS SaaS]

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Ansible Playbook]]
[[Kategorie:Software]]
[[Kategorie:CalDAV]]

Matrix Synapse installieren

2024-08-12T10:24:03Z

Hsh-milanihl:

Der Matrix Server ''Synapse'', der sogenannte 'Homeserver', ist aktuell die einzige vollständige serverseitige Implementierung des Matrix-Protokolls.

{{Textkasten|gelb|Work in Progress|Leider funktioniert die Server-zu-Server-Kommunikation von Synapse hinter dem Apache-Proxy mit den genannten Rewrite-Rules nicht. Bitten Sie dazu den Service, Ihren Apache VHost individuell für den Matrix Server anzupassen.}}

Synapse wird bei Hostsharing als ''eigener Daemon'' betrieben. Der Betrieb ist im Shared Hosting anmelde- und kostenpflichtig. Daher empfehlen wir für den Betrieb einen ''Managed Server''.

Diese Anleitung beschreibt, wie man den Matrix-Homeserver Synapse auf der Managed Hosting Plattform von Hostsharing installieren kann. Dabei sind die User-IDs nach dem Schema @user:beispiel.de aufgebaut, der Homeserver an sich ist unter matrix.beispiel.de erreichbar.

== Vorbereitungen ==

Mit Hilfe von HSAdmin werden angelegt:
# Ein User als Service-User mit ''/bin/bash'' als Shell, zum Beispiel Beispiel: ''xyz00-matrix''
# Eine Domain mit ''xyz00-matrix'' als Domain-Administrator, zum Beispiel ''matrix.beispiel.de''
# Einen Postgresql-User ''xyz00_matrixuser'' mit Passwort ''meinPasswort''
# Eine Postgresql-Datenbank ''xyz00_matrixdb'' mit Datenbank-Owner ''xyz00_matrixuser''

Verwendeter IP-Port für den Server-Dienst:
# Synapse: localhost:32801

== Installation von Synapse ==

Installationsanleitung basierend auf https://matrix-org.github.io/synapse/latest/setup/installation.html#installing-as-a-python-module-from-pypi

Auf Debian Buster muss ein neueres Python, z.B. Python 3.9 installiert werden, siehe [https://wiki.hostsharing.net/index.php?title=Eigenes_Python_installieren#Installation_mit_pyenv Eigenes Python mit pyenv installieren].

Als User ''xyz00-matrix" ein Python3 virtualenv mit Python 3.9 erstellen

<syntaxhighlight lang="shell">
mkdir -p ~/synapse
cd ~/synapse
pipenv install --python 3.9.18
</syntaxhighlight>

Synapse und Postgres-Dependencies installieren

<syntaxhighlight lang="shell">
cd ~/synapse
pipenv shell
pipenv install matrix-synapse[postgres]
</syntaxhighlight>

Initiale Konfiguration mit richtigem server-name "beispiel.de" generieren, außerdem im laufenden Betrieb keine Statistiken an Matrix.org senden

<syntaxhighlight lang="shell">
cd ~/synapse
pipenv run python -m synapse.app.homeserver --server-name beispiel.de --config-path homeserver.yaml --generate-config --report-stats=no
</syntaxhighlight>

== Konfiguration von Synapse ==

In die initial generierte Konfiguration muss noch die Port- und Datenbank-Konfiguration eingetragen werden:

Port: Innerhalb der listener-section den Port 8008 auf 32801 (wie initial definiert) ändern, alles andere beibehalten:

<syntaxhighlight lang=yaml line>
- port: 32801
tls: false
bind_addresses: ['::1', '127.0.0.1']
type: http
x_forwarded: true
</syntaxhighlight>

Postgres-Datenbank:
<syntaxhighlight lang=yaml line>
database:
# The database engine name
name: "psycopg2"
# Arguments to pass to the engine
args:
host: "localhost"
database: "xyz00_matrixdb"
user: "xyz00_matrixuser"
password: "meinPasswort"
cp_min: 5
cp_max: 10
</syntaxhighlight>

== Starten der Dienste ==

Der ''Synapse''-Dienst wird hier als Service-Unit im SystemD des Users eingetragen.

Lege dazu die folgende Datei an: ''~/.config/systemd/user/synapse.service'' mit dem Inhalt:
<syntaxhighlight lang="ini" line>
[Unit]
Description=Synapse

[Service]
Type=simple
WorkingDirectory=%h/synapse
Environment=LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so.2
ExecStart=pipenv run python -m synapse.app.homeserver --config-path=%h/synapse/homeserver.yaml

[Install]
WantedBy=default.target
</syntaxhighlight>

Durch Aufruf der folgenden Kommandos wird der Dienst aktiviert und gestartet:
<syntaxhighlight lang="shell" lines>
systemctl --user daemon-reload
systemctl --user enable synapse.service
systemctl --user start synapse.service
</syntaxhighlight>
== Einrichten des Apache VHost ==

Die ''~/doms/matrix.beispiel.de/.htaccess'' mit dem Editor der Wahl öffnen und
folgende Konfiguration einfügen:
<syntaxhighlight lang=apache line>
DirectoryIndex disabled
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-l
RewriteRule .* http://localhost:32801%{REQUEST_URI} [NE,proxy]
RequestHeader set X-Forwarded-Proto "https"
</syntaxhighlight>
== Well-Known unter beispiel.de ==

Damit die User-Accounts das Format @user:beispiel.de haben, der Server aber unter matrix.beispiel.de erreichbar ist, müssen noch folgende zwei Dateien unter der Domain beispiel.de abgelegt werden:

https://beispiel.de/.well-known/matrix/server
<syntaxhighlight lang=json line>
{
"m.server": "matrix.beispiel.de:443"
}
</syntaxhighlight>

https://beispiel.de/.well-known/matrix/client
<syntaxhighlight lang=json line>
{
"m.homeserver": {
"base_url": "https://matrix.beispiel.de"
},
"m.identity_server": {
"base_url": "https://vector.im"
}
}
</syntaxhighlight>

Für die muss noch der CORS-Header Access-Control-Allow-Origin "*" gesetzt werden, damit die Datei aus beliebigem Riot-Web im Browser abrufbar ist. Dazu in den Ordner .well-known/matrix/ folgende .htaccess anlegen:
<syntaxhighlight lang=apache line>
<IfModule mod_headers.c>
Header set Access-Control-Allow-Origin "*"
</IfModule>
</syntaxhighlight>

Die Dokumentation dazu findet man unter https://matrix.org/docs/spec/server_server/r0.1.2#get-well-known-matrix-server und https://matrix.org/docs/spec/client_server/r0.5.0#get-well-known-matrix-client

== Update von Synapse ==

mit pipenv:
<syntaxhighlight lang=shell>
systemctl --user stop synapse.service
cd ~/synapse
source .venv/bin/activate || pipenv shell
pipenv install update
systemctl --user start synapse.service
</syntaxhighlight>

oder falls Synapse mit pip verwaltet wird:

<syntaxhighlight lang=shell>
systemctl --user stop synapse.service
cd ~/synapse
source venv/bin/activate
pip freeze > requirements.txt
sed -i "s/==.*//g" requirements.txt
pip install -r requirements.txt --upgrade
systemctl --user start synapse.service
</syntaxhighlight>
Falls Monit verwendet wird statt systemctl:

<syntaxhighlight lang=shell>
monit stop synapse
#... updaten ...
monit start synapse
</syntaxhighlight>

Wenn die Föderation für den Synapse Server aktiviert ist, kann mit dem [https://federationtester.matrix.org/ Matrix Federation Tester] die eigene Instanz auf die laufende Version geprüft werden. Als Server nicht matrix.example.org eingeben, sondern den öffentlichen Namen, wo auch die Benutzernamen drauf laufen, z.B. example.org

Ansonsten ist die laufende Version auch über die URL https://matrix.example.org/_synapse/admin/v1/server_version zu erfahren.

== Element-Web ==

Element-Web ist aus Server-Seite eine rein statische html+javascript-Kombination, daher:

* Account und Domain anlegen (separat von der Synapse-Domain)
* [https://github.com/element-hq/element-web/releases/latest aktuelles element-web release] .tgz herunterladen
* Symlink von htdocs-ssl auf entpacktes element-web-Verzeichnis
* config.sample.json in config.json kopieren und Matrix-Homeserver-Einträge anpassen
* Piwik aus config.json entfernen

== SAML mit Synapse ==

Synapse unterstützt mit Version 1.1.0 SAML. Dazu wie folgt vorgehen:

Das Paket xmlsec1 muss installiert sein:

<syntaxhighlight lang=shell>
$ xmlsec1 --version
xmlsec1 1.2.23 (openssl)
</syntaxhighlight>

Das Python-Paket pysaml2 installieren

<syntaxhighlight lang=shell>
cd ~/synapse
pipenv shell
pipenv install pysaml2
</syntaxhighlight>

In der homeserver.yaml die SAML-Direktiven einkommentieren, hier mit dem Beispiel eines SAML IdP unter https://login.beispiel.de/simplesaml/saml2/idp/metadata.php:

<syntaxhighlight lang=yaml line>
# Once SAML support is enabled, a metadata file will be exposed at
# https://<server>:<port>/_matrix/saml2/metadata.xml, which you may be able to
# use to configure your SAML IdP with. Alternatively, you can manually configure
# the IdP to use an ACS location of
# https://<server>:<port>/_matrix/saml2/authn_response.
#
saml2_config:
sp_config:
# point this to the IdP's metadata. You can use either a local file or
# (preferably) a URL.
metadata:
#local: ["saml2/idp.xml"]
remote:
- url: https://login.beispiel.de/simplesaml/saml2/idp/metadata.php
</syntaxhighlight>
Wichtig ist außerdem, dass die public_baseurl in der homeserver.yaml gesetzt ist, damit Synapse weiß, wie es erreichbar ist und dies in seine SP-Metadaten einbauen kann:
<syntaxhighlight lang=yaml line>
public_baseurl: https://matrix.beispiel.de/
</syntaxhighlight>
Die Service-Provider-Konfiguration als XML bekommt man von Synapse dann wie schon in der homeserver.yaml als Kommentar beschrieben, unter https://matrix.beispiel.de/_matrix/saml2/metadata.xml

Diese dann in den SAML-IdP-importieren und dann sollte der Single-Sign-On via SAML funktionieren.

== Federation Sender Worker für Synapse ==

Zur Parallelisierung bietet Synapse das Konzept "Worker" an, die spezifische Aufgaben übernehmen, damit der Hauptprozess diese nicht durchführen muss.

Details dazu: https://github.com/matrix-org/synapse/blob/master/docs/workers.md

Ein einfach einzurichtender Worker, der auch viel Last abfedert, ist der Federation Sender Worker, da das Verschicken des Federation-Traffics 10-50% der Serverlast ausmacht.

In der homeserver.yaml die Worker-Konfiguration aktivieren:
<syntaxhighlight lang=yaml line>
## Worker ##
worker_app: synapse.app.homeserver
daemonize: true
</syntaxhighlight>

und dazugehörige Listener (Abschnitt listener:) aktivieren:
<syntaxhighlight lang=yaml line>
# The TCP replication port
- port: 32892
bind_address: '127.0.0.1'
type: replication
# The HTTP replication port
- port: 32893
bind_address: '127.0.0.1'
type: http
resources:
- names: [replication]
</syntaxhighlight>

Funktionen, die Worker machen sollen, in der homeserver.yaml deaktivieren:
<syntaxhighlight lang=yaml line>
# disable federation sending here, use worker for it
send_federation: False
</syntaxhighlight>
Dann Verzeichnis synapse/workers anlegen, darin federation_sender.yaml:
<syntaxhighlight lang=yaml line>
worker_app: synapse.app.federation_sender

# The replication listener on the synapse to talk to.
worker_replication_host: 127.0.0.1
worker_replication_port: 32892
worker_replication_http_port: 32893

worker_daemonize: True
worker_pid_file: /home/pacs/xyz00/users/matrix/synapse/federation_sender.pid
worker_log_config: /home/pacs/xyz00/users/matrix/synapse/federation_sender.log.config
</syntaxhighlight>
.monitrc um worker erweitern:
<syntaxhighlight lang=shell line>
check process federation_sender with pidfile /home/pacs/xyz00/users/matrix/synapse/federation_sender.pid
start program "/bin/bash -c 'export VIRTUAL_ENV=$HOME/synapse/env && export PATH=$VIRTUAL_ENV/bin:$PATH && cd $HOME/synapse && synctl -w workers/federation_sender.yaml start'"
stop program "/bin/bash -c '/bin/kill $( cat $HOME/synapse/federation_sender.pid )'"
</syntaxhighlight>
Monit neu laden und synapse und federation_sender neustarten:

<syntaxhighlight lang=shell>
monit reload
monit restart all
</syntaxhighlight>

Nach Updates ebenfalls immer Hauptprozess und alle Worker neustarten

<syntaxhighlight lang=shell>
monit restart all
</syntaxhighlight>

== Sliding Sync Proxy ==
Zum Zeitpunkt dieser Anleitung werden aktiv neue Element Anwendungen (Element X) und ein neues Syncverfahren entwickelt um Matrix performater und weniger ressourcenhungrig zu machen. Unterstützung hierfür findet sich noch(!) nicht nativ in Synapse, sondern wird mit einem dedizierten kleinen Proxy umgesetzt. Bei stärkerer Matrix Nutzung können die neuen Anwendungen besonders mobil schon eine große Entlastung sein – es sind allerdings noch nicht alle Matrix-Funktionen fertig eingebaut.

=== Installation ===
Best practice ist auch hier wieder ein eigener User, sowie eigene Domain.

''Wir brauchen:''<br>
* eine PostgreSQL Datenbank
* einen freien internen http Port
* eine aktuelle sliding-sync Binary – [https://github.com/matrix-org/sliding-sync/releases diese kann hier bezogen werden]

''Verzeichnisstruktur''<br>
Es wird die folgende Struktur vorgeschlagen:
<syntaxhighlight lang=shell>
mkdir -p .config/systemd/user config bin scripts
</syntaxhighlight>

''Binary laden:''<br>
Mit den folgenden Befehlen kann die aktuelle Release erkannt, und von dieser das Binary heruntergeladen werden:
<syntaxhighlight lang=shell>
export release=`curl -L https://api.github.com/repos/matrix-org/sliding-sync/releases/latest -s | jq -r '.tag_name'`
wget --show-progress -q -O $HOME/bin/syncv3 https://github.com/matrix-org/sliding-sync/releases/download/$release/syncv3_linux_amd64
</syntaxhighlight>

Nun sollte sich die Datei als <code>./bin/syncv3</code> wiederfinden.

=== Konfiguration ===
Wir legen eine Environment-Datei an. In diesem Beispiel: <code>config/config.env</code>. Dies sind die wichtigsten Einstellungen – bitte vor ausprobieren anpassen:
<syntaxhighlight lang=ini>
SYNCV3_SECRET=$(cat $HOME/.secret)
SYNCV3_SERVER=https://matrix.meinedomain.de
SYNCV3_DB="user=xyz00_syncv3 dbname=xyz00_syncv3 sslmode=disable host=localhost password=sicherespasswort"
SYNCV3_BINDADDR=0.0.0.0:32804
SYNCV3_LOG_LEVEL=warn
# Prometheus
# SYNCV3_PROM=0.0.0.0:8882
</syntaxhighlight>

Jetzt fehlt noch das Secret, das wir oben aus einer Datei lesen lassen wollen. Das Secret darf nicht gelöscht werden. Andernfalls muss die Datenbank zurückgesetzt werden.
<syntaxhighlight lang=shell>
echo -n "$(openssl rand -hex 32)" > $HOME/.secret
</syntaxhighlight>

=== .htaccess anpassen ===
Ähnlich wie für Synapse oben, scheint das Folgende direkt zu funktionieren:
<syntaxhighlight lang="apache">
DirectoryIndex disabled
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-l
RewriteRule .* http://localhost:32804%{REQUEST_URI} [NE,proxy]
RequestHeader set X-Forwarded-Proto "https"
</syntaxhighlight>

=== Starten ===
In der Datei <code>~/.config/systemd/user/syncv3.service</code> schreiben wir den folgenden Inhalt:

<syntaxhighlight lang="ini" lines>
[Unit]
Description=Matrix SyncV3 Proxy
After=postgresql.service

[Service]
Type=simple
WorkingDirectory=%h
EnvironmentFile=%h/config/config.env
ExecStart=%h/bin/syncv3

[Install]
WantedBy=default.target
</syntaxhighlight>

Sicherheitshalber jetzt noch einmal <code>export XDG_RUNTIME_DIR=/run/user/$UID</code> damit wir systemd auch steuern können und dann: <code>systemctl enable --user --now syncv3</code>. Logs können beispielsweise mittels <code>journalctl --user -xefu syncv3</code> betrachtet werden.

=== Auffindbar machen ===
Moderne Anwendungen wie Element X erwarten automatisch zu erkennen, ob syncv3 Support vorhanden ist. Hierfür müssen wir die well-known für die Hauptdomain des Matrixservers ergänzen. Also den <code>server_name</code> des Synapse servers.

Konkret muss <code>/.well-known/matrix/client</code> auf das Folgende erweitert werden:
<syntaxhighlight lang="json" line start="4">
"org.matrix.msc3575.proxy": {
"url": "https://syncv3.meinedomain.de"
}
</syntaxhighlight>

== Links ==

* https://matrix.org/docs/projects/server/synapse
* https://github.com/element-hq/synapse
* https://github.com/element-hq/synapse/blob/master/INSTALL.md
* https://github.com/matrix-org/sliding-sync
* https://matrix.org/docs/spec/
* https://www.hostsharing.net/loesungen/matrix/
* https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/synapse
* https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/element

[[Kategorie:Messenger]]
[[Kategorie:Software]]
[[Kategorie:Eigene Daemons]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Ansible Playbook]]

Nextcloud

2024-08-12T10:11:16Z

Hsh-milanihl:

= Nextcloud =

[https://nextcloud.com/ Nextcloud] ist eine PHP-basierte Open Source Lösung für gängige Cloud-Anwendungen, u.a.:

* Filesharing unter Nutzern derselben Nextcloud, und mit der Öffentlichkeit
* Single-Sign-On Authentifizierung (SSO)
* Videokonferenzen (WebRTC)
* Online-Office Anwendung [https://www.collaboraoffice.com/ Collabora Online]

Beispiel-Funktionalität, die über Plugins, sogenannte [https://apps.nextcloud.com/ "Apps"], bereit gestellt werden kann:

* Kalender, Aufgabenverwaltung, Adressbuch
* Datei-Kollaboration (Kommentare zu Dateien, Verschlagwortung)
* Feedreader
* E-Mail-Programm
* Fotogalerie
* Musik- und Videowiedergabe

= Nextcloud installieren =

== Vorbereitungen ==

In ''hsadmin'', zum Beispiel mit ''hsscript'':

''hsadmin''-Shell starten mit:

hsscript -u xyz00 -i
Password: ********

Dann nacheinander anlegen:

* Linux User als Domain-Administrator
* Subdomain ''cloud.example.org''
* PostgreSQL-User
* PostgreSQL Datenbank

<syntaxhighlight lang=shell>
xyz00@hsadmin> user.add({set:{name:'xyz00-cloud',password:'geheim',shell:'/bin/bash',comment:'Nextcloud'}})
xyz00@hsadmin> domain.add({set:{name:'cloud.example.org',user:'xyz00-cloud'}})
xyz00@hsadmin> postgresqluser.add({set:{name:'xyz00_nextclusr',password:'geheim'}})
xyz00@hsadmin> postgresqldb.add({set:{name:'xyz00_nextcloud',owner:'xyz00_nextclusr'}})
</syntaxhighlight>

== Nextcloud installieren ==

Anmelden als Linux-User ''xyz00-cloud'':

<syntaxhighlight lang=shell>
ssh -l xyz00-cloud xyz00.hostsharing.net
</syntaxhighlight>

''htdocs'' Verzeichnis vorbereiten

<syntaxhighlight lang=shell>
cd
mkdir nextcloud
cd doms/cloud.example.org
rm -rf subs/www subs-ssl/www htdocs-ssl
ln -s $HOME/nextcloud htdocs-ssl
</syntaxhighlight>

Nextcloud herunterladen und entpacken.

<syntaxhighlight lang=shell>
cd
wget https://download.nextcloud.com/server/releases/nextcloud-27.1.2.zip
unzip nextcloud-27.1.2.zip
rm nextcloud-27.1.2.zip
mkdir data tmp
chmod 700 data tmp
</syntaxhighlight>

== Nextcloud konfigurieren ==

Im Verzeichnis "$HOME/doms/cloud.example.org/fastcgi-ssl/" eine Datei "php.ini" anlegen mit folgendem Inhalt:

<syntaxhighlight lang=ini>
memory_limit=512M
session.save_path=/home/pacs/xyz00/users/cloud/tmp
</syntaxhighlight>

Dann mit einem Editor diese Datei bearbeiten: In der zweiten Zeile den korrekten Pfad des vorher angelegten tmp-Verzeichnisses eintragen.

Im Browser auf die Seite
http://cloud.example.org gehen und den Anweisungen folgen.

Auf der ersten Seite sind anzugeben:

* Login und Passwort für den Administrator definieren
* PostgreSQL als Datenbanksystem
* PostgreSQL-User und Passwort aus dem ersten Schritt oben
* Name der PostgreSQL-Datenbank aus dem ersten Schritt
* "localhost" als Datenbankserver (Nextcloud 23.0.2 empfiehlt hier die Angabe des Ports, diesen also lt. [[PostgreSQL]] angeben)
* Das Verzeichnis "/home/pacs/xyz00/users/cloud/data/" als Daten-Verzeichnis (bitte beachten: das im Eingabefeld voreingestellte verweist auf das Verzeichnis "/home/pacs/xyz00/users/cloud/'''nextcloud'''/data/")

'''Achtung!''' Die Felder für die Datenbank sind auf dem Startscreen hinter einem unscheinbaren Link versteckt. Um man das Formular für die Datenbank-Daten zu gelangen, muss man auf den Link klicken. Anschließend kann man die gewünschte Datenbank auswählen und die entsprechenden Daten eintragen. '''Das sollte geschehen, bevor man die Installation abschließt!''' Tut man dies nicht, wird Nextcloud mit SQLite installiert. Eine Änderung der Datenbank soll zwar laut Dokumentation auch später noch möglich sein, ging aber bei einem Test schief.

In der Konfigurationsdatei der Nextcloud (in ''~/nextcloud/config/config.php'') lassen sich weitere Voreinstellungen treffen:

<syntaxhighlight lang=php line>
'maintenance_window_start' => 1, // Wartungsfenster ab 1:00 Uhr
'defaultapp' => 'calendar,files', // bei Start wird der Kalender gezeigt
'default_phone_region' => 'DE', // Format Telefonnummern
'default_language' => 'de', // Sprache deutsch
'force_language' => 'de',
'default_locale' => 'de_DE', // Locale (Formatierung Zeitangaben etc.)
'force_locale' => 'de_DE',
</syntaxhighlight>

== Nextcloud beschleunigen ==

Dieser Teil ist optional.

Wenn regelmäßig '''im Browser''' mit Nextcloud gearbeitet werden soll, ist Nextcloud im Browser oft sehr langsam. Um dies zu verbessern, unterstützt Nextcloud die Anwendung von unterschiedlichen Cache-Verfahren (zum Beispiel Memcache, Redis).

Redis ist auf den Hostsharing-Servern vorinstalliert und wird von den Nextcloud-Entwicklern empfohlen. '''In Verbindung mit einem Managed Webspace''' muss Redis als eigener Server '''Daemon''' angemeldet werden und ist '''kostenpflichtig'''. Siehe zu Kosten im Webspace Konfigurator unter: https://www.hostsharing.net/angebote/managed-webspace/ – '''1 individueller Serverdienst''' (Daemons).

Die Konfiguration des Redis-Dientes ist auf der Seite [[Redis]] beschrieben. Hier wird für Nextcloud die Variante mit einem Unixsocket benutzt.

In der Konfiguration der Nextcloud (in ''~/nextcloud/config/config.php'') wird der Redis-Cache wie folgt konfiguriert:

<syntaxhighlight lang=php line>
'memcache.local' => '\\OC\\Memcache\\Redis',
'memcache.distributed' => '\\OC\\Memcache\\Redis',
'memcache.locking' => '\\OC\\Memcache\\Redis',
'redis' =>
array (
'host' => '/home/pacs/xyz00/users/cloud/redis/var/redis-server.sock',
'port' => 0,
'password' => 'mein-redis-passwort',
'timeout' => 1.5,
),
</syntaxhighlight>

Um es perfekt zu machen, nutze ich ''logrotate'' um die Logdateien zu organisieren. Dazu die Konfiguration in ''~/.logrotate''

<syntaxhighlight lang=shell line>
compress
/home/pacs/xyz00/users/cloud/redis/var/redis.log {
rotate 5
daily
missingok
}
</syntaxhighlight>
Eine Crontab sorgt für den Start von Monit und das tägliche Rotieren der Logdateien:

<syntaxhighlight lang=shell line>
# m h dom mon dow command
HOME=/home/pacs/xyz00/users/cloud
PATH=/usr/local/bin:/usr/bin:/bin:/usr/local/games:/usr/games
MAILTO=webmaster@example.com
@reboot /usr/bin/monit -c $HOME/.monitrc
1 1 * * * /usr/sbin/logrotate -s $HOME/.logrotate.state $HOME/.logrotate
*/5 * * * * /usr/bin/php $HOME/nextcloud/cron.php
</syntaxhighlight>

Die letzte Zeile der ''crontab'' enthält den Cronjob für die regelmäßigen Hintergrundprozesse der Nextcloud. Durch die Erledigung dieser Aufgaben mit Cron lässt sich die Nextcloud ebenfalls etwas beschleunigen.

== Nextcloud mit Online Office ==

In Nextcloud können Office-Dokumente (Textverarbeitung, Tabellen und Präsentationen) im Browser bearbeitet werden. Dazu steht bei Hostsharing die Collabora Developer Version zur Verfügung. Bestellung und Konfiguration sind hier im Wiki auf der Seite [[Collabora_Online]] beschrieben.

== Nextcloud mit Nextcloud Talk ==

Über die Nextcloud-App "Talk" können Videokonfererenzen mit Screensharing durchgeführt werden. Für die regelmäßige Nutzung kann es sinnvoll sein einen eigenen TURN Server zu betreiben. Siehe dazu [[Coturn_Installieren]]

== Virenscanner ==

Einige Nutzer wollen die Dateien in Ihrer Nextcloud regelmäßig auf Viren überprüfen. Auf unseren Servern steht dafür der OpenSource-Virenscanner "ClamAV" zur Verfügung. Wenn dieser Scanner benutzt wird, dann sollten die Einstellungen so gewählt sein, dass der ClamAV-Daemon über eine Socket Verbindung angesprochen wird. Die Einstellungen sind im Screenshot dokumentiert.

[[Datei:Nextcloud-ClamAV-Einstellungen.png||nextcloud einstellungen für die virenscanner-app]]

== Volltextsuche ==

Über die Dokumente einer Nextcloud kann ein Volltextindex erstellt werden. Die Volltextsuche ermöglicht über den Index eine Suche über beliebige Begriffe, die in Dokumenten vorkommen.

Voraussetzung ist der Betrieb eines Elasticsearch Servers. Der Betrieb im Managed Webspace erfodert die Buchung von zwei "Serverdiensten". Nutzer eines Managed Server müssen mit einem spürbaren Mehrbedarf an Hauptspeicher rechnen.

Zur Installation von Elasticsearch existiert eine eigene Wikiseite: [[Elasticsearch]].

In der Nextcloud sind folgende ''Apps'' zu installieren:
* Full Text Search
* Full Text Search - Elasticsearch Platform
* Full Text Search - Files

nach der Installation der drei Apps steht in den Einstellungen ein neuer Menüpunkt "Volltextsuche" zur Verfügung.

Hier ist einzustellen:
* Suchplattform: Elasticsearch
* Adresse des Servlets: http://elastic:das-erzeugt-passwort@127.0.0.1:39200
* Index: frei-gewaehlter-name-idx
* Analyzer tokenizer: standard

Die anderen Einstellung nach den eigenen Vorstellungen vornehmen.

Der initiale Aufbau des Suchindex erfolgt über ein "occ"-Kommando auf der Shell:

<syntaxhighlight lang=shell line>
cd nextcloud/
php occ fulltextsearch:index --output
</syntaxhighlight>

Wenn dieser Fehler kommt:
TypeError: Return value of OCA\Files_FullTextSearch\Model\MountPoint::isGlobal()
must be of the type bool, null returned in [...]/apps/files_fulltextsearch/lib/Model/MountPoint.php:103
sollte dieser Patch angewendet werden: https://github.com/nextcloud/files_fulltextsearch/issues/125#issuecomment-877789742

Zur Pflege des Indexes wird ein weiterer Hintergrundprozess gestartet:

<syntaxhighlight lang=shell line>
cd nextcloud/
php occ fulltextsearch:live -q
</syntaxhighlight>

Die Monit Konfiguration dafür sieht so aus:

<syntaxhighlight lang=shell line>
#~/bin/start-fulltextsearchlive
#
#!/bin/bash
export HOME=/home/pacs/xyz00/users/cloud
cd $HOME
mkdir -p $HOME/var
cd $HOME/nextcloud
exec php occ fulltextsearch:live -q &
echo $! >$HOME/var/fulltextsearchlive.pid
</syntaxhighlight>

<syntaxhighlight lang=shell line>
#~/bin/stop-fulltextsearchlive
#
#!/bin/bash
export HOME=/home/pacs/xyz00/users/cloud
kill $( cat $HOME/var/fulltextsearchlive.pid )
</syntaxhighlight>

~/.monitrc (siehe oben von der Redis Installation) entsprechend ergänzen:
<syntaxhighlight lang=shell line>
check process fulltextsearchlive with pidfile /home/pacs/xyz00/users/cloud/var/fulltextsearchlive.pid
start program "/home/pacs/xyz00/users/cloud/bin/start-fulltextsearchlive"
stop program "/home/pacs/xyz00/users/cloud/bin/stop-fulltextsearchlive"
</syntaxhighlight>
== Integration mit LDAP ==

Um einheitliche Benutzerzugänge für verschiedene Anwendungen zu ermöglichen, wird oft auf ein zentrales LDAP Verzeichnis gesetzt.

Dieses kann für Nextcloud eingesetzt werden, damit Benutzer nicht lokal in Nextcloud, sondern in LDAP verwaltet werden können.

Siehe auch https://docs.nextcloud.com/server/latest/admin_manual/configuration_user/user_auth_ldap.html

Dazu muss die App "LDAP user and group backend" in den Nextcloud Apps aktiviert werden.

Dann muss die LDAP Anbindung in den Administrationseinstellungen unter "LDAP/AD-Integration" eingerichtet werden.

Der Server mit Port, die BenutzerDN mit Passwort und die BaseDN müssen eingetragen werden.

Es muss auch bestimmt werden, welche Klasse (z.B. inetOrgPerson) die Benutzer brauchen, um Zugriff auf die Nextcloud zu erhalten.

Falls schon Benutzer in der Nextcloud existieren, und diese zu LDAP mitgenommen werden sollen, kann der Anleitung aus diesem Forum Eintrag gefolgt werden: https://help.nextcloud.com/t/migration-to-ldap-keeping-users-and-data/13205

* Voraussetzung ist, dass der Benutzernamen der zu übernehmenden Benutzer in Nextcloud der uid in LDAP entspricht.
* Es wird ein Administrator Benutzer benötigt, der lokal angelegt wurde, und auch lokal bleibt.
* Mit diesem Administrator Benutzer wird die LDAP Anbindung eingerichtet.
* In der Experten Ansicht von LDAP/AD muss bei "Attribut für interne Benutzernamen" eingetragen werden: uid
* Klicke den Schalter "LDAP Benutzernamenzuordnung löschen"
* Klicke den Schalter "LDAP Gruppennamenzuordnung löschen"
* dann in der MySQL Datenbank anmelden, und aus uc_users alle Benutzer bis auf den Administrator Benutzer löschen
* Dann in der Nextcloud Weboberfläche sich alle Benutzer anzeigen lassen
* Nun gelingt die Anmeldung mit den anderen Benutzern mit dem LDAP Passwort, und die Dateien wurden übernommen.

== Optimierung der Geschwindigkeit ==
Manchmal fühlt sich die Nextcloud träge an.

Folgende Änderungen können helfen:

* HTTP/2.0 aktivieren: dem Service von Hostsharing Bescheid geben
* Die App Dashboard deaktivieren, und dafür werden direkt die Dateien angezeigt
* Einblenden der README in den Ordnern abschalten: das kann pro Ordner in der UI geschehen (links unten), oder global: <code>occ config:app:set text workspace_available --value=0</code>. Siehe auch [https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/text_configuration.html#disable-rich-workspaces-globally]

== Default App einstellen ==

In der Datei config.php können wir einstellen, welche App direkt nach der Anmeldung gezeigt wird.

Das ist entweder die Dashboard App, wenn sie aktiviert ist, oder die Dateien App (files).

Falls der Kalender direkt angezeigt werden soll, muss folgende Zeile in der config.php hinzugefügt werden (siehe auch [https://docs.nextcloud.com/server/stable/admin_manual/configuration_server/config_sample_php_parameters.html#defaultapp]):

<syntaxhighlight lang=shell>
'defaultapp' => 'calendar',
</syntaxhighlight>

= Nextcloud Updates =

== Updater über die Shell starten ==

Wenn die NextCloud sich nicht über das Webfrontend updaten lässt, kann der Updater auch per Shell im directory /updater durch ausführen des updater.phar gestartet werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud/updater
xyz00-cloud@h00:~/nextcloud/updater$ chmod u+x updater.phar
xyz00-cloud@h00:~/nextcloud/updater$ ./updater.phar
</syntaxhighlight>

Es sollten außerdem ein paar Routine-Aufräumarbeiten durchgeführt werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-primary-keys --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-columns --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-indices --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:convert-filecache-bigint --no-interaction
</syntaxhighlight>

So können die Apps noch alle aktualisiert werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ app:update --all -n --no-ansi
</syntaxhighlight>

Für weitere Informationen kann auf die offizielle Doku ab Ziffer 2. zurückgegriffen werden.

* [https://docs.nextcloud.com/server/latest/admin_manual/maintenance/update.html#using-the-command-line-based-updater https://docs.nextcloud.com]

Hier gibt es ein kurzes Video, das die Anmeldung über die Kommandozeile mit Putty erklärt und die Aktualisierung von Nextcloud auf der Kommandozeile:

* [https://tube.solidcharity.net/w/0cf5ee97-ba7c-41df-a56f-8d1fea842ab0 Nextcloud auf der Kommandozeile aktualisieren]

== Wartungsmodus per Shell ein- oder ausschalten ==

So kann der Wartungsmodus angeschaltet werden:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --on
</syntaxhighlight>

So kann der Wartungsmodus wieder ausgeschaltet werden, d.h. die Nextcloud ist dann wieder in Betrieb:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --off
</syntaxhighlight>

== Webfrontend-Updater Probleme / Lösungen ==

=== Datenbank: Indizes | Primärschlüssel | Konvertierungen ===

Aufgetreten nach erfolgtem Versionsupdate Nextcloud 19 auf Nextcloud 20

Nach dem erfolgten Update lädt automatisch die Seite: '''Sicherheits- und Einrichtungswarnungen''' auf dieser wird angemerkt, dass manuelle Schritte für die Datenbank durchzuführen sind. Dies betrifft Indizes, Primärschlüssel und Konvertierungen.

Per Shell in der directory /nextcloud folgende Kommandos ausführen:

<syntaxhighlight lang=shell line>
xyz00-cloud@h00:~$ cd ~/nextcloud
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-primary-keys --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-columns --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-indices --no-interaction
xyz00-cloud@h00:~/nextcloud$ php occ db:convert-filecache-bigint --no-interaction
</syntaxhighlight>

Wichtig ist hier dem durch Nextcloud angegebenen Kommando ein '''php''' voranzustellen.

== Update per Skript ==

Es ist möglich die regelmäßigen Updates weitgehend zu automatisieren. Ein Skript wäre etwa:

<syntaxhighlight lang=shell line>
#!/bin/bash
if [ -f $HOME/nextcloud/occ ]; then
echo "Nextcloud Update";
cd $HOME/nextcloud;
php updater/updater.phar -vv --no-backup --no-interaction
php occ maintenance:mode --on
php occ db:add-missing-primary-keys --no-interaction
php occ db:add-missing-columns --no-interaction
php occ db:add-missing-indices --no-interaction
php occ db:convert-filecache-bigint --no-interaction
php occ app:update --all
php occ maintenance:mode --off
else
echo "Keine Nextcloud Installation gefunden";
fi
</syntaxhighlight>

== Update: bei old-stable Version bleiben ==

Normalerweise fragt jede Nextcloud Instanz zentral ab, welches Update zur Verfügung steht, abhängig vom Release Channel. Dabei wird aber relativ schnell auf die nächste Version gewechselt, also z.B. von Nextcloud 28 auf Nextcloud 29, obwohl Nextcloud 28 noch mehrere Monate gepflegt wird, und manche Apps noch nicht bereit sind für Nextcloud 29.

Es kann aber auch eine Alternative eingerichtet werden, in der Datei nextcloud/config/config.php, unter dem Eintrag updater.server.url

Hier wird z.B. auf einen Updater von unserem Mitglied Timotheus Pokorra verwiesen:

<syntaxhighlight lang=php line>
updater_server_url: "https://ncupdater.solidcharity.com"
</syntaxhighlight>

Dahinter läuft ein Skript, mit dem wir noch länger eine bestimmte Version anbieten können: https://codeberg.org/tpokorra/ncupdater

= Daten auf HDD Storage =
== Einrichtung des HDD Storage ==

Um den langsameren aber günstigeren HDD Storage von Hostsharing zu nutzen, kann das data Verzeichnis von SSD auf HDD Storage verschoben werden. Ein symbolischer Link reicht nicht aus, man muss den Pfad in der Nextcloud Konfigurationsdatei anpassen.

<syntaxhighlight lang=shell>
# Nextcloud in Wartungsmodus versetzen
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --on
# Daten auf HDD Storage verschieben
xyz00-cloud@h00:~/nextcloud$ mv data /home/storage/xyz00/users/cloud/
# symbolischen Link anlegen
xyz00-cloud@h00:~/nextcloud$ ln -s /home/storage/xyz00/users/cloud/data data
# Pfad in config.php ändern
nano config/config.php
# Die Zeile mit 'datadirectory' finden und entsprechend ändern:
# 'datadirectory' => '/home/storage/xyz00/users/cloud/data',
# Wartungsmodus beenden
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --off
</syntaxhighlight>

= Einschränkende Bemerkungen =
== Nextcloud Sync Client ==

Der Nextcloud Sync Client erfüllt eine Funktion ähnlich wie Dropbox, und synchronisiert ganze Ordnerstrukturen.

Gerade wenn man mit mehreren Menschen in einer Nextcloud arbeitet, ist diese Funktion mit Vorsicht zu benutzen.

* Änderungen an der Ordnerstruktur sollten nicht lokal, sondern im Webbrowser vorgenommen werden.
* Wenn die Gefahr besteht, dass mehrere Menschen gleichzeitig eine Datei bearbeiten, sollte die Datei nicht lokal, sondern im Webbrowser bearbeitet werden.
* Aus Sicht des Datenschutzes und der Daten-Minimierung sollte überlegt werden, ob die Daten wirklich auf jeden Laptop und Rechner synchronisiert werden sollen, oder ob es reicht, ausschließlich über den Webbrowser auf die Daten zuzugreifen.

= weiterführende Links =

* [https://docs.nextcloud.com/ Nextcloud Dokumentation]
* [https://apps.nextcloud.com/ Nextcloud Erweiterungen ("Apps")]
* [https://ownyourbits.com/2019/06/29/understanding-and-improving-nextcloud-previews/ Optimierung des Caches für Previews]
* [https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/nextcloud Ansible Playbook für Hostsharing]

= Nextcloud Reseller bei HS =

[https://nextcloud.ossaas.de OS SaaS]

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Ansible Playbook]]
[[Kategorie:Software]]
[[Kategorie:CalDAV]]

HS-Mailrouting

2024-07-23T11:44:31Z

Hsh-milanihl:

== Grundsätze ==

* Nur der Hive (xyz00.hostsharing.net) des Benutzers nimmt Mails per SMTP-Auth an (Postausgangsserver).
* Nur der Hive (xyz00.hostsharing.net) des Benutzers bietet eingegangene Mails per POP3 oder IMAP an (Posteingangsserver).
* Alle Mails von extern an Domains, die bei Hostsharing gehostet sind, erreichen Hostsharing über mailin{1,2,3}.
* Alle Mails nach extern verlassen Hostsharing über mailout{1,2,3}.

* Interne Mails gehen über mailout{1,2,3} nach mailin{1,2,3}.

== Ausgehende Mails ==

Mails, die lokal erzeugt werden (Kommandozeile, Anwendung) auf einem
HS-Server, werden an [[mailout]]{1,2,3}.hostsharing.net weitergeleitet. Von
dort werden sie weiter zugestellt.

Entsprechendes gilt für Mails, die per SMTP-Auth auf den Hives
eingeliefert werden:

* (Benutzer =>) Hive => mailout{1,2,3} => extern

== Eingehende Mails ==

Mails, die von extern für einen Empfänger bei Hostsharing eingeliefert
werden, werden von [[mailin]]{1,2,3}.hostsharing.net entgegen genommen, an
den [[Hive]] des Empfängers weitergeleitet und dort zugestellt.

Auf dem Hive können die Mails weitergeleitet, verarbeitet oder abgelegt
und per POP3 oder IMAP abgeholt werden.

* extern => mailin{1,2,3} => Hive (=> Benutzer)

(Sonderfall: Ist keine E-Mail-Adresse für die Empänger-Domain konfiguriert, aber ein MX mit höherer Priorität (10) als
{1,2,3}.hostsharing.net durch ein eigenes [[Verwalten der Zonendaten|Zonefile]] für die Domain spezifiziert, so wird die E-Mail
an den Mailserver mit höherer Priorität weitergeleitet. Dies bietet interessante Gestaltungsmöglichkeiten für Betreiber eigener Mailserver.)

* extern => externer Mailserver
* extern => mailin{1,2,3} => externer Mailserver (BackupMX-Funktion)

== Mail Relay mit eigenen Mailservern ==

In der Konfiguration des Mailservers muss der Hostname des Webpakets (xyz00.hostsharing.net im Falle des Pakets xyz00) eingetragen werden. Ferner ist sicherzustellen, dass der einliefernde Mailserver keinen MX Lookup für diesen Hostnamen vornimmt.

Ist dies nicht gewährleistet, so wird der eigene Mailserver versuchen, ausgehende E-Mails für externe Domains an unsere Maileingangsserver zu übergeben, welche diese mit "Relay access denied" abweisen werden.

Siehe: https://lists.hostsharing.net/archiv/global-announce/2012-October/000566.html

=== Beispiel mit Postfix ===
Hat man einen eigenen funktionierenden Postfix-Mailserver laufen, kann man Mails über seinen Hostsharing-Account versenden. Elemente der Konfiguration sind:

<syntaxhighlight lang=cfg line>
# /etc/postfix/main.cf
relayhost = [xyz00.hostsharing.net]:465
smtp_sasl_password_maps = hash:/etc/postfix/saslpass
smtp_sasl_auth_enable = yes
smtp_tls_security_level = encrypt
smtp_sasl_security_options = noanonymous
smtp_tls_wrappermode = yes
</syntaxhighlight>

<syntaxhighlight lang=bash>
# /etc/postfix/saslpass
[xyz00.hostsharing.net]:465 xyz00:MeinGeheimesPasswort
</syntaxhighlight>

(Hostname in '''beiden''' Dateien in eckigen Klammern, entsprechend o.g. MX-Themas.)

Nach Änderung/Erstellung folgendes ausführen:
<syntaxhighlight lang=bash>
postmap /etc/postfix/saslpass
</syntaxhighlight>

Postfix Konfiguration neu laden (entsprechend, wenn nicht systemd):
<syntaxhighlight lang=bash>
systemctl reload postfix
</syntaxhighlight>

Tipps:
* Alphanumerisches Passwort verwenden. (Just sayin'...)
* Tests mehrfach durchführen und sehen ob Fehlermeldung gleich bleibt. (Verbindungsabbrüche passieren.)

Nicht vergessen den SPF-Record zu setzen und die TTL abzuwarten... ;) z.B.:
<syntaxhighlight lang=bash>
v=spf1 include:spf.hostsharing.net -all
</syntaxhighlight>

[[Kategorie:HSDoku]]
[[Kategorie:E-Mail]]

Mlmmj

2024-07-23T10:16:02Z

Hsh-milanihl: /* Mehrere Mailinglisten betreiben */

[http://www.mlmmj.org/ mlmmj], angeblich eine Abkürzung für "Mailing List Management Made Joyful", ist ein Programm, mit dem in einem Hostsharing Paket E-Mail-Verteiler realisiert werden kann.

Wer noch nicht weiß, was ein E-Mail-Verteiler machen soll oder wie, lese veilleicht auch den Wikipedia-Artikel:
[http://de.wikipedia.org/wiki/Mailingliste Mailingliste]

Eine leistungsfähigere Alternative zu mlmmj könnte [[Mailman_3_installieren|Mailman 3]] sein.

Diese Anleitung beschreibt die Einrichtung einer Mailingliste für eine Domain in einem Hostsharing-Webspace.

== Voraussetzungen ==

Das Debian Paket [http://packages.debian.org/search?keywords=mlmmj mlmmj] ist auf den Shared-Hosting-Servern bereits installiert. (Wer die Software selbst kompilieren möchte kann aktuellen Source-Code bei [https://codeberg.org/mlmmj/mlmmj|codeberg.org] finden.)

Für den Betrieb der Mailingliste empfiehlt sich das Anlegen eines eigenen Users für diesen Zweck mit hsadmin.

In dieser Anleitung heißt das Paket ''xyz00'' und der für Mailinglisten eingesetzte User ''xyz00-list''.

Die E-Mail-Adresse der einzurichtende Mailing-Liste soll ''discuss@example.org'' sein. Den lokalen Teil dieser Adresse, ''discuss'', ist der Listenname. Der Listenname darf auf keinen Fall das Plus-Zeichen (+) enthalten, weil dies ein Sonderbedeutung für die Listensteuerung hat: ''mlmmj'' wird nämlich Befehle der Abonnenten über erweiterte Adressen annehmen, wie z.B. ''discuss+help@example.org''.

Die Domain ''example.org'' muss dazu bei einem beliebigen User im Paket ''xyz00'' [[aufgeschaltet]] sein. ("Aufgeschaltet" bedeutet, daß diese Domain bei Hostsharing gehostet wird und der Domainname als Verzeichnis /home/pacs/xyz00/*User*/doms/example.org/ erscheint.)

== Einrichtung ==

Ich melde mich über SSH auf der Hostsharing-Console als der Paketuser ''xyz00'' an.

Im Shell kann ich dann durch den Befehl ''hsscript -i'' das Verwaltungswerkzeug [[hsadmin]] interaktiv ausführen:

<syntaxhighlight lang=shell>
xyz00@h03:~$ hsscript -i
Password: *************
xyz00@hsadmin>
</syntaxhighlight>

In ''hsadmin'' werden User und E-Mail-Adresse angelegt.

<syntaxhighlight lang=shell>
xyz00@hsadmin> user.add({set:{name:'xyz00-list',comment:'Mailingliste Discuss',shell:'/bin/bash',password:'geheimnis'}})
xyz00@hsadmin> emailaddress.add({set:{target:'xyz00-list',localpart:'discuss',domain:'example.org'}})
xyz00@hsadmin> bye
</syntaxhighlight>

Mit dem Parameter "target" wird die für diese Adresse eingehende Post zunächst in das Postfach des Users xyz00-list abgelegt.

Für den User xyz00-list lege ich in seinem Heimat-Verzeichnis das Unterverzeichnis <tt>mlmmj</tt> an:

<syntaxhighlight lang=shell>
mkdir /home/pacs/xyz00/users/list/mlmmj
</syntaxhighlight>

Dann lege ich die Mailingliste mit folgendem Kommando an:

<syntaxhighlight lang=shell>
mlmmj-make-ml -L discuss -s /home/pacs/xyz00/users/list/mlmmj
</syntaxhighlight>

Das Skript ''mlmmj-make-ml'' fragt weitere Parameter der Mailingliste ab:

<syntaxhighlight lang=output line>
The Domain for the List? [] : example.org
The emailaddress of the list owner? [postmaster] : webmaster@example.org
For the list texts you can choose between the following languages or
give an absolute path to a directory containing the texts.
Available languages:
cz da de en es fr it nl ru
The path to texts for the list? [en] : de
</syntaxhighlight>

Das skript ''mlmmj-make-ml'' legt daraufhin unter "/home/pacs/xyz00/users/list/mlmmj" ein Verzeichnis "discuss" an, das die Datenstruktur zur Verwaltung der Mailingliste enthält.

Weitere Konfigurationen der Liste erfolgen durch das Anlegen von Dateien im
Verzeichnis "/home/pacs/xyz00/users/list/mlmmj/discuss/control".
Die Konfigurationsmöglichkeiten finden Sie auf der [http://mlmmj.org/docs/tunables/ Internetseite von mlmmj].

Damit mlmmj die Verteilung der Post übernimmt, muß ich im Heimat-Verzeichnis des users xyz00-list die Datei <tt>.forward</tt> mit folgenden Inhalt (INKLUSIVE der Anführungszeichen!) erstellen:

<syntaxhighlight lang=shell>
"|/usr/bin/mlmmj-recieve -L /home/pacs/xyz00/users/list/mlmmj/discuss/"
</syntaxhighlight>

(Ja, ''receive'' schreibt sich mit ''-ei-'', aber mlmmj hält einen symbolischen Link bereit für diejenigen, die in englischer Rechtschreibung unsicher sind:)

<syntaxhighlight lang=shell>
xyz00-list@h03:~$ ls -la /usr/bin/mlmmj-rec*
-rwxr-xr-x 1 root root 27104 Sep 25 2018 /usr/bin/mlmmj-receive
lrwxrwxrwx 1 root root 13 Sep 25 2018 /usr/bin/mlmmj-recieve -> mlmmj-receive
</syntaxhighlight>

Die <tt>.forward</tt>-Datei sorgt dafür, dass eingehende E-Mails an das User-Postfach an das Programm ''mlmmj-recieve'' übergeben werden.

Für regelmäßige Aufgaben der Listen-Managers definiere ich die
[[Cron|crontab]] wie folgt (immer noch als ''xyz00-list''):

xyz00-list@h03:~$ crontab -e

<syntaxhighlight lang=shell line>
MAILTO=webmaster@example.org
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/X11R6/bin
HOME=/home/pacs/xyz00/users/list
SHELL=/bin/bash
LANG=en_US.UTF-8
# m h dom mon dow command
28 */4 * * * /usr/bin/mlmmj-maintd -d /home/pacs/xyz00/users/list/mlmmj -F
</syntaxhighlight>

Zum Schluss rufe ich das Skript mlmmj-sub auf, um die E-Mail-Adressen der gewünschten Abonnenten des Verteilers einzutragen:

<syntaxhighlight lang=shell>
/usr/bin/mlmmj-sub -L /home/pacs/xyz00/users/list/mlmmj/discuss -a klaus.muster@gmx.de -c
/usr/bin/mlmmj-sub -L /home/pacs/xyz00/users/list/mlmmj/discuss -a sabine.beispiel@arcor.de -c
</syntaxhighlight>

Dabei bewirkt "-c", dass der Abonnent eine Begrüßungs-Nachricht erhält. Alternativ kann man "-C" (großes C) angeben: dann muss der Abonnent das Abo durch Antworten auf die Nachricht bestätigen.

== weitere Optionen ==

Noch ein paar Dinge, die Sie möglicherweise einstellen wollen:

Ein Prefix in der Betreffzeile setzen, z.B.: "[discuss]".

<syntaxhighlight lang=shell>
echo "[discuss]" > /home/pacs/xyz00/users/list/mlmmj/discuss/control/prefix
</syntaxhighlight>

Wenn die Liste nur E-Mails von eingetragenen Abonnenten weiterleiten soll:

<syntaxhighlight lang=shell>
touch /home/pacs/xyz00/users/list/mlmmj/discuss/control/subonlypost
</syntaxhighlight>

Damit der Listen-Owner weitere Abonnements bestätigen muss:

<syntaxhighlight lang=shell>
touch /home/pacs/xyz00/users/list/mlmmj/discuss/control/submod
</syntaxhighlight>

Einen "Reply-To:"-Header setzen, damit Antwort-Mails standardmäßig an die Mailing-Liste gehen:

<syntaxhighlight lang=shell>
echo "Reply-To:" > /home/pacs/xyz00/users/list/mlmmj/discuss/control/delheaders
echo "Reply-To: discuss@example.org" > /home/pacs/xyz00/users/list/mlmmj/discuss/control/customheaders
</syntaxhighlight>

Beim Massenversand, z.B. bei Newslettern, nutzen Sie bitte möglichst den dedizierten Postausgangsserver für den Massenversand. Dadurch tragen Sie dazu bei, die Reputation unserer regulären Ausgangsserver aufrechtzuerhalten.

Um dies zu tun, setzen Sie den SMTP-Port entsprechend:

<syntaxhighlight lang=shell>
echo "4025" > /home/pacs/xyz00/users/list/mlmmj/discuss/control/smtpport
</syntaxhighlight>

Weitere Konfigurationsvariante des Ausgangsserver sind unter https://www.hostsharing.net/doc/managed-operations-platform/email/ zu finden.

Weitere Möglichkeiten finden Sie (wie oben bereits angegeben)
auf der [http://mlmmj.org/docs/tunables/ Internetseite von mlmmj].

=== Achtung: DKIM ===

Mlmmj gibt die Möglichkeit, mit '''delheaders''' und '''customheaders''' die Header der durchgeleiteten Mail umfangreich zu ändern. Allerdings tragen Mails heute häufig kryptografische Signaturen der sendenden Mailserver. Eine DKIM-Signatur sichert damit in der Regel die Integrität des Body der Mail sowie der Header ''Subject:'', ''From:'', ''To:'', ''Date:'', ''From'', und oft auch ''Reply-To:''.

Wird zum Beispiel mit einem Prefix das Subject geändert oder ein Footer angehängt, macht dies die DKIM-Signatur ungültig. Das ist für viele Mailprovider ein Grund die Nachricht abzuweisen.

== Zur Konfiguration im Browser ==

Die Original-Distribution von ''mlmmj'' enthält ein paar einfache PHP- und Perl-Skripte. Das sind Beispiele für Subscribe-/Unsubscribe-Formulare, ein Admin-Formular zum Eintragen und Löschen von Abonnements und eine Seite mit der gesamten Listen-Konfiguration.

Wer es sich ansehen möchte:

Als Paket-Admin eine Domain aufschalten:
<syntaxhighlight lang=shell>
hsscript -u xyz00 -e "domain.add({set:{name:'lists.example.org',user:'xyz00-list'}})"
</syntaxhighlight>
Und weiter als "xyz00-list".

Download der neuesten Version der Sourcen von mlmmj von http://mlmmj.org/downloads/ (noch besser: Download des aktuellen Debian-Pakets von [https://packages.debian.org/bookworm/all/mlmmj-php-web-admin/download debian.org]: da sind einige veraltete PHP-Ausdrücke schon herausgepatcht) und diese in einem temporären Verzeichnis entpacken (mit tar oder dpkg-deb).

Unter "/mlmmj-$versionsnummer/contrib/web/php-admin/", oder beim .deb-Paket unter "usr/share/mlmmj-...", findet sich die PHP-Admin-Anwendung. Also ...

* den Inhalt diese Verzeichnisses nach "/home/pacs/xyz00/users/list/doms/lists.example.org/" packen;
* in "/home/pacs/xyz00/users/list/doms/lists.example.org/conf/config.php" die Variable "$topdir" anpassen;
* die Dateien aus "/home/pacs/xyz00/users/list/doms/lists.example.org/htdocs/" nach "/home/pacs/xyz00/users/list/doms/lists.example.org/htdocs-ssl/" verschieben;
* Beim .deb-Paket die config.php, die templates/ und die tunables.pl aus etc/ nach example.org/conf/ verschieben;
* in "/home/pacs/xyz00/users/list/mlmmj" und in "/home/pacs/xyz00/users/list/doms/lists.example.org/htdocs-ssl/" eine ".htaccess" mit folgendem Inhalt ablegen:
<syntaxhighlight lang=apache line>
Require valid-user
AuthType Basic
AuthName "mlmmj web-interface"
AuthUserFile /home/pacs/xyz00/users/list/doms/lists.example.org/etc/htpasswd
</syntaxhighlight>
* Und schließlich die "htpasswd"-Datei anlegen.

cd /home/pacs/xyz00/users/list/doms/lists.example.org/etc/
htpasswd -c htpasswd listadmin

* Ein Passwort angeben.

Nun enthält diese PHP-Anwendung, wenn man sie nicht dem Debian-Paket entnommen hat, leider noch eine Zeile, die schon seit PHP 7 nicht mehr lauffähig ist. Also muß man noch

* in <tt>.../htdocs-ssl/index.php</tt> folgende Änderung vornehmen:
<syntaxhighlight lang=diff line>
@@ -38,4 +38,5 @@
# use scandir to have alphabetical order
foreach (scandir($topdir) as $file) {
- if (!ereg("^\.",$file))
+# ereg obsolete!! Vormals: if (!ereg("^\.",$file))
+ if (!preg_match('/^\./',$file))
{
</syntaxhighlight>
und das Ergebnis auf https://lists.example.org anschauen.

== Mehrere Mailinglisten betreiben ==

Wenn mehrere Mailinglisten in einem Account und mit einer Admin-Oberfläche betrieben werden soll, empfiehlt sich die Nutzung von Procmail für den Aufruf von ''mlmmj'' für die jeweiligen Liste mit ihrem Daten-Verzeichnis.

Dazu trägt man in der Datei <tt>.forward</tt> statt des Aufrufs von ''mlmmj-recieve'' einen Aufruf von ''procmail'' ein:

<syntaxhighlight lang=shell>
|/usr/bin/procmail
</syntaxhighlight>

Die Konfiguration von Procmail kann generisch erfolgen. Dazu legt man eine Datei <tt>.procmailrc</tt> mit folgendem Inhalt ins $HOME des Users:

<syntaxhighlight lang=shell>
SHELL=/bin/sh
HOMEDIR=/home/pacs/xyz00/users/list
MAILDIR=/home/pacs/xyz00/users/list/Maildir
PMDIR=/home/pacs/xyz00/users/list
VERBOSE=yes
LOGFILE=/home/pacs/xyz00/users/list/var/procmail.log
DEFAULT

:0:
* ^X-Original-To: ()\/[^@+]+
|/usr/bin/mlmmj-receive -F -L /home/pacs/xyz00/users/list/mlmmj/${MATCH}/

:0
{ EXITCODE 67 }
</syntaxhighlight>

Bitte dafür sorgen, dass das Verzeichnis ''/home/pacs/xyz00/users/list/var'' existiert.

Der kryptische reguläre Ausdruck hinter dem Header ''X-Original-To:'' passt auf den Beginn der E-Mail-Adresse bis zum ersten ''@''- oder ''+''-Zeichen. In der Variable ''MATCH'' steht also der Name der Mailingliste, d.h. der Name der Verzeichnisses, in dem die Liste verwaltet wird.

Sehr wichtig ist die Zeile ''DEFAULT'' zu Beginn der ''.procmailrc''. Die Variable ''DEFAULT'' wird von ''procmail'' gesetzt. Wir sorgen mit dieser Zeile dafür, dass sie wieder undefiniert ist. Diese Variable wird intern von ''mlmmj'' benutzt, wenn sie gesetzt ist. Das führt in Kombination mit ''procmail'' zu Fehlfunktionen (vgl. Links).

===Groß- und Kleinschreibung===

Achtung, mit der Groß- und Kleinschreibung von Listennamen gibt es bei dieser Procmail-Lösung eine kleine Tücke. Procmail übernimmt in die Variable $MATCH genau die in der X-Original-To-Headerzeile vorgefundene Schreibweise, und diese kann denkbarerweise "Listen-Name" oder "listen-name" oder "Listen-name" sein. <tt>mlmmj</tt> hingegen wird diesen Wert in Unix-Manier mit dem genauen Verzeichnisnamen <tt>${HOME}/mlmmj/listen-name</tt> vergleichen, und bei unterschiedlicher Schreibweise die Mail nicht verteilen.

====Lösung 1====

Eine teilweise Lösung besteht darin, den Listennamen in dem <tt>mlmmj</tt>-Aufruf in der <tt>.procmailrc</tt> in Kleinbuchstaben umzuschreiben. Dann lautet das Rezept so:

<syntaxhighlight lang=shell>
:0:
* ^X-Original-To: ()\/[^@+]+
|/usr/bin/mlmmj-receive -F -L /home/pacs/xyz00/users/list/mlmmj/$(echo ${MATCH} | tr [:upper:] [:lower:])/
</syntaxhighlight>

Der Rest der Datei muß gleich bleiben, wie weiter oben angezeigt.

In diesem Fall müssen aber alle Mailing-Listen ohne Großbuchstaben im Namen angelegt werden!

(Man kann auch in <tt>${HOME}/mlmmj/</tt> durch kleingeschriebene Symlinks großgeschriebene Listennamen ansprechbar machen:

<syntaxhighlight lang=output>
xyz00-list@h02:~$ ls -lA mlmmj/
total 8
-rw-r--r-- 1 xyz00-list xyz00 148 Feb 1 16:56 .htaccess
lrwxrwxrwx 1 xyz00-list xyz00 10 Feb 2 18:01 mitglieder -> Mitglieder
drwxr-xr-x 15 xyz00-list xyz00 4096 Feb 2 16:53 Mitglieder
</syntaxhighlight>

====Lösung 2====

Bash kann bei der Auflösung von Variablen die Groß- und Kleinschreibung manipulieren. (Siehe dazu bei der Zeichenfolge <tt>,,</tt> in <tt>man bash</tt>.) Dann ist <tt>$(echo ${MATCH} | tr [:upper:] [:lower:])</tt> gleichbedeutend mit <tt>${MATCH,,}</tt>. Allerdings braucht procmail einige Überredung, um Bash zu verwenden.

<syntaxhighlight lang=shell>
SHELL=/bin/bash
SHELLMETAS=&|<>~;?*[{
HOMEDIR= ...

...

:0:
* ^X-Original-To: ()\/[^@+]+
|/usr/bin/mlmmj-receive -F -L /home/pacs/xyz00/users/list/mlmmj/${MATCH,,}/
</syntaxhighlight>

Die Tücke ist, daß procmail den in SHELL angegebenen Shell nur dann verwendet, wenn die Befehlszeile eines der in SHELLMETAS angegebenen Zeichen enthält. Und das '|' am Anfang der Zeile zählt dabei nicht! In diesem Beispiel ist es das Zeichen <tt>{</tt>, das den Einsatz von Bash auslöst.

Beide Lösungen scheinen zu funktionieren; Angabe ohne Gewähr.

== Links ==

* http://mlmmj.org/ Projektseite
* https://codeberg.org/mlmmj mlmmj auf Codeberg
* https://github.com/tchapi/mlmmj-simple-web-interface ein Admin-Interface in NodeJS
* [https://web.archive.org/web/20221228110514/https://www.tablix.org/~avian/blog/archives/2010/04/the_faulty_default/ https://www.tablix.org/~avian/blog/archives/2010/04/the_faulty_default/ (via web.archive.org)] Nutzung von mlmmj in Verbindung mit Procmail
* [https://gist.github.com/kboss/7c9593f0fd9219406226c4f11256b98a Einfaches Python-Script zum Massenimport aus einem Texfile.] Geht bestimmt auch eleganter mit purem Bash
* Ein Self-Service zum Subscriben/Unsubscriben lässt sich in Form von Mail-to-Links in Webseiten einbinden. Beispiele gibt es bei Hostsharing für die öffentlichen "public"-Mailinglisten: https://www.hostsharing.net/lists/public-discussion/ . Alternativ auf https://github.com/hblasum/mlmmj-php-web-simplified ein Webfrontend mit dem sich Benutzerinnen und Benutzer selbst ein-/austragen können (Vereinfachung von mlmmj-php-web von Christoph Thiel).

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Software]]
[[Kategorie:Mailinglisten]]
[[Kategorie:E-Mail]]

Mlmmj

2024-07-23T10:13:06Z

Hsh-milanihl: /* weitere Optionen */

[http://www.mlmmj.org/ mlmmj], angeblich eine Abkürzung für "Mailing List Management Made Joyful", ist ein Programm, mit dem in einem Hostsharing Paket E-Mail-Verteiler realisiert werden kann.

Wer noch nicht weiß, was ein E-Mail-Verteiler machen soll oder wie, lese veilleicht auch den Wikipedia-Artikel:
[http://de.wikipedia.org/wiki/Mailingliste Mailingliste]

Eine leistungsfähigere Alternative zu mlmmj könnte [[Mailman_3_installieren|Mailman 3]] sein.

Diese Anleitung beschreibt die Einrichtung einer Mailingliste für eine Domain in einem Hostsharing-Webspace.

== Voraussetzungen ==

Das Debian Paket [http://packages.debian.org/search?keywords=mlmmj mlmmj] ist auf den Shared-Hosting-Servern bereits installiert. (Wer die Software selbst kompilieren möchte kann aktuellen Source-Code bei [https://codeberg.org/mlmmj/mlmmj|codeberg.org] finden.)

Für den Betrieb der Mailingliste empfiehlt sich das Anlegen eines eigenen Users für diesen Zweck mit hsadmin.

In dieser Anleitung heißt das Paket ''xyz00'' und der für Mailinglisten eingesetzte User ''xyz00-list''.

Die E-Mail-Adresse der einzurichtende Mailing-Liste soll ''discuss@example.org'' sein. Den lokalen Teil dieser Adresse, ''discuss'', ist der Listenname. Der Listenname darf auf keinen Fall das Plus-Zeichen (+) enthalten, weil dies ein Sonderbedeutung für die Listensteuerung hat: ''mlmmj'' wird nämlich Befehle der Abonnenten über erweiterte Adressen annehmen, wie z.B. ''discuss+help@example.org''.

Die Domain ''example.org'' muss dazu bei einem beliebigen User im Paket ''xyz00'' [[aufgeschaltet]] sein. ("Aufgeschaltet" bedeutet, daß diese Domain bei Hostsharing gehostet wird und der Domainname als Verzeichnis /home/pacs/xyz00/*User*/doms/example.org/ erscheint.)

== Einrichtung ==

Ich melde mich über SSH auf der Hostsharing-Console als der Paketuser ''xyz00'' an.

Im Shell kann ich dann durch den Befehl ''hsscript -i'' das Verwaltungswerkzeug [[hsadmin]] interaktiv ausführen:

<syntaxhighlight lang=shell>
xyz00@h03:~$ hsscript -i
Password: *************
xyz00@hsadmin>
</syntaxhighlight>

In ''hsadmin'' werden User und E-Mail-Adresse angelegt.

<syntaxhighlight lang=shell>
xyz00@hsadmin> user.add({set:{name:'xyz00-list',comment:'Mailingliste Discuss',shell:'/bin/bash',password:'geheimnis'}})
xyz00@hsadmin> emailaddress.add({set:{target:'xyz00-list',localpart:'discuss',domain:'example.org'}})
xyz00@hsadmin> bye
</syntaxhighlight>

Mit dem Parameter "target" wird die für diese Adresse eingehende Post zunächst in das Postfach des Users xyz00-list abgelegt.

Für den User xyz00-list lege ich in seinem Heimat-Verzeichnis das Unterverzeichnis <tt>mlmmj</tt> an:

<syntaxhighlight lang=shell>
mkdir /home/pacs/xyz00/users/list/mlmmj
</syntaxhighlight>

Dann lege ich die Mailingliste mit folgendem Kommando an:

<syntaxhighlight lang=shell>
mlmmj-make-ml -L discuss -s /home/pacs/xyz00/users/list/mlmmj
</syntaxhighlight>

Das Skript ''mlmmj-make-ml'' fragt weitere Parameter der Mailingliste ab:

<syntaxhighlight lang=output line>
The Domain for the List? [] : example.org
The emailaddress of the list owner? [postmaster] : webmaster@example.org
For the list texts you can choose between the following languages or
give an absolute path to a directory containing the texts.
Available languages:
cz da de en es fr it nl ru
The path to texts for the list? [en] : de
</syntaxhighlight>

Das skript ''mlmmj-make-ml'' legt daraufhin unter "/home/pacs/xyz00/users/list/mlmmj" ein Verzeichnis "discuss" an, das die Datenstruktur zur Verwaltung der Mailingliste enthält.

Weitere Konfigurationen der Liste erfolgen durch das Anlegen von Dateien im
Verzeichnis "/home/pacs/xyz00/users/list/mlmmj/discuss/control".
Die Konfigurationsmöglichkeiten finden Sie auf der [http://mlmmj.org/docs/tunables/ Internetseite von mlmmj].

Damit mlmmj die Verteilung der Post übernimmt, muß ich im Heimat-Verzeichnis des users xyz00-list die Datei <tt>.forward</tt> mit folgenden Inhalt (INKLUSIVE der Anführungszeichen!) erstellen:

<syntaxhighlight lang=shell>
"|/usr/bin/mlmmj-recieve -L /home/pacs/xyz00/users/list/mlmmj/discuss/"
</syntaxhighlight>

(Ja, ''receive'' schreibt sich mit ''-ei-'', aber mlmmj hält einen symbolischen Link bereit für diejenigen, die in englischer Rechtschreibung unsicher sind:)

<syntaxhighlight lang=shell>
xyz00-list@h03:~$ ls -la /usr/bin/mlmmj-rec*
-rwxr-xr-x 1 root root 27104 Sep 25 2018 /usr/bin/mlmmj-receive
lrwxrwxrwx 1 root root 13 Sep 25 2018 /usr/bin/mlmmj-recieve -> mlmmj-receive
</syntaxhighlight>

Die <tt>.forward</tt>-Datei sorgt dafür, dass eingehende E-Mails an das User-Postfach an das Programm ''mlmmj-recieve'' übergeben werden.

Für regelmäßige Aufgaben der Listen-Managers definiere ich die
[[Cron|crontab]] wie folgt (immer noch als ''xyz00-list''):

xyz00-list@h03:~$ crontab -e

<syntaxhighlight lang=shell line>
MAILTO=webmaster@example.org
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/X11R6/bin
HOME=/home/pacs/xyz00/users/list
SHELL=/bin/bash
LANG=en_US.UTF-8
# m h dom mon dow command
28 */4 * * * /usr/bin/mlmmj-maintd -d /home/pacs/xyz00/users/list/mlmmj -F
</syntaxhighlight>

Zum Schluss rufe ich das Skript mlmmj-sub auf, um die E-Mail-Adressen der gewünschten Abonnenten des Verteilers einzutragen:

<syntaxhighlight lang=shell>
/usr/bin/mlmmj-sub -L /home/pacs/xyz00/users/list/mlmmj/discuss -a klaus.muster@gmx.de -c
/usr/bin/mlmmj-sub -L /home/pacs/xyz00/users/list/mlmmj/discuss -a sabine.beispiel@arcor.de -c
</syntaxhighlight>

Dabei bewirkt "-c", dass der Abonnent eine Begrüßungs-Nachricht erhält. Alternativ kann man "-C" (großes C) angeben: dann muss der Abonnent das Abo durch Antworten auf die Nachricht bestätigen.

== weitere Optionen ==

Noch ein paar Dinge, die Sie möglicherweise einstellen wollen:

Ein Prefix in der Betreffzeile setzen, z.B.: "[discuss]".

<syntaxhighlight lang=shell>
echo "[discuss]" > /home/pacs/xyz00/users/list/mlmmj/discuss/control/prefix
</syntaxhighlight>

Wenn die Liste nur E-Mails von eingetragenen Abonnenten weiterleiten soll:

<syntaxhighlight lang=shell>
touch /home/pacs/xyz00/users/list/mlmmj/discuss/control/subonlypost
</syntaxhighlight>

Damit der Listen-Owner weitere Abonnements bestätigen muss:

<syntaxhighlight lang=shell>
touch /home/pacs/xyz00/users/list/mlmmj/discuss/control/submod
</syntaxhighlight>

Einen "Reply-To:"-Header setzen, damit Antwort-Mails standardmäßig an die Mailing-Liste gehen:

<syntaxhighlight lang=shell>
echo "Reply-To:" > /home/pacs/xyz00/users/list/mlmmj/discuss/control/delheaders
echo "Reply-To: discuss@example.org" > /home/pacs/xyz00/users/list/mlmmj/discuss/control/customheaders
</syntaxhighlight>

Beim Massenversand, z.B. bei Newslettern, nutzen Sie bitte möglichst den dedizierten Postausgangsserver für den Massenversand. Dadurch tragen Sie dazu bei, die Reputation unserer regulären Ausgangsserver aufrechtzuerhalten.

Um dies zu tun, setzen Sie den SMTP-Port entsprechend:

<syntaxhighlight lang=shell>
echo "4025" > /home/pacs/xyz00/users/list/mlmmj/discuss/control/smtpport
</syntaxhighlight>

Weitere Konfigurationsvariante des Ausgangsserver sind unter https://www.hostsharing.net/doc/managed-operations-platform/email/ zu finden.

Weitere Möglichkeiten finden Sie (wie oben bereits angegeben)
auf der [http://mlmmj.org/docs/tunables/ Internetseite von mlmmj].

=== Achtung: DKIM ===

Mlmmj gibt die Möglichkeit, mit '''delheaders''' und '''customheaders''' die Header der durchgeleiteten Mail umfangreich zu ändern. Allerdings tragen Mails heute häufig kryptografische Signaturen der sendenden Mailserver. Eine DKIM-Signatur sichert damit in der Regel die Integrität des Body der Mail sowie der Header ''Subject:'', ''From:'', ''To:'', ''Date:'', ''From'', und oft auch ''Reply-To:''.

Wird zum Beispiel mit einem Prefix das Subject geändert oder ein Footer angehängt, macht dies die DKIM-Signatur ungültig. Das ist für viele Mailprovider ein Grund die Nachricht abzuweisen.

== Zur Konfiguration im Browser ==

Die Original-Distribution von ''mlmmj'' enthält ein paar einfache PHP- und Perl-Skripte. Das sind Beispiele für Subscribe-/Unsubscribe-Formulare, ein Admin-Formular zum Eintragen und Löschen von Abonnements und eine Seite mit der gesamten Listen-Konfiguration.

Wer es sich ansehen möchte:

Als Paket-Admin eine Domain aufschalten:
<syntaxhighlight lang=shell>
hsscript -u xyz00 -e "domain.add({set:{name:'lists.example.org',user:'xyz00-list'}})"
</syntaxhighlight>
Und weiter als "xyz00-list".

Download der neuesten Version der Sourcen von mlmmj von http://mlmmj.org/downloads/ (noch besser: Download des aktuellen Debian-Pakets von [https://packages.debian.org/bookworm/all/mlmmj-php-web-admin/download debian.org]: da sind einige veraltete PHP-Ausdrücke schon herausgepatcht) und diese in einem temporären Verzeichnis entpacken (mit tar oder dpkg-deb).

Unter "/mlmmj-$versionsnummer/contrib/web/php-admin/", oder beim .deb-Paket unter "usr/share/mlmmj-...", findet sich die PHP-Admin-Anwendung. Also ...

* den Inhalt diese Verzeichnisses nach "/home/pacs/xyz00/users/list/doms/lists.example.org/" packen;
* in "/home/pacs/xyz00/users/list/doms/lists.example.org/conf/config.php" die Variable "$topdir" anpassen;
* die Dateien aus "/home/pacs/xyz00/users/list/doms/lists.example.org/htdocs/" nach "/home/pacs/xyz00/users/list/doms/lists.example.org/htdocs-ssl/" verschieben;
* Beim .deb-Paket die config.php, die templates/ und die tunables.pl aus etc/ nach example.org/conf/ verschieben;
* in "/home/pacs/xyz00/users/list/mlmmj" und in "/home/pacs/xyz00/users/list/doms/lists.example.org/htdocs-ssl/" eine ".htaccess" mit folgendem Inhalt ablegen:
<syntaxhighlight lang=apache line>
Require valid-user
AuthType Basic
AuthName "mlmmj web-interface"
AuthUserFile /home/pacs/xyz00/users/list/doms/lists.example.org/etc/htpasswd
</syntaxhighlight>
* Und schließlich die "htpasswd"-Datei anlegen.

cd /home/pacs/xyz00/users/list/doms/lists.example.org/etc/
htpasswd -c htpasswd listadmin

* Ein Passwort angeben.

Nun enthält diese PHP-Anwendung, wenn man sie nicht dem Debian-Paket entnommen hat, leider noch eine Zeile, die schon seit PHP 7 nicht mehr lauffähig ist. Also muß man noch

* in <tt>.../htdocs-ssl/index.php</tt> folgende Änderung vornehmen:
<syntaxhighlight lang=diff line>
@@ -38,4 +38,5 @@
# use scandir to have alphabetical order
foreach (scandir($topdir) as $file) {
- if (!ereg("^\.",$file))
+# ereg obsolete!! Vormals: if (!ereg("^\.",$file))
+ if (!preg_match('/^\./',$file))
{
</syntaxhighlight>
und das Ergebnis auf https://lists.example.org anschauen.

== Mehrere Mailinglisten betreiben ==

Wenn mehrere Mailinglisten in einem Account und mit einer Admin-Oberfläche betrieben werden soll, empfiehlt sich die Nutzung von Procmail für den Aufruf von ''mlmmj'' für die jeweiligen Liste mit ihrem Daten-Verzeichnis.

Dazu trägt man in der Datei <tt>.forward</tt> statt des Aufrufs von ''mlmmj-recieve'' einen Aufruf von ''procmail'' ein:

|/usr/bin/procmail

Die Konfiguration von Procmail kann generisch erfolgen. Dazu legt man eine Datei <tt>.procmailrc</tt> mit folgendem Inhalt ins $HOME des Users:

SHELL=/bin/sh
HOMEDIR=/home/pacs/xyz00/users/list
MAILDIR=/home/pacs/xyz00/users/list/Maildir
PMDIR=/home/pacs/xyz00/users/list
VERBOSE=yes
LOGFILE=/home/pacs/xyz00/users/list/var/procmail.log
DEFAULT

:0:
* ^X-Original-To: ()\/[^@+]+
|/usr/bin/mlmmj-receive -F -L /home/pacs/xyz00/users/list/mlmmj/${MATCH}/

:0
{ EXITCODE 67 }

Bitte dafür sorgen, dass das Verzeichnis ''/home/pacs/xyz00/users/list/var'' existiert.

Der kryptische reguläre Ausdruck hinter dem Header ''X-Original-To:'' passt auf den Beginn der E-Mail-Adresse bis zum ersten ''@''- oder ''+''-Zeichen. In der Variable ''MATCH'' steht also der Name der Mailingliste, d.h. der Name der Verzeichnisses, in dem die Liste verwaltet wird.

Sehr wichtig ist die Zeile ''DEFAULT'' zu Beginn der ''.procmailrc''. Die Variable ''DEFAULT'' wird von ''procmail'' gesetzt. Wir sorgen mit dieser Zeile dafür, dass sie wieder undefiniert ist. Diese Variable wird intern von ''mlmmj'' benutzt, wenn sie gesetzt ist. Das führt in Kombination mit ''procmail'' zu Fehlfunktionen (vgl. Links).

===Groß- und Kleinschreibung===

Achtung, mit der Groß- und Kleinschreibung von Listennamen gibt es bei dieser Procmail-Lösung eine kleine Tücke. Procmail übernimmt in die Variable $MATCH genau die in der X-Original-To-Headerzeile vorgefundene Schreibweise, und diese kann denkbarerweise "Listen-Name" oder "listen-name" oder "Listen-name" sein. <tt>mlmmj</tt> hingegen wird diesen Wert in Unix-Manier mit dem genauen Verzeichnisnamen <tt>${HOME}/mlmmj/listen-name</tt> vergleichen, und bei unterschiedlicher Schreibweise die Mail nicht verteilen.

====Lösung 1====

Eine teilweise Lösung besteht darin, den Listennamen in dem <tt>mlmmj</tt>-Aufruf in der <tt>.procmailrc</tt> in Kleinbuchstaben umzuschreiben. Dann lautet das Rezept so:

:0:
* ^X-Original-To: ()\/[^@+]+
|/usr/bin/mlmmj-receive -F -L /home/pacs/xyz00/users/list/mlmmj/$(echo ${MATCH} | tr [:upper:] [:lower:])/

Der Rest der Datei muß gleich bleiben, wie weiter oben angezeigt.

In diesem Fall müssen aber alle Mailing-Listen ohne Großbuchstaben im Namen angelegt werden!

(Man kann auch in <tt>${HOME}/mlmmj/</tt> durch kleingeschriebene Symlinks großgeschriebene Listennamen ansprechbar machen:

xyz00-list@h02:~$ ls -lA mlmmj/
total 8
-rw-r--r-- 1 xyz00-list xyz00 148 Feb 1 16:56 .htaccess
lrwxrwxrwx 1 xyz00-list xyz00 10 Feb 2 18:01 mitglieder -> Mitglieder
drwxr-xr-x 15 xyz00-list xyz00 4096 Feb 2 16:53 Mitglieder

====Lösung 2====

Bash kann bei der Auflösung von Variablen die Groß- und Kleinschreibung manipulieren. (Siehe dazu bei der Zeichenfolge <tt>,,</tt> in <tt>man bash</tt>.) Dann ist <tt>$(echo ${MATCH} | tr [:upper:] [:lower:])</tt> gleichbedeutend mit <tt>${MATCH,,}</tt>. Allerdings braucht procmail einige Überredung, um Bash zu verwenden.

SHELL=/bin/bash
SHELLMETAS=&|<>~;?*[{
HOMEDIR= ...

...

:0:
* ^X-Original-To: ()\/[^@+]+
|/usr/bin/mlmmj-receive -F -L /home/pacs/xyz00/users/list/mlmmj/${MATCH,,}/

Die Tücke ist, daß procmail den in SHELL angegebenen Shell nur dann verwendet, wenn die Befehlszeile eines der in SHELLMETAS angegebenen Zeichen enthält. Und das '|' am Anfang der Zeile zählt dabei nicht! In diesem Beispiel ist es das Zeichen <tt>{</tt>, das den Einsatz von Bash auslöst.

Beide Lösungen scheinen zu funktionieren; Angabe ohne Gewähr.

== Links ==

* http://mlmmj.org/ Projektseite
* https://codeberg.org/mlmmj mlmmj auf Codeberg
* https://github.com/tchapi/mlmmj-simple-web-interface ein Admin-Interface in NodeJS
* [https://web.archive.org/web/20221228110514/https://www.tablix.org/~avian/blog/archives/2010/04/the_faulty_default/ https://www.tablix.org/~avian/blog/archives/2010/04/the_faulty_default/ (via web.archive.org)] Nutzung von mlmmj in Verbindung mit Procmail
* [https://gist.github.com/kboss/7c9593f0fd9219406226c4f11256b98a Einfaches Python-Script zum Massenimport aus einem Texfile.] Geht bestimmt auch eleganter mit purem Bash
* Ein Self-Service zum Subscriben/Unsubscriben lässt sich in Form von Mail-to-Links in Webseiten einbinden. Beispiele gibt es bei Hostsharing für die öffentlichen "public"-Mailinglisten: https://www.hostsharing.net/lists/public-discussion/ . Alternativ auf https://github.com/hblasum/mlmmj-php-web-simplified ein Webfrontend mit dem sich Benutzerinnen und Benutzer selbst ein-/austragen können (Vereinfachung von mlmmj-php-web von Christoph Thiel).

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Software]]
[[Kategorie:Mailinglisten]]
[[Kategorie:E-Mail]]

Vorlage:Kerndoku

2024-07-15T11:48:14Z

Hsh-milanihl: /* Verwendung */

<noinclude>
Diese Vorlage dient dazu einen Verweis auf eine Seite in der Kerndoku zu setzen.

== Verwendung ==

Um einen Hinweis auf die Kerndoku zu setzen, gib einfach am Anfang der Seite folgendes ein:

<syntaxhighlight lang=twig>{{Kerndoku|Link|Optionaler Text}}</syntaxhighlight>

Dadurch erscheint folgender Hinweis:
</noinclude>

{{Textkasten|gruen|Dieses Thema in der technischen Dokumentation ([https://doc.hostsharing.net/ Kerndoku])| {{{1}}}
{{{2|}}}
}}

<noinclude>
[[Kategorie:Textkasten]]
[[Kategorie:Vorlage]]
</noinclude>

Textgestaltung

2024-07-15T11:44:25Z

Hsh-milanihl:

Diese Seite erklärt, wie du in Wiki-Syntax Überschriften, Listen und Absätze erzeugst und Textstellen formatierst. Durch Überschriften wird ein automatisches Inhaltsverzeichnis erzeugt. Hier ist die Hilfe für [[Hilfe:Tabellen|Tabellen]]

{| border="1" cellpadding="2" cellspacing="0"
!Wie es dargestellt wird
!Was du schreibst
|-
|''Kursiv''<br/>
'''fett'''<br/>
'''''kursiv und fett'''''
| style="background:#EEEEEE;" | <syntaxhighlight lang=html line>''Kursiv''
'''fett'''
'''''kursiv und fett'''''
</syntaxhighlight>
<small>(Das sind mehrere Apostrophe [ganz genau genommen Zeichen für Fuß, keine Anführungszeichen und auch keine Akzente - drück Shift+#.)</small>
|-
| Du kannst Wörter <strike>durchstreichen</strike> oder auch so<br/>
<s>durchstreichen</s> und <u>unterstreichen</u>.
| style="background:#EEEEEE;" |
<syntaxhighlight lang=html line>Du kannst Wörter <strike>durchstreichen</strike> oder auch so

<s>durchstreichen</s> und <u>unterstreichen</u>.</syntaxhighlight>
|-
|

== Neuer Abschnitt ==
=== Unterabschnitt ===
==== Unter-Unterabschnitt ====
| style="background:#EEEEEE;" |
<syntaxhighlight lang=markdown line>
== Neuer Abschnitt ==
=== Unterabschnitt ===
==== Unter-Unterabschnitt ====
</syntaxhighlight>
|-
| Ein einzelner Zeilenumbruch wird ignoriert.

Aber durch eine leere Zeile wird ein neuer Absatz erzeugt.

Ein Zeilenumbruch wird durch<br/>erzwungen. ''Dies sollte jedoch vermieden werden.''
| style="background:#EEEEEE;" |
<syntaxhighlight lang=html line>Ein einzelner Zeilenumbruch
wird ignoriert.

Aber durch eine leere Zeile wird ein neuer
Absatz erzeugt.

Ein Zeilenumbruch wird durch<br/>erzwungen.
</syntaxhighlight>
|-
|
* Listen sind praktisch:
** sie sorgen für Struktur
** sie sehen sauber aus
*** Man kann sie schachteln
* Das Listenzeichen (der Stern)<br/>muss das
erste Zeichen der Zeile sein.
| style="background:#EEEEEE;" |
<syntaxhighlight lang=html line>
* Listen sind praktisch:
** sie sorgen für Struktur
** sie sehen sauber aus
*** Man kann sie schachteln
* Das Listenzeichen (der Stern)<br/>muss das
erste Zeichen der Zeile sein.
</syntaxhighlight>
|-
|
# Nummerierte Listen sind auch gut
## Genau so übersichtlich
## und einfach zu erzeugen
| style="background:#EEEEEE;" |
<syntaxhighlight lang=markdown line>
# Nummerierte Listen sind auch gut
## Genau so übersichtlich
## und einfach zu erzeugen
</syntaxhighlight>
|-
|
; Definitionsliste : Liste von Definitionen
; Begriff : Definition des Begriffs
| style="background:#EEEEEE;" |
<syntaxhighlight lang=html line>
; Definitionsliste : Liste von Definitionen
; Begriff : Definition des Begriffs
</syntaxhighlight>
|-
|
:Zeilen können
::eingerückt werden
:::sogar mehrfach
| style="background:#EEEEEE;" |
<syntaxhighlight lang=html line>
:Zeilen können
::eingerückt werden
:::sogar mehrfach
</syntaxhighlight>
|-
|
* Man kann Listen
*: und Einrückungen
*:: sogar mischen
*# und verschachteln
*#* so wie hier

| style="background:#EEEEEE;" | <syntaxhighlight lang=html line>
* Man kann Listen
*: und Einrückungen
*:: sogar mischen
*# und verschachteln
*#* so wie hier
</syntaxhighlight>
|-
|
Wenn eine Zeile mit einem Leerzeichen beginnt,

wird sie genau so formatiert
wie sie geschrieben wurde.
Dabei wird ein Zeichensatz mit fester
Zeichenbreite verwendet. Die
Zeilen werden nicht umgebrochen.
Das ist nützlich um:
* vorformatierten Text einzufügen
* Programmcode oder Algorithmen anzuzeigen
* Diagramme mit Zeichen zu gestalten
* einfache Tabellen zu erzeugen

VORSICHT: Wenn du die Zeilen zu lang machst,
erzeugst du dadurch eine sehr breite Seite,
die dadurch schlecht zu lesen ist.

| style="background:#EEEEEE;" | <syntaxhighlight lang=html line>
Wenn eine Zeile mit einem Leerzeichen beginnt,
wird sie genau so formatiert
wie sie geschrieben wurde.
Dabei wird ein Zeichensatz mit fester
Zeichenbreite verwendet. Die
Zeilen werden nicht umgebrochen.
Das ist nützlich um:
* vorformatierten Text einzufügen
* Programmcode oder Algorithmen anzuzeigen
* Diagramme mit Zeichen zu gestalten
* einfache Tabellen zu erzeugen

VORSICHT: Wenn du die Zeilen zu lang machst,
erzeugst du dadurch eine sehr breite Seite,
die dadurch schlecht zu lesen ist.</syntaxhighlight>

|-
|<div align="center">Zentrierter Text.</div>
| style="background:#EEEEEE;" | <syntaxhighlight lang=html line><div align="center">Zentrierter Text.</div></syntaxhighlight>
|-
|<div align="right">Rechtsbündiger Text.</div>
| style="background:#EEEEEE;" | <syntaxhighlight lang=html line><div align="right">Rechtsbündiger Text.</div></syntaxhighlight>
|-
|
Eine waagrechte Linie: Text davor
----

und danach.
| style="background:#EEEEEE;" | <syntaxhighlight lang=html line>Eine waagrechte Linie: Text davor
----
und danach.
</syntaxhighlight>
|-
| Etwas Text und ein 
| style="background:#EEEEEE;" | <syntaxhighlight lang=html line>Etwas Text und ein </syntaxhighlight>
|-
| <nowiki>[[Wiki-Syntax]] die nicht [[Beachtung|beachtet]] wird</nowiki>
| style="background:#EEEEEE;" | <syntaxhighlight lang=html line><nowiki>[[Wiki-Syntax]] die nicht
[[Beachtung|beachtet]] wird</nowiki></syntaxhighlight>
|}

[[Kategorie:Hilfe]]

AWStats installieren

2024-07-15T11:37:55Z

Hsh-milanihl:

== AWStats ==

AWStats ist ein Tool zur graphischen Auswertung von Logfiles.

mehr Infos unter http://www.awstats.org/

=== Vorarbeiten ===

Als Paketadmin die Logfiles per Eintrag in die config.ini auf die entsprechende Domain verteilen (http_log_directory = domain)

siehe [[Logging#Konfigurationsm.C3.B6glichkeiten|Traffic logs]].

In HSAdmin (https://admin.hostsharing.net) wird eine Domain mit dem Namen stats.example.com angelegt und bei "Apache-Scripting-Optionen" wird die Option "CGI-Funktion" aktiviert.

=== Download und Entpacken ===

Login als Domainadmin, in unserem Fall heißt dieser xyz00-doms. Auf http://www.awstats.org/#DOWNLOAD findet sich die aktuelle Version. In unserem Beispiel verwenden wir die Version 7.9 und laden sie direkt mit wget ins Home-Verzeichnis:
<syntaxhighlight lang=shell>
xyz00-doms:~$ wget http://prdownloads.sourceforge.net/awstats/awstats-7.9.tar.gz
</syntaxhighlight>
Datei entpacken:
<syntaxhighlight lang=shell>
xyz00-doms:~$ tar -xvzf awstats-7.9.tar.gz
</syntaxhighlight>
Die entpackten Ordner verteilen:
<syntaxhighlight lang=shell>
cd doms/stats.example.com
mv ~/awstats-7.9/wwwroot/cgi-bin/ cgi-ssl/awstats
mv ~/awstats-7.9/wwwroot/icon htdocs-ssl
mv ~/awstats-7.9/wwwroot/js htdocs-ssl
</syntaxhighlight>
Der Rest kann wieder gelöscht werden:
<syntaxhighlight lang=shell>
rm ~/awstats-7.9.tar.gz
rm -rf ~/awstats-7.9
</syntaxhighlight>
Verzeichnis anlegen, in das awstats seine Daten schreiben kann:
<syntaxhighlight lang=shell>
mkdir ~/aw_data
</syntaxhighlight>

=== Konfiguration ===
Config-Datei anlegen:
<syntaxhighlight lang=shell>
cd ~/doms/stats.example.com/cgi-ssl/awstats
cp awstats.model.conf awstats.example.com.conf
</syntaxhighlight>

Config-Datei zum Editieren öffnen, z.b. mit nano:
<syntaxhighlight lang=shell>
nano awstats.example.com.conf
</syntaxhighlight>

Folgende Einträge sind anzupassen:

* LogFile="gzip -cd /home/doms/example.com/var/web-example.com-%YYYY-0%MM-0%DD-0*|"
** oder wenn die Webseite über www läuft:
** LogFile="gzip -cd /home/doms/example.com/var/web-www.example.com-%YYYY-0%MM-0%DD-0*|"
* SiteDomain="example.com"
** oder wenn die Webseite über www läuft: SiteDomain="www.example.com"
* HostAliases="localhost 127.0.0.1 REGEX[example\.com$]"
* DirData="/home/pacs/xyz00/aw_data/"
* DirCgi="/cgi-bin/awstats"
* Lang="de"

Die wichtigsten weiteren Möglichkeiten:

* Um über den Browser eine Jahressortierung zu ermöglichen:
<syntaxhighlight lang=ini>
AllowFullYearView=3
</syntaxhighlight>
* Um Client-Informationen über Javascript auszulesen:
<syntaxhighlight lang=ini>
o MiscTrackerUrl="/js/awstats_misc_tracker.js"
o ShowScreenSizeStats=1
o ShowMiscStats=anjdfrqwp
</syntaxhighlight>
(Hinweis: dazu muss die Startseite (index.html) innerhalb des body-tags um folgenden Eintrag ergänzt werden:
<syntaxhighlight lang=html line>
<script language=javascript src="/js/awstats_misc_tracker.js"></script>
<noscript><img src="/js/awstats_misc_tracker.js?nojs=y" height=0 width=0 border=0 style="display: none"></noscript>
</syntaxhighlight>

Weiterführende Informationen zu den Einträgen in der Config-Datei sind hier zu finden: http://awstats.sourceforge.net/docs/awstats_config.html

Config-Datei unter cgi-ssl/awstats/awstats.example.com.conf abspeichern.

=== Rechtevergabe ===

Folgende Rechte müssen wir noch setzen:
<syntaxhighlight lang=shell>
Prüfen:
cd doms/example.com
chmod 755 cgi-ssl/awstats/lang
chmod 755 cgi-ssl/awstats/lib
chmod 755 cgi-ssl/awstats/plugins
chmod 755 cgi-ssl/awstats/awstats.pl
chmod 755 cgi-ssl/awstats/awredir.pl

Ändern:
chmod 644 cgi-ssl/awstats/awstats.example.com.conf
chmod 777 ~/aw_data
</syntaxhighlight>

=== Massen-Import der Tage vor Inbetriebnahme von awstats ===
<syntaxhighlight lang=shell>
mkdir ~/tmp
cd ~/tmp
cp ~/var/web-www.example.org-* .
for f in web*; do gunzip $f; done
for f in *.log; do export domain=example.org; $HOME/doms/example.com/cgi-ssl/awstats/awstats.pl -config=$domain -update -LogFile=$f; done
rm -Rf ~/tmp/*.log
</syntaxhighlight>
=== Seite einrichten ===

Die folgende index.html Datei ermöglicht einen einfachen Zugriff auf die AWStats Oberfläche:

<syntaxhighlight lang=shell>
nano ~/doms/stats.example.org/htdocs-ssl/index.html
</syntaxhighlight>

mit diesem Inhalt:
<syntaxhighlight lang=html line>
<html>
<body>
<h1>AWStats</h1>
<a href='/awstats/awstats.pl?config=example.com'>example.com</a><br/>
<a href='/awstats/awstats.pl?config=example2.com'>example2.com</a><br/>
</body>
</html>
</syntaxhighlight>

Im gleichen Verzeichnis sollte noch eine htaccess Datei liegen:
<syntaxhighlight lang=shell>
nano ~/doms/stats.example.com/htdocs-ssl/.htaccess
</syntaxhighlight>

mit diesem Inhalt:

<syntaxhighlight lang=apache line>
DirectoryIndex index.html
RewriteEngine on
RewriteBase /
RewriteRule ^awstats/(.*) https://stats.example.com/cgi-bin/awstats/$1 [proxy,last]
</syntaxhighlight>

=== Statistik Seite mit Passwort schützen ===

Dann sollte die Seite noch mit einem Passwort geschützt werden: siehe die Erklärung auf [[.htaccess#Passwortschutz_für_Dateien|.htaccess Passwortschutz für Dateien]]

=== Cronjob für zukünftige automatische Ausführung einrichten ===

Skript anlegen:

<syntaxhighlight lang=shell>
mkdir ~/bin
nano ~/bin/awstats.sh
</syntaxhighlight>

Diesen Inhalt einfügen, ggfs. mehrere Domains einfügen:

<syntaxhighlight lang=shell line>
#!/bin/bash

function processWebLogs
{
domain=$1
$HOME/doms/stats.example.com/cgi-ssl/awstats/awstats.pl -config=$domain -update
}

processWebLogs example.com
# processWebLogs example.org
</syntaxhighlight>

Dann das Skript ausführbar machen und den cronjob anlegen:

<syntaxhighlight lang=shell>
chmod a+x ~/bin/awstats.sh
crontab -e

# Folgende Zeile einfügen:

33 3 * * * $HOME/bin/awstats.sh >> /dev/null 2>&1
</syntaxhighlight>

Es muss eine Zeit nach 2 Uhr Nachts genommen werden, weil gegen 1:45 Uhr die Log Dateien rotiert werden.

== Weitere WebStatistik Tools bei HS ==

* [[AWStats_installieren|AWStat]]
* [[Goaccess]]
* [[Matomo Installieren|Matomo]]

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:WebStatistik]]
[[Kategorie:Software]]

Visitors

2024-07-15T11:21:55Z

Hsh-milanihl:

== Visitors ==

{{Textkasten|rot|Achtung:|Das Programm Visitors ist nicht mehr installiert und wird nicht mehr gepflegt.}}

Das Programm (Vs. 0.7) ist bei uns Zentral installiert.
* http://www.hping.org/visitors/

=== Aufruf ===

Der Aufruf von visitors erfolgt über die Kommandozeile bzw per [[cron]].
Hauptvorteil ist, dass es auch mit den voreingestellten Logfiles problemlos
funktioniert, z.B. mit dem Kommando (im Domain Directory)
<syntaxhighlight lang=shell>
zcat ~/var/web-www.example.com*log.gz | visitors -A -m 50 - > visitors.htm
</syntaxhighlight>

=== Doku ===
siehe dazu unter:
* http://www.hping.org/visitors/doc.html

=== Muster Report ===
* http://www.hping.org/visitors/report.html

== Weitere WebStatistik Tools bei HS ==

* [[AWStats_installieren|AWStat]]
* [[Goaccess]]
* [[Piwik Installieren|Piwik]]

----
[[Kategorie:Veraltet]]

Vorlage:Textkasten

2024-07-15T11:02:20Z

Hsh-milanihl:

<div style="{{Textkastenstil-{{{1}}}}}"><p style="font-weight:bold;">{{{2|}}}</p>{{{3}}}</div>
<noinclude>
== Verwendung ==
<syntaxhighlight lang=twig>{{Textkasten|Farbe|Überschrift|Text}}</syntaxhighlight>

Gültige Werte für den Parameter Farbe sind: blau, gruen, gelb, rot.

== Beispiel ==

<syntaxhighlight lang=twig>{{Textkasten|gruen|Ein Beispiel|Dies ist ein Beispiel für die Verwendung der Vorlage.}}</syntaxhighlight>

ergibt:

{{Textkasten|gruen|Ein Beispiel|Dies ist ein Beispiel für die Verwendung der Vorlage.}}

[[Kategorie:Vorlage]]
[[Kategorie:Textkasten]]
</noinclude>

Redmine FastCGI installieren

2024-07-15T10:47:08Z

Hsh-milanihl:

{{Textkasten|gelb|veraltet|Wir empfehlen die Installation von Redmine mit Passenger: [[Redmine_im_Webspace]].}}

== Redmine mit FastCGI installieren ==

[http://redmine.org Redmine] ist ein Werkzeug zur Projektverwaltung - in erster Linie für Software-Entwicklungs-Projekte geeignet.

Redmine ist in [http://www.ruby-lang.org/de/ Ruby] mit dem Framework [http://rubyonrails.org/ Ruby on Rails] programmiert. Es steht unter der [http://www.gnu.org/licenses/old-licenses/gpl-2.0.html|GNU General Public License v2] (GPL).

Hier soll es als Beispiel dienen, wie man auf der [http://www.hostsharing.net Hostsharing]-Infrastruktur Rails-Anwendungen betrieben kann.

=== Vorbereitungen ===

Download der aktuellen Redmine Version von [http://rubyforge.org/frs/?group_id=1850 RubyForge] (zur Zeit Version 1.4.1)

<syntaxhighlight lang="shell">
cd ~
tar xfz /path/to/redmine-1.4.1-tgz
cd ~/redmine-1.4.1
</syntaxhighlight>

=== Auflösen der Abhängigkeiten ===

<syntaxhighlight lang="shell">
export GEM_PATH=$( gem env gempath )
export GEM_HOME=$HOME/.gem/ruby/1.8
export RAILS_ENV=production
gem install bundler
</syntaxhighlight>

=== Konfiguration ===

==== Datenbank ====

Mit ''hsadmin'' habe ich den Postgres-User 'xyz00_redmine' (Passwort sei 'geheim') und die Datenbank 'xyz00_redmine' angelegt.

Die Datenbank konfigurieren ich wie folgt:

<syntaxhighlight lang="shell">
cd ~/redmine-1.4.1/config/
vi database.yml
</syntaxhighlight>

mit folgendem Inhalt:

<syntaxhighlight lang="yaml" line>
production:
adapter: postgresql
database: xyz00_redmine
host: localhost
username: xyz00_redmine
password: geheim
</syntaxhighlight>

==== E-Mail, Dateiablage ====

<syntaxhighlight lang="shell">
cd ~/redmine-1.4.1/config/
vi configuration.yml
</syntaxhighlight>

Wichtige Inhalte:

<syntaxhighlight lang="yaml" line>
default:
email_delivery:
delivery_method: :smtp
smtp_settings:
address: localhost
port: 25
domain: example.org
attachments_storage_path: /home/pacs/xyz00/users/redmine/attach
</syntaxhighlight>

=== Laden von Abhängigkeiten, Datenbankschema ===

Folgende Kommandos ausführen:

<syntaxhighlight lang="shell">
cd ~/redmine-1.4.1
~/.gem/ruby/1.8/bin/bundle install --without development test
~/.gem/ruby/1.8/bin/bundle exec rake generate_session_store
~/.gem/ruby/1.8/bin/bundle exec rake db:migrate
~/.gem/ruby/1.8/bin/bundle exec rake redmine:load_default_data
</syntaxhighlight>

Das Skript fragt einer Sprache für die Inhalte der Datenbank: je nach Wunsche 'de' oder 'en' wählen.

=== Konfiguration von FastCGI ===

Datei ~/doms/redmine.example.org/htdocs/.htaccess

<syntaxhighlight lang="apache" line>
RewriteEngine On
RewriteRule ^$ index.html [QSA]
RewriteRule ^([^.]+)$ $1.html [QSA]
RewriteCond %{REQUEST_FILENAME} !-f [OR]
RewriteCond %{REQUEST_FILENAME} dispatch.fcgi$
RewriteRule ^(.*)$ /fastcgi-bin/dispatch.fcgi [QSA,L]
</syntaxhighlight>

Datei ~/doms/redmine.example.org/fastcgi/dispatch.fcgi

<syntaxhighlight lang="ruby" line>
#!/usr/bin/env ruby
require "/home/pacs/xyz00/users/meinuser/redmine-1.4.1/config/environment"
require 'fcgi_handler'
RailsFCGIHandler.process!
</syntaxhighlight>

FastCGI-Skript ausführbar machen:

<syntaxhighlight lang="shell">
chmod 755 ~/doms/redmine.example.org/fastcgi/dispatch.fcgi
</syntaxhighlight>

Am Anfang von ~/redmine-1.4.1/config/environment.rb füge ich ein:

<syntaxhighlight lang="ruby" line>
ENV['RAILS_ENV'] ||= 'production'
ENV['GEM_PATH'] ||= '/home/pacs/xyz00/users/meinuser/.gem/ruby/1.8:/var/lib/gems/1.8'
</syntaxhighlight>

Die Inhalte von ~/doms/redmine.example.org/public/ als webroot sichtbar machen:

<syntaxhighlight lang="shell">
# Vorhandene Dateien sichern. (Alternativ in ~/redmine-1.4.1/public kopieren)
mv ~/doms/redmine.example.org/htdocs ~/doms/redmine.example.org/htdocs.old
ln -s ~/redmine-1.4.1/public ~/doms/redmine.example.org/htdocs
</syntaxhighlight>

=== Konfiguration von SSL ===

Die Verzeichnisse ~/doms/redmine.example.org/fastcgi-ssl/ und ~/doms/redmine.example.org/htdocs-ssl/ werden analog zu bzw. anstelle von fastcgi und htdocs gefüllt.

[[Kategorie:Veraltet]]

Redmine in Tomcat installieren

2024-07-15T10:33:33Z

Hsh-milanihl:

{{Textkasten|gelb|veraltet|Wir empfehlen die Installation von Redmine mit Passenger: [[Redmine_im_Webspace]]. "Ruby on Rails"-Anwendungen sind Stand heute nicht mit JRuby lauffähig.}}

== Redmine im Tomcat installieren ==

[http://redmine.org Redmine] ist ein Werkzeug zur Projektverwaltung - in erster Linie für Software-Entwicklungs-Projekte geeignet.

Redmine ist in [http://www.ruby-lang.org/de/ Ruby] mit dem Framework [http://rubyonrails.org/ Ruby on Rails] programmiert. Es steht unter der [http://www.gnu.org/licenses/old-licenses/gpl-2.0.html|GNU General Public License v2] (GPL).

Hier soll es als Beispiel dienen, wie man auf der [http://www.hostsharing.net Hostsharing]-Infrastruktur mit der Tomcat-Option Rails-Anwendungen betrieben kann.

=== Vorbereitungen ===

Ich brauche:
# die aktuelle Redmine Version von [http://www.redmine.org/projects/redmine/wiki/Download redmine.org] (zur Zeit Version 2.5.1)
# die aktuelle JRuby Version von [http://www.jruby.org/download jruby.org] (aktuell Version 1.7.11)

=== Download und Entpacken ===

<syntaxhighlight lang=shell>
cd
mkdir tmp
cd tmp
wget http://jruby.org.s3.amazonaws.com/downloads/1.7.11/jruby-bin-1.7.11.tar.gz
wget http://www.redmine.org/releases/redmine-2.5.1.tar.gz
tar xzf jruby-bin-1.7.11.tar.gz
tar xzf redmine-2.5.1.tar.gz
</syntaxhighlight>

=== Datenbank anlegen und konfigurieren ===

Die Datenbank wird mit HSAdmin angelegt.

Auf der Kommandozeile könnte das so aussehen:

<syntaxhighlight lang="yaml">
hsscript -u xyz00 -i
Password: ********
xyz00@hsadmin> mysqluser.add({set:{name:'xyz00_dbadmin',password:'geheim'}})
xyz00@hsadmin> mysqldb.add({set:{name:'xyz00_redmine',user:'xyz00_dbadmin'}})
xyz00@hsadmin> bye
</syntaxhighlight>

Dann wird die Datenbank in Redmine konfiguriert, indem die "Datei config/database.yml" in der entpackten
Redmine-Software angelegt. Inhalt der Datei:

<syntaxhighlight lang="yaml" line>
production:
adapter: mysql
database: xyz00_redmine
host: localhost
username: xyz00_dbadmin
password: "geheim"
encoding: utf8
</syntaxhighlight>

=== Bauen der Anwendung ===

<syntaxhighlight lang="shell">
cd $HOME/tmp/redmine-2.5.1
export PATH=$HOME/tmp/jruby-1.7.11/bin:$PATH
</syntaxhighlight>

Zur Kontrolle (sollte das gem im bin-Verzeichnis der JRuby-Installation liefern):

<syntaxhighlight lang="shell">
which gem
</syntaxhighlight>

Dann werden mit "bundler" die Abhängigkeiten aufgelöst und die Datenbank initialisiert:

<syntaxhighlight lang="shell">
gem install bundler
bundle install --without development test
rake generate_secret_token
RAILS_ENV=production rake db:migrate
RAILS_ENV=production REDMINE_LANG=de rake redmine:load_default_data
</syntaxhighlight>

Zum Schluss bauen wir eine Web-Applikation für den Tomcat Server:

<syntaxhighlight lang="shell">
gem install warbler
warble war
</syntaxhighlight>

=== Installation im Tomcat ===

Voraussetzung: Installierter Tomcat-Webserver

Die war-Datei nach Wunsch umbennen (z.B. "redmine.war" oder auch "ROOT.war") und ins webapps-Verzeichnis des Tomcat kopieren.

[[Kategorie:Veraltet]]

Analog installieren

2024-07-15T10:25:32Z

Hsh-milanihl:

== Analog ==

{{Textkasten|rot|Achtung:|Das Programm Analog ist nicht mehr installiert und wird nicht mehr gepflegt.}}

=== Vorbereitung ===

Analog ist ein Tool zur Analyse von logfiles. Damit lässt sich der Traffic auf den Sites genau darstellen. Das kann auch automatisch gemacht werden.

Analog ist bei Hostsharing zentral installiert.

Am einfachsten ist es, analog im Verzeichnis des Domain-Users auszuführen, also als Domain-User einloggen. Vorher muss man aber sicherstellen, dass die Logfiles auch dort abgelegt werden. Normalerweise landen diese nämlich im Paket-Verzeichnis. Wie man die Ablegung steuert, ist [[logging]] beschrieben.

Am besten, man lässt die logfiles in das Verzeichnis doms/example.com/var fließen.

Es macht Sinn, für die Statistiken ein eigenes Verzeichnis anzulegen, das auch per http erreichbar ist, also z.B. http://www.example.com/statistik. Also erstellen wir ein neues Verzeichnis:
<syntaxhighlight lang="shell">
mkdir doms/example.com/subs/www/statistik
</syntaxhighlight>
Und gleich noch eines für die images:
<syntaxhighlight lang="shell">
mkdir doms/example.com/subs/www/statistik/images
</syntaxhighlight>
In das images-Verzeichnis kopieren wir gleich die nötigen Bilder, die schon bei uns liegen, nämlich in /usr/share/doc/analog/docs/:
<syntaxhighlight lang="shell">
cp /usr/share/doc/analog/docs/*.gif doms/example.com/subs/www/statistik/images
</syntaxhighlight>
=== Konfiguration ===

Als nächstes muss man eine config-Datei für Analog erstellen. Genaueres dazu ist auf www.analog.cx nachzulesen. Eine Beispielconfig gibt es hier. Nachstehend die wichtigsten Anpassungen.

* Hier wird angegeben, wo die Logfiles liegen:
<syntaxhighlight lang="shell">LOGFILE /home/doms/example.com/var/web-*.example.com-*.log.gz</syntaxhighlight>
* Hier landet die Auswertung (ist also unter www.example.com/statistik/index.htm abrufbar):
<syntaxhighlight lang="shell">OUTFILE /home/doms/example.com/subs/www/statistik/index.htm</syntaxhighlight>
* Das wird als Titelzeile angezeigt:
<syntaxhighlight lang="shell">HOSTNAME "example.com"</syntaxhighlight>
* Hier liegen die images:
<syntaxhighlight lang="shell">IMAGEDIR images/</syntaxhighlight>

Man speichert die Datei am besten im etc-Verzeichnis des Domain-Users, z.B. als analog.cfg.

=== Aufruf ===

Der Aufruf von analog erfolgt über die Kommandozeile:

<syntaxhighlight lang="shell">
/usr/bin/analog -G +g./analog.cfg
</syntaxhighlight>
-G weist analog an, nicht die Standardconfig zu verwenden, und +g weist eine eigene config-Datei zu - in diesem Fall unsere analog.cfg. Fehler oder Warnungen landen in errors.txt.

Interessant wird analog aber erst dann, wenn man die logfiles automatisch auswertet. Das funktioniert mit einem cronjob.

Mit dem Eintrag im crontab 0 3 * * * /usr/bin/analog -G +g./analog.cfg wird jeden Tag um 3.00 Uhr eine neue Statistik gebastelt.

Noch schöner ist es, die Zeitsteuerung mit unserem [[Eventhandler]] zu lösen. Damit kann man nämlich festlegen, dass die Auswertung direkt nach dem Verschieben oder Erzeugen der Logfiles erfolgt.

Diese ist dann unter www.example.com/statistik/index.htm zu erreichen.

=== Caching ===

Mit dem Caching können Logfileanalysen in einem cachefile gespeichert und in spätere Analysen einbezogen werden. So ist es z.B. möglich, alte Logfiles auf dem Server zu löschen, um Platz zu sparen.

Aber Vorsicht: Man muss aufpassen, dass im cachefile alle gewünschten Informationen landen. Eine Rekonstruktion zusätzlicher, nicht geschriebener Daten ist nicht mehr möglich.

'''''Es müssen alle INCLUDE und EXCLUDE Kommandos gesetzt sein, auch FROM und TO. Auch alle ALIASEs und LOGTIMEOFFSETs müssen beim Schreiben des cachefiles wie gewünscht gesetzt werden.
'''''
Das cachefile wird mit der Option CACHEOUTFILE definiert:
<syntaxhighlight lang="shell">
CACHEOUTFILE cache20060720.ch
</syntaxhighlight>
Sollte die Datei bereits vorhanden sein, wird kein cachefile erzeugt, um ein Überschreiben zu vermeiden. Es empfiehlt sich also, das Datum im Namen der Datei anzugeben.

Hat man das cachefile geschrieben und enthält es alle gewünschten Informationen, kann man es in eine nachfolgende Analyse einfließen lassen. Das geschieht mit der Option CACHEFILE. Wildcards und Kommas sind möglich:

CACHEFILE cache20060720.ch,cache2.ch,cache*.ch

=== Ablauf ===

Da häufig Fehler und Missverständnisse auftreten, was die Benutzung von Caching angeht, hier ein möglicher Ablauf:

* Von den bisherigen Logfiles (LOGFILE) erstellen wir gleichzeitig ein cachefile (mit CACHEOUTFILE) und einen Report (mit OUTFILE).
<syntaxhighlight lang="shell">
...
LOGFILE /home/doms/example.com/var/web-*.example.com-*.log.gz
CACHEOUTFILE cache20060720.ch
OUTFILE /home/doms/example.com/subs/www/statistik/index.htm
...
</syntaxhighlight>
* Das cachefile sollten wir testen. Wir erstellen einfach einen neuen Report, in dem wir nur das cachefile analysieren und nicht mehr die alten Logfiles (also kein LOGFILE).
<syntaxhighlight lang="shell">
...
CACHEFILE cache20060720.ch
OUTFILE /home/doms/example.com/subs/www/statistik/index2.htm
...
</syntaxhighlight>
* Die beiden erstellten Reportdateien können nun verglichen werden und sollten übereinstimmen.
* Nun können die Logfiles gelöscht oder (noch besser) lokal gespeichert und damit Platz auf dem Server geschaffen werden.

Im folgenden analysieren wir das cachefile und zusätzlich alle neu einfließenden Logfiles, bis wir den Vorgang wiederholen.
<syntaxhighlight lang="shell">
...
LOGFILE /home/doms/example.com/var/web-*.example.com-*.log.gz
CACHEFILE cache20060720.ch
OUTFILE /home/doms/example.com/subs/www/statistik/index.htm
...
</syntaxhighlight>

Man kann das Verfahren natürlich prinzipiell automatisieren, z.B. mit cronjobs. Aber es empfiehlt sich immer die Kontrolle der generierten cachefiles.

== Weitere WebStatistik Tools bei HS ==

* [[AWStats_installieren|AWStat]]
* [[Goaccess]]
* [[Piwik Installieren|Piwik]]

[[Kategorie:Veraltet]]

Redis

2024-07-15T10:15:50Z

Hsh-milanihl:

== Redis installieren ==

'''Redis''' ist ein einfacher Datenspeicher für Schlüssel-Wert-Paare. Datensätze werden jeweils unter einem Schlüssel abgelegt. Die Daten werden jeweils im Hauptspeicher gehalten und nur zu konfigurierbaren Zeitpunkten auf die Festplatte gesichert.

Redis-Datenbanken werden häufig zur Speicherung von Warteschlangen benutzt. In Redis werden Aufträge gespeichert, die asynchron von Hintergrundprogrammen abgearbeitet werden.

=== Konfiguration ===

Redis ist auf den Hostsharing-Servern vorinstalliert. Für die Nutzung muss lediglich eine Konfigurationsdatei angelegt werden und ein Hitergrundprogramm gestartet werden.

Im folgenden wird für den User ''xyz00-service'' ein Redis-Dienst eingerichtet.
Der User ''xyz00-service'' ist in HSAdmin mit ''/bin/bash'' als Shell eingerichtet.

Nach dem Login als ''xyz00-service'' lege ich Verzeichnisse ''~/redis/etc'' und ''~/redis/var'' an:

<syntaxhighlight lang="shell">
mkdir -p redis/{etc,var}
</syntaxhighlight>

Im etc-Verzeichnis wird die Konfigurationsdatei ''redis.conf'' für den Redis-Dienst abgelegt.

Eine Beispiel-Konfiguration ist:

<syntaxhighlight lang="shell" line>
requirepass <generiertes-passwort>
bind 127.0.0.1
port 33033
tcp-backlog 128
timeout 300
loglevel notice
logfile /home/pacs/xyz00/users/service/redis/var/redis.log
databases 16
save 900 1
save 300 10
save 60 10000
slave-serve-stale-data yes
appendonly no
dbfilename dump.rdb
dir /home/pacs/xyz00/users/service/redis/var/
</syntaxhighlight>

Der Redis-Dienst ist über die Server-lokale Netzwerk-Adresse 127.0.0.1 erreichbar und mit einem Passwort geschützt. Der Port ''33033'' für die Netzwerk-Schnittstelle muss ggf. angepasst werden.

Der Dienst wird gestartet mit:

<syntaxhighlight lang="shell">
xyz00-service@h00:~/redis$ /usr/bin/redis-server etc/redis.conf
</syntaxhighlight>

Mit Ctrl-C kann der Dienst wieder gestoppt werden.

Alternativ kann der zugriff auf Redis über einen Unixsocket erfolgen. Dann entfällt die Zeile 'bind 127.0.0.1' in der Konfiguration, der port wird auf 0 gesetzt. Stattdessen wir ein Unixsocket konfiguriert:

<syntaxhighlight lang="shell" line>
unixsocket /home/pacs/xyz00/users/service/redis/var/redis-server.sock
unixsocketperm 700
port 0
</syntaxhighlight>

(der Unixsocket benötigt in der Konfiguration den vollständigen absoluten Pfad zum Socket im Dateisystem!)

=== Einrichtung als Server-Dienst ===

'''Redis''' soll über den Systemdienst '''SystemD''' automatisch im Hintergrund gestartet werden.

Dazu wird im Verzeichnis ''~/.config/systemd/user'' eine Datei ''redis.service'' mit dem folgenden Inhalt angelegt:

<syntaxhighlight lang="ini" line>
[Unit]
Description=Redis Service

[Service]
WorkingDirectory=%h/redis
Environment="PATH=/usr/local/bin:/usr/bin:/bin"
ExecStart=/usr/bin/redis-server %h/redis/etc/redis.conf
Restart=always
PrivateTmp=true
NoNewPrivileges=true

[Install]
WantedBy=default.target
</syntaxhighlight>

Die Datei wird mit den folgenden Shell-Kommandos geladen und aktiviert:

<syntaxhighlight lang="shell">
systemctl --user daemon-reload
systemctl --user enable --now redis.service
</syntaxhighlight>

Mit den Kommandos

<syntaxhighlight lang="shell">
systemctl --user status
systemctl --user status redis.service
</syntaxhighlight>

kann der Status des Dienstes ermittelt werden.

=== Links ===

* [https://redis.io/ Internetseite des Redis Projekts]

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Software]]
[[Kategorie:SystemD]]

Redis

2024-07-15T10:14:45Z

Hsh-milanihl:

== Redis installieren ==

'''Redis''' ist ein einfacher Datenspeicher für Schlüssel-Wert-Paare. Datensätze werden jeweils unter einem Schlüssel abgelegt. Die Daten werden jeweils im Hauptspeicher gehalten und nur zu konfigurierbaren Zeitpunkten auf die Festplatte gesichert.

Redis-Datenbanken werden häufig zur Speicherung von Warteschlangen benutzt. In Redis werden Aufträge gespeichert, die asynchron von Hintergrundprogrammen abgearbeitet werden.

=== Konfiguration ===

Redis ist auf den Hostsharing-Servern vorinstalliert. Für die Nutzung muss lediglich eine Konfigurationsdatei angelegt werden und ein Hitergrundprogramm gestartet werden.

Im folgenden wird für den User ''xyz00-service'' ein Redis-Dienst eingerichtet.
Der User ''xyz00-service'' ist in HSAdmin mit ''/bin/bash'' als Shell eingerichtet.

Nach dem Login als ''xyz00-service'' lege ich Verzeichnisse ''~/redis/etc'' und ''~/redis/var'' an:

<syntaxhighlight lang="shell">
mkdir -p redis/{etc,var}
</syntaxhighlight>

Im etc-Verzeichnis wird die Konfigurationsdatei ''redis.conf'' für den Redis-Dienst abgelegt.

Eine Beispiel-Konfiguration ist:

<syntaxhighlight lang="shell" line>
requirepass <generiertes-passwort>
bind 127.0.0.1
port 33033
tcp-backlog 128
timeout 300
loglevel notice
logfile /home/pacs/xyz00/users/service/redis/var/redis.log
databases 16
save 900 1
save 300 10
save 60 10000
slave-serve-stale-data yes
appendonly no
dbfilename dump.rdb
dir /home/pacs/xyz00/users/service/redis/var/
</syntaxhighlight>

Der Redis-Dienst ist über die Server-lokale Netzwerk-Adresse 127.0.0.1 erreichbar und mit einem Passwort geschützt. Der Port ''33033'' für die Netzwerk-Schnittstelle muss ggf. angepasst werden.

Der Dienst wird gestartet mit:

<syntaxhighlight lang="shell">
xyz00-service@h00:~/redis$ /usr/bin/redis-server etc/redis.conf
</syntaxhighlight>

Mit Ctrl-C kann der Dienst wieder gestoppt werden.

Alternativ kann der zugriff auf Redis über einen Unixsocket erfolgen. Dann entfällt die Zeile 'bind 127.0.0.1' in der Konfiguration, der port wird auf 0 gesetzt. Stattdessen wir ein Unixsocket konfiguriert:

<syntaxhighlight lang="shell" line>
unixsocket /home/pacs/xyz00/users/service/redis/var/redis-server.sock
unixsocketperm 700
port 0
</syntaxhighlight>

(der Unixsocket benötigt in der Konfiguration den vollständigen absoluten Pfad zum Socket im Dateisystem!)

=== Einrichtung als Server-Dienst ===

'''Redis''' soll über den Systemdienst '''SystemD''' automatisch im Hintergrund gestartet werden.

Dazu wird im Verzeichnis ''~/.config/systemd/user'' eine Datei ''redis.service'' mit dem folgenden Inhalt angelegt:

<syntaxhighlight lang="ini" line>
[Unit]
Description=Redis Service

[Service]
WorkingDirectory=%h/redis
Environment="PATH=/usr/local/bin:/usr/bin:/bin"
ExecStart=/usr/bin/redis-server %h/redis/etc/redis.conf
Restart=always
PrivateTmp=true
NoNewPrivileges=true

[Install]
WantedBy=default.target
</syntaxhighlight>

Die Datei wird mit den folgenden Shell-Kommandos geladen und aktiviert:

<syntaxhighlight lang="shell">
systemctl --user daemon-reload
systemctl --user enable redis.service
systemctl --user start redis.service
</syntaxhighlight>

Mit den Kommandos

<syntaxhighlight lang="shell">
systemctl --user status
systemctl --user status redis.service
</syntaxhighlight>

kann der Status des Dienstes ermittelt werden.

=== Links ===

* [https://redis.io/ Internetseite des Redis Projekts]

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Software]]
[[Kategorie:SystemD]]

RubyRBEnv

2024-07-11T13:05:15Z

Hsh-milanihl:

== Eigene Ruby Installation ==

Oft ist die vorinstallierte Version der Programmiersprache Ruby (die in Debian enthaltene Version) zu alt für die eingesetze Software.

Hier eine kurze Anleitung, mit der man eine eigene Ruby-Umgebung für einen User einrichten kann.

=== Installation von rbenv ===

Konfiguration für einen User mit "/bin/bash" als Shell. Die Umgebungsvariablen werden in ".bash_profile" hinterlegt.

<syntaxhighlight lang=shell>
git clone https://github.com/sstephenson/rbenv.git ~/.rbenv
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bash_profile
echo 'eval "$(rbenv init -)"' >> ~/.bash_profile
source ~/.bash_profile
</syntaxhighlight>

Der Befehl

<syntaxhighlight lang=shell>
type rbenv
</syntaxhighlight>

sollte eine Ausgabe erzeugen, die beginnt: "rbenv is a function"

=== Installation von ruby-build ===

<syntaxhighlight lang=shell>
git clone https://github.com/sstephenson/ruby-build.git ~/.rbenv/plugins/ruby-build
</syntaxhighlight>

=== Installation von ruby ===

Mit dem Kommando

<syntaxhighlight lang=shell>
rbenv install --list
</syntaxhighlight>

erhält man eine Liste der aktuell untersützten Ruby-Versionen

Installation mit (hier Version 3.1.3):

<syntaxhighlight lang=shell>
rbenv install 3.1.3
rbenv global 3.1.3
gem install bundler
rbenv rehash
</syntaxhighlight>

Der Befehl

<syntaxhighlight lang=shell>
ruby -v
</syntaxhighlight>

liefert die Ausgabe "ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [x86_64-linux]"

== Minimale Web Applikation mit Passenger ==

Zur Integration der eigenen Ruby-Installation in den Apache erfolgt über das Apache-Modul "Passenger".
Vor der Nutzung dieses Moduls bitte unbedingt die
[[Phusion Passenger|Hinweise zur Nutzung beachten]].

Für eine minimale Beispielanwendung legen wir eine Datei ''config.ru'' mit folgenden Inhalt an
("ru" kurz für "rackup"):

<syntaxhighlight lang=ruby line>
# config.ru

class App
def call(env)
headers = { 'Content-Type' => 'text/html' }
response = ['Greetings from Rack!!']
[200, headers, response]
end
end

run App.new
</syntaxhighlight>

== Sinatra Web Applikation mit Passenger ==

Um eine Beispielanwendung zu installieren, orientieren wir uns an https://github.com/phusion/passenger-ruby-sinatra-demo/tree/end_result

Im Verzeichnis "/home/pacs/xyz00/users/example/doms/example.com/app-ssl/" legen wir folgende Dateien und Verzeichnisse an:

Gemfile:

<syntaxhighlight lang=ruby line>
source 'https://rubygems.org/'

gem 'sinatra'
gem 'tilt'
gem 'base64', '0.1.1'
</syntaxhighlight>

app.rb:

<syntaxhighlight lang=ruby line>
require 'sinatra/base'
require 'tilt/erb'

class ExampleApp < Sinatra::Base
get '/' do
erb :index
end
end
</syntaxhighlight>

config.ru:

<syntaxhighlight lang=ruby line>
require File.absolute_path("app.rb")

run ExampleApp
</syntaxhighlight>

views/index.erb:

<syntaxhighlight lang=html line>
<!DOCTYPE html>
<html>
<head><title>Hello</title></head>
<body>
<h1>Hello world!</h1>
<% if defined?(PhusionPassenger) %>
<p>Congratulations, you are running this app in Passenger!<br/>
You are running Ruby Version: <%= RUBY_VERSION %>
</p>
<% else %>
<p>You are not running this app in Passenger.</p>
<% end %>
</body>
</html>
</syntaxhighlight>

Im Verzeichnis "/home/pacs/xyz00/users/example/doms/example.com/app-ssl/" führen wir aus:

<syntaxhighlight lang=shell line>
bundle config --local path vendor/bundle
bundle install
</syntaxhighlight>

== Links ==

* https://www.writesoftwarewell.com/definitive-guide-to-rack/

----
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Software]]

Toast paketmanager

2024-07-11T12:59:35Z

Hsh-milanihl:

= Toast Paketmanager =

Toast ist eine große Hilfe, wenn eine Software benötigt wird, die bei Hostsharing nicht installiert wird. Das kann vorkommen,
wenn es die richtige Version nicht in der stabilen Debian-Distribution gibt oder wenn andere Gründe gegen eine zentrale Installation sprechen.

[http://toastball.net/toast/ Toast] ist ein einfacher Paket-Manager, der in der Lage ist Source-Tar-Balls herunterzuladen und im Home-Verzeichnis des Users zu installieren.

Die Installation von Toast ist denkbar einfach:

<syntaxhighlight lang=shell>
wget -O- http://toastball.net/toast/toast | perl -x - arm toast
</syntaxhighlight>

Die folgende Zeile gehört in die Datei ".profile":

<syntaxhighlight lang=shell>
eval $($HOME/.toast/armed/bin/toast env)
</syntaxhighlight>

Eine man-Page findet sich unter [http://toastball.net/toast/man http://toastball.net/toast/man]

== PHP7 gefällig? ==

Mit Toast kein Problem:

<syntaxhighlight lang=shell>
toast arm http://de1.php.net/distributions/php-7.1.2.tar.gz
</syntaxhighlight>

Zum Kompilieren des PHP-Stub für Fast-CGI siehe [[Eigene_PHP_Version]]

----
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Software]]

Piwik mit Plone verwenden

2024-07-11T12:33:49Z

Hsh-milanihl:

Das CMS [[Plone]] ist für die Verwendung mit JavaScript-Zählscripten vorbereitet. Hierfür existiert im Properties-Tool bei den site_properties das Feld "webstats_js".

Das Verfahren für [[Piwik]] und Plone funktioniert grundsätzlich wie beschrieben; für weitere Webanwendungen ist es nicht Bestandteil dieser Dokumentation, dürfte sich aber ganz ähnlich verwenden lassen.

== Programmatisch: propertiestool.xml ==

In einem policy-Produkt ist die propertiestool.xml-Datei wie folgt zu ändern. Sollte Code für Google Analytics hier eingetragen sein bitte den Paketadmin benachrichtigen; hier besteht eine Unverträglichkeit.

Pfad: <code>/plone40_buildout/src/name.webpolicy/name/webpolicy/profiles/default/propertiestool.xml</code>

<syntaxhighlight lang=xml line>
<?xml version="1.0"?>
<object name="portal_properties" meta_type="Plone Properties Tool">
<object name="site_properties" meta_type="Plone Property Sheet">
<property name="title">Site wide properties</property>
...
<property name="webstats_js"
type="text"><script type="text/javascript">
var pkBaseURL = (("https:" == document.location.protocol) ? "https://www.mydomain.de/piwik/" : "http://www.mydomain.de/piwik/");
document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
try {
var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 1);
piwikTracker.trackPageView();
piwikTracker.enableLinkTracking();
} catch( err ) {}
</script><noscript><p><img src="http://www.mydomain.de/piwik/piwik.php?idsite=1" style="border:0" alt="" /></p></noscript>
</property>
</object>
</object>
</syntaxhighlight>

Der Teil innerhalb von <code><property name="webstats_js" type="text"></code> bis <code></property></code> muss escaped werden; einfaches Kopieren und Einfügen wird nicht wie erwartet funktionieren. D.h. für die Verwendung in der <code>propertiestool.xml</code> sind folgende Ersetzungen vorzunehmen:

* <code><</code> durch Entität "less-than" ersetzen (& lt ;)
* <code>></code> durch Entität "greater-than" ersetzen (& gt ;)

== ZMI ==

Die Konfiguration über das ZMI ist möglich, aber mangels Nachhaltigkeit bei der Wartung nicht empfohlen. Hier braucht keine Ersetzung/kein Escaping vorgenommen zu werden.

Sollte Code für Google Analytics hier eingetragen sein bitte vor einer Änderung den Paketadmin benachrichtigen; hier besteht eine Unverträglichkeit.

== Opt-out Cookie ==

Um datenschutzfreundlich zu bleiben soll den Benutzern der Webseite, die getrackt wird, die Möglichkeit gegeben werden einen "Opt-out Cookie" zu setzen. Am einfachsten ist es, hier die mit der [[Piwik Installieren|Piwik-Installation]] mitgelieferte Funktion zu verwenden. Sie wird über einen IFrame eingebunden, in Plone ist das möglich mit dem Produkt <code>[http://pypi.python.org/pypi/Products.windowZ/1.3b2 Products.windowZ]</code>.

An der Installation sind folgende Änderungen durchzuführen, wenn [http://www.buildout.org Buildout] und die extension "mr.developer" verwendet wird:

=== buildout.cfg ===

<syntaxhighlight lang=ini line>
[buildout]
...
extensions =
mr.developer

...

auto-checkout =
Products.windowZ

[instance]
...
eggs =
Products.windowZ

[sources]
Products.windowZ = svn http://svn.plone.org/svn/collective/Products.windowZ/trunk
</syntaxhighlight>

Für Plone 4 soll dabei die Version aus dem Collective verwendet werden, da ''Interfaces'' in Products.windowZ > 1.3 nicht zur Verfügung steht.

=== Plone ===

Das Produkt Products.windowZ fügt einen neuen Content-Type zu Plone hinzu.

* Login auf der Plone-Site
* "Window" hinzufügen
* Im Feld URL die Adresse des spezifischen IFrame angeben: <code>http://www.mydomain.de/piwik/index.php?module=CoreAdminHome&action=optOut&language=de</code>

Das erscheinende Formular enthält einigen erklärenden Text und eine Checkbox. Das Cookie wird je nach Zustand dynamisch gesetzt.

<syntaxhighlight lang=output line>
Sie können sich hier entscheiden, ob in Ihrem Browser ein eindeutiger Webanalyse-Cookie abgelegt werden darf, um dem Betreiber der Webseite die Erfassung und Analyse verschiedener statistischer Daten zu ermöglichen.
Wenn Sie sich dagegen entscheiden möchten, klicken Sie den folgenden Link, um den Piwik-Deaktivierungs-Cookie in Ihrem Browser abzulegen.
Ihr Besuch dieser Webseite wird aktuell von der Piwik Webanalyse erfasst. Klicken Sie hier damit ihr Besuch nicht mehr erfasst wird.
</syntaxhighlight>

Ist die Checkbox ausgeschaltet ist der Text dieser:

<syntaxhighlight lang=output line>
Deaktivierung vollständig! Ihre Besuche auf dieser Webseite werden von der Webanalyse nicht mehr erfasst.
Bitte beachten Sie, dass auch der Piwik-Deaktivierungs-Cookie dieser Webseite gelöscht wird, wenn Sie die in Ihrem Browser abgelegten Cookies bereinigen. Außerdem müssen Sie, wenn Sie einen anderen Computer oder einen anderen Webbrowser verwenden, die Deaktivierungsprozedur nochmals absolvieren.
Ihr Besuch dieser Webseite wird aktuell von der Piwik Webanalyse nicht erfasst. Klicken Sie hier um ihren Besuch wieder erfassen zu lassen.
</syntaxhighlight>

----

[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Software]]
[[Kategorie:Piwik]]
[[Kategorie:Plone]]

Mlmmj

2024-07-10T13:24:20Z

Hsh-milanihl: /* Einrichtung */

[http://www.mlmmj.org/ mlmmj], angeblich eine Abkürzung für "Mailing List Management Made Joyful", ist ein Programm, mit dem in einem Hostsharing Paket E-Mail-Verteiler realisiert werden kann.

Wer noch nicht weiß, was ein E-Mail-Verteiler machen soll oder wie, lese veilleicht auch den Wikipedia-Artikel:
[http://de.wikipedia.org/wiki/Mailingliste Mailingliste]

Eine leistungsfähigere Alternative zu mlmmj könnte [[Mailman_3_installieren|Mailman 3]] sein.

Diese Anleitung beschreibt die Einrichtung einer Mailingliste für eine Domain in einem Hostsharing-Webspace.

== Voraussetzungen ==

Das Debian Paket [http://packages.debian.org/search?keywords=mlmmj mlmmj] ist auf den Shared-Hosting-Servern bereits installiert. (Wer die Software selbst kompilieren möchte kann aktuellen Source-Code bei [https://codeberg.org/mlmmj/mlmmj|codeberg.org] finden.)

Für den Betrieb der Mailingliste empfiehlt sich das Anlegen eines eigenen Users für diesen Zweck mit hsadmin.

In dieser Anleitung heißt das Paket ''xyz00'' und der für Mailinglisten eingesetzte User ''xyz00-list''.

Die E-Mail-Adresse der einzurichtende Mailing-Liste soll ''discuss@example.org'' sein. Den lokalen Teil dieser Adresse, ''discuss'', ist der Listenname. Der Listenname darf auf keinen Fall das Plus-Zeichen (+) enthalten, weil dies ein Sonderbedeutung für die Listensteuerung hat: ''mlmmj'' wird nämlich Befehle der Abonnenten über erweiterte Adressen annehmen, wie z.B. ''discuss+help@example.org''.

Die Domain ''example.org'' muss dazu bei einem beliebigen User im Paket ''xyz00'' [[aufgeschaltet]] sein. ("Aufgeschaltet" bedeutet, daß diese Domain bei Hostsharing gehostet wird und der Domainname als Verzeichnis /home/pacs/xyz00/*User*/doms/example.org/ erscheint.)

== Einrichtung ==

Ich melde mich über SSH auf der Hostsharing-Console als der Paketuser ''xyz00'' an.

Im Shell kann ich dann durch den Befehl ''hsscript -i'' das Verwaltungswerkzeug [[hsadmin]] interaktiv ausführen:

<syntaxhighlight lang=shell>
xyz00@h03:~$ hsscript -i
Password: *************
xyz00@hsadmin>
</syntaxhighlight>

In ''hsadmin'' werden User und E-Mail-Adresse angelegt.

<syntaxhighlight lang=shell>
xyz00@hsadmin> user.add({set:{name:'xyz00-list',comment:'Mailingliste Discuss',shell:'/bin/bash',password:'geheimnis'}})
xyz00@hsadmin> emailaddress.add({set:{target:'xyz00-list',localpart:'discuss',domain:'example.org'}})
xyz00@hsadmin> bye
</syntaxhighlight>

Mit dem Parameter "target" wird die für diese Adresse eingehende Post zunächst in das Postfach des Users xyz00-list abgelegt.

Für den User xyz00-list lege ich in seinem Heimat-Verzeichnis das Unterverzeichnis <tt>mlmmj</tt> an:

<syntaxhighlight lang=shell>
mkdir /home/pacs/xyz00/users/list/mlmmj
</syntaxhighlight>

Dann lege ich die Mailingliste mit folgendem Kommando an:

<syntaxhighlight lang=shell>
mlmmj-make-ml -L discuss -s /home/pacs/xyz00/users/list/mlmmj
</syntaxhighlight>

Das Skript ''mlmmj-make-ml'' fragt weitere Parameter der Mailingliste ab:

<syntaxhighlight lang=output line>
The Domain for the List? [] : example.org
The emailaddress of the list owner? [postmaster] : webmaster@example.org
For the list texts you can choose between the following languages or
give an absolute path to a directory containing the texts.
Available languages:
cz da de en es fr it nl ru
The path to texts for the list? [en] : de
</syntaxhighlight>

Das skript ''mlmmj-make-ml'' legt daraufhin unter "/home/pacs/xyz00/users/list/mlmmj" ein Verzeichnis "discuss" an, das die Datenstruktur zur Verwaltung der Mailingliste enthält.

Weitere Konfigurationen der Liste erfolgen durch das Anlegen von Dateien im
Verzeichnis "/home/pacs/xyz00/users/list/mlmmj/discuss/control".
Die Konfigurationsmöglichkeiten finden Sie auf der [http://mlmmj.org/docs/tunables/ Internetseite von mlmmj].

Damit mlmmj die Verteilung der Post übernimmt, muß ich im Heimat-Verzeichnis des users xyz00-list die Datei <tt>.forward</tt> mit folgenden Inhalt (INKLUSIVE der Anführungszeichen!) erstellen:

<syntaxhighlight lang=shell>
"|/usr/bin/mlmmj-recieve -L /home/pacs/xyz00/users/list/mlmmj/discuss/"
</syntaxhighlight>

(Ja, ''receive'' schreibt sich mit ''-ei-'', aber mlmmj hält einen symbolischen Link bereit für diejenigen, die in englischer Rechtschreibung unsicher sind:)

<syntaxhighlight lang=shell>
xyz00-list@h03:~$ ls -la /usr/bin/mlmmj-rec*
-rwxr-xr-x 1 root root 27104 Sep 25 2018 /usr/bin/mlmmj-receive
lrwxrwxrwx 1 root root 13 Sep 25 2018 /usr/bin/mlmmj-recieve -> mlmmj-receive
</syntaxhighlight>

Die <tt>.forward</tt>-Datei sorgt dafür, dass eingehende E-Mails an das User-Postfach an das Programm ''mlmmj-recieve'' übergeben werden.

Für regelmäßige Aufgaben der Listen-Managers definiere ich die
[[Cron|crontab]] wie folgt (immer noch als ''xyz00-list''):

xyz00-list@h03:~$ crontab -e

<syntaxhighlight lang=shell line>
MAILTO=webmaster@example.org
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/X11R6/bin
HOME=/home/pacs/xyz00/users/list
SHELL=/bin/bash
LANG=en_US.UTF-8
# m h dom mon dow command
28 */4 * * * /usr/bin/mlmmj-maintd -d /home/pacs/xyz00/users/list/mlmmj -F
</syntaxhighlight>

Zum Schluss rufe ich das Skript mlmmj-sub auf, um die E-Mail-Adressen der gewünschten Abonnenten des Verteilers einzutragen:

<syntaxhighlight lang=shell>
/usr/bin/mlmmj-sub -L /home/pacs/xyz00/users/list/mlmmj/discuss -a klaus.muster@gmx.de -c
/usr/bin/mlmmj-sub -L /home/pacs/xyz00/users/list/mlmmj/discuss -a sabine.beispiel@arcor.de -c
</syntaxhighlight>

Dabei bewirkt "-c", dass der Abonnent eine Begrüßungs-Nachricht erhält. Alternativ kann man "-C" (großes C) angeben: dann muss der Abonnent das Abo durch Antworten auf die Nachricht bestätigen.

== weitere Optionen ==

Noch ein paar Dinge, die Sie möglicherweise einstellen wollen:

Ein Prefix in der Betreffzeile setzen, z.B.: "[discuss]".

echo "[discuss]" > /home/pacs/xyz00/users/list/mlmmj/discuss/control/prefix

Wenn die Liste nur E-Mails von eingetragenen Abonnenten weiterleiten soll:

touch /home/pacs/xyz00/users/list/mlmmj/discuss/control/subonlypost

Damit der Listen-Owner weitere Abonnements bestätigen muss:

touch /home/pacs/xyz00/users/list/mlmmj/discuss/control/submod

Einen "Reply-To:"-Header setzen, damit Antwort-Mails standardmäßig an die Mailing-Liste gehen:

echo "Reply-To:" > /home/pacs/xyz00/users/list/mlmmj/discuss/control/delheaders
echo "Reply-To: discuss@example.org" > /home/pacs/xyz00/users/list/mlmmj/discuss/control/customheaders

Weitere Möglichkeiten finden Sie (wie oben bereits angegeben)
auf der [http://mlmmj.org/docs/tunables/ Internetseite von mlmmj].

=== Achtung: DKIM ===

Mlmmj gibt die Möglichkeit, mit '''delheaders''' und '''customheaders''' die Header der durchgeleiteten Mail umfangreich zu ändern. Allerdings tragen Mails heute häufig kryptografische Signaturen der sendenden Mailserver. Eine DKIM-Signatur sichert damit in der Regel die Integrität des Body der Mail sowie der Header ''Subject:'', ''From:'', ''To:'', ''Date:'', ''From'', und oft auch ''Reply-To:''.

Wird zum Beispiel mit einem Prefix das Subject geändert oder ein Footer angehängt, macht dies die DKIM-Signatur ungültig. Das ist für viele Mailprovider ein Grund die Nachricht abzuweisen.

== Zur Konfiguration im Browser ==

Die Original-Distribution von ''mlmmj'' enthält ein paar einfache PHP- und Perl-Skripte. Das sind Beispiele für Subscribe-/Unsubscribe-Formulare, ein Admin-Formular zum Eintragen und Löschen von Abonnements und eine Seite mit der gesamten Listen-Konfiguration.

Wer es sich ansehen möchte:

Als Paket-Admin eine Domain aufschalten:
<syntaxhighlight lang=shell>
hsscript -u xyz00 -e "domain.add({set:{name:'lists.example.org',user:'xyz00-list'}})"
</syntaxhighlight>
Und weiter als "xyz00-list".

Download der neuesten Version der Sourcen von mlmmj von http://mlmmj.org/downloads/ (noch besser: Download des aktuellen Debian-Pakets von [https://packages.debian.org/bookworm/all/mlmmj-php-web-admin/download debian.org]: da sind einige veraltete PHP-Ausdrücke schon herausgepatcht) und diese in einem temporären Verzeichnis entpacken (mit tar oder dpkg-deb).

Unter "/mlmmj-$versionsnummer/contrib/web/php-admin/", oder beim .deb-Paket unter "usr/share/mlmmj-...", findet sich die PHP-Admin-Anwendung. Also ...

* den Inhalt diese Verzeichnisses nach "/home/pacs/xyz00/users/list/doms/lists.example.org/" packen;
* in "/home/pacs/xyz00/users/list/doms/lists.example.org/conf/config.php" die Variable "$topdir" anpassen;
* die Dateien aus "/home/pacs/xyz00/users/list/doms/lists.example.org/htdocs/" nach "/home/pacs/xyz00/users/list/doms/lists.example.org/htdocs-ssl/" verschieben;
* Beim .deb-Paket die config.php, die templates/ und die tunables.pl aus etc/ nach example.org/conf/ verschieben;
* in "/home/pacs/xyz00/users/list/mlmmj" und in "/home/pacs/xyz00/users/list/doms/lists.example.org/htdocs-ssl/" eine ".htaccess" mit folgendem Inhalt ablegen:
<syntaxhighlight lang=apache line>
Require valid-user
AuthType Basic
AuthName "mlmmj web-interface"
AuthUserFile /home/pacs/xyz00/users/list/doms/lists.example.org/etc/htpasswd
</syntaxhighlight>
* Und schließlich die "htpasswd"-Datei anlegen.

cd /home/pacs/xyz00/users/list/doms/lists.example.org/etc/
htpasswd -c htpasswd listadmin

* Ein Passwort angeben.

Nun enthält diese PHP-Anwendung, wenn man sie nicht dem Debian-Paket entnommen hat, leider noch eine Zeile, die schon seit PHP 7 nicht mehr lauffähig ist. Also muß man noch

* in <tt>.../htdocs-ssl/index.php</tt> folgende Änderung vornehmen:
<syntaxhighlight lang=diff line>
@@ -38,4 +38,5 @@
# use scandir to have alphabetical order
foreach (scandir($topdir) as $file) {
- if (!ereg("^\.",$file))
+# ereg obsolete!! Vormals: if (!ereg("^\.",$file))
+ if (!preg_match('/^\./',$file))
{
</syntaxhighlight>
und das Ergebnis auf https://lists.example.org anschauen.

== Mehrere Mailinglisten betreiben ==

Wenn mehrere Mailinglisten in einem Account und mit einer Admin-Oberfläche betrieben werden soll, empfiehlt sich die Nutzung von Procmail für den Aufruf von ''mlmmj'' für die jeweiligen Liste mit ihrem Daten-Verzeichnis.

Dazu trägt man in der Datei <tt>.forward</tt> statt des Aufrufs von ''mlmmj-recieve'' einen Aufruf von ''procmail'' ein:

|/usr/bin/procmail

Die Konfiguration von Procmail kann generisch erfolgen. Dazu legt man eine Datei <tt>.procmailrc</tt> mit folgendem Inhalt ins $HOME des Users:

SHELL=/bin/sh
HOMEDIR=/home/pacs/xyz00/users/list
MAILDIR=/home/pacs/xyz00/users/list/Maildir
PMDIR=/home/pacs/xyz00/users/list
VERBOSE=yes
LOGFILE=/home/pacs/xyz00/users/list/var/procmail.log
DEFAULT

:0:
* ^X-Original-To: ()\/[^@+]+
|/usr/bin/mlmmj-receive -F -L /home/pacs/xyz00/users/list/mlmmj/${MATCH}/

:0
{ EXITCODE 67 }

Bitte dafür sorgen, dass das Verzeichnis ''/home/pacs/xyz00/users/list/var'' existiert.

Der kryptische reguläre Ausdruck hinter dem Header ''X-Original-To:'' passt auf den Beginn der E-Mail-Adresse bis zum ersten ''@''- oder ''+''-Zeichen. In der Variable ''MATCH'' steht also der Name der Mailingliste, d.h. der Name der Verzeichnisses, in dem die Liste verwaltet wird.

Sehr wichtig ist die Zeile ''DEFAULT'' zu Beginn der ''.procmailrc''. Die Variable ''DEFAULT'' wird von ''procmail'' gesetzt. Wir sorgen mit dieser Zeile dafür, dass sie wieder undefiniert ist. Diese Variable wird intern von ''mlmmj'' benutzt, wenn sie gesetzt ist. Das führt in Kombination mit ''procmail'' zu Fehlfunktionen (vgl. Links).

===Groß- und Kleinschreibung===

Achtung, mit der Groß- und Kleinschreibung von Listennamen gibt es bei dieser Procmail-Lösung eine kleine Tücke. Procmail übernimmt in die Variable $MATCH genau die in der X-Original-To-Headerzeile vorgefundene Schreibweise, und diese kann denkbarerweise "Listen-Name" oder "listen-name" oder "Listen-name" sein. <tt>mlmmj</tt> hingegen wird diesen Wert in Unix-Manier mit dem genauen Verzeichnisnamen <tt>${HOME}/mlmmj/listen-name</tt> vergleichen, und bei unterschiedlicher Schreibweise die Mail nicht verteilen.

====Lösung 1====

Eine teilweise Lösung besteht darin, den Listennamen in dem <tt>mlmmj</tt>-Aufruf in der <tt>.procmailrc</tt> in Kleinbuchstaben umzuschreiben. Dann lautet das Rezept so:

:0:
* ^X-Original-To: ()\/[^@+]+
|/usr/bin/mlmmj-receive -F -L /home/pacs/xyz00/users/list/mlmmj/$(echo ${MATCH} | tr [:upper:] [:lower:])/

Der Rest der Datei muß gleich bleiben, wie weiter oben angezeigt.

In diesem Fall müssen aber alle Mailing-Listen ohne Großbuchstaben im Namen angelegt werden!

(Man kann auch in <tt>${HOME}/mlmmj/</tt> durch kleingeschriebene Symlinks großgeschriebene Listennamen ansprechbar machen:

xyz00-list@h02:~$ ls -lA mlmmj/
total 8
-rw-r--r-- 1 xyz00-list xyz00 148 Feb 1 16:56 .htaccess
lrwxrwxrwx 1 xyz00-list xyz00 10 Feb 2 18:01 mitglieder -> Mitglieder
drwxr-xr-x 15 xyz00-list xyz00 4096 Feb 2 16:53 Mitglieder

====Lösung 2====

Bash kann bei der Auflösung von Variablen die Groß- und Kleinschreibung manipulieren. (Siehe dazu bei der Zeichenfolge <tt>,,</tt> in <tt>man bash</tt>.) Dann ist <tt>$(echo ${MATCH} | tr [:upper:] [:lower:])</tt> gleichbedeutend mit <tt>${MATCH,,}</tt>. Allerdings braucht procmail einige Überredung, um Bash zu verwenden.

SHELL=/bin/bash
SHELLMETAS=&|<>~;?*[{
HOMEDIR= ...

...

:0:
* ^X-Original-To: ()\/[^@+]+
|/usr/bin/mlmmj-receive -F -L /home/pacs/xyz00/users/list/mlmmj/${MATCH,,}/

Die Tücke ist, daß procmail den in SHELL angegebenen Shell nur dann verwendet, wenn die Befehlszeile eines der in SHELLMETAS angegebenen Zeichen enthält. Und das '|' am Anfang der Zeile zählt dabei nicht! In diesem Beispiel ist es das Zeichen <tt>{</tt>, das den Einsatz von Bash auslöst.

Beide Lösungen scheinen zu funktionieren; Angabe ohne Gewähr.

== Links ==

* http://mlmmj.org/ Projektseite
* https://codeberg.org/mlmmj mlmmj auf Codeberg
* https://github.com/tchapi/mlmmj-simple-web-interface ein Admin-Interface in NodeJS
* [https://web.archive.org/web/20221228110514/https://www.tablix.org/~avian/blog/archives/2010/04/the_faulty_default/ https://www.tablix.org/~avian/blog/archives/2010/04/the_faulty_default/ (via web.archive.org)] Nutzung von mlmmj in Verbindung mit Procmail
* [https://gist.github.com/kboss/7c9593f0fd9219406226c4f11256b98a Einfaches Python-Script zum Massenimport aus einem Texfile.] Geht bestimmt auch eleganter mit purem Bash
* Ein Self-Service zum Subscriben/Unsubscriben lässt sich in Form von Mail-to-Links in Webseiten einbinden. Beispiele gibt es bei Hostsharing für die öffentlichen "public"-Mailinglisten: https://www.hostsharing.net/lists/public-discussion/ . Alternativ auf https://github.com/hblasum/mlmmj-php-web-simplified ein Webfrontend mit dem sich Benutzerinnen und Benutzer selbst ein-/austragen können (Vereinfachung von mlmmj-php-web von Christoph Thiel).

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Software]]
[[Kategorie:Mailinglisten]]
[[Kategorie:E-Mail]]

Tabellen

2024-07-10T13:21:13Z

Hsh-milanihl:

{{Shortcut|WP:TAB, WP:TBL}}
{{Wikipedia-Hilfe}}
Wikipedia bietet eine eigene Syntax, um '''Tabellen''' darzustellen. Diese Syntax ist zwar an das verbreitete [[Hypertext Markup Language|HTML]] angelehnt, erleichtert jedoch durch eine vereinfachte Schreibweise die Arbeit an komplizierteren Tabellen wesentlich. Diese Seite bietet eine Kurzübersicht, wie du Tabellen erstellst, eine ausführliche Darstellung findet sich auf '''[[Hilfe:Tabellen-Referenz]]'''.

Um die Zellen einer Tabelle zu formatieren, lassen sich sowohl für die Tabelle als Ganzes als auch für einzelne Zellen HTML-Attribute angeben. Insbesondere kann das <tt>style</tt>-Attribut verwendet werden, wodurch sich beliebige [[Cascading Style Sheets|CSS]]-Formatierungen realisieren lassen. Zwar lassen sich auch einzelne Zeilen einer Tabelle formatieren, möchte man jedoch ein Attribut an eine bestimmte Spalte vergeben, so muss dies zellenweise geschehen.

== Wann Tabellen einsetzen? ==
'''Tabellen''' sind ein gutes Mittel, um gleichartige Informationen übersichtlich zu gestalten. Sie helfen die Beziehungen zwischen Tabellenzellen und ihren Zeilen und Spalten zu verstehen (siehe [[Semantik|semantische Beziehungen]]). Insbesondere als sortierbare Tabellen bieten sie einen schnellen Überblick beispielsweise über Jahreszahlen, Namen oder Orte.
:''Siehe Hauptartikel [[Wikipedia:Tabellen]]''.

Andererseits sind Tabellen komplizierter als normaler Text. Deshalb sollten sie nur dort eingesetzt werden, wo sie tatsächlich für bessere Übersicht sorgen. Überlege immer, ob du die Informationen nicht besser in einer einfachen Liste unterbringen kannst (siehe [[Hilfe:Textgestaltung|Textgestaltung]] und [[Hilfe:Listen|Listen]]).

Tabellen sollte man nicht als „grafisches Gestaltungsmittel“ einsetzen.

== CSS-Klassen für Tabellen ==
Um Tabellen sowohl in ihren Inhalten als auch bereits im Kopfbereich weitestgehend frei von Elementen zu halten, die die Darstellungsweise betreffen, wurden für das global wirksame CSS einige Klassen entwickelt, die es erlauben, wichtige Stile mit wenigen anschaulichen Anweisungen festzulegen.

=== wikitable ===
Mittels <code>class="wikitable"</code> im Tabellenkopf lässt sich eine schwach grau getönte Tabelle mit sichtbaren, wenngleich dezenten Zellgrenzen erstellen. Zwischen Zellinhalt und Rand wird etwas "Luft" gelassen. Die Standardtabelle ist rahmenlos und hat weißen Hintergrund, was für Layout-Zwecke teilweise erwünscht ist, sich jedoch in bestimmten Fällen zu schlecht vom Text absetzt.

Die Klasse <code>prettytable</code> mit einem ganz ähnlichem Anspruch sollte nicht mehr verwendet werden, um die Kohärenz der Stilmittel zwischen den verschiedenen Wikipedias zu fördern. Sie wird ausschließlich in der deutschen Wikipedia verwendet.

=== sortable ===
Mittels <code>class="sortable"</code> werden Spalten sortierbar gemacht. Das heißt, wenn [[JavaScript]] für die Wikipedia aktiviert ist, können Tabellen durch Klick auf das entsprechende Symbol in einem Spaltenkopf nach dieser Spalte auf- und absteigend sortiert werden. Die mitunter unsortierte Ausgangs-Darstellung erhält man durch Neuladen der Seite. Einzelne Spalten, für die eine Sortierung als unsinnig angesehen wird, können mittels der spaltenweisen Angabe von <code>class="unsortable"</code> markiert werden, so werden die Sortierfunktion und -symbol unterdrückt. Mit der gleichen Angabe können auch einzelne Tabellen''zeilen'' von der Sortierung ausgenommen werden.

''siehe auch:'' [[:meta:Help:Sorting|MediaWiki Handbook - Sorting]]

=== toptextcells ===
Durch <code>class="toptextcells"</code> im Tabellenkopf kann das Standardverhalten, dass Texte in Zellen vertikal zentriert dargestellt werden, dahingehend abgeändert werden, dass die Texte immer oben beginnen und der Abstand jeweils nach unten variiert. In Fällen stark unterschiedlicher Auffüllung führt dies zu einer größeren Übersicht, die obere Textzeile bildet mit der oberen Begrenzung zusammen eine Flucht. Die Alternative zu dieser Klasse wäre die Einfügung von style-Anweisungen pro Tabellenzeile.

=== Kombinationen ===
Die genannten drei Klassen lassen sich kombinieren. Hierbei sollte Augenmaß gewahrt werden, nicht jede Eigenschaft ist immer passend. Sortierbare Wikitables (<code>class="wikitable sortable"</code>) werden sich häufig anbieten. Oben ausgerichtete Texte in Zellen werden häufig mit Wikitable kombiniert werden.

Auch Kombinationen aller drei Stile sind denkbar, wenn in Tabellen umfangreiche Erläuterungen enthalten sind, diese sollten dann als <code>unsortable</code> markiert werden.

=== Probleme mit der class="wikitable" ===

Am 23. Februar 2008 wurde die „[[Vorlage:Prettytable]]“ als „veraltet“ [{{fullurl:Spezial:Logbuch|type=delete&page=Vorlage:Prettytable&year=2008&month=2}} gelöscht] und somit endgültig von der [[Cascading Style Sheets|CSS]]-<code>class="wikitable"</code> ersetzt (zu finden in [[MediaWiki:Common.css]]). Daneben existiert auch die <code>class="prettytable"</code>, diese sollte aber nicht mehr verwendet werden, da die deutschsprachige Wikipedia die einzige ist, welche diese Klasse verwendet. Im Zuge der Internationalisierung und für den Export ist es hilfreich, wenn sie nicht mehr verwendet wird.<ref>Eine Umstellung auf <code>wikitable</code> sollte bei der Bearbeitung eines Artikels erfolgen, Bearbeitungen die nur diese Umstellung beinhalten sowie Botläufe, sind zu unterlassen. Weitere Informationen gibt es dazu unter [[Wikipedia Diskussion:Bots/Archiv 2008#Klasse "wikitable"]] und [[MediaWiki Diskussion:Common.css#Klasse "wikitable"]]</ref>

Diese Umstellung ist in mancherlei Hinsicht nicht nur ein Segen. So kann mit <code>class="wikitable"</code> beispielsweise das [http://de.selfhtml.org/html/referenz/attribute.htm#table <code><span style="background-color:#FDFBCD;">'''cellpadding'''</span></code>] (die „Zellen-Polsterung“) anscheinend ''nicht mehr in einem Rutsch'' für die ganze Tabelle verändert/definiert werden<sup>[[[Wikipedia:Fragen zur Wikipedia/Archiv/2008/Woche 25#Falsch angewandtes cellpadding?|WP:FZW-Archiv: Juni 2008]]]</sup>. Wo deshalb „unbedingt“ nötig, kann statt <code style="white-space:nowrap;"><nowiki>{| class="wikitable"</nowiki></code> doch noch eine Entsprechung der „[[Vorlage:Prettytable]]“ verwendet werden:
* <code>border="1" <span style="background-color:#FDFBCD;">cellpadding="20"</span> style="margin:1em 1em 1em 0; background:#f9f9f9; border:1px #AAA solid; border-collapse:collapse; empty-cells:show;"</code>

;Tipp: Mit der Eigenschaft <code>text-indent</code> und einem Wert so um die 4px bekommt man einen ganz vernünftigen Abstand zum linken Rand hin. Wenn das hinter der Klasse "wikitable sortable" oder "wikitable" notiert wird, bezieht sich diese Zuweisung auf alle Zellen. So könnte die erste Zeile einer Tabelle aussehen: <code>{| class="wikitable sortable" style="text-indent:4px"</code>

== Einfache Tabelle ==
Eine einfache Beispieltabelle aus dem Artikel [[Bayern-Landshut#Liste der Herzöge von Bayern-Landshut|Bayern-Landshut]]:

{| class="wikitable"
|- class="hintergrundfarbe5"
! Name !! Regierungszeit !! Abstammung
|-
| [[Stephan II. (Bayern)|Stephan II.]] || <tt>1347–1375</tt> Herzog von Bayern || Sohn Kaiser Ludwigs IV.
|-
| [[Friedrich (Bayern)|Friedrich]] || <tt>1375–1393</tt> Herzog von Bayern-Landshut || Sohn Stephans II.
|-
| [[Heinrich XVI. (Bayern)|Heinrich XVI.]] || <tt>1393–1450</tt> Herzog von Bayern-Landshut || Sohn Friedrichs
|-
| [[Ludwig IX. (Bayern)|Ludwig IX.]] || <tt>1450–1479</tt> Herzog von Bayern-Landshut || Sohn Heinrichs XVI.
|-
| [[Georg (Bayern)|Georg]] || <tt>1479–1503</tt> Herzog von Bayern-Landshut || Sohn Ludwigs IX.
|}

Die obige Tabelle wird durch den folgenden Quelltext erzeugt:
<syntaxhighlight lang=html line>
{| class="wikitable"
|- class="hintergrundfarbe5"
! Name !! Regierungszeit !! Abstammung
|-
| [[Stephan II. (Bayern)|Stephan&nbsp;II.]] || <tt>1347–1375</tt> Herzog von Bayern || Sohn Kaiser Ludwigs&nbsp;IV.
|-
| [[Friedrich (Bayern)|Friedrich]] || <tt>1375–1393</tt> Herzog von Bayern-Landshut || Sohn Stephans&nbsp;II.
|-
| [[Heinrich XVI. (Bayern)|Heinrich&nbsp;XVI.]] || <tt>1393–1450</tt> Herzog von Bayern-Landshut || Sohn Friedrichs
|-
| [[Ludwig IX. (Bayern)|Ludwig&nbsp;IX.]] || <tt>1450–1479</tt> Herzog von Bayern-Landshut || Sohn Heinrichs&nbsp;XVI.
|-
| [[Georg (Bayern)|Georg]] || <tt>1479–1503</tt> Herzog von Bayern-Landshut || Sohn Ludwigs&nbsp;IX.
|}
</syntaxhighlight>

'''Erläuterungen'''

* Die Zeichen <code>{|</code> beginnen eine Tabelle, während <code>|}</code> sie abschließen. Beide Tags müssen an einem Zeilenanfang stehen.
* Das Attribut <code>class="wikitable"</code> veranlasst, dass die ganze Tabelle nach den Vorgaben der Klasse <code>wikitable</code> formatiert wird. Diese sieht unter anderem Trennlinien zwischen den Zellen sowie zusätzlichen Platz zwischen Zelleninhalt und Zellenrand (das sogenannte ''cellpadding'') vor.
* Zeilen, die mit einem Ausrufezeichen (<code>!</code>) beginnen, definieren Kopfzeilen von Tabellen. Der Text in einer Zelle einer solchen Zeile wird zentriert und fettgedruckt. Gewöhnliche Tabellenzeilen beginnen dagegen mit einem senkrechten Trennstrich (<code>|</code>).
* Das Tag <code>|-</code> beginnt eine neue Tabellenzeile, falls es im Quelltext an einem Zeilenanfang steht.
* Die Zeichen <code>||</code> trennen nebeneinanderliegende Tabellenzellen.
* Die Zeichenfolge <code>&nbsp;</code> anstatt eines Leerzeichens verhindert einen Zeilenumbruch zwischen den beiden Wörtern, die das Leerzeichen trennt.
* Die Jahreszahlen werden durch <code><tt></code> mit fester Zeichenbreite dargestellt, um sicherzugehen, dass sie am Bindestrich ausgerichtet werden.

Soll die Tabelle rechtsbündig zum Text ausgerichtet werden, lässt sich dies durch die zusätzliche Klasse <code>float-right</code> im Attribut erreichen: <code>class="wikitable float-right"</code>. Zentrierung der Tabelle erreicht man durch die zusätzliche Klasse <code>centered</code>: <code>class="wikitable centered"</code>.

== Sortierbare Tabelle ==
Sortierbare Tabellen ermöglichen verschiedene und vom Leser wählbare Sichtweisen auf eine Sache:
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! ABC !! Länge !! Breite !! Farbe !! class="unsortable" | Bemerkung
|-
| [[a]]
| style="text-align:right" | 1100
| style="text-align:right" | 1000
| hellblau
| Blau ist der Himmel
|-
| [[b]]
| style="text-align:right" | 30
| style="text-align:right" | 2
| grün
| Grün ist das Gras
|-
| [[c]]
| style="text-align:right" | 100
| style="text-align:right" | 90
| rot
| Rot ist die Liebe
|}

Diese sortierbare Tabelle wird durch folgenden Code erzeugt:
<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! ABC !! Länge !! Breite !! Farbe !! class="unsortable" | Bemerkung
|-
| [[a]]
| style="text-align:right" | 1100
| style="text-align:right" | 1000
| hellblau
| Blau ist der Himmel
|-
| [[b]]
| style="text-align:right" | 30
| style="text-align:right" | 2
| grün
| Grün ist das Gras
|-
| [[c]]
| style="text-align:right" | 100
| style="text-align:right" | 90
| rot
| Rot ist die Liebe
|}
</syntaxhighlight>

=== Sortierbare Namen ===
Nach der Namenskonvention steht in Wikipedia zuerst der Vorname, gefolgt vom Nachnamen.<br />Die [[Vorlage:SortKeyName]] sorgt dafür, dass die Tabellenspalten hier dennoch nach dem Nachnamen sortiert werden:
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Name !! Vorname !! Nachname
|-
| {{SortKeyName|Bernd|Müller}}
| Bernd
| Müller
|-
| {{SortKeyName|Hans|Zehnder}}
| Hans
| Zehnder
|-
| {{SortKeyName|Stefan|Ackermann}}
| Stefan
| Ackermann
|}
<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Name !! Vorname !! Nachname
|-
| {{SortKeyName|Bernd|Müller}}
| Bernd
| Müller
|-
| {{SortKeyName|Hans|Zehnder}}
| Hans
| Zehnder
|-
| {{SortKeyName|Stefan|Ackermann}}
| Stefan
| Ackermann
|}
</syntaxhighlight>

Bei komplizierteren Namen, beispielsweise mit zwei Vornamen oder mit Sonderzeichen im Namen funktioniert [[Vorlage:SortKey]]:
{| class="wikitable"
|-
| {{SortKey|Ambrozy, Peter}}[[Peter Michael Ambrozy|Peter Ambrozy]]
|}

<syntaxhighlight lang=html line>
| {{SortKey|Ambrozy, Peter}}[[Peter Michael Ambrozy|Peter Ambrozy]]
</syntaxhighlight>

Beispiel: [[Liste der Abgeordneten zum Kärntner Landtag (29. Gesetzgebungsperiode)|Abgeordnete im Kärntner Landtag]]

=== Sortierbare Zahlen und Geldbeträge ===
Zahlen und Geld-Währungen werden so rechtsbündig und sortierbar dargestellt:

{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! €<br />sortieren
|-
| style="text-align:right" | 1,00
|-
| style="text-align:right" | 2000,10
|-
| style="text-align:right" | 3.000,02
|-
| style="text-align:right" | 40.000,00
|-
| style="text-align:right" | 5,10
|-
| style="text-align:right" | 1.000.006,01
|-
| style="text-align:right" | 7000,01
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! €<br />sortieren
|-
| style="text-align:right" | 1,00
|-
| style="text-align:right" | 2000,10
|-
| style="text-align:right" | 3.000,02
|-
| style="text-align:right" | 40.000,00
|-
| style="text-align:right" | 5,10
|-
| style="text-align:right" | 1.000.006,01
|-
| style="text-align:right" | 7000,01
|}
</syntaxhighlight>

Rechtsbündige Zahlen werden nur dann korrekt sortiert, wenn die Anzahl der Nachkommastellen bei allen Einträgen einer Spalte gleich sind.

''Siehe auch:'' [[Vorlage:Dts]] für Datumsangaben, [[Vorlage:Nts]] und [[Vorlage:0]] für Zahlen

=== Verschiedenstellige Zahlen ===
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Nummer !! Ort
|-
| {{SortKey| 033_ | 033x }} || [[Land Brandenburg|Brandenburg]]
|-
| {{SortKey| 0330_ | 0330x }} || Oranienburg und Umgebung
|-
| 03301 || [[Oranienburg]]
|-
| 03302 || [[Hennigsdorf]]
|}

<syntaxhighlight lang=html line>
| {{SortKey| 033_ | 033x }} || [[Land Brandenburg|Brandenburg]]
|-
| {{SortKey| 0330_ | 0330x }} || Oranienburg und Umgebung
</syntaxhighlight>

Beispiel: [[Vorwahl 03 (Deutschland)|Telefon-Vorwahl 03 (Deutschland)]]

=== Sortierbare verschiedenstellige Zahlen mit Dezimaltrennzeichen ===
Damit bei verschiedenstelligen Zahlen in einer Spalte das Komma immer übereinander dargestellt wird gibt es zwei Möglichkeiten. Beide sind sortierbar. Lösung a) ist angenehmer zu lesen also für Wikipedia geeigneter. Lösung b) ist einfacher zu schreiben und für Zahlen mit immer gleicher Zahl von Nachkommastellen, Währungen beispielsweise, genauso gut geeignet:

a) Verwendung von [[Vorlage:0]] für alle führenden Nullen:

{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Zähler !! Wert
|-
| 1
| 1000
|-
| 2
| {{0}}{{0}}{{0}}1,0001
|-
| 3
| {{0}}200,2
|-
| 4
| {{0}}{{0}}{{0}}1,1
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Zähler !! Wert
|-
| 1
| 1000
|-
| 2
| {{0}}{{0}}{{0}}1,0001
|-
| 3
| {{0}}200,2
|-
| 4
| {{0}}{{0}}{{0}}1,1
|}
</syntaxhighlight>

b) rechtsbündiger Zellenformatierung unter Verwendung der gleichen Anzahl an Nachkommastellen, wobei die zur Ausrichtung künstlich aufgefüllten Nachkommastellen per <code><nowiki>{{0}}</nowiki></code> versteckt werden können, ein zu versteckendes Komma ist per <code><nowiki>{{0|,}}</nowiki></code> erzielbar:

{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Zähler !! Wert
|-
| 1
| style="text-align:right" | 1000{{0|,}}{{0}}{{0}}{{0}}{{0}}
|-
| 2
| style="text-align:right" | 1,0001
|-
| 3
| style="text-align:right" | 200,2{{0}}{{0}}{{0}}
|-
| 4
| style="text-align:right" | 1,1{{0}}{{0}}{{0}}
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Zähler !! Wert
|-
| 1
| style="text-align:right" | 1000{{0|,}}{{0}}{{0}}{{0}}{{0}}
|-
| 2
| style="text-align:right" | 1,0001
|-
| 3
| style="text-align:right" | 200,2{{0}}{{0}}{{0}}
|-
| 4
| style="text-align:right" | 1,1{{0}}{{0}}{{0}}
|}
</syntaxhighlight>

=== Sortierbare Zahl mit Währungs- oder %-Symbol ===
{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Zähler !! Prozent
|-
| 1
| 10 %
|-
| 2
| {{0}}1 %
|-
| 3
| {{0}}7 %
|-
| 4
| 80 %
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Zähler !! Prozent
|-
| 1
| 10 %
|-
| 2
| {{0}}3 %
|-
| 3
| {{0}}7 %
|-
| 4
| 80 %
|}
</syntaxhighlight>
=== Sortierbare Tabelle mit einer nicht-sortierbaren Zeile ===
{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Name !! Wert
|-
| Alfons
| 90
|-
| Berta
| 12
|- class="unsortable"
| '''Fest'''
| '''45'''
|-
| Cäsar
| 37
|-
| Dietmar
| 6
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Name !! Wert
|-
| Alfons
| 90
|-
| Berta
| 12
|- class="unsortable"
| '''Fest'''
| '''45'''
|-
| Cäsar
| 37
|-
| Dietmar
| 6
|}
</syntaxhighlight>

== Layout ==
=== Tabellenüberschriften, Trennstriche ===
Das folgende Beispiel zeigt, wie man eine Tabellenüberschrift erzeugt, sowie eine Möglichkeit, wie sich Trennstriche zwischen bestimmten Zellen realisieren lassen:

{| style="text-align:right;"
|+ Addition von vier Zahlen
|-
| <tt>365</tt>
|-
| <tt>+ 123</tt>
|-
| <tt>+ 235</tt>
|-
| <tt>+ 277</tt>
|-
| style="border-top: 1pt black solid;" | <tt>1000</tt>
|}

Der Quelltext dieser Beispieltabelle sieht wie folgt aus:

<syntaxhighlight lang=html line>
{| style="text-align:right;"
|+ Addition von vier Zahlen
|-
| <tt>365</tt>
|-
| <tt>+ 123</tt>
|-
| <tt>+ 235</tt>
|-
| <tt>+ 277</tt>
|-
| style="border-top: 1pt black solid;" | <tt>1000</tt>
|}
</syntaxhighlight>

'''Erläuterungen'''

* Die Zeile, die mit <code>|+</code> beginnt, bezeichnet den Titel der Tabelle.
* Der Befehl <code>border-top: 1pt</code> weist der Zelle einen oberen Rand mit definierter Breite zu. Weitere Befehle sind: <code>border-left, border-right</code> und <code>border-bottom</code> für einen Rand links, rechts oder unten. <code>border: 1pt</code> setzt alle vier Ränder.

=== Zellfärbung, Spaltenbreite, Textausrichtung ===
Dieses Beispiel erläutert, wie man sortierbare Tabellen erstellt, wie man Zellen färbt, den Zelleninhalt rechts ausrichtet und die Spaltenbreite einstellt. Es lehnt sich an die [[Liste der römischen Kaiser der Antike#Liste der römischen Kaiser|Liste der römischen Kaiser]] an:

{| class="wikitable sortable"
|+ style="padding-bottom:1em;" | Kaiser der Flavischen Dynastie
|- class="hintergrundfarbe5"
! width="15%" | Kaiser !! width="30%" | Vollständiger Name
! width="15%" | Regierungszeit !! class="unsortable" width="40%" | Anmerkungen
|-
| [[Vespasian]] || Titus Flavius Vespasianus
| style="text-align:right" | 69–79 || konsolidierte Verwaltung und Finanzen des Reiches
|-
| [[Titus]] || Titus Flavius Vespasianus
| style="text-align:right" | {{SortKey|79-81}}Mitte 79–81 || eröffnete das [[Kolosseum]] in Rom
|-
| [[Domitian]] || Titus Flavius Domitianus
| style="text-align:right" | 81–96 || beendete römische Expansion in Germanien
|-
| [[Lucius Antonius Saturninus|Saturninus]] || Lucius Antonius Saturninus
| style="text-align:right" | 89 || Gegenkaiser in Germanien, gefallen
|- class="sortbottom hintergrundfarbe5"
| '''[[Liste der römischen Kaiser der Antike#Liste der römischen Kaiser|Vollst. Liste]]'''
|
|
|
|}

Der Quelltext hierfür sieht folgendermaßen aus:

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|+ style="padding-bottom:1em;" | Kaiser der Flavischen Dynastie
|- class="hintergrundfarbe5"
! width="15%" | Kaiser !! width="30%" | Vollständiger Name
! width="15%" | Regierungszeit !! class="unsortable" width="40%" | Anmerkungen
|-
| [[Vespasian]] || Titus Flavius Vespasianus
| style="text-align:right" | 69–79 || konsolidierte Verwaltung und Finanzen des Reiches
|-
| [[Titus]] || Titus Flavius Vespasianus
| style="text-align:right" | {{SortKey|79-81}}Mitte 79–81 || eröffnete das [[Kolosseum]] in Rom
|-
| [[Domitian]] || Titus Flavius Domitianus
| style="text-align:right" | 81–96 || beendete römische Expansion in Germanien
|-
| [[Lucius Antonius Saturninus|Saturninus]] || Lucius Antonius Saturninus
| style="text-align:right" | 89 || Gegenkaiser in Germanien, gefallen
|- class="sortbottom hintergrundfarbe5"
| '''[[Liste der römischen Kaiser der Antike#Liste der römischen Kaiser|Vollst. Liste]]'''
|
|
|
|}
</syntaxhighlight>

'''Erläuterungen'''

* Das <code>sortable</code> in <code>class="wikitable sortable"</code> erlaubt die Sortierung der Tabelle nach wählbaren Spalten.
* Mit <code>class="unsortable"</code> können einzelne Spalten von der Sortierbarkeit ausgenommen werden.
* Mit den Vorlagen [[:Vorlage:Dts]], [[:Vorlage:Nts]] und [[:Vorlage:SortKey]] lässt sich die Sortierreihenfolge einzelner Tabelleneinträge beeinflussen
* Der Befehl <code>width="15%"</code> weist einer Spalte 15 % der Gesamtbreite der Tabelle als Breite zu.
* Die Ausrichtung von Text rechtsbündig in einer Zelle erreicht man durch die [[Cascading Style Sheets|CSS]]-Anweisung <code>style="text-align:right"</code>.
* Nebeneinanderliegende Zellen kann man sowohl durch das <code>||</code>-Zeichen trennen, als auch durch einen Zeilenumbruch gefolgt von einem einfachen <code>|</code>-Zeichen.
* Der Befehl <code>|- class="hintergrundfarbe5"</code> weist der darauffolgenden Zeile eine Hintergrundfarbe zu. In Artikeln sollen die entsprechenden Standardfarben verwendet werden (siehe [[Hilfe:Farben#Farben verwenden|Farben verwenden]] in der [[Hilfe:Farben|Hilfe zu Farben]]). Außerhalb des Artikelnamensraumes können Farben außer durch ihren englischen Namen auch als Hexadezimalzahl aus sechs Ziffern eingegeben werden, wobei die ersten zwei Ziffern für den Rotanteil von bis zu 256 stehen, die nächsten zwei für den Grünanteil und die letzten zwei für den Blauanteil, das heißt, dass <code>#ff0000</code> die Farbe Rot bedeutet, <code>#00ff00</code> steht für Grün und <code>#0000ff</code> steht für Blau. Durch eine Mischung erhält man beispielsweise Violett: <code>#ff00ff</code>.
* Leerzellen können durch einen einfachen Abstand erzeugt werden. Diese Zellen werden aber beim Sortieren an den Anfang gestellt, Leerzellen mit <code>&nbsp;</code> stehen am Ende.
* Das <code>sortbottom</code> in <code>class="sortbottom hintergrundfarbe5"</code> führt dazu, dass die Zeile von der Sortierung ausgenommen wird und damit stets als Fußzeile der Tabelle angezeigt wird.

=== Geschachtelte Tabellen ===
Tabellen können geschachtelt werden:

'''colspan'''

{| class="wikitable float-right" style="text-align:center"
! style="background:#e3e3e3" | A
! style="background:#e3e3e3" | B
! style="background:#e3e3e3" | C
|-
| colspan="3" style="background:#EED5B7" | eine Zeile
|}

<syntaxhighlight lang=html line>
{| class="wikitable" style="text-align:center"
! A
! B
! C
|-
| colspan="3" | eine Zeile
|}
</syntaxhighlight>
<br style="clear:both;" clear="all" />

'''rowspan'''

{| class="wikitable float-right" style="text-align:center"
! style="background:#e3e3e3" | A
| rowspan="3" style="background:#EED5B7" | eine Spalte
|-
! style="background:#e3e3e3" | B
|-
! style="background:#e3e3e3" | C
|}

<syntaxhighlight lang=html line>
{| class="wikitable" style="text-align:center"
! A
| rowspan="3" | eine Spalte
|-
! B
|-
! C
|}
</syntaxhighlight>
<br style="clear:both;" clear="all" />

'''colspan + rowspan'''

{| class="wikitable float-right" style="text-align:center"
! colspan="2" style="background:#e3e3e3" | A
|-
! style="background:#e3e3e3" | B
| rowspan="2" style="background:#EED5B7" | eine Spalte
|-
! style="background:#e3e3e3" | C
|}

<syntaxhighlight lang=html line>

{| class="wikitable" style="text-align:center"
! colspan="2" style="text-align:center" | A
|- style="text-align:center"
! B
| rowspan="2"| eine Spalte
|- style="text-align:center"
! C
|}

</syntaxhighlight>

<br style="clear:both;" clear="all" />

;
{| class="wikitable float-right" style="text-align:center"
|- style="background:#e3e3e3"
! colspan="4" | Titel
|- style="background:#e3e3e3"
! rowspan="2" style="background:#EED5B7" | eine Spalte
| A || B || C
|- style="background:#e3e3e3"
| D || E || F
|}

<syntaxhighlight lang=html line>
{| class="wikitable" style="text-align:center"
|-
! colspan="4" | Titel
|-
! rowspan="2" | eine Spalte
| A || B || C
|-
| D || E || F
|}
</syntaxhighlight>
<br style="clear:both;" clear="all" />

=== Tabellen nebeneinander ===
<syntaxhighlight lang=html line>
<div style="float:left; margin-right:1em;">
{| class="wikitable"
|+ Linke Tabelle
! Überschrift 1 || Überschrift 2
|-
| Feld 1 || Feld 2
|}
</div>

<div style="float:left;">
{| class="wikitable"
|+ Rechte Tabelle
! Überschrift 1 || Überschrift 2
|-
| Feld 1 || Feld 2
|}
</div>

<div style="clear:both;" />
</syntaxhighlight>

<div style="float:left; margin-right:1em;">
{| class="wikitable"
|+ Linke Tabelle
! Überschrift 1 || Überschrift 2
|-
| Feld 1 || Feld 2
|}
</div>

<div style="float:left;">
{| class="wikitable"
|+ Rechte Tabelle
! Überschrift 1 || Überschrift 2
|-
| Feld 1 || Feld 2
|}
</div>

<div style="clear:both;" />

=== Gleich breite Tabellen ===
<syntaxhighlight lang=html line>
{| class="wikitable"
|-
| style="width:5em" | a: 5em
| style="width:10em" | b: 10em
| style="width:7em" | c: 7em
|}
{| class="wikitable"
|-
| style="width:5em" | a: 5em
| style="width:10em" | b: 10em
| style="width:7em" | c: 7em
|}
</syntaxhighlight>

{| class="wikitable"
|-
| style="width:5em" | a: 5em
| style="width:10em" | b: 10em
| style="width:7em" | c: 7em
|}
{| class="wikitable"
|-
| style="width:5em" | a: 5em
| style="width:10em" | b: 10em
| style="width:7em" | c: 7em
|}

=== Listen in Tabellen, Bilder in Tabellen ===
Tabellen können Tabellen, Bilder und Wiki-Syntax-Formatierung enthalten:

{{Taxobox
| Taxon_Name = Hyänen
| Taxon_WissName = Hyaenidae
| Taxon_Rang = Familie
| Taxon_Autor = [[John Edward Gray|Gray]], 1821
| Taxon2_Name = Katzenartige
| Taxon2_WissName = Feloidea
| Taxon2_Rang = Überfamilie
| Taxon3_Name = Raubtiere
| Taxon3_WissName = Carnivora
| Taxon3_Rang = Ordnung
| Taxon4_Name = Höhere Säugetiere
| Taxon4_WissName = Eutheria
| Taxon4_Rang = Unterklasse
| Taxon5_Name = Säugetiere
| Taxon5_WissName = Mammalia
| Taxon5_Rang = Klasse
| Taxon6_Name = Kiefermäuler
| Taxon6_WissName = Gnathostomata
| Taxon6_Rang = Überklasse
| Bild = Crocuta-hejda.jpg
| Bildbeschreibung = [[Tüpfelhyäne]] ''(Crocuta crocuta)''
| Subtaxa_Rang = Art
| Subtaxa =
* [[Streifenhyäne]] ''(Hyaena hyaena)''
* [[Schabrackenhyäne]] ''(Hyaena brunnea)''
* [[Tüpfelhyäne]] ''(Crocuta crocuta)''
* [[Erdwolf]] ''(Proteles cristatus)''
}}

Dieser Text erzeugt die rechte Tabelle, wenn man ihn in einen Artikel eingibt:
<syntaxhighlight lang=ini>{{Taxobox
| Taxon_Name = Hyänen
| Taxon_WissName = Hyaenidae
| Taxon_Rang = Familie
| Taxon_Autor = [[John Edward Gray|Gray]], 1821
| Taxon2_Name = Katzenartige
| Taxon2_WissName = Feloidea
| Taxon2_Rang = Überfamilie
| Taxon3_Name = Raubtiere
| Taxon3_WissName = Carnivora
| Taxon3_Rang = Ordnung
| Taxon4_Name = Höhere Säugetiere
| Taxon4_WissName = Eutheria
| Taxon4_Rang = Unterklasse
| Taxon5_Name = Säugetiere
| Taxon5_WissName = Mammalia
| Taxon5_Rang = Klasse
| Taxon6_Name = Kiefermäuler
| Taxon6_WissName = Gnathostomata
| Taxon6_Rang = Überklasse
| Bild = Crocuta-hejda.jpg
| Bildbeschreibung = [[Tüpfelhyäne]] ''(Crocuta crocuta)''
| Subtaxa_Rang = Art
| Subtaxa =
* [[Streifenhyäne]] ''(Hyaena hyaena)''
* [[Schabrackenhyäne]] ''(Hyaena brunnea)''
* [[Tüpfelhyäne]] ''(Crocuta crocuta)''
* [[Erdwolf]] ''(Proteles cristatus)''
}}</syntaxhighlight>

'''Erläuterungen'''

→ ''Siehe: [[Wikipedia:Taxoboxen]]''

== Siehe auch ==

* Bei [[meta:Main Page|MetaWiki]] befindet sich ein [[meta:Help:Table|englischer Artikel]], der die Gestaltung mit Tabellen etwas ausführlicher behandelt.
* Außerdem gibt es bei [[meta:Main Page|MetaWiki]] einen [[meta:Help:Sorting|englischen Artikel]], der die Sortierung von Tabellen im Detail behandelt.
* Im Abschnitt [[Wikipedia:Wie gute Artikel aussehen#Tabellen|Tabellen]] in [[Wikipedia:Wie gute Artikel aussehen|Wie gute Artikel aussehen]] wird auf die Bedeutung von Vorlagen zur Vereinheitlichung hingewiesen.
* Der Abschnitt [[Hilfe:Bilder#Ausrichten im Text|Ausrichten im Text]] in der [[Hilfe:Bilder|Hilfe für Bilder]] über die Positionierung von Bildern in Tabellen
* In [[Hilfe:Tabellen-Referenz]] sind die einzelnen Möglichkeiten nochmals mit Beispielen aufgeführt.
* Beispiele: [[:Kategorie:Vorlage:Tabelle]] – Tabellen, die auf mehreren Seiten als Vorlage eingebunden werden

== Hilfen ==

* '''[[Benutzer:PeerBr/WPro|WPro]]''' (Server zur Zeit nicht erreichbar) ist ein Wikipedia-Editor für den [[Windows Internet Explorer|Internet Explorer]] 6.0, der Tabellen per Knopfdruck einfügen und formatieren kann.
* '''[[Wikipedia:Textverarbeitung/EXCEL-Tabellenumwandlung|EXCEL-Tabellenumwandlung]]''' konvertiert den ausgewählten Tabellenbereich aus MS Excel direkt ins Wiki-Tabellenformat. Die wichtigsten Formatierungen wie Fett/Kursiv, Zellenhöhe und -breite, Schriftgröße, Farbinformation aus MS Excel bleiben erhalten.
* '''[[Wikipedia:Textverarbeitung/Excel2Wiki|Excel2Wiki]]''' Berücksichtigt verbundene Zellen, dazu auch ein Programm zur Umwandlung der Spalten in Zeilen und umgekehrt und ein Programm zur Zeilenumkehr, d. h. die letzte Zeile wird zur ersten usw.
* '''[[Benutzer:Duesentrieb/csv2wp|csv2wp]]''' ist ein Werkzeug zum Umwandeln von [[CSV (Dateiformat)|CSV-Datei]]en in Wiki-Tabellenformat. Damit lassen sich z. B. Tabellen aus [[Microsoft Excel]] importieren.
* Ab [[OpenOffice.org|OpenOffice]] 2.3 kann man Writer-Dokumente ins [http://de.openoffice.org/presse/pressemitteilung_20070917.html Mediawiki-Format] exportieren.
* [[OpenOffice.org|OpenOffice]]-Tabellen können mit [[Wikipedia:Textverarbeitung/OOoCalc2Wiki|Calc2Wiki]] konvertiert werden. Eine Alternative (mit der ein oder anderen Erweiterung) ist [[Benutzer:Erodeist/Calc2WikiTable|Calc2WikiTable]].
* [http://www.cnic.org/html2mediawiki.html Umwandlung von HTML-Tabellen in Wiki-Tabellen]

----
[[Kategorie:Hilfe]]

Tabellen

2024-07-10T13:20:36Z

Hsh-milanihl:

{{Shortcut|WP:TAB, WP:TBL}}
{{Wikipedia-Hilfe}}
Wikipedia bietet eine eigene Syntax, um '''Tabellen''' darzustellen. Diese Syntax ist zwar an das verbreitete [[Hypertext Markup Language|HTML]] angelehnt, erleichtert jedoch durch eine vereinfachte Schreibweise die Arbeit an komplizierteren Tabellen wesentlich. Diese Seite bietet eine Kurzübersicht, wie du Tabellen erstellst, eine ausführliche Darstellung findet sich auf '''[[Hilfe:Tabellen-Referenz]]'''.

Um die Zellen einer Tabelle zu formatieren, lassen sich sowohl für die Tabelle als Ganzes als auch für einzelne Zellen HTML-Attribute angeben. Insbesondere kann das <tt>style</tt>-Attribut verwendet werden, wodurch sich beliebige [[Cascading Style Sheets|CSS]]-Formatierungen realisieren lassen. Zwar lassen sich auch einzelne Zeilen einer Tabelle formatieren, möchte man jedoch ein Attribut an eine bestimmte Spalte vergeben, so muss dies zellenweise geschehen.

== Wann Tabellen einsetzen? ==
'''Tabellen''' sind ein gutes Mittel, um gleichartige Informationen übersichtlich zu gestalten. Sie helfen die Beziehungen zwischen Tabellenzellen und ihren Zeilen und Spalten zu verstehen (siehe [[Semantik|semantische Beziehungen]]). Insbesondere als sortierbare Tabellen bieten sie einen schnellen Überblick beispielsweise über Jahreszahlen, Namen oder Orte.
:''Siehe Hauptartikel [[Wikipedia:Tabellen]]''.

Andererseits sind Tabellen komplizierter als normaler Text. Deshalb sollten sie nur dort eingesetzt werden, wo sie tatsächlich für bessere Übersicht sorgen. Überlege immer, ob du die Informationen nicht besser in einer einfachen Liste unterbringen kannst (siehe [[Hilfe:Textgestaltung|Textgestaltung]] und [[Hilfe:Listen|Listen]]).

Tabellen sollte man nicht als „grafisches Gestaltungsmittel“ einsetzen.

== CSS-Klassen für Tabellen ==
Um Tabellen sowohl in ihren Inhalten als auch bereits im Kopfbereich weitestgehend frei von Elementen zu halten, die die Darstellungsweise betreffen, wurden für das global wirksame CSS einige Klassen entwickelt, die es erlauben, wichtige Stile mit wenigen anschaulichen Anweisungen festzulegen.

=== wikitable ===
Mittels <code>class="wikitable"</code> im Tabellenkopf lässt sich eine schwach grau getönte Tabelle mit sichtbaren, wenngleich dezenten Zellgrenzen erstellen. Zwischen Zellinhalt und Rand wird etwas "Luft" gelassen. Die Standardtabelle ist rahmenlos und hat weißen Hintergrund, was für Layout-Zwecke teilweise erwünscht ist, sich jedoch in bestimmten Fällen zu schlecht vom Text absetzt.

Die Klasse <code>prettytable</code> mit einem ganz ähnlichem Anspruch sollte nicht mehr verwendet werden, um die Kohärenz der Stilmittel zwischen den verschiedenen Wikipedias zu fördern. Sie wird ausschließlich in der deutschen Wikipedia verwendet.

=== sortable ===
Mittels <code>class="sortable"</code> werden Spalten sortierbar gemacht. Das heißt, wenn [[JavaScript]] für die Wikipedia aktiviert ist, können Tabellen durch Klick auf das entsprechende Symbol in einem Spaltenkopf nach dieser Spalte auf- und absteigend sortiert werden. Die mitunter unsortierte Ausgangs-Darstellung erhält man durch Neuladen der Seite. Einzelne Spalten, für die eine Sortierung als unsinnig angesehen wird, können mittels der spaltenweisen Angabe von <code>class="unsortable"</code> markiert werden, so werden die Sortierfunktion und -symbol unterdrückt. Mit der gleichen Angabe können auch einzelne Tabellen''zeilen'' von der Sortierung ausgenommen werden.

''siehe auch:'' [[:meta:Help:Sorting|MediaWiki Handbook - Sorting]]

=== toptextcells ===
Durch <code>class="toptextcells"</code> im Tabellenkopf kann das Standardverhalten, dass Texte in Zellen vertikal zentriert dargestellt werden, dahingehend abgeändert werden, dass die Texte immer oben beginnen und der Abstand jeweils nach unten variiert. In Fällen stark unterschiedlicher Auffüllung führt dies zu einer größeren Übersicht, die obere Textzeile bildet mit der oberen Begrenzung zusammen eine Flucht. Die Alternative zu dieser Klasse wäre die Einfügung von style-Anweisungen pro Tabellenzeile.

=== Kombinationen ===
Die genannten drei Klassen lassen sich kombinieren. Hierbei sollte Augenmaß gewahrt werden, nicht jede Eigenschaft ist immer passend. Sortierbare Wikitables (<code>class="wikitable sortable"</code>) werden sich häufig anbieten. Oben ausgerichtete Texte in Zellen werden häufig mit Wikitable kombiniert werden.

Auch Kombinationen aller drei Stile sind denkbar, wenn in Tabellen umfangreiche Erläuterungen enthalten sind, diese sollten dann als <code>unsortable</code> markiert werden.

=== Probleme mit der class="wikitable" ===

Am 23. Februar 2008 wurde die „[[Vorlage:Prettytable]]“ als „veraltet“ [{{fullurl:Spezial:Logbuch|type=delete&page=Vorlage:Prettytable&year=2008&month=2}} gelöscht] und somit endgültig von der [[Cascading Style Sheets|CSS]]-<code>class="wikitable"</code> ersetzt (zu finden in [[MediaWiki:Common.css]]). Daneben existiert auch die <code>class="prettytable"</code>, diese sollte aber nicht mehr verwendet werden, da die deutschsprachige Wikipedia die einzige ist, welche diese Klasse verwendet. Im Zuge der Internationalisierung und für den Export ist es hilfreich, wenn sie nicht mehr verwendet wird.<ref>Eine Umstellung auf <code>wikitable</code> sollte bei der Bearbeitung eines Artikels erfolgen, Bearbeitungen die nur diese Umstellung beinhalten sowie Botläufe, sind zu unterlassen. Weitere Informationen gibt es dazu unter [[Wikipedia Diskussion:Bots/Archiv 2008#Klasse "wikitable"]] und [[MediaWiki Diskussion:Common.css#Klasse "wikitable"]]</ref>

Diese Umstellung ist in mancherlei Hinsicht nicht nur ein Segen. So kann mit <code>class="wikitable"</code> beispielsweise das [http://de.selfhtml.org/html/referenz/attribute.htm#table <code><span style="background-color:#FDFBCD;">'''cellpadding'''</span></code>] (die „Zellen-Polsterung“) anscheinend ''nicht mehr in einem Rutsch'' für die ganze Tabelle verändert/definiert werden<sup>[[[Wikipedia:Fragen zur Wikipedia/Archiv/2008/Woche 25#Falsch angewandtes cellpadding?|WP:FZW-Archiv: Juni 2008]]]</sup>. Wo deshalb „unbedingt“ nötig, kann statt <code style="white-space:nowrap;"><nowiki>{| class="wikitable"</nowiki></code> doch noch eine Entsprechung der „[[Vorlage:Prettytable]]“ verwendet werden:
* <code>border="1" <span style="background-color:#FDFBCD;">cellpadding="20"</span> style="margin:1em 1em 1em 0; background:#f9f9f9; border:1px #AAA solid; border-collapse:collapse; empty-cells:show;"</code>

;Tipp: Mit der Eigenschaft <code>text-indent</code> und einem Wert so um die 4px bekommt man einen ganz vernünftigen Abstand zum linken Rand hin. Wenn das hinter der Klasse "wikitable sortable" oder "wikitable" notiert wird, bezieht sich diese Zuweisung auf alle Zellen. So könnte die erste Zeile einer Tabelle aussehen: <code>{| class="wikitable sortable" style="text-indent:4px"</code>

== Einfache Tabelle ==
Eine einfache Beispieltabelle aus dem Artikel [[Bayern-Landshut#Liste der Herzöge von Bayern-Landshut|Bayern-Landshut]]:

{| class="wikitable"
|- class="hintergrundfarbe5"
! Name !! Regierungszeit !! Abstammung
|-
| [[Stephan II. (Bayern)|Stephan II.]] || <tt>1347–1375</tt> Herzog von Bayern || Sohn Kaiser Ludwigs IV.
|-
| [[Friedrich (Bayern)|Friedrich]] || <tt>1375–1393</tt> Herzog von Bayern-Landshut || Sohn Stephans II.
|-
| [[Heinrich XVI. (Bayern)|Heinrich XVI.]] || <tt>1393–1450</tt> Herzog von Bayern-Landshut || Sohn Friedrichs
|-
| [[Ludwig IX. (Bayern)|Ludwig IX.]] || <tt>1450–1479</tt> Herzog von Bayern-Landshut || Sohn Heinrichs XVI.
|-
| [[Georg (Bayern)|Georg]] || <tt>1479–1503</tt> Herzog von Bayern-Landshut || Sohn Ludwigs IX.
|}

Die obige Tabelle wird durch den folgenden Quelltext erzeugt:
<syntaxhighlight lang=html line>
{| class="wikitable"
|- class="hintergrundfarbe5"
! Name !! Regierungszeit !! Abstammung
|-
| [[Stephan II. (Bayern)|Stephan&nbsp;II.]] || <tt>1347–1375</tt> Herzog von Bayern || Sohn Kaiser Ludwigs&nbsp;IV.
|-
| [[Friedrich (Bayern)|Friedrich]] || <tt>1375–1393</tt> Herzog von Bayern-Landshut || Sohn Stephans&nbsp;II.
|-
| [[Heinrich XVI. (Bayern)|Heinrich&nbsp;XVI.]] || <tt>1393–1450</tt> Herzog von Bayern-Landshut || Sohn Friedrichs
|-
| [[Ludwig IX. (Bayern)|Ludwig&nbsp;IX.]] || <tt>1450–1479</tt> Herzog von Bayern-Landshut || Sohn Heinrichs&nbsp;XVI.
|-
| [[Georg (Bayern)|Georg]] || <tt>1479–1503</tt> Herzog von Bayern-Landshut || Sohn Ludwigs&nbsp;IX.
|}
</syntaxhighlight>

'''Erläuterungen'''

* Die Zeichen <code>{|</code> beginnen eine Tabelle, während <code>|}</code> sie abschließen. Beide Tags müssen an einem Zeilenanfang stehen.
* Das Attribut <code>class="wikitable"</code> veranlasst, dass die ganze Tabelle nach den Vorgaben der Klasse <code>wikitable</code> formatiert wird. Diese sieht unter anderem Trennlinien zwischen den Zellen sowie zusätzlichen Platz zwischen Zelleninhalt und Zellenrand (das sogenannte ''cellpadding'') vor.
* Zeilen, die mit einem Ausrufezeichen (<code>!</code>) beginnen, definieren Kopfzeilen von Tabellen. Der Text in einer Zelle einer solchen Zeile wird zentriert und fettgedruckt. Gewöhnliche Tabellenzeilen beginnen dagegen mit einem senkrechten Trennstrich (<code>|</code>).
* Das Tag <code>|-</code> beginnt eine neue Tabellenzeile, falls es im Quelltext an einem Zeilenanfang steht.
* Die Zeichen <code>||</code> trennen nebeneinanderliegende Tabellenzellen.
* Die Zeichenfolge <code>&nbsp;</code> anstatt eines Leerzeichens verhindert einen Zeilenumbruch zwischen den beiden Wörtern, die das Leerzeichen trennt.
* Die Jahreszahlen werden durch <code><tt></code> mit fester Zeichenbreite dargestellt, um sicherzugehen, dass sie am Bindestrich ausgerichtet werden.

Soll die Tabelle rechtsbündig zum Text ausgerichtet werden, lässt sich dies durch die zusätzliche Klasse <code>float-right</code> im Attribut erreichen: <code>class="wikitable float-right"</code>. Zentrierung der Tabelle erreicht man durch die zusätzliche Klasse <code>centered</code>: <code>class="wikitable centered"</code>.

== Sortierbare Tabelle ==
Sortierbare Tabellen ermöglichen verschiedene und vom Leser wählbare Sichtweisen auf eine Sache:
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! ABC !! Länge !! Breite !! Farbe !! class="unsortable" | Bemerkung
|-
| [[a]]
| style="text-align:right" | 1100
| style="text-align:right" | 1000
| hellblau
| Blau ist der Himmel
|-
| [[b]]
| style="text-align:right" | 30
| style="text-align:right" | 2
| grün
| Grün ist das Gras
|-
| [[c]]
| style="text-align:right" | 100
| style="text-align:right" | 90
| rot
| Rot ist die Liebe
|}

Diese sortierbare Tabelle wird durch folgenden Code erzeugt:
<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! ABC !! Länge !! Breite !! Farbe !! class="unsortable" | Bemerkung
|-
| [[a]]
| style="text-align:right" | 1100
| style="text-align:right" | 1000
| hellblau
| Blau ist der Himmel
|-
| [[b]]
| style="text-align:right" | 30
| style="text-align:right" | 2
| grün
| Grün ist das Gras
|-
| [[c]]
| style="text-align:right" | 100
| style="text-align:right" | 90
| rot
| Rot ist die Liebe
|}
</syntaxhighlight>

=== Sortierbare Namen ===
Nach der Namenskonvention steht in Wikipedia zuerst der Vorname, gefolgt vom Nachnamen.<br />Die [[Vorlage:SortKeyName]] sorgt dafür, dass die Tabellenspalten hier dennoch nach dem Nachnamen sortiert werden:
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Name !! Vorname !! Nachname
|-
| {{SortKeyName|Bernd|Müller}}
| Bernd
| Müller
|-
| {{SortKeyName|Hans|Zehnder}}
| Hans
| Zehnder
|-
| {{SortKeyName|Stefan|Ackermann}}
| Stefan
| Ackermann
|}
<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Name !! Vorname !! Nachname
|-
| {{SortKeyName|Bernd|Müller}}
| Bernd
| Müller
|-
| {{SortKeyName|Hans|Zehnder}}
| Hans
| Zehnder
|-
| {{SortKeyName|Stefan|Ackermann}}
| Stefan
| Ackermann
|}
</syntaxhighlight>

Bei komplizierteren Namen, beispielsweise mit zwei Vornamen oder mit Sonderzeichen im Namen funktioniert [[Vorlage:SortKey]]:
{| class="wikitable"
|-
| {{SortKey|Ambrozy, Peter}}[[Peter Michael Ambrozy|Peter Ambrozy]]
|}

<syntaxhighlight lang=html line>
| {{SortKey|Ambrozy, Peter}}[[Peter Michael Ambrozy|Peter Ambrozy]]
</syntaxhighlight>

Beispiel: [[Liste der Abgeordneten zum Kärntner Landtag (29. Gesetzgebungsperiode)|Abgeordnete im Kärntner Landtag]]

=== Sortierbare Zahlen und Geldbeträge ===
Zahlen und Geld-Währungen werden so rechtsbündig und sortierbar dargestellt:

{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! €<br />sortieren
|-
| style="text-align:right" | 1,00
|-
| style="text-align:right" | 2000,10
|-
| style="text-align:right" | 3.000,02
|-
| style="text-align:right" | 40.000,00
|-
| style="text-align:right" | 5,10
|-
| style="text-align:right" | 1.000.006,01
|-
| style="text-align:right" | 7000,01
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! €<br />sortieren
|-
| style="text-align:right" | 1,00
|-
| style="text-align:right" | 2000,10
|-
| style="text-align:right" | 3.000,02
|-
| style="text-align:right" | 40.000,00
|-
| style="text-align:right" | 5,10
|-
| style="text-align:right" | 1.000.006,01
|-
| style="text-align:right" | 7000,01
|}
</syntaxhighlight>

Rechtsbündige Zahlen werden nur dann korrekt sortiert, wenn die Anzahl der Nachkommastellen bei allen Einträgen einer Spalte gleich sind.

''Siehe auch:'' [[Vorlage:Dts]] für Datumsangaben, [[Vorlage:Nts]] und [[Vorlage:0]] für Zahlen

=== Verschiedenstellige Zahlen ===
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Nummer !! Ort
|-
| {{SortKey| 033_ | 033x }} || [[Land Brandenburg|Brandenburg]]
|-
| {{SortKey| 0330_ | 0330x }} || Oranienburg und Umgebung
|-
| 03301 || [[Oranienburg]]
|-
| 03302 || [[Hennigsdorf]]
|}

<syntaxhighlight lang=html line>
| {{SortKey| 033_ | 033x }} || [[Land Brandenburg|Brandenburg]]
|-
| {{SortKey| 0330_ | 0330x }} || Oranienburg und Umgebung
</syntaxhighlight>

Beispiel: [[Vorwahl 03 (Deutschland)|Telefon-Vorwahl 03 (Deutschland)]]

=== Sortierbare verschiedenstellige Zahlen mit Dezimaltrennzeichen ===
Damit bei verschiedenstelligen Zahlen in einer Spalte das Komma immer übereinander dargestellt wird gibt es zwei Möglichkeiten. Beide sind sortierbar. Lösung a) ist angenehmer zu lesen also für Wikipedia geeigneter. Lösung b) ist einfacher zu schreiben und für Zahlen mit immer gleicher Zahl von Nachkommastellen, Währungen beispielsweise, genauso gut geeignet:

a) Verwendung von [[Vorlage:0]] für alle führenden Nullen:

{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Zähler !! Wert
|-
| 1
| 1000
|-
| 2
| {{0}}{{0}}{{0}}1,0001
|-
| 3
| {{0}}200,2
|-
| 4
| {{0}}{{0}}{{0}}1,1
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Zähler !! Wert
|-
| 1
| 1000
|-
| 2
| {{0}}{{0}}{{0}}1,0001
|-
| 3
| {{0}}200,2
|-
| 4
| {{0}}{{0}}{{0}}1,1
|}
</syntaxhighlight>

b) rechtsbündiger Zellenformatierung unter Verwendung der gleichen Anzahl an Nachkommastellen, wobei die zur Ausrichtung künstlich aufgefüllten Nachkommastellen per <code><nowiki>{{0}}</nowiki></code> versteckt werden können, ein zu versteckendes Komma ist per <code><nowiki>{{0|,}}</nowiki></code> erzielbar:

{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Zähler !! Wert
|-
| 1
| style="text-align:right" | 1000{{0|,}}{{0}}{{0}}{{0}}{{0}}
|-
| 2
| style="text-align:right" | 1,0001
|-
| 3
| style="text-align:right" | 200,2{{0}}{{0}}{{0}}
|-
| 4
| style="text-align:right" | 1,1{{0}}{{0}}{{0}}
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Zähler !! Wert
|-
| 1
| style="text-align:right" | 1000{{0|,}}{{0}}{{0}}{{0}}{{0}}
|-
| 2
| style="text-align:right" | 1,0001
|-
| 3
| style="text-align:right" | 200,2{{0}}{{0}}{{0}}
|-
| 4
| style="text-align:right" | 1,1{{0}}{{0}}{{0}}
|}
</syntaxhighlight>

=== Sortierbare Zahl mit Währungs- oder %-Symbol ===
{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Zähler !! Prozent
|-
| 1
| 10 %
|-
| 2
| {{0}}1 %
|-
| 3
| {{0}}7 %
|-
| 4
| 80 %
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Zähler !! Prozent
|-
| 1
| 10 %
|-
| 2
| {{0}}3 %
|-
| 3
| {{0}}7 %
|-
| 4
| 80 %
|}
</syntaxhighlight>
=== Sortierbare Tabelle mit einer nicht-sortierbaren Zeile ===
{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Name !! Wert
|-
| Alfons
| 90
|-
| Berta
| 12
|- class="unsortable"
| '''Fest'''
| '''45'''
|-
| Cäsar
| 37
|-
| Dietmar
| 6
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Name !! Wert
|-
| Alfons
| 90
|-
| Berta
| 12
|- class="unsortable"
| '''Fest'''
| '''45'''
|-
| Cäsar
| 37
|-
| Dietmar
| 6
|}
</syntaxhighlight>

== Layout ==
=== Tabellenüberschriften, Trennstriche ===
Das folgende Beispiel zeigt, wie man eine Tabellenüberschrift erzeugt, sowie eine Möglichkeit, wie sich Trennstriche zwischen bestimmten Zellen realisieren lassen:

{| style="text-align:right;"
|+ Addition von vier Zahlen
|-
| <tt>365</tt>
|-
| <tt>+ 123</tt>
|-
| <tt>+ 235</tt>
|-
| <tt>+ 277</tt>
|-
| style="border-top: 1pt black solid;" | <tt>1000</tt>
|}

Der Quelltext dieser Beispieltabelle sieht wie folgt aus:

<syntaxhighlight lang=html line>
{| style="text-align:right;"
|+ Addition von vier Zahlen
|-
| <tt>365</tt>
|-
| <tt>+ 123</tt>
|-
| <tt>+ 235</tt>
|-
| <tt>+ 277</tt>
|-
| style="border-top: 1pt black solid;" | <tt>1000</tt>
|}
</syntaxhighlight>

'''Erläuterungen'''

* Die Zeile, die mit <code>|+</code> beginnt, bezeichnet den Titel der Tabelle.
* Der Befehl <code>border-top: 1pt</code> weist der Zelle einen oberen Rand mit definierter Breite zu. Weitere Befehle sind: <code>border-left, border-right</code> und <code>border-bottom</code> für einen Rand links, rechts oder unten. <code>border: 1pt</code> setzt alle vier Ränder.

=== Zellfärbung, Spaltenbreite, Textausrichtung ===
Dieses Beispiel erläutert, wie man sortierbare Tabellen erstellt, wie man Zellen färbt, den Zelleninhalt rechts ausrichtet und die Spaltenbreite einstellt. Es lehnt sich an die [[Liste der römischen Kaiser der Antike#Liste der römischen Kaiser|Liste der römischen Kaiser]] an:

{| class="wikitable sortable"
|+ style="padding-bottom:1em;" | Kaiser der Flavischen Dynastie
|- class="hintergrundfarbe5"
! width="15%" | Kaiser !! width="30%" | Vollständiger Name
! width="15%" | Regierungszeit !! class="unsortable" width="40%" | Anmerkungen
|-
| [[Vespasian]] || Titus Flavius Vespasianus
| style="text-align:right" | 69–79 || konsolidierte Verwaltung und Finanzen des Reiches
|-
| [[Titus]] || Titus Flavius Vespasianus
| style="text-align:right" | {{SortKey|79-81}}Mitte 79–81 || eröffnete das [[Kolosseum]] in Rom
|-
| [[Domitian]] || Titus Flavius Domitianus
| style="text-align:right" | 81–96 || beendete römische Expansion in Germanien
|-
| [[Lucius Antonius Saturninus|Saturninus]] || Lucius Antonius Saturninus
| style="text-align:right" | 89 || Gegenkaiser in Germanien, gefallen
|- class="sortbottom hintergrundfarbe5"
| '''[[Liste der römischen Kaiser der Antike#Liste der römischen Kaiser|Vollst. Liste]]'''
|
|
|
|}

Der Quelltext hierfür sieht folgendermaßen aus:

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|+ style="padding-bottom:1em;" | Kaiser der Flavischen Dynastie
|- class="hintergrundfarbe5"
! width="15%" | Kaiser !! width="30%" | Vollständiger Name
! width="15%" | Regierungszeit !! class="unsortable" width="40%" | Anmerkungen
|-
| [[Vespasian]] || Titus Flavius Vespasianus
| style="text-align:right" | 69–79 || konsolidierte Verwaltung und Finanzen des Reiches
|-
| [[Titus]] || Titus Flavius Vespasianus
| style="text-align:right" | {{SortKey|79-81}}Mitte 79–81 || eröffnete das [[Kolosseum]] in Rom
|-
| [[Domitian]] || Titus Flavius Domitianus
| style="text-align:right" | 81–96 || beendete römische Expansion in Germanien
|-
| [[Lucius Antonius Saturninus|Saturninus]] || Lucius Antonius Saturninus
| style="text-align:right" | 89 || Gegenkaiser in Germanien, gefallen
|- class="sortbottom hintergrundfarbe5"
| '''[[Liste der römischen Kaiser der Antike#Liste der römischen Kaiser|Vollst. Liste]]'''
|
|
|
|}
</syntaxhighlight>

'''Erläuterungen'''

* Das <code>sortable</code> in <code>class="wikitable sortable"</code> erlaubt die Sortierung der Tabelle nach wählbaren Spalten.
* Mit <code>class="unsortable"</code> können einzelne Spalten von der Sortierbarkeit ausgenommen werden.
* Mit den Vorlagen [[:Vorlage:Dts]], [[:Vorlage:Nts]] und [[:Vorlage:SortKey]] lässt sich die Sortierreihenfolge einzelner Tabelleneinträge beeinflussen
* Der Befehl <code>width="15%"</code> weist einer Spalte 15 % der Gesamtbreite der Tabelle als Breite zu.
* Die Ausrichtung von Text rechtsbündig in einer Zelle erreicht man durch die [[Cascading Style Sheets|CSS]]-Anweisung <code>style="text-align:right"</code>.
* Nebeneinanderliegende Zellen kann man sowohl durch das <code>||</code>-Zeichen trennen, als auch durch einen Zeilenumbruch gefolgt von einem einfachen <code>|</code>-Zeichen.
* Der Befehl <code>|- class="hintergrundfarbe5"</code> weist der darauffolgenden Zeile eine Hintergrundfarbe zu. In Artikeln sollen die entsprechenden Standardfarben verwendet werden (siehe [[Hilfe:Farben#Farben verwenden|Farben verwenden]] in der [[Hilfe:Farben|Hilfe zu Farben]]). Außerhalb des Artikelnamensraumes können Farben außer durch ihren englischen Namen auch als Hexadezimalzahl aus sechs Ziffern eingegeben werden, wobei die ersten zwei Ziffern für den Rotanteil von bis zu 256 stehen, die nächsten zwei für den Grünanteil und die letzten zwei für den Blauanteil, das heißt, dass <code>#ff0000</code> die Farbe Rot bedeutet, <code>#00ff00</code> steht für Grün und <code>#0000ff</code> steht für Blau. Durch eine Mischung erhält man beispielsweise Violett: <code>#ff00ff</code>.
* Leerzellen können durch einen einfachen Abstand erzeugt werden. Diese Zellen werden aber beim Sortieren an den Anfang gestellt, Leerzellen mit <code>&nbsp;</code> stehen am Ende.
* Das <code>sortbottom</code> in <code>class="sortbottom hintergrundfarbe5"</code> führt dazu, dass die Zeile von der Sortierung ausgenommen wird und damit stets als Fußzeile der Tabelle angezeigt wird.

=== Geschachtelte Tabellen ===
Tabellen können geschachtelt werden:

'''colspan'''

{| class="wikitable float-right" style="text-align:center"
! style="background:#e3e3e3" | A
! style="background:#e3e3e3" | B
! style="background:#e3e3e3" | C
|-
| colspan="3" style="background:#EED5B7" | eine Zeile
|}

<syntaxhighlight lang=html line>
{| class="wikitable" style="text-align:center"
! A
! B
! C
|-
| colspan="3" | eine Zeile
|}
</syntaxhighlight>
<br style="clear:both;" clear="all" />

'''rowspan'''

{| class="wikitable float-right" style="text-align:center"
! style="background:#e3e3e3" | A
| rowspan="3" style="background:#EED5B7" | eine Spalte
|-
! style="background:#e3e3e3" | B
|-
! style="background:#e3e3e3" | C
|}

<syntaxhighlight lang=html line>
{| class="wikitable" style="text-align:center"
! A
| rowspan="3" | eine Spalte
|-
! B
|-
! C
|}
</syntaxhighlight>
<br style="clear:both;" clear="all" />

'''colspan + rowspan'''

{| class="wikitable float-right" style="text-align:center"
! colspan="2" style="background:#e3e3e3" | A
|-
! style="background:#e3e3e3" | B
| rowspan="2" style="background:#EED5B7" | eine Spalte
|-
! style="background:#e3e3e3" | C
|}

<syntaxhighlight lang=html line>

{| class="wikitable" style="text-align:center"
! colspan="2" style="text-align:center" | A
|- style="text-align:center"
! B
| rowspan="2"| eine Spalte
|- style="text-align:center"
! C
|}

</syntaxhighlight lang=html line>

<br style="clear:both;" clear="all" />

;
{| class="wikitable float-right" style="text-align:center"
|- style="background:#e3e3e3"
! colspan="4" | Titel
|- style="background:#e3e3e3"
! rowspan="2" style="background:#EED5B7" | eine Spalte
| A || B || C
|- style="background:#e3e3e3"
| D || E || F
|}

<syntaxhighlight lang=html line>
{| class="wikitable" style="text-align:center"
|-
! colspan="4" | Titel
|-
! rowspan="2" | eine Spalte
| A || B || C
|-
| D || E || F
|}
</syntaxhighlight>
<br style="clear:both;" clear="all" />

=== Tabellen nebeneinander ===
<syntaxhighlight lang=html line>
<div style="float:left; margin-right:1em;">
{| class="wikitable"
|+ Linke Tabelle
! Überschrift 1 || Überschrift 2
|-
| Feld 1 || Feld 2
|}
</div>

<div style="float:left;">
{| class="wikitable"
|+ Rechte Tabelle
! Überschrift 1 || Überschrift 2
|-
| Feld 1 || Feld 2
|}
</div>

<div style="clear:both;" />
</syntaxhighlight>

<div style="float:left; margin-right:1em;">
{| class="wikitable"
|+ Linke Tabelle
! Überschrift 1 || Überschrift 2
|-
| Feld 1 || Feld 2
|}
</div>

<div style="float:left;">
{| class="wikitable"
|+ Rechte Tabelle
! Überschrift 1 || Überschrift 2
|-
| Feld 1 || Feld 2
|}
</div>

<div style="clear:both;" />

=== Gleich breite Tabellen ===
<syntaxhighlight lang=html line>
{| class="wikitable"
|-
| style="width:5em" | a: 5em
| style="width:10em" | b: 10em
| style="width:7em" | c: 7em
|}
{| class="wikitable"
|-
| style="width:5em" | a: 5em
| style="width:10em" | b: 10em
| style="width:7em" | c: 7em
|}
</syntaxhighlight>

{| class="wikitable"
|-
| style="width:5em" | a: 5em
| style="width:10em" | b: 10em
| style="width:7em" | c: 7em
|}
{| class="wikitable"
|-
| style="width:5em" | a: 5em
| style="width:10em" | b: 10em
| style="width:7em" | c: 7em
|}

=== Listen in Tabellen, Bilder in Tabellen ===
Tabellen können Tabellen, Bilder und Wiki-Syntax-Formatierung enthalten:

{{Taxobox
| Taxon_Name = Hyänen
| Taxon_WissName = Hyaenidae
| Taxon_Rang = Familie
| Taxon_Autor = [[John Edward Gray|Gray]], 1821
| Taxon2_Name = Katzenartige
| Taxon2_WissName = Feloidea
| Taxon2_Rang = Überfamilie
| Taxon3_Name = Raubtiere
| Taxon3_WissName = Carnivora
| Taxon3_Rang = Ordnung
| Taxon4_Name = Höhere Säugetiere
| Taxon4_WissName = Eutheria
| Taxon4_Rang = Unterklasse
| Taxon5_Name = Säugetiere
| Taxon5_WissName = Mammalia
| Taxon5_Rang = Klasse
| Taxon6_Name = Kiefermäuler
| Taxon6_WissName = Gnathostomata
| Taxon6_Rang = Überklasse
| Bild = Crocuta-hejda.jpg
| Bildbeschreibung = [[Tüpfelhyäne]] ''(Crocuta crocuta)''
| Subtaxa_Rang = Art
| Subtaxa =
* [[Streifenhyäne]] ''(Hyaena hyaena)''
* [[Schabrackenhyäne]] ''(Hyaena brunnea)''
* [[Tüpfelhyäne]] ''(Crocuta crocuta)''
* [[Erdwolf]] ''(Proteles cristatus)''
}}

Dieser Text erzeugt die rechte Tabelle, wenn man ihn in einen Artikel eingibt:
<syntaxhighlight lang=ini>{{Taxobox
| Taxon_Name = Hyänen
| Taxon_WissName = Hyaenidae
| Taxon_Rang = Familie
| Taxon_Autor = [[John Edward Gray|Gray]], 1821
| Taxon2_Name = Katzenartige
| Taxon2_WissName = Feloidea
| Taxon2_Rang = Überfamilie
| Taxon3_Name = Raubtiere
| Taxon3_WissName = Carnivora
| Taxon3_Rang = Ordnung
| Taxon4_Name = Höhere Säugetiere
| Taxon4_WissName = Eutheria
| Taxon4_Rang = Unterklasse
| Taxon5_Name = Säugetiere
| Taxon5_WissName = Mammalia
| Taxon5_Rang = Klasse
| Taxon6_Name = Kiefermäuler
| Taxon6_WissName = Gnathostomata
| Taxon6_Rang = Überklasse
| Bild = Crocuta-hejda.jpg
| Bildbeschreibung = [[Tüpfelhyäne]] ''(Crocuta crocuta)''
| Subtaxa_Rang = Art
| Subtaxa =
* [[Streifenhyäne]] ''(Hyaena hyaena)''
* [[Schabrackenhyäne]] ''(Hyaena brunnea)''
* [[Tüpfelhyäne]] ''(Crocuta crocuta)''
* [[Erdwolf]] ''(Proteles cristatus)''
}}</syntaxhighlight>

'''Erläuterungen'''

→ ''Siehe: [[Wikipedia:Taxoboxen]]''

== Siehe auch ==

* Bei [[meta:Main Page|MetaWiki]] befindet sich ein [[meta:Help:Table|englischer Artikel]], der die Gestaltung mit Tabellen etwas ausführlicher behandelt.
* Außerdem gibt es bei [[meta:Main Page|MetaWiki]] einen [[meta:Help:Sorting|englischen Artikel]], der die Sortierung von Tabellen im Detail behandelt.
* Im Abschnitt [[Wikipedia:Wie gute Artikel aussehen#Tabellen|Tabellen]] in [[Wikipedia:Wie gute Artikel aussehen|Wie gute Artikel aussehen]] wird auf die Bedeutung von Vorlagen zur Vereinheitlichung hingewiesen.
* Der Abschnitt [[Hilfe:Bilder#Ausrichten im Text|Ausrichten im Text]] in der [[Hilfe:Bilder|Hilfe für Bilder]] über die Positionierung von Bildern in Tabellen
* In [[Hilfe:Tabellen-Referenz]] sind die einzelnen Möglichkeiten nochmals mit Beispielen aufgeführt.
* Beispiele: [[:Kategorie:Vorlage:Tabelle]] – Tabellen, die auf mehreren Seiten als Vorlage eingebunden werden

== Hilfen ==

* '''[[Benutzer:PeerBr/WPro|WPro]]''' (Server zur Zeit nicht erreichbar) ist ein Wikipedia-Editor für den [[Windows Internet Explorer|Internet Explorer]] 6.0, der Tabellen per Knopfdruck einfügen und formatieren kann.
* '''[[Wikipedia:Textverarbeitung/EXCEL-Tabellenumwandlung|EXCEL-Tabellenumwandlung]]''' konvertiert den ausgewählten Tabellenbereich aus MS Excel direkt ins Wiki-Tabellenformat. Die wichtigsten Formatierungen wie Fett/Kursiv, Zellenhöhe und -breite, Schriftgröße, Farbinformation aus MS Excel bleiben erhalten.
* '''[[Wikipedia:Textverarbeitung/Excel2Wiki|Excel2Wiki]]''' Berücksichtigt verbundene Zellen, dazu auch ein Programm zur Umwandlung der Spalten in Zeilen und umgekehrt und ein Programm zur Zeilenumkehr, d. h. die letzte Zeile wird zur ersten usw.
* '''[[Benutzer:Duesentrieb/csv2wp|csv2wp]]''' ist ein Werkzeug zum Umwandeln von [[CSV (Dateiformat)|CSV-Datei]]en in Wiki-Tabellenformat. Damit lassen sich z. B. Tabellen aus [[Microsoft Excel]] importieren.
* Ab [[OpenOffice.org|OpenOffice]] 2.3 kann man Writer-Dokumente ins [http://de.openoffice.org/presse/pressemitteilung_20070917.html Mediawiki-Format] exportieren.
* [[OpenOffice.org|OpenOffice]]-Tabellen können mit [[Wikipedia:Textverarbeitung/OOoCalc2Wiki|Calc2Wiki]] konvertiert werden. Eine Alternative (mit der ein oder anderen Erweiterung) ist [[Benutzer:Erodeist/Calc2WikiTable|Calc2WikiTable]].
* [http://www.cnic.org/html2mediawiki.html Umwandlung von HTML-Tabellen in Wiki-Tabellen]

----
[[Kategorie:Hilfe]]

Tabellen

2024-07-10T13:17:10Z

Hsh-milanihl:

{{Shortcut|WP:TAB, WP:TBL}}
{{Wikipedia-Hilfe}}
Wikipedia bietet eine eigene Syntax, um '''Tabellen''' darzustellen. Diese Syntax ist zwar an das verbreitete [[Hypertext Markup Language|HTML]] angelehnt, erleichtert jedoch durch eine vereinfachte Schreibweise die Arbeit an komplizierteren Tabellen wesentlich. Diese Seite bietet eine Kurzübersicht, wie du Tabellen erstellst, eine ausführliche Darstellung findet sich auf '''[[Hilfe:Tabellen-Referenz]]'''.

Um die Zellen einer Tabelle zu formatieren, lassen sich sowohl für die Tabelle als Ganzes als auch für einzelne Zellen HTML-Attribute angeben. Insbesondere kann das <tt>style</tt>-Attribut verwendet werden, wodurch sich beliebige [[Cascading Style Sheets|CSS]]-Formatierungen realisieren lassen. Zwar lassen sich auch einzelne Zeilen einer Tabelle formatieren, möchte man jedoch ein Attribut an eine bestimmte Spalte vergeben, so muss dies zellenweise geschehen.

== Wann Tabellen einsetzen? ==
'''Tabellen''' sind ein gutes Mittel, um gleichartige Informationen übersichtlich zu gestalten. Sie helfen die Beziehungen zwischen Tabellenzellen und ihren Zeilen und Spalten zu verstehen (siehe [[Semantik|semantische Beziehungen]]). Insbesondere als sortierbare Tabellen bieten sie einen schnellen Überblick beispielsweise über Jahreszahlen, Namen oder Orte.
:''Siehe Hauptartikel [[Wikipedia:Tabellen]]''.

Andererseits sind Tabellen komplizierter als normaler Text. Deshalb sollten sie nur dort eingesetzt werden, wo sie tatsächlich für bessere Übersicht sorgen. Überlege immer, ob du die Informationen nicht besser in einer einfachen Liste unterbringen kannst (siehe [[Hilfe:Textgestaltung|Textgestaltung]] und [[Hilfe:Listen|Listen]]).

Tabellen sollte man nicht als „grafisches Gestaltungsmittel“ einsetzen.

== CSS-Klassen für Tabellen ==
Um Tabellen sowohl in ihren Inhalten als auch bereits im Kopfbereich weitestgehend frei von Elementen zu halten, die die Darstellungsweise betreffen, wurden für das global wirksame CSS einige Klassen entwickelt, die es erlauben, wichtige Stile mit wenigen anschaulichen Anweisungen festzulegen.

=== wikitable ===
Mittels <code>class="wikitable"</code> im Tabellenkopf lässt sich eine schwach grau getönte Tabelle mit sichtbaren, wenngleich dezenten Zellgrenzen erstellen. Zwischen Zellinhalt und Rand wird etwas "Luft" gelassen. Die Standardtabelle ist rahmenlos und hat weißen Hintergrund, was für Layout-Zwecke teilweise erwünscht ist, sich jedoch in bestimmten Fällen zu schlecht vom Text absetzt.

Die Klasse <code>prettytable</code> mit einem ganz ähnlichem Anspruch sollte nicht mehr verwendet werden, um die Kohärenz der Stilmittel zwischen den verschiedenen Wikipedias zu fördern. Sie wird ausschließlich in der deutschen Wikipedia verwendet.

=== sortable ===
Mittels <code>class="sortable"</code> werden Spalten sortierbar gemacht. Das heißt, wenn [[JavaScript]] für die Wikipedia aktiviert ist, können Tabellen durch Klick auf das entsprechende Symbol in einem Spaltenkopf nach dieser Spalte auf- und absteigend sortiert werden. Die mitunter unsortierte Ausgangs-Darstellung erhält man durch Neuladen der Seite. Einzelne Spalten, für die eine Sortierung als unsinnig angesehen wird, können mittels der spaltenweisen Angabe von <code>class="unsortable"</code> markiert werden, so werden die Sortierfunktion und -symbol unterdrückt. Mit der gleichen Angabe können auch einzelne Tabellen''zeilen'' von der Sortierung ausgenommen werden.

''siehe auch:'' [[:meta:Help:Sorting|MediaWiki Handbook - Sorting]]

=== toptextcells ===
Durch <code>class="toptextcells"</code> im Tabellenkopf kann das Standardverhalten, dass Texte in Zellen vertikal zentriert dargestellt werden, dahingehend abgeändert werden, dass die Texte immer oben beginnen und der Abstand jeweils nach unten variiert. In Fällen stark unterschiedlicher Auffüllung führt dies zu einer größeren Übersicht, die obere Textzeile bildet mit der oberen Begrenzung zusammen eine Flucht. Die Alternative zu dieser Klasse wäre die Einfügung von style-Anweisungen pro Tabellenzeile.

=== Kombinationen ===
Die genannten drei Klassen lassen sich kombinieren. Hierbei sollte Augenmaß gewahrt werden, nicht jede Eigenschaft ist immer passend. Sortierbare Wikitables (<code>class="wikitable sortable"</code>) werden sich häufig anbieten. Oben ausgerichtete Texte in Zellen werden häufig mit Wikitable kombiniert werden.

Auch Kombinationen aller drei Stile sind denkbar, wenn in Tabellen umfangreiche Erläuterungen enthalten sind, diese sollten dann als <code>unsortable</code> markiert werden.

=== Probleme mit der class="wikitable" ===

Am 23. Februar 2008 wurde die „[[Vorlage:Prettytable]]“ als „veraltet“ [{{fullurl:Spezial:Logbuch|type=delete&page=Vorlage:Prettytable&year=2008&month=2}} gelöscht] und somit endgültig von der [[Cascading Style Sheets|CSS]]-<code>class="wikitable"</code> ersetzt (zu finden in [[MediaWiki:Common.css]]). Daneben existiert auch die <code>class="prettytable"</code>, diese sollte aber nicht mehr verwendet werden, da die deutschsprachige Wikipedia die einzige ist, welche diese Klasse verwendet. Im Zuge der Internationalisierung und für den Export ist es hilfreich, wenn sie nicht mehr verwendet wird.<ref>Eine Umstellung auf <code>wikitable</code> sollte bei der Bearbeitung eines Artikels erfolgen, Bearbeitungen die nur diese Umstellung beinhalten sowie Botläufe, sind zu unterlassen. Weitere Informationen gibt es dazu unter [[Wikipedia Diskussion:Bots/Archiv 2008#Klasse "wikitable"]] und [[MediaWiki Diskussion:Common.css#Klasse "wikitable"]]</ref>

Diese Umstellung ist in mancherlei Hinsicht nicht nur ein Segen. So kann mit <code>class="wikitable"</code> beispielsweise das [http://de.selfhtml.org/html/referenz/attribute.htm#table <code><span style="background-color:#FDFBCD;">'''cellpadding'''</span></code>] (die „Zellen-Polsterung“) anscheinend ''nicht mehr in einem Rutsch'' für die ganze Tabelle verändert/definiert werden<sup>[[[Wikipedia:Fragen zur Wikipedia/Archiv/2008/Woche 25#Falsch angewandtes cellpadding?|WP:FZW-Archiv: Juni 2008]]]</sup>. Wo deshalb „unbedingt“ nötig, kann statt <code style="white-space:nowrap;"><nowiki>{| class="wikitable"</nowiki></code> doch noch eine Entsprechung der „[[Vorlage:Prettytable]]“ verwendet werden:
* <code>border="1" <span style="background-color:#FDFBCD;">cellpadding="20"</span> style="margin:1em 1em 1em 0; background:#f9f9f9; border:1px #AAA solid; border-collapse:collapse; empty-cells:show;"</code>

;Tipp: Mit der Eigenschaft <code>text-indent</code> und einem Wert so um die 4px bekommt man einen ganz vernünftigen Abstand zum linken Rand hin. Wenn das hinter der Klasse "wikitable sortable" oder "wikitable" notiert wird, bezieht sich diese Zuweisung auf alle Zellen. So könnte die erste Zeile einer Tabelle aussehen: <code>{| class="wikitable sortable" style="text-indent:4px"</code>

== Einfache Tabelle ==
Eine einfache Beispieltabelle aus dem Artikel [[Bayern-Landshut#Liste der Herzöge von Bayern-Landshut|Bayern-Landshut]]:

{| class="wikitable"
|- class="hintergrundfarbe5"
! Name !! Regierungszeit !! Abstammung
|-
| [[Stephan II. (Bayern)|Stephan II.]] || <tt>1347–1375</tt> Herzog von Bayern || Sohn Kaiser Ludwigs IV.
|-
| [[Friedrich (Bayern)|Friedrich]] || <tt>1375–1393</tt> Herzog von Bayern-Landshut || Sohn Stephans II.
|-
| [[Heinrich XVI. (Bayern)|Heinrich XVI.]] || <tt>1393–1450</tt> Herzog von Bayern-Landshut || Sohn Friedrichs
|-
| [[Ludwig IX. (Bayern)|Ludwig IX.]] || <tt>1450–1479</tt> Herzog von Bayern-Landshut || Sohn Heinrichs XVI.
|-
| [[Georg (Bayern)|Georg]] || <tt>1479–1503</tt> Herzog von Bayern-Landshut || Sohn Ludwigs IX.
|}

Die obige Tabelle wird durch den folgenden Quelltext erzeugt:
<syntaxhighlight lang=html line>
{| class="wikitable"
|- class="hintergrundfarbe5"
! Name !! Regierungszeit !! Abstammung
|-
| [[Stephan II. (Bayern)|Stephan&nbsp;II.]] || <tt>1347–1375</tt> Herzog von Bayern || Sohn Kaiser Ludwigs&nbsp;IV.
|-
| [[Friedrich (Bayern)|Friedrich]] || <tt>1375–1393</tt> Herzog von Bayern-Landshut || Sohn Stephans&nbsp;II.
|-
| [[Heinrich XVI. (Bayern)|Heinrich&nbsp;XVI.]] || <tt>1393–1450</tt> Herzog von Bayern-Landshut || Sohn Friedrichs
|-
| [[Ludwig IX. (Bayern)|Ludwig&nbsp;IX.]] || <tt>1450–1479</tt> Herzog von Bayern-Landshut || Sohn Heinrichs&nbsp;XVI.
|-
| [[Georg (Bayern)|Georg]] || <tt>1479–1503</tt> Herzog von Bayern-Landshut || Sohn Ludwigs&nbsp;IX.
|}
</syntaxhighlight>

'''Erläuterungen'''

* Die Zeichen <code>{|</code> beginnen eine Tabelle, während <code>|}</code> sie abschließen. Beide Tags müssen an einem Zeilenanfang stehen.
* Das Attribut <code>class="wikitable"</code> veranlasst, dass die ganze Tabelle nach den Vorgaben der Klasse <code>wikitable</code> formatiert wird. Diese sieht unter anderem Trennlinien zwischen den Zellen sowie zusätzlichen Platz zwischen Zelleninhalt und Zellenrand (das sogenannte ''cellpadding'') vor.
* Zeilen, die mit einem Ausrufezeichen (<code>!</code>) beginnen, definieren Kopfzeilen von Tabellen. Der Text in einer Zelle einer solchen Zeile wird zentriert und fettgedruckt. Gewöhnliche Tabellenzeilen beginnen dagegen mit einem senkrechten Trennstrich (<code>|</code>).
* Das Tag <code>|-</code> beginnt eine neue Tabellenzeile, falls es im Quelltext an einem Zeilenanfang steht.
* Die Zeichen <code>||</code> trennen nebeneinanderliegende Tabellenzellen.
* Die Zeichenfolge <code>&nbsp;</code> anstatt eines Leerzeichens verhindert einen Zeilenumbruch zwischen den beiden Wörtern, die das Leerzeichen trennt.
* Die Jahreszahlen werden durch <code><tt></code> mit fester Zeichenbreite dargestellt, um sicherzugehen, dass sie am Bindestrich ausgerichtet werden.

Soll die Tabelle rechtsbündig zum Text ausgerichtet werden, lässt sich dies durch die zusätzliche Klasse <code>float-right</code> im Attribut erreichen: <code>class="wikitable float-right"</code>. Zentrierung der Tabelle erreicht man durch die zusätzliche Klasse <code>centered</code>: <code>class="wikitable centered"</code>.

== Sortierbare Tabelle ==
Sortierbare Tabellen ermöglichen verschiedene und vom Leser wählbare Sichtweisen auf eine Sache:
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! ABC !! Länge !! Breite !! Farbe !! class="unsortable" | Bemerkung
|-
| [[a]]
| style="text-align:right" | 1100
| style="text-align:right" | 1000
| hellblau
| Blau ist der Himmel
|-
| [[b]]
| style="text-align:right" | 30
| style="text-align:right" | 2
| grün
| Grün ist das Gras
|-
| [[c]]
| style="text-align:right" | 100
| style="text-align:right" | 90
| rot
| Rot ist die Liebe
|}

Diese sortierbare Tabelle wird durch folgenden Code erzeugt:
<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! ABC !! Länge !! Breite !! Farbe !! class="unsortable" | Bemerkung
|-
| [[a]]
| style="text-align:right" | 1100
| style="text-align:right" | 1000
| hellblau
| Blau ist der Himmel
|-
| [[b]]
| style="text-align:right" | 30
| style="text-align:right" | 2
| grün
| Grün ist das Gras
|-
| [[c]]
| style="text-align:right" | 100
| style="text-align:right" | 90
| rot
| Rot ist die Liebe
|}
</syntaxhighlight>

=== Sortierbare Namen ===
Nach der Namenskonvention steht in Wikipedia zuerst der Vorname, gefolgt vom Nachnamen.<br />Die [[Vorlage:SortKeyName]] sorgt dafür, dass die Tabellenspalten hier dennoch nach dem Nachnamen sortiert werden:
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Name !! Vorname !! Nachname
|-
| {{SortKeyName|Bernd|Müller}}
| Bernd
| Müller
|-
| {{SortKeyName|Hans|Zehnder}}
| Hans
| Zehnder
|-
| {{SortKeyName|Stefan|Ackermann}}
| Stefan
| Ackermann
|}
<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Name !! Vorname !! Nachname
|-
| {{SortKeyName|Bernd|Müller}}
| Bernd
| Müller
|-
| {{SortKeyName|Hans|Zehnder}}
| Hans
| Zehnder
|-
| {{SortKeyName|Stefan|Ackermann}}
| Stefan
| Ackermann
|}
</syntaxhighlight>

Bei komplizierteren Namen, beispielsweise mit zwei Vornamen oder mit Sonderzeichen im Namen funktioniert [[Vorlage:SortKey]]:
{| class="wikitable"
|-
| {{SortKey|Ambrozy, Peter}}[[Peter Michael Ambrozy|Peter Ambrozy]]
|}

<syntaxhighlight lang=html line>
| {{SortKey|Ambrozy, Peter}}[[Peter Michael Ambrozy|Peter Ambrozy]]
</syntaxhighlight>

Beispiel: [[Liste der Abgeordneten zum Kärntner Landtag (29. Gesetzgebungsperiode)|Abgeordnete im Kärntner Landtag]]

=== Sortierbare Zahlen und Geldbeträge ===
Zahlen und Geld-Währungen werden so rechtsbündig und sortierbar dargestellt:

{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! €<br />sortieren
|-
| style="text-align:right" | 1,00
|-
| style="text-align:right" | 2000,10
|-
| style="text-align:right" | 3.000,02
|-
| style="text-align:right" | 40.000,00
|-
| style="text-align:right" | 5,10
|-
| style="text-align:right" | 1.000.006,01
|-
| style="text-align:right" | 7000,01
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! €<br />sortieren
|-
| style="text-align:right" | 1,00
|-
| style="text-align:right" | 2000,10
|-
| style="text-align:right" | 3.000,02
|-
| style="text-align:right" | 40.000,00
|-
| style="text-align:right" | 5,10
|-
| style="text-align:right" | 1.000.006,01
|-
| style="text-align:right" | 7000,01
|}
</syntaxhighlight>

Rechtsbündige Zahlen werden nur dann korrekt sortiert, wenn die Anzahl der Nachkommastellen bei allen Einträgen einer Spalte gleich sind.

''Siehe auch:'' [[Vorlage:Dts]] für Datumsangaben, [[Vorlage:Nts]] und [[Vorlage:0]] für Zahlen

=== Verschiedenstellige Zahlen ===
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Nummer !! Ort
|-
| {{SortKey| 033_ | 033x }} || [[Land Brandenburg|Brandenburg]]
|-
| {{SortKey| 0330_ | 0330x }} || Oranienburg und Umgebung
|-
| 03301 || [[Oranienburg]]
|-
| 03302 || [[Hennigsdorf]]
|}

<syntaxhighlight lang=html line>
| {{SortKey| 033_ | 033x }} || [[Land Brandenburg|Brandenburg]]
|-
| {{SortKey| 0330_ | 0330x }} || Oranienburg und Umgebung
</syntaxhighlight>

Beispiel: [[Vorwahl 03 (Deutschland)|Telefon-Vorwahl 03 (Deutschland)]]

=== Sortierbare verschiedenstellige Zahlen mit Dezimaltrennzeichen ===
Damit bei verschiedenstelligen Zahlen in einer Spalte das Komma immer übereinander dargestellt wird gibt es zwei Möglichkeiten. Beide sind sortierbar. Lösung a) ist angenehmer zu lesen also für Wikipedia geeigneter. Lösung b) ist einfacher zu schreiben und für Zahlen mit immer gleicher Zahl von Nachkommastellen, Währungen beispielsweise, genauso gut geeignet:

a) Verwendung von [[Vorlage:0]] für alle führenden Nullen:

{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Zähler !! Wert
|-
| 1
| 1000
|-
| 2
| {{0}}{{0}}{{0}}1,0001
|-
| 3
| {{0}}200,2
|-
| 4
| {{0}}{{0}}{{0}}1,1
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Zähler !! Wert
|-
| 1
| 1000
|-
| 2
| {{0}}{{0}}{{0}}1,0001
|-
| 3
| {{0}}200,2
|-
| 4
| {{0}}{{0}}{{0}}1,1
|}
</syntaxhighlight>

b) rechtsbündiger Zellenformatierung unter Verwendung der gleichen Anzahl an Nachkommastellen, wobei die zur Ausrichtung künstlich aufgefüllten Nachkommastellen per <code><nowiki>{{0}}</nowiki></code> versteckt werden können, ein zu versteckendes Komma ist per <code><nowiki>{{0|,}}</nowiki></code> erzielbar:

{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Zähler !! Wert
|-
| 1
| style="text-align:right" | 1000{{0|,}}{{0}}{{0}}{{0}}{{0}}
|-
| 2
| style="text-align:right" | 1,0001
|-
| 3
| style="text-align:right" | 200,2{{0}}{{0}}{{0}}
|-
| 4
| style="text-align:right" | 1,1{{0}}{{0}}{{0}}
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Zähler !! Wert
|-
| 1
| style="text-align:right" | 1000{{0|,}}{{0}}{{0}}{{0}}{{0}}
|-
| 2
| style="text-align:right" | 1,0001
|-
| 3
| style="text-align:right" | 200,2{{0}}{{0}}{{0}}
|-
| 4
| style="text-align:right" | 1,1{{0}}{{0}}{{0}}
|}
</syntaxhighlight>

=== Sortierbare Zahl mit Währungs- oder %-Symbol ===
{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Zähler !! Prozent
|-
| 1
| 10 %
|-
| 2
| {{0}}1 %
|-
| 3
| {{0}}7 %
|-
| 4
| 80 %
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Zähler !! Prozent
|-
| 1
| 10 %
|-
| 2
| {{0}}3 %
|-
| 3
| {{0}}7 %
|-
| 4
| 80 %
|}
</syntaxhighlight>
=== Sortierbare Tabelle mit einer nicht-sortierbaren Zeile ===
{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Name !! Wert
|-
| Alfons
| 90
|-
| Berta
| 12
|- class="unsortable"
| '''Fest'''
| '''45'''
|-
| Cäsar
| 37
|-
| Dietmar
| 6
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Name !! Wert
|-
| Alfons
| 90
|-
| Berta
| 12
|- class="unsortable"
| '''Fest'''
| '''45'''
|-
| Cäsar
| 37
|-
| Dietmar
| 6
|}
</syntaxhighlight>

== Layout ==
=== Tabellenüberschriften, Trennstriche ===
Das folgende Beispiel zeigt, wie man eine Tabellenüberschrift erzeugt, sowie eine Möglichkeit, wie sich Trennstriche zwischen bestimmten Zellen realisieren lassen:

{| style="text-align:right;"
|+ Addition von vier Zahlen
|-
| <tt>365</tt>
|-
| <tt>+ 123</tt>
|-
| <tt>+ 235</tt>
|-
| <tt>+ 277</tt>
|-
| style="border-top: 1pt black solid;" | <tt>1000</tt>
|}

Der Quelltext dieser Beispieltabelle sieht wie folgt aus:

<syntaxhighlight lang=html line>
{| style="text-align:right;"
|+ Addition von vier Zahlen
|-
| <tt>365</tt>
|-
| <tt>+ 123</tt>
|-
| <tt>+ 235</tt>
|-
| <tt>+ 277</tt>
|-
| style="border-top: 1pt black solid;" | <tt>1000</tt>
|}
</syntaxhighlight>

'''Erläuterungen'''

* Die Zeile, die mit <code>|+</code> beginnt, bezeichnet den Titel der Tabelle.
* Der Befehl <code>border-top: 1pt</code> weist der Zelle einen oberen Rand mit definierter Breite zu. Weitere Befehle sind: <code>border-left, border-right</code> und <code>border-bottom</code> für einen Rand links, rechts oder unten. <code>border: 1pt</code> setzt alle vier Ränder.

=== Zellfärbung, Spaltenbreite, Textausrichtung ===
Dieses Beispiel erläutert, wie man sortierbare Tabellen erstellt, wie man Zellen färbt, den Zelleninhalt rechts ausrichtet und die Spaltenbreite einstellt. Es lehnt sich an die [[Liste der römischen Kaiser der Antike#Liste der römischen Kaiser|Liste der römischen Kaiser]] an:

{| class="wikitable sortable"
|+ style="padding-bottom:1em;" | Kaiser der Flavischen Dynastie
|- class="hintergrundfarbe5"
! width="15%" | Kaiser !! width="30%" | Vollständiger Name
! width="15%" | Regierungszeit !! class="unsortable" width="40%" | Anmerkungen
|-
| [[Vespasian]] || Titus Flavius Vespasianus
| style="text-align:right" | 69–79 || konsolidierte Verwaltung und Finanzen des Reiches
|-
| [[Titus]] || Titus Flavius Vespasianus
| style="text-align:right" | {{SortKey|79-81}}Mitte 79–81 || eröffnete das [[Kolosseum]] in Rom
|-
| [[Domitian]] || Titus Flavius Domitianus
| style="text-align:right" | 81–96 || beendete römische Expansion in Germanien
|-
| [[Lucius Antonius Saturninus|Saturninus]] || Lucius Antonius Saturninus
| style="text-align:right" | 89 || Gegenkaiser in Germanien, gefallen
|- class="sortbottom hintergrundfarbe5"
| '''[[Liste der römischen Kaiser der Antike#Liste der römischen Kaiser|Vollst. Liste]]'''
|
|
|
|}

Der Quelltext hierfür sieht folgendermaßen aus:

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|+ style="padding-bottom:1em;" | Kaiser der Flavischen Dynastie
|- class="hintergrundfarbe5"
! width="15%" | Kaiser !! width="30%" | Vollständiger Name
! width="15%" | Regierungszeit !! class="unsortable" width="40%" | Anmerkungen
|-
| [[Vespasian]] || Titus Flavius Vespasianus
| style="text-align:right" | 69–79 || konsolidierte Verwaltung und Finanzen des Reiches
|-
| [[Titus]] || Titus Flavius Vespasianus
| style="text-align:right" | {{SortKey|79-81}}Mitte 79–81 || eröffnete das [[Kolosseum]] in Rom
|-
| [[Domitian]] || Titus Flavius Domitianus
| style="text-align:right" | 81–96 || beendete römische Expansion in Germanien
|-
| [[Lucius Antonius Saturninus|Saturninus]] || Lucius Antonius Saturninus
| style="text-align:right" | 89 || Gegenkaiser in Germanien, gefallen
|- class="sortbottom hintergrundfarbe5"
| '''[[Liste der römischen Kaiser der Antike#Liste der römischen Kaiser|Vollst. Liste]]'''
|
|
|
|}
</syntaxhighlight>

'''Erläuterungen'''

* Das <code>sortable</code> in <code>class="wikitable sortable"</code> erlaubt die Sortierung der Tabelle nach wählbaren Spalten.
* Mit <code>class="unsortable"</code> können einzelne Spalten von der Sortierbarkeit ausgenommen werden.
* Mit den Vorlagen [[:Vorlage:Dts]], [[:Vorlage:Nts]] und [[:Vorlage:SortKey]] lässt sich die Sortierreihenfolge einzelner Tabelleneinträge beeinflussen
* Der Befehl <code>width="15%"</code> weist einer Spalte 15 % der Gesamtbreite der Tabelle als Breite zu.
* Die Ausrichtung von Text rechtsbündig in einer Zelle erreicht man durch die [[Cascading Style Sheets|CSS]]-Anweisung <code>style="text-align:right"</code>.
* Nebeneinanderliegende Zellen kann man sowohl durch das <code>||</code>-Zeichen trennen, als auch durch einen Zeilenumbruch gefolgt von einem einfachen <code>|</code>-Zeichen.
* Der Befehl <code>|- class="hintergrundfarbe5"</code> weist der darauffolgenden Zeile eine Hintergrundfarbe zu. In Artikeln sollen die entsprechenden Standardfarben verwendet werden (siehe [[Hilfe:Farben#Farben verwenden|Farben verwenden]] in der [[Hilfe:Farben|Hilfe zu Farben]]). Außerhalb des Artikelnamensraumes können Farben außer durch ihren englischen Namen auch als Hexadezimalzahl aus sechs Ziffern eingegeben werden, wobei die ersten zwei Ziffern für den Rotanteil von bis zu 256 stehen, die nächsten zwei für den Grünanteil und die letzten zwei für den Blauanteil, das heißt, dass <code>#ff0000</code> die Farbe Rot bedeutet, <code>#00ff00</code> steht für Grün und <code>#0000ff</code> steht für Blau. Durch eine Mischung erhält man beispielsweise Violett: <code>#ff00ff</code>.
* Leerzellen können durch einen einfachen Abstand erzeugt werden. Diese Zellen werden aber beim Sortieren an den Anfang gestellt, Leerzellen mit <code>&nbsp;</code> stehen am Ende.
* Das <code>sortbottom</code> in <code>class="sortbottom hintergrundfarbe5"</code> führt dazu, dass die Zeile von der Sortierung ausgenommen wird und damit stets als Fußzeile der Tabelle angezeigt wird.

=== Geschachtelte Tabellen ===
Tabellen können geschachtelt werden:

'''colspan'''

{| class="wikitable float-right" style="text-align:center"
! style="background:#e3e3e3" | A
! style="background:#e3e3e3" | B
! style="background:#e3e3e3" | C
|-
| colspan="3" style="background:#EED5B7" | eine Zeile
|}

<syntaxhighlight lang=html line>
{| class="wikitable" style="text-align:center"
! A
! B
! C
|-
| colspan="3" | eine Zeile
|}
</syntaxhighlight>
<br style="clear:both;" clear="all" />

'''rowspan'''

{| class="wikitable float-right" style="text-align:center"
! style="background:#e3e3e3" | A
| rowspan="3" style="background:#EED5B7" | eine Spalte
|-
! style="background:#e3e3e3" | B
|-
! style="background:#e3e3e3" | C
|}

<syntaxhighlight lang=html line>
{| class="wikitable" style="text-align:center"
! A
| rowspan="3" | eine Spalte
|-
! B
|-
! C
|}
</syntaxhighlight>
<br style="clear:both;" clear="all" />

'''colspan + rowspan'''

{| class="wikitable float-right" style="text-align:center"
! colspan="2" style="background:#e3e3e3" | A
|-
! style="background:#e3e3e3" | B
| rowspan="2" style="background:#EED5B7" | eine Spalte
|-
! style="background:#e3e3e3" | C
|}

<syntaxhighlight lang=html line>
{| class="wikitable" style="text-align:center"
! colspan="2" style="text-align:center" | A
|- style="text-align:center"
! B
| rowspan="2"| eine Spalte
|- style="text-align:center"
! C
|}
</syntaxhighlight lang=html line>
<br style="clear:both;" clear="all" />

;
{| class="wikitable float-right" style="text-align:center"
|- style="background:#e3e3e3"
! colspan="4" | Titel
|- style="background:#e3e3e3"
! rowspan="2" style="background:#EED5B7" | eine Spalte
| A || B || C
|- style="background:#e3e3e3"
| D || E || F
|}

<syntaxhighlight lang=html line>
{| class="wikitable" style="text-align:center"
|-
! colspan="4" | Titel
|-
! rowspan="2" | eine Spalte
| A || B || C
|-
| D || E || F
|}
</syntaxhighlight>
<br style="clear:both;" clear="all" />

=== Tabellen nebeneinander ===
<syntaxhighlight lang=html line>
<div style="float:left; margin-right:1em;">
{| class="wikitable"
|+ Linke Tabelle
! Überschrift 1 || Überschrift 2
|-
| Feld 1 || Feld 2
|}
</div>

<div style="float:left;">
{| class="wikitable"
|+ Rechte Tabelle
! Überschrift 1 || Überschrift 2
|-
| Feld 1 || Feld 2
|}
</div>

<div style="clear:both;" />
</syntaxhighlight>

<div style="float:left; margin-right:1em;">
{| class="wikitable"
|+ Linke Tabelle
! Überschrift 1 || Überschrift 2
|-
| Feld 1 || Feld 2
|}
</div>

<div style="float:left;">
{| class="wikitable"
|+ Rechte Tabelle
! Überschrift 1 || Überschrift 2
|-
| Feld 1 || Feld 2
|}
</div>

<div style="clear:both;" />

=== Gleich breite Tabellen ===
<syntaxhighlight lang=html line>
{| class="wikitable"
|-
| style="width:5em" | a: 5em
| style="width:10em" | b: 10em
| style="width:7em" | c: 7em
|}
{| class="wikitable"
|-
| style="width:5em" | a: 5em
| style="width:10em" | b: 10em
| style="width:7em" | c: 7em
|}
</syntaxhighlight>

{| class="wikitable"
|-
| style="width:5em" | a: 5em
| style="width:10em" | b: 10em
| style="width:7em" | c: 7em
|}
{| class="wikitable"
|-
| style="width:5em" | a: 5em
| style="width:10em" | b: 10em
| style="width:7em" | c: 7em
|}

=== Listen in Tabellen, Bilder in Tabellen ===
Tabellen können Tabellen, Bilder und Wiki-Syntax-Formatierung enthalten:

{{Taxobox
| Taxon_Name = Hyänen
| Taxon_WissName = Hyaenidae
| Taxon_Rang = Familie
| Taxon_Autor = [[John Edward Gray|Gray]], 1821
| Taxon2_Name = Katzenartige
| Taxon2_WissName = Feloidea
| Taxon2_Rang = Überfamilie
| Taxon3_Name = Raubtiere
| Taxon3_WissName = Carnivora
| Taxon3_Rang = Ordnung
| Taxon4_Name = Höhere Säugetiere
| Taxon4_WissName = Eutheria
| Taxon4_Rang = Unterklasse
| Taxon5_Name = Säugetiere
| Taxon5_WissName = Mammalia
| Taxon5_Rang = Klasse
| Taxon6_Name = Kiefermäuler
| Taxon6_WissName = Gnathostomata
| Taxon6_Rang = Überklasse
| Bild = Crocuta-hejda.jpg
| Bildbeschreibung = [[Tüpfelhyäne]] ''(Crocuta crocuta)''
| Subtaxa_Rang = Art
| Subtaxa =
* [[Streifenhyäne]] ''(Hyaena hyaena)''
* [[Schabrackenhyäne]] ''(Hyaena brunnea)''
* [[Tüpfelhyäne]] ''(Crocuta crocuta)''
* [[Erdwolf]] ''(Proteles cristatus)''
}}

Dieser Text erzeugt die rechte Tabelle, wenn man ihn in einen Artikel eingibt:
<syntaxhighlight lang=ini>{{Taxobox
| Taxon_Name = Hyänen
| Taxon_WissName = Hyaenidae
| Taxon_Rang = Familie
| Taxon_Autor = [[John Edward Gray|Gray]], 1821
| Taxon2_Name = Katzenartige
| Taxon2_WissName = Feloidea
| Taxon2_Rang = Überfamilie
| Taxon3_Name = Raubtiere
| Taxon3_WissName = Carnivora
| Taxon3_Rang = Ordnung
| Taxon4_Name = Höhere Säugetiere
| Taxon4_WissName = Eutheria
| Taxon4_Rang = Unterklasse
| Taxon5_Name = Säugetiere
| Taxon5_WissName = Mammalia
| Taxon5_Rang = Klasse
| Taxon6_Name = Kiefermäuler
| Taxon6_WissName = Gnathostomata
| Taxon6_Rang = Überklasse
| Bild = Crocuta-hejda.jpg
| Bildbeschreibung = [[Tüpfelhyäne]] ''(Crocuta crocuta)''
| Subtaxa_Rang = Art
| Subtaxa =
* [[Streifenhyäne]] ''(Hyaena hyaena)''
* [[Schabrackenhyäne]] ''(Hyaena brunnea)''
* [[Tüpfelhyäne]] ''(Crocuta crocuta)''
* [[Erdwolf]] ''(Proteles cristatus)''
}}</syntaxhighlight>

'''Erläuterungen'''

→ ''Siehe: [[Wikipedia:Taxoboxen]]''

== Siehe auch ==

* Bei [[meta:Main Page|MetaWiki]] befindet sich ein [[meta:Help:Table|englischer Artikel]], der die Gestaltung mit Tabellen etwas ausführlicher behandelt.
* Außerdem gibt es bei [[meta:Main Page|MetaWiki]] einen [[meta:Help:Sorting|englischen Artikel]], der die Sortierung von Tabellen im Detail behandelt.
* Im Abschnitt [[Wikipedia:Wie gute Artikel aussehen#Tabellen|Tabellen]] in [[Wikipedia:Wie gute Artikel aussehen|Wie gute Artikel aussehen]] wird auf die Bedeutung von Vorlagen zur Vereinheitlichung hingewiesen.
* Der Abschnitt [[Hilfe:Bilder#Ausrichten im Text|Ausrichten im Text]] in der [[Hilfe:Bilder|Hilfe für Bilder]] über die Positionierung von Bildern in Tabellen
* In [[Hilfe:Tabellen-Referenz]] sind die einzelnen Möglichkeiten nochmals mit Beispielen aufgeführt.
* Beispiele: [[:Kategorie:Vorlage:Tabelle]] – Tabellen, die auf mehreren Seiten als Vorlage eingebunden werden

== Hilfen ==

* '''[[Benutzer:PeerBr/WPro|WPro]]''' (Server zur Zeit nicht erreichbar) ist ein Wikipedia-Editor für den [[Windows Internet Explorer|Internet Explorer]] 6.0, der Tabellen per Knopfdruck einfügen und formatieren kann.
* '''[[Wikipedia:Textverarbeitung/EXCEL-Tabellenumwandlung|EXCEL-Tabellenumwandlung]]''' konvertiert den ausgewählten Tabellenbereich aus MS Excel direkt ins Wiki-Tabellenformat. Die wichtigsten Formatierungen wie Fett/Kursiv, Zellenhöhe und -breite, Schriftgröße, Farbinformation aus MS Excel bleiben erhalten.
* '''[[Wikipedia:Textverarbeitung/Excel2Wiki|Excel2Wiki]]''' Berücksichtigt verbundene Zellen, dazu auch ein Programm zur Umwandlung der Spalten in Zeilen und umgekehrt und ein Programm zur Zeilenumkehr, d. h. die letzte Zeile wird zur ersten usw.
* '''[[Benutzer:Duesentrieb/csv2wp|csv2wp]]''' ist ein Werkzeug zum Umwandeln von [[CSV (Dateiformat)|CSV-Datei]]en in Wiki-Tabellenformat. Damit lassen sich z. B. Tabellen aus [[Microsoft Excel]] importieren.
* Ab [[OpenOffice.org|OpenOffice]] 2.3 kann man Writer-Dokumente ins [http://de.openoffice.org/presse/pressemitteilung_20070917.html Mediawiki-Format] exportieren.
* [[OpenOffice.org|OpenOffice]]-Tabellen können mit [[Wikipedia:Textverarbeitung/OOoCalc2Wiki|Calc2Wiki]] konvertiert werden. Eine Alternative (mit der ein oder anderen Erweiterung) ist [[Benutzer:Erodeist/Calc2WikiTable|Calc2WikiTable]].
* [http://www.cnic.org/html2mediawiki.html Umwandlung von HTML-Tabellen in Wiki-Tabellen]

----
[[Kategorie:Hilfe]]

Tabellen

2024-07-10T13:16:08Z

Hsh-milanihl:

{{Shortcut|WP:TAB, WP:TBL}}
{{Wikipedia-Hilfe}}
Wikipedia bietet eine eigene Syntax, um '''Tabellen''' darzustellen. Diese Syntax ist zwar an das verbreitete [[Hypertext Markup Language|HTML]] angelehnt, erleichtert jedoch durch eine vereinfachte Schreibweise die Arbeit an komplizierteren Tabellen wesentlich. Diese Seite bietet eine Kurzübersicht, wie du Tabellen erstellst, eine ausführliche Darstellung findet sich auf '''[[Hilfe:Tabellen-Referenz]]'''.

Um die Zellen einer Tabelle zu formatieren, lassen sich sowohl für die Tabelle als Ganzes als auch für einzelne Zellen HTML-Attribute angeben. Insbesondere kann das <tt>style</tt>-Attribut verwendet werden, wodurch sich beliebige [[Cascading Style Sheets|CSS]]-Formatierungen realisieren lassen. Zwar lassen sich auch einzelne Zeilen einer Tabelle formatieren, möchte man jedoch ein Attribut an eine bestimmte Spalte vergeben, so muss dies zellenweise geschehen.

== Wann Tabellen einsetzen? ==
'''Tabellen''' sind ein gutes Mittel, um gleichartige Informationen übersichtlich zu gestalten. Sie helfen die Beziehungen zwischen Tabellenzellen und ihren Zeilen und Spalten zu verstehen (siehe [[Semantik|semantische Beziehungen]]). Insbesondere als sortierbare Tabellen bieten sie einen schnellen Überblick beispielsweise über Jahreszahlen, Namen oder Orte.
:''Siehe Hauptartikel [[Wikipedia:Tabellen]]''.

Andererseits sind Tabellen komplizierter als normaler Text. Deshalb sollten sie nur dort eingesetzt werden, wo sie tatsächlich für bessere Übersicht sorgen. Überlege immer, ob du die Informationen nicht besser in einer einfachen Liste unterbringen kannst (siehe [[Hilfe:Textgestaltung|Textgestaltung]] und [[Hilfe:Listen|Listen]]).

Tabellen sollte man nicht als „grafisches Gestaltungsmittel“ einsetzen.

== CSS-Klassen für Tabellen ==
Um Tabellen sowohl in ihren Inhalten als auch bereits im Kopfbereich weitestgehend frei von Elementen zu halten, die die Darstellungsweise betreffen, wurden für das global wirksame CSS einige Klassen entwickelt, die es erlauben, wichtige Stile mit wenigen anschaulichen Anweisungen festzulegen.

=== wikitable ===
Mittels <code>class="wikitable"</code> im Tabellenkopf lässt sich eine schwach grau getönte Tabelle mit sichtbaren, wenngleich dezenten Zellgrenzen erstellen. Zwischen Zellinhalt und Rand wird etwas "Luft" gelassen. Die Standardtabelle ist rahmenlos und hat weißen Hintergrund, was für Layout-Zwecke teilweise erwünscht ist, sich jedoch in bestimmten Fällen zu schlecht vom Text absetzt.

Die Klasse <code>prettytable</code> mit einem ganz ähnlichem Anspruch sollte nicht mehr verwendet werden, um die Kohärenz der Stilmittel zwischen den verschiedenen Wikipedias zu fördern. Sie wird ausschließlich in der deutschen Wikipedia verwendet.

=== sortable ===
Mittels <code>class="sortable"</code> werden Spalten sortierbar gemacht. Das heißt, wenn [[JavaScript]] für die Wikipedia aktiviert ist, können Tabellen durch Klick auf das entsprechende Symbol in einem Spaltenkopf nach dieser Spalte auf- und absteigend sortiert werden. Die mitunter unsortierte Ausgangs-Darstellung erhält man durch Neuladen der Seite. Einzelne Spalten, für die eine Sortierung als unsinnig angesehen wird, können mittels der spaltenweisen Angabe von <code>class="unsortable"</code> markiert werden, so werden die Sortierfunktion und -symbol unterdrückt. Mit der gleichen Angabe können auch einzelne Tabellen''zeilen'' von der Sortierung ausgenommen werden.

''siehe auch:'' [[:meta:Help:Sorting|MediaWiki Handbook - Sorting]]

=== toptextcells ===
Durch <code>class="toptextcells"</code> im Tabellenkopf kann das Standardverhalten, dass Texte in Zellen vertikal zentriert dargestellt werden, dahingehend abgeändert werden, dass die Texte immer oben beginnen und der Abstand jeweils nach unten variiert. In Fällen stark unterschiedlicher Auffüllung führt dies zu einer größeren Übersicht, die obere Textzeile bildet mit der oberen Begrenzung zusammen eine Flucht. Die Alternative zu dieser Klasse wäre die Einfügung von style-Anweisungen pro Tabellenzeile.

=== Kombinationen ===
Die genannten drei Klassen lassen sich kombinieren. Hierbei sollte Augenmaß gewahrt werden, nicht jede Eigenschaft ist immer passend. Sortierbare Wikitables (<code>class="wikitable sortable"</code>) werden sich häufig anbieten. Oben ausgerichtete Texte in Zellen werden häufig mit Wikitable kombiniert werden.

Auch Kombinationen aller drei Stile sind denkbar, wenn in Tabellen umfangreiche Erläuterungen enthalten sind, diese sollten dann als <code>unsortable</code> markiert werden.

=== Probleme mit der class="wikitable" ===

Am 23. Februar 2008 wurde die „[[Vorlage:Prettytable]]“ als „veraltet“ [{{fullurl:Spezial:Logbuch|type=delete&page=Vorlage:Prettytable&year=2008&month=2}} gelöscht] und somit endgültig von der [[Cascading Style Sheets|CSS]]-<code>class="wikitable"</code> ersetzt (zu finden in [[MediaWiki:Common.css]]). Daneben existiert auch die <code>class="prettytable"</code>, diese sollte aber nicht mehr verwendet werden, da die deutschsprachige Wikipedia die einzige ist, welche diese Klasse verwendet. Im Zuge der Internationalisierung und für den Export ist es hilfreich, wenn sie nicht mehr verwendet wird.<ref>Eine Umstellung auf <code>wikitable</code> sollte bei der Bearbeitung eines Artikels erfolgen, Bearbeitungen die nur diese Umstellung beinhalten sowie Botläufe, sind zu unterlassen. Weitere Informationen gibt es dazu unter [[Wikipedia Diskussion:Bots/Archiv 2008#Klasse "wikitable"]] und [[MediaWiki Diskussion:Common.css#Klasse "wikitable"]]</ref>

Diese Umstellung ist in mancherlei Hinsicht nicht nur ein Segen. So kann mit <code>class="wikitable"</code> beispielsweise das [http://de.selfhtml.org/html/referenz/attribute.htm#table <code><span style="background-color:#FDFBCD;">'''cellpadding'''</span></code>] (die „Zellen-Polsterung“) anscheinend ''nicht mehr in einem Rutsch'' für die ganze Tabelle verändert/definiert werden<sup>[[[Wikipedia:Fragen zur Wikipedia/Archiv/2008/Woche 25#Falsch angewandtes cellpadding?|WP:FZW-Archiv: Juni 2008]]]</sup>. Wo deshalb „unbedingt“ nötig, kann statt <code style="white-space:nowrap;"><nowiki>{| class="wikitable"</nowiki></code> doch noch eine Entsprechung der „[[Vorlage:Prettytable]]“ verwendet werden:
* <code>border="1" <span style="background-color:#FDFBCD;">cellpadding="20"</span> style="margin:1em 1em 1em 0; background:#f9f9f9; border:1px #AAA solid; border-collapse:collapse; empty-cells:show;"</code>

;Tipp: Mit der Eigenschaft <code>text-indent</code> und einem Wert so um die 4px bekommt man einen ganz vernünftigen Abstand zum linken Rand hin. Wenn das hinter der Klasse "wikitable sortable" oder "wikitable" notiert wird, bezieht sich diese Zuweisung auf alle Zellen. So könnte die erste Zeile einer Tabelle aussehen: <code>{| class="wikitable sortable" style="text-indent:4px"</code>

== Einfache Tabelle ==
Eine einfache Beispieltabelle aus dem Artikel [[Bayern-Landshut#Liste der Herzöge von Bayern-Landshut|Bayern-Landshut]]:

{| class="wikitable"
|- class="hintergrundfarbe5"
! Name !! Regierungszeit !! Abstammung
|-
| [[Stephan II. (Bayern)|Stephan II.]] || <tt>1347–1375</tt> Herzog von Bayern || Sohn Kaiser Ludwigs IV.
|-
| [[Friedrich (Bayern)|Friedrich]] || <tt>1375–1393</tt> Herzog von Bayern-Landshut || Sohn Stephans II.
|-
| [[Heinrich XVI. (Bayern)|Heinrich XVI.]] || <tt>1393–1450</tt> Herzog von Bayern-Landshut || Sohn Friedrichs
|-
| [[Ludwig IX. (Bayern)|Ludwig IX.]] || <tt>1450–1479</tt> Herzog von Bayern-Landshut || Sohn Heinrichs XVI.
|-
| [[Georg (Bayern)|Georg]] || <tt>1479–1503</tt> Herzog von Bayern-Landshut || Sohn Ludwigs IX.
|}

Die obige Tabelle wird durch den folgenden Quelltext erzeugt:
<syntaxhighlight lang=html line>
{| class="wikitable"
|- class="hintergrundfarbe5"
! Name !! Regierungszeit !! Abstammung
|-
| [[Stephan II. (Bayern)|Stephan&nbsp;II.]] || <tt>1347–1375</tt> Herzog von Bayern || Sohn Kaiser Ludwigs&nbsp;IV.
|-
| [[Friedrich (Bayern)|Friedrich]] || <tt>1375–1393</tt> Herzog von Bayern-Landshut || Sohn Stephans&nbsp;II.
|-
| [[Heinrich XVI. (Bayern)|Heinrich&nbsp;XVI.]] || <tt>1393–1450</tt> Herzog von Bayern-Landshut || Sohn Friedrichs
|-
| [[Ludwig IX. (Bayern)|Ludwig&nbsp;IX.]] || <tt>1450–1479</tt> Herzog von Bayern-Landshut || Sohn Heinrichs&nbsp;XVI.
|-
| [[Georg (Bayern)|Georg]] || <tt>1479–1503</tt> Herzog von Bayern-Landshut || Sohn Ludwigs&nbsp;IX.
|}
</syntaxhighlight>

'''Erläuterungen'''

* Die Zeichen <code>{|</code> beginnen eine Tabelle, während <code>|}</code> sie abschließen. Beide Tags müssen an einem Zeilenanfang stehen.
* Das Attribut <code>class="wikitable"</code> veranlasst, dass die ganze Tabelle nach den Vorgaben der Klasse <code>wikitable</code> formatiert wird. Diese sieht unter anderem Trennlinien zwischen den Zellen sowie zusätzlichen Platz zwischen Zelleninhalt und Zellenrand (das sogenannte ''cellpadding'') vor.
* Zeilen, die mit einem Ausrufezeichen (<code>!</code>) beginnen, definieren Kopfzeilen von Tabellen. Der Text in einer Zelle einer solchen Zeile wird zentriert und fettgedruckt. Gewöhnliche Tabellenzeilen beginnen dagegen mit einem senkrechten Trennstrich (<code>|</code>).
* Das Tag <code>|-</code> beginnt eine neue Tabellenzeile, falls es im Quelltext an einem Zeilenanfang steht.
* Die Zeichen <code>||</code> trennen nebeneinanderliegende Tabellenzellen.
* Die Zeichenfolge <code>&nbsp;</code> anstatt eines Leerzeichens verhindert einen Zeilenumbruch zwischen den beiden Wörtern, die das Leerzeichen trennt.
* Die Jahreszahlen werden durch <code><tt></code> mit fester Zeichenbreite dargestellt, um sicherzugehen, dass sie am Bindestrich ausgerichtet werden.

Soll die Tabelle rechtsbündig zum Text ausgerichtet werden, lässt sich dies durch die zusätzliche Klasse <code>float-right</code> im Attribut erreichen: <code>class="wikitable float-right"</code>. Zentrierung der Tabelle erreicht man durch die zusätzliche Klasse <code>centered</code>: <code>class="wikitable centered"</code>.

== Sortierbare Tabelle ==
Sortierbare Tabellen ermöglichen verschiedene und vom Leser wählbare Sichtweisen auf eine Sache:
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! ABC !! Länge !! Breite !! Farbe !! class="unsortable" | Bemerkung
|-
| [[a]]
| style="text-align:right" | 1100
| style="text-align:right" | 1000
| hellblau
| Blau ist der Himmel
|-
| [[b]]
| style="text-align:right" | 30
| style="text-align:right" | 2
| grün
| Grün ist das Gras
|-
| [[c]]
| style="text-align:right" | 100
| style="text-align:right" | 90
| rot
| Rot ist die Liebe
|}

Diese sortierbare Tabelle wird durch folgenden Code erzeugt:
<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! ABC !! Länge !! Breite !! Farbe !! class="unsortable" | Bemerkung
|-
| [[a]]
| style="text-align:right" | 1100
| style="text-align:right" | 1000
| hellblau
| Blau ist der Himmel
|-
| [[b]]
| style="text-align:right" | 30
| style="text-align:right" | 2
| grün
| Grün ist das Gras
|-
| [[c]]
| style="text-align:right" | 100
| style="text-align:right" | 90
| rot
| Rot ist die Liebe
|}
</syntaxhighlight>

=== Sortierbare Namen ===
Nach der Namenskonvention steht in Wikipedia zuerst der Vorname, gefolgt vom Nachnamen.<br />Die [[Vorlage:SortKeyName]] sorgt dafür, dass die Tabellenspalten hier dennoch nach dem Nachnamen sortiert werden:
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Name !! Vorname !! Nachname
|-
| {{SortKeyName|Bernd|Müller}}
| Bernd
| Müller
|-
| {{SortKeyName|Hans|Zehnder}}
| Hans
| Zehnder
|-
| {{SortKeyName|Stefan|Ackermann}}
| Stefan
| Ackermann
|}
<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Name !! Vorname !! Nachname
|-
| {{SortKeyName|Bernd|Müller}}
| Bernd
| Müller
|-
| {{SortKeyName|Hans|Zehnder}}
| Hans
| Zehnder
|-
| {{SortKeyName|Stefan|Ackermann}}
| Stefan
| Ackermann
|}
</syntaxhighlight>

Bei komplizierteren Namen, beispielsweise mit zwei Vornamen oder mit Sonderzeichen im Namen funktioniert [[Vorlage:SortKey]]:
{| class="wikitable"
|-
| {{SortKey|Ambrozy, Peter}}[[Peter Michael Ambrozy|Peter Ambrozy]]
|}

<syntaxhighlight lang=html line>
| {{SortKey|Ambrozy, Peter}}[[Peter Michael Ambrozy|Peter Ambrozy]]
</syntaxhighlight>

Beispiel: [[Liste der Abgeordneten zum Kärntner Landtag (29. Gesetzgebungsperiode)|Abgeordnete im Kärntner Landtag]]

=== Sortierbare Zahlen und Geldbeträge ===
Zahlen und Geld-Währungen werden so rechtsbündig und sortierbar dargestellt:

{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! €<br />sortieren
|-
| style="text-align:right" | 1,00
|-
| style="text-align:right" | 2000,10
|-
| style="text-align:right" | 3.000,02
|-
| style="text-align:right" | 40.000,00
|-
| style="text-align:right" | 5,10
|-
| style="text-align:right" | 1.000.006,01
|-
| style="text-align:right" | 7000,01
|}

<psyntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! €<br />sortieren
|-
| style="text-align:right" | 1,00
|-
| style="text-align:right" | 2000,10
|-
| style="text-align:right" | 3.000,02
|-
| style="text-align:right" | 40.000,00
|-
| style="text-align:right" | 5,10
|-
| style="text-align:right" | 1.000.006,01
|-
| style="text-align:right" | 7000,01
|}
</syntaxhighlight>

Rechtsbündige Zahlen werden nur dann korrekt sortiert, wenn die Anzahl der Nachkommastellen bei allen Einträgen einer Spalte gleich sind.

''Siehe auch:'' [[Vorlage:Dts]] für Datumsangaben, [[Vorlage:Nts]] und [[Vorlage:0]] für Zahlen

=== Verschiedenstellige Zahlen ===
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Nummer !! Ort
|-
| {{SortKey| 033_ | 033x }} || [[Land Brandenburg|Brandenburg]]
|-
| {{SortKey| 0330_ | 0330x }} || Oranienburg und Umgebung
|-
| 03301 || [[Oranienburg]]
|-
| 03302 || [[Hennigsdorf]]
|}

<syntaxhighlight lang=html line>
| {{SortKey| 033_ | 033x }} || [[Land Brandenburg|Brandenburg]]
|-
| {{SortKey| 0330_ | 0330x }} || Oranienburg und Umgebung
</syntaxhighlight>

Beispiel: [[Vorwahl 03 (Deutschland)|Telefon-Vorwahl 03 (Deutschland)]]

=== Sortierbare verschiedenstellige Zahlen mit Dezimaltrennzeichen ===
Damit bei verschiedenstelligen Zahlen in einer Spalte das Komma immer übereinander dargestellt wird gibt es zwei Möglichkeiten. Beide sind sortierbar. Lösung a) ist angenehmer zu lesen also für Wikipedia geeigneter. Lösung b) ist einfacher zu schreiben und für Zahlen mit immer gleicher Zahl von Nachkommastellen, Währungen beispielsweise, genauso gut geeignet:

a) Verwendung von [[Vorlage:0]] für alle führenden Nullen:

{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Zähler !! Wert
|-
| 1
| 1000
|-
| 2
| {{0}}{{0}}{{0}}1,0001
|-
| 3
| {{0}}200,2
|-
| 4
| {{0}}{{0}}{{0}}1,1
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Zähler !! Wert
|-
| 1
| 1000
|-
| 2
| {{0}}{{0}}{{0}}1,0001
|-
| 3
| {{0}}200,2
|-
| 4
| {{0}}{{0}}{{0}}1,1
|}
</syntaxhighlight>

b) rechtsbündiger Zellenformatierung unter Verwendung der gleichen Anzahl an Nachkommastellen, wobei die zur Ausrichtung künstlich aufgefüllten Nachkommastellen per <code><nowiki>{{0}}</nowiki></code> versteckt werden können, ein zu versteckendes Komma ist per <code><nowiki>{{0|,}}</nowiki></code> erzielbar:

{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Zähler !! Wert
|-
| 1
| style="text-align:right" | 1000{{0|,}}{{0}}{{0}}{{0}}{{0}}
|-
| 2
| style="text-align:right" | 1,0001
|-
| 3
| style="text-align:right" | 200,2{{0}}{{0}}{{0}}
|-
| 4
| style="text-align:right" | 1,1{{0}}{{0}}{{0}}
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Zähler !! Wert
|-
| 1
| style="text-align:right" | 1000{{0|,}}{{0}}{{0}}{{0}}{{0}}
|-
| 2
| style="text-align:right" | 1,0001
|-
| 3
| style="text-align:right" | 200,2{{0}}{{0}}{{0}}
|-
| 4
| style="text-align:right" | 1,1{{0}}{{0}}{{0}}
|}
</syntaxhighlight>

=== Sortierbare Zahl mit Währungs- oder %-Symbol ===
{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Zähler !! Prozent
|-
| 1
| 10 %
|-
| 2
| {{0}}1 %
|-
| 3
| {{0}}7 %
|-
| 4
| 80 %
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|- class="hintergrundfarbe5"
! Zähler !! Prozent
|-
| 1
| 10 %
|-
| 2
| {{0}}3 %
|-
| 3
| {{0}}7 %
|-
| 4
| 80 %
|}
</syntaxhighlight>
=== Sortierbare Tabelle mit einer nicht-sortierbaren Zeile ===
{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Name !! Wert
|-
| Alfons
| 90
|-
| Berta
| 12
|- class="unsortable"
| '''Fest'''
| '''45'''
|-
| Cäsar
| 37
|-
| Dietmar
| 6
|}

<syntaxhighlight lang=html line>
{| class="wikitable sortable float-right"
|- class="hintergrundfarbe5"
! Name !! Wert
|-
| Alfons
| 90
|-
| Berta
| 12
|- class="unsortable"
| '''Fest'''
| '''45'''
|-
| Cäsar
| 37
|-
| Dietmar
| 6
|}
</syntaxhighlight>

== Layout ==
=== Tabellenüberschriften, Trennstriche ===
Das folgende Beispiel zeigt, wie man eine Tabellenüberschrift erzeugt, sowie eine Möglichkeit, wie sich Trennstriche zwischen bestimmten Zellen realisieren lassen:

{| style="text-align:right;"
|+ Addition von vier Zahlen
|-
| <tt>365</tt>
|-
| <tt>+ 123</tt>
|-
| <tt>+ 235</tt>
|-
| <tt>+ 277</tt>
|-
| style="border-top: 1pt black solid;" | <tt>1000</tt>
|}

Der Quelltext dieser Beispieltabelle sieht wie folgt aus:

<syntaxhighlight lang=html line>
{| style="text-align:right;"
|+ Addition von vier Zahlen
|-
| <tt>365</tt>
|-
| <tt>+ 123</tt>
|-
| <tt>+ 235</tt>
|-
| <tt>+ 277</tt>
|-
| style="border-top: 1pt black solid;" | <tt>1000</tt>
|}
</syntaxhighlight>

'''Erläuterungen'''

* Die Zeile, die mit <code>|+</code> beginnt, bezeichnet den Titel der Tabelle.
* Der Befehl <code>border-top: 1pt</code> weist der Zelle einen oberen Rand mit definierter Breite zu. Weitere Befehle sind: <code>border-left, border-right</code> und <code>border-bottom</code> für einen Rand links, rechts oder unten. <code>border: 1pt</code> setzt alle vier Ränder.

=== Zellfärbung, Spaltenbreite, Textausrichtung ===
Dieses Beispiel erläutert, wie man sortierbare Tabellen erstellt, wie man Zellen färbt, den Zelleninhalt rechts ausrichtet und die Spaltenbreite einstellt. Es lehnt sich an die [[Liste der römischen Kaiser der Antike#Liste der römischen Kaiser|Liste der römischen Kaiser]] an:

{| class="wikitable sortable"
|+ style="padding-bottom:1em;" | Kaiser der Flavischen Dynastie
|- class="hintergrundfarbe5"
! width="15%" | Kaiser !! width="30%" | Vollständiger Name
! width="15%" | Regierungszeit !! class="unsortable" width="40%" | Anmerkungen
|-
| [[Vespasian]] || Titus Flavius Vespasianus
| style="text-align:right" | 69–79 || konsolidierte Verwaltung und Finanzen des Reiches
|-
| [[Titus]] || Titus Flavius Vespasianus
| style="text-align:right" | {{SortKey|79-81}}Mitte 79–81 || eröffnete das [[Kolosseum]] in Rom
|-
| [[Domitian]] || Titus Flavius Domitianus
| style="text-align:right" | 81–96 || beendete römische Expansion in Germanien
|-
| [[Lucius Antonius Saturninus|Saturninus]] || Lucius Antonius Saturninus
| style="text-align:right" | 89 || Gegenkaiser in Germanien, gefallen
|- class="sortbottom hintergrundfarbe5"
| '''[[Liste der römischen Kaiser der Antike#Liste der römischen Kaiser|Vollst. Liste]]'''
|
|
|
|}

Der Quelltext hierfür sieht folgendermaßen aus:

<syntaxhighlight lang=html line>
{| class="wikitable sortable"
|+ style="padding-bottom:1em;" | Kaiser der Flavischen Dynastie
|- class="hintergrundfarbe5"
! width="15%" | Kaiser !! width="30%" | Vollständiger Name
! width="15%" | Regierungszeit !! class="unsortable" width="40%" | Anmerkungen
|-
| [[Vespasian]] || Titus Flavius Vespasianus
| style="text-align:right" | 69–79 || konsolidierte Verwaltung und Finanzen des Reiches
|-
| [[Titus]] || Titus Flavius Vespasianus
| style="text-align:right" | {{SortKey|79-81}}Mitte 79–81 || eröffnete das [[Kolosseum]] in Rom
|-
| [[Domitian]] || Titus Flavius Domitianus
| style="text-align:right" | 81–96 || beendete römische Expansion in Germanien
|-
| [[Lucius Antonius Saturninus|Saturninus]] || Lucius Antonius Saturninus
| style="text-align:right" | 89 || Gegenkaiser in Germanien, gefallen
|- class="sortbottom hintergrundfarbe5"
| '''[[Liste der römischen Kaiser der Antike#Liste der römischen Kaiser|Vollst. Liste]]'''
|
|
|
|}
</syntaxhighlight>

'''Erläuterungen'''

* Das <code>sortable</code> in <code>class="wikitable sortable"</code> erlaubt die Sortierung der Tabelle nach wählbaren Spalten.
* Mit <code>class="unsortable"</code> können einzelne Spalten von der Sortierbarkeit ausgenommen werden.
* Mit den Vorlagen [[:Vorlage:Dts]], [[:Vorlage:Nts]] und [[:Vorlage:SortKey]] lässt sich die Sortierreihenfolge einzelner Tabelleneinträge beeinflussen
* Der Befehl <code>width="15%"</code> weist einer Spalte 15 % der Gesamtbreite der Tabelle als Breite zu.
* Die Ausrichtung von Text rechtsbündig in einer Zelle erreicht man durch die [[Cascading Style Sheets|CSS]]-Anweisung <code>style="text-align:right"</code>.
* Nebeneinanderliegende Zellen kann man sowohl durch das <code>||</code>-Zeichen trennen, als auch durch einen Zeilenumbruch gefolgt von einem einfachen <code>|</code>-Zeichen.
* Der Befehl <code>|- class="hintergrundfarbe5"</code> weist der darauffolgenden Zeile eine Hintergrundfarbe zu. In Artikeln sollen die entsprechenden Standardfarben verwendet werden (siehe [[Hilfe:Farben#Farben verwenden|Farben verwenden]] in der [[Hilfe:Farben|Hilfe zu Farben]]). Außerhalb des Artikelnamensraumes können Farben außer durch ihren englischen Namen auch als Hexadezimalzahl aus sechs Ziffern eingegeben werden, wobei die ersten zwei Ziffern für den Rotanteil von bis zu 256 stehen, die nächsten zwei für den Grünanteil und die letzten zwei für den Blauanteil, das heißt, dass <code>#ff0000</code> die Farbe Rot bedeutet, <code>#00ff00</code> steht für Grün und <code>#0000ff</code> steht für Blau. Durch eine Mischung erhält man beispielsweise Violett: <code>#ff00ff</code>.
* Leerzellen können durch einen einfachen Abstand erzeugt werden. Diese Zellen werden aber beim Sortieren an den Anfang gestellt, Leerzellen mit <code>&nbsp;</code> stehen am Ende.
* Das <code>sortbottom</code> in <code>class="sortbottom hintergrundfarbe5"</code> führt dazu, dass die Zeile von der Sortierung ausgenommen wird und damit stets als Fußzeile der Tabelle angezeigt wird.

=== Geschachtelte Tabellen ===
Tabellen können geschachtelt werden:

'''colspan'''

{| class="wikitable float-right" style="text-align:center"
! style="background:#e3e3e3" | A
! style="background:#e3e3e3" | B
! style="background:#e3e3e3" | C
|-
| colspan="3" style="background:#EED5B7" | eine Zeile
|}

<syntaxhighlight lang=html line>
{| class="wikitable" style="text-align:center"
! A
! B
! C
|-
| colspan="3" | eine Zeile
|}
</syntaxhighlight>
<br style="clear:both;" clear="all" />

'''rowspan'''

{| class="wikitable float-right" style="text-align:center"
! style="background:#e3e3e3" | A
| rowspan="3" style="background:#EED5B7" | eine Spalte
|-
! style="background:#e3e3e3" | B
|-
! style="background:#e3e3e3" | C
|}

<syntaxhighlight lang=html line>
{| class="wikitable" style="text-align:center"
! A
| rowspan="3" | eine Spalte
|-
! B
|-
! C
|}
</syntaxhighlight>
<br style="clear:both;" clear="all" />

'''colspan + rowspan'''

{| class="wikitable float-right" style="text-align:center"
! colspan="2" style="background:#e3e3e3" | A
|-
! style="background:#e3e3e3" | B
| rowspan="2" style="background:#EED5B7" | eine Spalte
|-
! style="background:#e3e3e3" | C
|}

<syntaxhighlight lang=html line>
{| class="wikitable" style="text-align:center"
! colspan="2" style="text-align:center" | A
|- style="text-align:center"
! B
| rowspan="2"| eine Spalte
|- style="text-align:center"
! C
|}
</syntaxhighlight lang=html line>
<br style="clear:both;" clear="all" />

;
{| class="wikitable float-right" style="text-align:center"
|- style="background:#e3e3e3"
! colspan="4" | Titel
|- style="background:#e3e3e3"
! rowspan="2" style="background:#EED5B7" | eine Spalte
| A || B || C
|- style="background:#e3e3e3"
| D || E || F
|}

<syntaxhighlight lang=html line>
{| class="wikitable" style="text-align:center"
|-
! colspan="4" | Titel
|-
! rowspan="2" | eine Spalte
| A || B || C
|-
| D || E || F
|}
</syntaxhighlight>
<br style="clear:both;" clear="all" />

=== Tabellen nebeneinander ===
<syntaxhighlight lang=html line>
<div style="float:left; margin-right:1em;">
{| class="wikitable"
|+ Linke Tabelle
! Überschrift 1 || Überschrift 2
|-
| Feld 1 || Feld 2
|}
</div>

<div style="float:left;">
{| class="wikitable"
|+ Rechte Tabelle
! Überschrift 1 || Überschrift 2
|-
| Feld 1 || Feld 2
|}
</div>

<div style="clear:both;" />
</syntaxhighlight>

<div style="float:left; margin-right:1em;">
{| class="wikitable"
|+ Linke Tabelle
! Überschrift 1 || Überschrift 2
|-
| Feld 1 || Feld 2
|}
</div>

<div style="float:left;">
{| class="wikitable"
|+ Rechte Tabelle
! Überschrift 1 || Überschrift 2
|-
| Feld 1 || Feld 2
|}
</div>

<div style="clear:both;" />

=== Gleich breite Tabellen ===
<syntaxhighlight lang=html line>
{| class="wikitable"
|-
| style="width:5em" | a: 5em
| style="width:10em" | b: 10em
| style="width:7em" | c: 7em
|}
{| class="wikitable"
|-
| style="width:5em" | a: 5em
| style="width:10em" | b: 10em
| style="width:7em" | c: 7em
|}
</syntaxhighlight>

{| class="wikitable"
|-
| style="width:5em" | a: 5em
| style="width:10em" | b: 10em
| style="width:7em" | c: 7em
|}
{| class="wikitable"
|-
| style="width:5em" | a: 5em
| style="width:10em" | b: 10em
| style="width:7em" | c: 7em
|}

=== Listen in Tabellen, Bilder in Tabellen ===
Tabellen können Tabellen, Bilder und Wiki-Syntax-Formatierung enthalten:

{{Taxobox
| Taxon_Name = Hyänen
| Taxon_WissName = Hyaenidae
| Taxon_Rang = Familie
| Taxon_Autor = [[John Edward Gray|Gray]], 1821
| Taxon2_Name = Katzenartige
| Taxon2_WissName = Feloidea
| Taxon2_Rang = Überfamilie
| Taxon3_Name = Raubtiere
| Taxon3_WissName = Carnivora
| Taxon3_Rang = Ordnung
| Taxon4_Name = Höhere Säugetiere
| Taxon4_WissName = Eutheria
| Taxon4_Rang = Unterklasse
| Taxon5_Name = Säugetiere
| Taxon5_WissName = Mammalia
| Taxon5_Rang = Klasse
| Taxon6_Name = Kiefermäuler
| Taxon6_WissName = Gnathostomata
| Taxon6_Rang = Überklasse
| Bild = Crocuta-hejda.jpg
| Bildbeschreibung = [[Tüpfelhyäne]] ''(Crocuta crocuta)''
| Subtaxa_Rang = Art
| Subtaxa =
* [[Streifenhyäne]] ''(Hyaena hyaena)''
* [[Schabrackenhyäne]] ''(Hyaena brunnea)''
* [[Tüpfelhyäne]] ''(Crocuta crocuta)''
* [[Erdwolf]] ''(Proteles cristatus)''
}}

Dieser Text erzeugt die rechte Tabelle, wenn man ihn in einen Artikel eingibt:
<syntaxhighlight lang=ini>{{Taxobox
| Taxon_Name = Hyänen
| Taxon_WissName = Hyaenidae
| Taxon_Rang = Familie
| Taxon_Autor = [[John Edward Gray|Gray]], 1821
| Taxon2_Name = Katzenartige
| Taxon2_WissName = Feloidea
| Taxon2_Rang = Überfamilie
| Taxon3_Name = Raubtiere
| Taxon3_WissName = Carnivora
| Taxon3_Rang = Ordnung
| Taxon4_Name = Höhere Säugetiere
| Taxon4_WissName = Eutheria
| Taxon4_Rang = Unterklasse
| Taxon5_Name = Säugetiere
| Taxon5_WissName = Mammalia
| Taxon5_Rang = Klasse
| Taxon6_Name = Kiefermäuler
| Taxon6_WissName = Gnathostomata
| Taxon6_Rang = Überklasse
| Bild = Crocuta-hejda.jpg
| Bildbeschreibung = [[Tüpfelhyäne]] ''(Crocuta crocuta)''
| Subtaxa_Rang = Art
| Subtaxa =
* [[Streifenhyäne]] ''(Hyaena hyaena)''
* [[Schabrackenhyäne]] ''(Hyaena brunnea)''
* [[Tüpfelhyäne]] ''(Crocuta crocuta)''
* [[Erdwolf]] ''(Proteles cristatus)''
}}</syntaxhighlight>

'''Erläuterungen'''

→ ''Siehe: [[Wikipedia:Taxoboxen]]''

== Siehe auch ==

* Bei [[meta:Main Page|MetaWiki]] befindet sich ein [[meta:Help:Table|englischer Artikel]], der die Gestaltung mit Tabellen etwas ausführlicher behandelt.
* Außerdem gibt es bei [[meta:Main Page|MetaWiki]] einen [[meta:Help:Sorting|englischen Artikel]], der die Sortierung von Tabellen im Detail behandelt.
* Im Abschnitt [[Wikipedia:Wie gute Artikel aussehen#Tabellen|Tabellen]] in [[Wikipedia:Wie gute Artikel aussehen|Wie gute Artikel aussehen]] wird auf die Bedeutung von Vorlagen zur Vereinheitlichung hingewiesen.
* Der Abschnitt [[Hilfe:Bilder#Ausrichten im Text|Ausrichten im Text]] in der [[Hilfe:Bilder|Hilfe für Bilder]] über die Positionierung von Bildern in Tabellen
* In [[Hilfe:Tabellen-Referenz]] sind die einzelnen Möglichkeiten nochmals mit Beispielen aufgeführt.
* Beispiele: [[:Kategorie:Vorlage:Tabelle]] – Tabellen, die auf mehreren Seiten als Vorlage eingebunden werden

== Hilfen ==

* '''[[Benutzer:PeerBr/WPro|WPro]]''' (Server zur Zeit nicht erreichbar) ist ein Wikipedia-Editor für den [[Windows Internet Explorer|Internet Explorer]] 6.0, der Tabellen per Knopfdruck einfügen und formatieren kann.
* '''[[Wikipedia:Textverarbeitung/EXCEL-Tabellenumwandlung|EXCEL-Tabellenumwandlung]]''' konvertiert den ausgewählten Tabellenbereich aus MS Excel direkt ins Wiki-Tabellenformat. Die wichtigsten Formatierungen wie Fett/Kursiv, Zellenhöhe und -breite, Schriftgröße, Farbinformation aus MS Excel bleiben erhalten.
* '''[[Wikipedia:Textverarbeitung/Excel2Wiki|Excel2Wiki]]''' Berücksichtigt verbundene Zellen, dazu auch ein Programm zur Umwandlung der Spalten in Zeilen und umgekehrt und ein Programm zur Zeilenumkehr, d. h. die letzte Zeile wird zur ersten usw.
* '''[[Benutzer:Duesentrieb/csv2wp|csv2wp]]''' ist ein Werkzeug zum Umwandeln von [[CSV (Dateiformat)|CSV-Datei]]en in Wiki-Tabellenformat. Damit lassen sich z. B. Tabellen aus [[Microsoft Excel]] importieren.
* Ab [[OpenOffice.org|OpenOffice]] 2.3 kann man Writer-Dokumente ins [http://de.openoffice.org/presse/pressemitteilung_20070917.html Mediawiki-Format] exportieren.
* [[OpenOffice.org|OpenOffice]]-Tabellen können mit [[Wikipedia:Textverarbeitung/OOoCalc2Wiki|Calc2Wiki]] konvertiert werden. Eine Alternative (mit der ein oder anderen Erweiterung) ist [[Benutzer:Erodeist/Calc2WikiTable|Calc2WikiTable]].
* [http://www.cnic.org/html2mediawiki.html Umwandlung von HTML-Tabellen in Wiki-Tabellen]

----
[[Kategorie:Hilfe]]

Hostsharing Wiki Konventionen

2024-07-10T12:46:57Z

Hsh-milanihl:

Praktisches über den Umgang mit dem HS Wiki und der Software Mediawiki.

== Allgemein - Klauen erwünscht!==

Das Wiki verändert sich mit dem zunehmenden Wissen seiner Benutzer. Daher kann man beim Neuanlegen einer Seite durchaus mal schauen, wie ist eine andere Seite (die gut und sinnvoll aussieht) aufgebaut. Am Besten lernt man, indem man den Quelltext guter Seiten oder Absätze studiert. Auch der eine oder andere Blick in die [[Hilfe]] ist zu Beginn sehr sinnvoll. Aber lasse dich nicht abschrecken. Ändern, Korrigieren, das Arbeiten, geht hier von der ersten Minute an. Also los, mach mit!

== Was soll ins Wiki ==
'''Nur reine Dokumentation.'''

Also nicht: Aktuelles, Produkte, Preise, Hostsharing eG. von der [http://www.hostsharing.net www.hostsharing.net] Seite.

== Seiten anlegen ==
Das funktioniert dadurch, dass man auf einer vorhandenen Seite einen Link anlegt:

<syntaxhighlight lang=twig>[[Link]]</syntaxhighlight>

Danach klickt man den Link und befindet sich auf der neuen, noch leeren Seite. Die kann man jetzt mit "Bearbeiten" mit Inhalten füllen.

=== Eine oder mehrere Seiten? ===

Bitte nicht sofort viele Seiten zu einem Thema anlegen und miteinander verlinken, das stört wahrscheinlich nur unnötig den Lesefluss. Oft ergibt sich die Struktur während des Schreibens von selbst, wie in [[Guter_Stil]] beschrieben.

Zuerst schreibt man einfach alle Information in eine einzige Seite, gliedert mit Headlines und vertraut auf die seiteninterne Navigation (TOC – Table Of Content), die schon sehr gut ist. Erst wenn die Seite wirklich zu lange wird oder man neue Bereiche erkennt, die klar abgrenzbar sind, teilt man die Seite auf. Dann kann man eine eigene [[Hostsharing_Wiki_Konventionen#Men.C3.BCleiste|Menüleiste]] kreieren und einsetzen, um wiederum Zusammenhänge zwischen den Seiten herzustellen.

== Seiten überarbeiten ==

Bitte beim Überarbeiten bereits vorhandener komplexer Seiten vorsichtig sein, wenn jemand schon gut strukturiert hat und sich auch offenbar tiefe Gedanken dazu gemacht hat. Dann kann der Originalautor auch auf dessen Benutzerseite angeschrieben werden (oder natürlich HS-Intern direkt kontaktiert werden): "Du ich hätte da mal eine Idee..."

Außerdem bietet jede Seite eine Diskussionsseite, die in der Regel von den Autoren auch beobachtet wird (die Autoren erhalten bei Änderungen ein Mail). Diese kann ebenfalls zur Kommunikation verwendet werden.

== Anrede des Lesers ==

Siehe auch [[Guter Stil]] und die zugehörige Diskussion.

Solange keine völlig unpersönliche Sprache gewählt ist, wirst du als Leser in der zweiten Person mit "Du" angesprochen. Die erste Person "ich" wird gemieden, damit auch andere an dem Text weiter arbeiten können. Benötigen wir ausnahmsweise die erste Person, verwenden wir wir. :-)

==Namenskonvention==

Eine Verpflichtung zu bestimmten Namensformen gibt es erst mal keine. Suche Dir einfach einen passenden Namen aus. Seiten können verschoben oder unter anderem Namen aufgerufen werden. Alles lässt sich nachträglich ändern!

Seiten, die sich auf eine bestimmte Software beziehen, sollten so benannt werden, dass der Name der Seite mit dem Namen der Software beginnt. So taucht die Seite in den von MediaWiki automatisch erstellten Seitenlisten alphabetisch unter dem Namen der Software einsortiert auf und ist für Leser leichter aufzufinden. [[:Kategorie:Installationsanleitungen|Installationsanleitungen]] sollten "Xyz installieren" heißen, wenn die Software Xyz heißt, wenn es mehrere Versionen der Software gibt, sollte auch die Versionsnummer mit in den Seitentitel aufgenommen werden und insgesamt müssen Installationsanleitungen natürlich entsprechend kategorisiert werden.

Seiten, die einen sehr allgemeinen Titel tragen und grundsätzliche Erklärungen beinhalten ([[Hive]]) verdienen es vielleicht, ins [[:Kategorie:Glossar|Glossar]] übernommen zu werden:

<syntaxhighlight lang=twig>
[[Kategorie:Glossar]]
</syntaxhighlight>

== Kategorisieren ==

Jede Seite und jede Vorlage sollte kategorisiert werden. Das geschieht am Ende der Seite durch einen speziellen Link mit dem Namensraum "Kategorie":

<syntaxhighlight lang=twig>
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Plone]]
</syntaxhighlight>

Alle Seiten, die die Dokumentation betreffen, werden grundsätzlich der Kategorie "HSDoku" zugeteilt. Alle Vorlagen bekommen die Kategorie "Vorlage".

== Weiterleitungen und Synonyme ==

'''Weiterleitungen'''

Es kommt ab und zu vor, dass man im Text etwas erwähnen möchte, das an anderer Stelle schon beschrieben ist, aber der Name des Links passt einfach nicht. So lange es sich um eine andere Wortform handelt, bietet sich die Einrichtung einer Weiterleitung an.

Dass [[Hive]] und [[Hives]] auf die gleiche Seite zeigen, ist das Ergebnis einer Weiterleitung. Die originale Seite trägt den Namen "Hive", damit der Link [[Hives]] auf die gleiche Seite zeigt, bedient er sich eines Redirects. Wenn man einen solchen Link anlegt, zeigt er zuerst einmal auf die neue Seite "Hives". Dort kann man folgendes eintragen:

<syntaxhighlight lang=twig>
#REDIRECT [[Hive]]
</syntaxhighlight>

Damit wird [[Hives]] auf [[Hive]] ungelenkt.

'''Synonyme'''

Ein Synonym hingegen, das nicht allgemein, sondern nur speziell in dem aktuell bearbeiteten Text vorkommen soll, kann durch Umbenennung innerhalb des Links erreicht werden. Hier linkt [[User|Einrichten eines Benutzers]] in Wirklichkeit auf [[User]]:

<syntaxhighlight lang=twig>
Hier linkt [[User|Einrichten eines Benutzers]] in Wirklichkeit auf [[User]]:
</syntaxhighlight>

== Weiterführende Links ==

Ist ein Thema zu umfangreich, um es auf einer Seite abzuhandeln, erhält die Hauptseite einen Absatz '''Weiterführende Links'''. Hier werden die direkt darunter liegenden Seiten verlinkt.

Für die Seite [[Pakete]] zum Beispiel sieht das so aus:

<syntaxhighlight lang=markdown>

== Weiterführende Links ==
* [[WEB-Paket]]
* [[Static-Web]]

</syntaxhighlight>

Im Beispiel muss natürlich auch in der Seite [[WEB-Paket]] ein entsprechender Absatz abgelegt werden, da sie ebenfalls auf "tiefer" liegende Seiten verweist.

Es bleibt dem Autor überlassen, ob der Absatz "Weiterführende Links" ganz oben oder ganz unten in der Seite angelegt wird, nur irgendwo in der Mitte hat er naturgemäß wenig Sinn. "Ganz oben" hat auf allen Seiten Sinn, die so lang sind, dass er sonst nicht gleich am Bildschirm auftaucht.

== Menüleiste ==

In besonderen Fällen kann eine Menüleiste wie zum Beispiel [[Vorlage:HSDoku-DomainLinks‏‎]] verwendet werden. Und zwar dann, wenn die durch die Menüleiste verlinkten Seiten in sehr engem thematischen Zusammenhang stehen, und es dem Benutzer ermöglicht werden soll, schnell zwischen den zusammengehörenden Seiten zu wechseln. Eine Menüleiste darf nur auf den Seiten eingesetzt werden, die direkt von ihr verlinkt werden. '''Die Menüleiste entfernt und ersetzt den sonst eingeblendeten Titel der Seite!'''

== Löschen und Ersetzen von Seiten ==

=== Löschen ===

Seiten werden nur in sehr begründeten Ausnahmefällen gelöscht, z.B. Spam, Seiten, deren Funktion einen temporären Charakter hatte und die durch Änderungen überflüssig geworden sind oder Seiten, die nicht mit sinnvollen Inhalten gefüllt werden (können). Löschen kann diese Seiten nur ein Administrator im Wiki. Daher wird eine solche Seite als Löschkandidat markiert, indem die entsprechende [[Vorlage:Löschkandidat]] an den Anfang gestellt (und der Grund für den Löschvorschlag in der zugehörigen Diskussionsseite festgehalten) wird:

<syntaxhighlight lang=twig>
{{Löschkandidat}}
</syntaxhighlight>

'''Es ist immer vorher zu prüfen, ob die Seite nicht ersetzt werden kann.''' Das gilt insbesondere dann, wenn davon auszugehen ist, dass Links auf diese Seite zeigen, ob von innerhalb des Wikis oder von außen.

=== Ersetzen ===

Meist werden Seiten ersetzt, Zum Beispiel dann, wenn die auf der ursprünglichen Seite beschriebene Methode veraltet ist. Da aber immer noch Links auf die urprüngliche Seite zeigen können, löschen wir den Inhalt und verwenden als Seiteninhalt '''einzig und allein''' die [[Vorlage:Ersetzt]], um mit ihrer Hilfe einen Link auf die neue Seite zu setzen und eine Begründung anzugeben. Dadurch wird gleichzeitig die ursprüngliche Seite aus allen Kategorien entfernt, außer [[:Kategorie:Veraltet]].

== Anmerkungen und Diskussionen ==

Jede Seite hat zusätzlich einen Bereich für die Diskussion. Ist der Inhalt der Seite fehlerhaft, falsch oder einfach diskussionswürdig, schreibt man das entsprechend da hinein. Man kann auch Diskussionen in seine [[Special:Watchlist|Beobachtungsliste]] aufnehmen und wird dann bei Änderungen/Antworten durch Andere benachrichtigt.

Es wird leicht übersehen, neben dem Link "Bearbeiten" gibt es ein kleines "+", das einem die Antwort erleichtert, man kann sogar einen Betreff eingeben, der als Überschrift erscheint.

== Seiten mit fehlerhaften oder falschen Inhalten ==

Ist man nicht in der Lage, zum Beispiel aufgrund fehlenden Fachwissens, die Seite zu korrigieren, beschreibt man den Fehler in der Diskussionsseite und kategorisiert die Seite als "Baustelle" durch die [[Vorlage:Baustelle]]:

<syntaxhighlight lang=twig>
{{Baustelle}}
</syntaxhighlight>

----
[[Kategorie:Hilfe]] [[Kategorie:Hostsharing Wiki]]

Autorenportal

2024-07-10T12:41:23Z

Hsh-milanihl:

Das Hostsharing-Wiki ist ein gemeinsames Projekt der Hostsharing-Mitglieder, in dem wir die Dokumentation der Dienste von Hostsharing überarbeiten und auf den aktuellen Stand bringen möchten. Auf dieser Seite findest du Informationen dazu, wie du dich daran beteiligen kannst.

== Erste Schritte ==

'''Anmelden'''

Das Wiki verwendet den Single-Sign-On-Dienst von Hostsharing, sodass Du Dich im Wiki mit jedem gültigen [[User]] (Benutzernamen) eines Servers von Hostsharing anmelden kannst. Du kannst Dir natürlich für die Nutzung des Wikis einen eigenen [[User]] in einem Deiner Pakete anlegen, zum Beispiel xyz00-wiki oder xyz00-hsdoku.

'''Benutzereinstellungen'''

Nachdem du dich im Wiki angemeldet hast, ist es sinnvoll, wenn du zunächst deine Benutzereinstellungen anpasst (der Link [[Spezial:Einstellungen | Einstellungen]] - nur sichtbar, wenn Du angemeldet bist). Mindestens deine E-Mail-Adresse solltest du eintragen, denn dann kannst du Seiten im Wiki beobachten und Nachrichten bekommen, wenn eine von dir beobachtete Seite geändert wurde.

Du solltest dich außerdem auf der Hostsharing-Mailingliste (nicht öffentliche Liste) [https://lists.hostsharing.net/mailman/listinfo/website/ website@hostsharing.net] anmelden. Dort diskutieren wir über die Weiterentwicklung der Dokumentation.

== Wo ist Arbeit nötig? ==

<div style="margin-left:2em;font-style:italic">Die wichtigsten Links: [[:Kategorie:Baustelle|Baustelle]]n, [[Hostsharing_Wiki:Wunschliste Installationsanleitungen|Wunschliste Installationsanleitungen]], [[Ideen für das Wiki]], [[Fehler im Wiki]]</div>

Ganz konkret kannst du zum Beispiel schauen, welche Seiten hier im Wiki als [[:Kategorie:Baustelle|Baustelle]] gekennzeichnet sind und diese überarbeiten. Oder du erstellst eine ganz neue Dokumentation zu einem Thema.

Natürlich kannst du auch als Benutzer die Dokumentation lesen und in der Diskussion der entsprechenden Seite darauf hinweisen, wo aus deiner Sicht Verbesserungen notwendig sind. Um eine Seite als Baustelle zu kennzeichnen, trage einfach folgendes ganz am Anfang der Seite ein:

<syntaxhighlight lang=twig>{{Baustelle}}</syntaxhighlight>

Am Anfang der Seite erscheint dann ein entsprechender Hinweis und die Seite wird in die [[:Kategorie:Baustelle|Liste der Baustellen]] aufgenommen.

== Konventionen ==

Wenn du an der Dokumentation arbeitest, solltest du unsere [[Hilfe:Hostsharing_Wiki_Konventionen|Konventionen]] und [[Hilfe:Guter_Stil|Hinweise zu gutem Stil]] beachten.

== Umgang mit der Wiki-Software ==

Wir verwenden als Software [http://www.mediawiki.org/ MediaWiki]. Nachfolgend einige Links auf Hinweise dazu, wie du im Wiki Texte formatierst und Links anlegst. Gefahrlos ausprobieren kannst du die Wiki-Funktionen auf der Seite [[Sandkasten]], diese ist explizit zum Experimentieren gedacht.

* [[Hilfe:Textgestaltung|Textformatierung im Wiki]]
* [[Hilfe:Link|Links anlegen]]

== Für den Leser schreiben! ==

Entgegen der langjährigen Tradition in Akademie und Technik, schreiben wir hier vor allem für diejenigen Leser*innen, die noch nicht das wissen, was wir als Autoren wissen. Deshalb immer beim Schreiben von Dokumentation daran denken, daß der Leser womöglich zum allerersten Mal eine Einrichtung vornehmen will, die uns quasi selbstverständlich ist. Das bedeutet, daß die Anleitungen in diesem Wiki mit '''genauer Terminologie''' und ohne allzuviele Abkürzungen '''ausführlich''' sagen sollen, was der Leser machen muß.

*Falsch: "Dann über die Shell die entsprechenden Rewrite-Zeilen in die .htaccess einfügen."
*Besser: "Dann mit ssh als Paketuser xyz00-username an example.com anmelden und folgende Zeilen in die Datei ~/doms/example.com/htdocs-ssl/.htaccess einfügen: ..."

----
[[Kategorie:Hilfe]]
[[Kategorie:Hostsharing Wiki]]