Jan Ulrich Hasecke
2022-08-05 62b67dcded0b9ade05953ec2723444bd28eeefc6
commit | author | age
261280 1 # Modul domain {#kap-modul-domain}
JUH 2
3 ## Funktionen
4
bd89e9 5 `domain.search` 
261280 6
bd89e9 7 : Suche Domain nach den im Befehlsausdruck angegebenen Feldern und Werten
261280 8
bd89e9 9 `domain.add`
261280 10
bd89e9 11 : Füge eine neue Domain nach den im Befehlsausdruck angegebenen Feldern und Werten hinzu.
261280 12
bd89e9 13 `domain.update`
261280 14
bd89e9 15 : Aktualisiere eine Domain nach den im Befehlsausdruck angegebenen Feldern und Werten.
261280 16
bd89e9 17 `domain.remove`
261280 18
bd89e9 19 : Lösche eine Domain nach den im Befehlsausdruck angegebenen Feldern und Werten.
261280 20
JUH 21 ## Editierbare Felder
22
bd89e9 23 Das HSAdmin-Modul `domain` kann entsprechend der folgenden Befehlssyntax von `HSAdmin` Felder setzen oder verändern:
261280 24
JUH 25     domain.function({where:{field:'value',...}, set:{field:'value',...}})
26
27 Im Modul `domain` stehen folgende Felder zur Verfügung.
28
bd89e9 29 `name`
261280 30
JUH 31 :   Name einer Domain
32
bd89e9 33 `user`
261280 34
JUH 35 :   Name des Domain-Admins
36
bd89e9 37 `validsubdomainnames`
261280 38
bd89e9 39 :   leichtgewichtige Subdomains in diesem Virtual-Host des Webservers, gültige Werte: `*` für beliebige Subdomains oder eine kommaseparierte Liste: `www,blog,other`
261280 40
bd89e9 41 `greylisting`
261280 42
bd89e9 43 :   E-Mails werden verzögert durch den Mailserver angenommen, siehe `Greylisting`.
JUH 44 Ist die Option deaktivert, werden E-Mails ohne Verzögerung angenommen.
261280 45
bd89e9 46 `multiviews`
261280 47
bd89e9 48 :   Der Webserver berücksichtigt Einstellungen im Browser beim Abruf einer Domain (z.B. eine bevorzugte Sprache).
JUH 49 Die Option kann mit einer `.htaccess`-Datei für jedes Verzeichnis konfiguriert werden.
261280 50
bd89e9 51 `indexes`
261280 52
bd89e9 53 :   Der Webserver erzeugt für Verzeichnisse, die keine eigene Index-Datei enthalten, eine Liste mit den im Verzeichnis enthaltenen Dateien.
JUH 54 Ist die Option deaktiviert, wird ein Fehler 303 ausgegeben.
55 Die Option kann mit einer .htaccess-Datei für jedes Verzeichnis konfiguriert werden.
261280 56
bd89e9 57 `htdocsfallback`
261280 58
bd89e9 59 :   Der Webserver leitet auf die Hauptdomain, wenn keine Sub-Domain angelegt ist.
JUH 60 Ist die Option deaktivert, wird ein Fehler 404 ausgegeben: Seite nicht gefunden.
261280 61
bd89e9 62 `includes`
261280 63
bd89e9 64 :   Der Webserver erkennt `SSI`-Komandos und -Dateien.
JUH 65 Die Option kann mit einer .htaccess-Datei für jedes Verzeichnis konfiguriert werden.
261280 66
bd89e9 67 `backupmxforexternalmx`
261280 68
bd89e9 69 :   Der Paket-Hive wird als Weiterleitung (transport) beim Mail-In-Server eingetragen.
JUH 70 Ist die Option aktiv, ist der Hostsharing-Mail-In-Server Backup-MX.
71 Der eigentliche Mailserver befindet sich außerhalb der Infrastruktur von Hostsharing (z.B.
72 anderer Provider, DSL-Anschluss mit fester IP)
261280 73
bd89e9 74 `letsencrypt`
261280 75
bd89e9 76 :   Es wird automatisch ein TLS Zertifikat für diese Domain und alle im Feld „validsubdomainnames" angegebenen Subdomains erzeugt
261280 77
bd89e9 78 `autoconfig`
261280 79
bd89e9 80 :   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
261280 81
62b67d 82 ::: hint
JUH 83 Die Option `backupmxforexternalmx` erfordert Änderungen am Zonefile einer Domain. 
84 :::
261280 85
JUH 86 ## Beispiele
87
bd89e9 88 Mit dem folgenden Befehl schalten wir die Domain `hs-example.de` auf und ordnen Sie dem Domain-Admin `xyz00-hsexample` zu.
261280 89
JUH 90 ``` console
91 xyz00@hsadmin> domain.add({set:{name:'hs-example.de',user:'xyz00-hsexample'}})
92 ```
93
bd89e9 94 Mit dem Befehl `domain.search` werden alle Informationen zu einer Domain angezeigt.
JUH 95 Die gesuchte Domain wird mit dem Befehlsausdruck `where` ausgewählt.
261280 96
JUH 97 ``` console
98 xyz00@hsadmin> domain.search({where:{name:'hs-example.de'}})
99 ```
100
bd89e9 101 Und mit dem Befehl `domain.remove` können wir eine Domain entfernen.
261280 102
JUH 103 ``` console
104 xyz00@hsadmin> domain.remove({where:{name:'hs-example.de'}})
105 ```
106
bd89e9 107 Mit dem Befehl `domain.update` lassen sich die Einstellungen für eine Domain verändern.
JUH 108 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.
261280 109
JUH 110 ``` console
111 xyz00@hsadmin> domain.update({where:{name:'hs-example.de'},set:{domainoptions:['htdocsfallback','indexes','greylisting','letsencrypt','autoconfig']}})
112 ```