From 8d081ac85398030bb1c1f5f6e59e5c995a6987fa Mon Sep 17 00:00:00 2001
From: Jan Ulrich Hasecke <jan.ulrich@hasecke.com>
Date: Wed, 06 Nov 2019 12:41:11 +0100
Subject: [PATCH] hsscript umgestellt

---
 source/referenz/hsadmin/domain.rst |   95 +++++++++++++++++++++++++++++------------------
 1 files changed, 59 insertions(+), 36 deletions(-)

diff --git a/source/referenz/hsadmin/domain.rst b/source/referenz/hsadmin/domain.rst
index 2f4c4e6..1615ac5 100644
--- a/source/referenz/hsadmin/domain.rst
+++ b/source/referenz/hsadmin/domain.rst
@@ -1,44 +1,67 @@
-====================
-HSAdmin-Modul domain
-====================
-Das HSAdmin-Modul ``domain`` verfügt über folgende Optionen:
+.. _kap-modul-domain:
 
-+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Option              | Erläuterung                                                                                                                                                       |
-+=====================+===================================================================================================================================================================+
-| name                | Name einer Domain                                                                                                                                                 |
-+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| user                | Name des Domain-Admins                                                                                                                                            |
-+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| validsubdomainnames | leichtgewichtige Subdomains in diesem virtual Host des Webservers, gültige Werte: "*" für beliebige Subdomains oder eine kommaseparierte Liste: "www,blog,other"  |
-+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+============
+Modul domain
+============
 
-Beispiel:
+Funktionen
+==========
 
+.. option:: domain.search
+
+   Suche Benutzer nach den im Befehlsausdruck angegebenen Feldern und Werten
+
+.. option:: domain.add
+
+   Füge einen neuen Benutzer nach den im Befehlsausdruck angegebenen Feldern und Werten hinzu.
+
+.. option:: domain.update
+
+   Aktualisiere einen Benutzer nach den im Befehlsausdruck angegebenen Feldern und Werten.
+
+.. option:: domain.remove
+
+   Lösche einen Benutzer nach den im Befehlsausdruck angegebenen Feldern und Werten.
+
+Editierbare Felder
+==================
+
+Das HSAdmin-Modul ``domain`` kann entsprechend der folgenden Befehlssyntax von :command:`HSADmin` Felder setzen oder verändern::
+
+   domain.function({where:{field:'value',...}, set:{field:'value',...}})
+
+Im Modul ``domain`` stehen folgende Felder zur Verfügung.
+
+name
+   Name einer Domain
+user
+   Name des Domain-Admins
+validsubdomainnames
+   leichtgewichtige Subdomains in diesem virtual Host des Webservers, gültige Werte: ``*`` für beliebige Subdomains oder eine kommaseparierte Liste: ``www,blog,other``
+greylisting
+   E-Mails werden verzögert durch den Mailserver angenommen, siehe :term:`Greylisting`. Ist die Option deaktivert, werden E-Mails ohne Verzögerung angenommen.
+multiviews
+   Der Webserver berücksichtigt Einstellungen im Browser beim Abruf einer Domain (z.B. eine bevorzugte Sprache). Die Option kann mit einer :term:`.htaccess`-Datei für jedes Verzeichnis konfiguriert werden.
+indexes
+   Der Webserver erzeugt für Verzeichnisse, die keine eigene Index-Datei enthalten, eine Liste mit den im Verzeichnis enthaltenen Dateien. Ist die Option deaktiviert, wird ein Fehler 303 ausgegeben. Die Option kann mit einer .htaccess-Datei für jedes Verzeichnis konfiguriert werden.
+htdocsfallback
+   Der Webserver leitet auf die Hauptdomain, wenn keine Sub-Domain angelegt ist. Ist die Option deaktivert, wird ein Fehler 404 ausgegeben: Seite nicht gefunden.
+includes
+   Der Webserver erkennt :term:`SSI`-Komandos und -Dateien. Die Option kann mit einer .htaccess-Datei für jedes Verzeichnis konfiguriert werden.
+backupmxforexternalmx
+   Der Paket-Hive wird als Weiterleitung (transport) beim Mail-In-Server eingetragen. Ist die Option aktiv, ist der Hostsharing-Mail-In-Server Backup-MX. Der eigentliche Mailserver befindet sich außerhalb der Infrastruktur von Hostsharing (z.B. anderer Provider, DSL-Anschluss mit fester IP)
+letsencrypt
+   Es wird automatisch ein TLS Zertifikat für diese Domain und alle im Feld „valid subdomain names“ angegebenen Subdomains erzeugt
+
+.. note::
+
+        Die Option ``backupmxforexternalmx`` erfordert Änderungen am :doc:`Zonefile<../zonefile/index>` einer Domain.
+
+Beispiele
+=========
 
 .. code-block:: console
 
     xyz00@hsadmin> domain.add ({set:{name:'hs-example.de',user:'xyz00'}})
 
-
-+-----------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Option                | default | Erläuterung                                                                                                                                                                                                                                                                                     |
-+=======================+=========+=================================================================================================================================================================================================================================================================================================+
-| greylisting           | on      | E-Mails werden verzögert durch den Mailserver angenommen, siehe :term:`Greylisting`. Ist die Option deaktivert, werden E-Mails ohne Verzögerung angenommen.                                                                                                                                     |
-+-----------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| multiviews            | on      | Der Webserver berücksichtigt Einstellungen im Browser beim Abruf einer Domain (z.B. eine bevorzugte Sprache).  Die Option kann mit einer :term:`.htaccess`-Datei für jedes Verzeichnis konfiguriert werden.                                                                                     |
-+-----------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| indexes               | on      | Der Webserver erzeugt für Verzeichnisse, die keine eigene Index-Datei enthalten, eine Liste mit den im Verzeichnis enthaltenen Dateien. Ist die Option deaktiviert, wird ein Fehler 303 ausgegeben. Die Option kann mit einer .htaccess-Datei für jedes Verzeichnis konfiguriert werden.        |
-+-----------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| htdocsfallback        | on      | Der Webserver leitet auf die Hauptdomain, wenn keine Sub-Domain angelegt ist. Ist die Option deaktivert, wird ein Fehler 404 ausgegeben: Seite nicht gefunden.                                                                                                                                  |
-+-----------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| includes              | on      | Der Webserver erkennt  :term:`SSI`-Komandos und -Dateien. Die Option kann mit einer .htaccess-Datei für jedes Verzeichnis konfiguriert werden.                                                                                                                                                  |
-+-----------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| backupmxforexternalmx | off     | Der Paket-Hive wird als Weiterleitung (transport) beim Mail-In-Server eingetragen. Ist die Option aktiv, ist der Hostsharing-Mail-In-Server Backup-MX. Der eigentliche Mailserver befindet sich außerhalb der Infrastruktur von Hostsharing (z.B. anderer Provider, DSL-Anschluß mit fester IP) |
-+-----------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| letsencrypt           | on      | Es wird automatisch ein TLS Zertifikat für diese Domain und alle im Feld "valid subdomain names" angegebenen Subdomains erzeugt                                                                                                                                                                 |
-+-----------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-.. note::
-
-        Die Option ``backupmxforexternalmx`` erfordert Änderungen am :doc:`Zonefile<../zonefile/index>` einer Domain.
+.. todo:: Weitere Beispiele, mindestens noch eins mit where-Kondition

--
Gitblit v1.9.0-SNAPSHOT