Jan Ulrich Hasecke
2019-12-13 e050b737b4c6cde95282e61d13e79114ca9031cd
commit | author | age
8d081a 1 .. _kap-modul-domain:
0a126d 2
8d081a 3 ============
JUH 4 Modul domain
5 ============
0a126d 6
8d081a 7 Funktionen
JUH 8 ==========
0a126d 9
8d081a 10 .. option:: domain.search
JUH 11
222551 12    Suche Domain nach den im Befehlsausdruck angegebenen Feldern und Werten
8d081a 13
JUH 14 .. option:: domain.add
15
222551 16    Füge eine neue Domain nach den im Befehlsausdruck angegebenen Feldern und Werten hinzu.
8d081a 17
JUH 18 .. option:: domain.update
19
222551 20    Aktualisiere eine Domain nach den im Befehlsausdruck angegebenen Feldern und Werten.
8d081a 21
JUH 22 .. option:: domain.remove
23
222551 24    Lösche eine Domain nach den im Befehlsausdruck angegebenen Feldern und Werten.
8d081a 25
JUH 26 Editierbare Felder
27 ==================
28
222551 29 Das HSAdmin-Modul ``domain`` kann entsprechend der folgenden Befehlssyntax von :command:`HSAdmin` Felder setzen oder verändern::
8d081a 30
JUH 31    domain.function({where:{field:'value',...}, set:{field:'value',...}})
32
33 Im Modul ``domain`` stehen folgende Felder zur Verfügung.
34
35 name
36    Name einer Domain
37 user
38    Name des Domain-Admins
39 validsubdomainnames
222551 40    leichtgewichtige Subdomains in diesem Virtual-Host des Webservers, gültige Werte: ``*`` für beliebige Subdomains oder eine kommaseparierte Liste: ``www,blog,other``
8d081a 41 greylisting
JUH 42    E-Mails werden verzögert durch den Mailserver angenommen, siehe :term:`Greylisting`. Ist die Option deaktivert, werden E-Mails ohne Verzögerung angenommen.
43 multiviews
44    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.
45 indexes
46    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.
47 htdocsfallback
48    Der Webserver leitet auf die Hauptdomain, wenn keine Sub-Domain angelegt ist. Ist die Option deaktivert, wird ein Fehler 404 ausgegeben: Seite nicht gefunden.
49 includes
50    Der Webserver erkennt :term:`SSI`-Komandos und -Dateien. Die Option kann mit einer .htaccess-Datei für jedes Verzeichnis konfiguriert werden.
51 backupmxforexternalmx
52    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)
53 letsencrypt
222551 54    Es wird automatisch ein TLS Zertifikat für diese Domain und alle im Feld „validsubdomainnames“ angegebenen Subdomains erzeugt
9f8db6 55 autoconfig
PH 56    Eine Unterstützung für die Konfiguration von E-Mail-Programmen durch die Verfahren "Autoconfig" (Mozilla) und "Autodiscover" (Microsoft) wird für die Domain eingeschaltet
8d081a 57
JUH 58 .. note::
59
60         Die Option ``backupmxforexternalmx`` erfordert Änderungen am :doc:`Zonefile<../zonefile/index>` einer Domain.
61
62 Beispiele
63 =========
0a126d 64
e050b7 65 Mit dem folgenden Befehl schalten wir die Domain ``hs-example.de`` auf und ordnen Sie dem Domain-Admin ``xyz00-hsexample`` zu.
JUH 66
0a126d 67 .. code-block:: console
JUH 68
9f8db6 69     xyz00@hsadmin> domain.add({set:{name:'hs-example.de',user:'xyz00-hsexample'}})
0a126d 70
e050b7 71
JUH 72 Mit dem Befehl :option:`domain.search` werden alle Informationen zu einer Domain angezeigt.
73 Die gesuchte Domain wird mit dem Befehlsausdruck ``where`` ausgewählt.
74
9f8db6 75 .. code-block:: console
PH 76
77     xyz00@hsadmin> domain.search({where:{name:'hs-example.de'}})
e050b7 78
JUH 79 Und mit dem Befehl :option:`domain.remove` können wir eine Domain entfernen.
80
81 .. code-block:: console
82
9f8db6 83     xyz00@hsadmin> domain.remove({where:{name:'hs-example.de'}})
PH 84
e050b7 85 Mit dem Befehl :option:`domain.update` lassen sich die Einstellungen für eine Domain verändern.
JUH 86 Bei einer Änderung der Domain-Optionen, wie im folgenden Beispiel, müssen immer alle Optionen angegeben werden, die gesetzt sein sollen, da der Befehl die bereits gesetzten Domain-Optionen komplett überschreibt.
9f8db6 87
PH 88 .. code-block:: console
89
90     xyz00@hsadmin> domain.update({where:{name:'hs-example.de'},set:{domainoptions:['htdocsfallback','indexes','greylisting','letsencrypt','autoconfig']}})