Jan Ulrich Hasecke
2022-06-30 2612805de7de8795c3f9092fc5f93671a8553150
commit | author | age
261280 1 # Modul domain {#kap-modul-domain}
JUH 2
3 ## Funktionen
4
5 ::: option
6 domain.search
7
8 Suche Domain nach den im Befehlsausdruck angegebenen Feldern und Werten
9 :::
10
11 ::: option
12 domain.add
13
14 Füge eine neue Domain nach den im Befehlsausdruck angegebenen Feldern
15 und Werten hinzu.
16 :::
17
18 ::: option
19 domain.update
20
21 Aktualisiere eine Domain nach den im Befehlsausdruck angegebenen Feldern
22 und Werten.
23 :::
24
25 ::: option
26 domain.remove
27
28 Lösche eine Domain nach den im Befehlsausdruck angegebenen Feldern und
29 Werten.
30 :::
31
32 ## Editierbare Felder
33
34 Das HSAdmin-Modul `domain` kann entsprechend der folgenden Befehlssyntax
35 von `HSAdmin`{.interpreted-text role="command"} Felder setzen oder
36 verändern:
37
38     domain.function({where:{field:'value',...}, set:{field:'value',...}})
39
40 Im Modul `domain` stehen folgende Felder zur Verfügung.
41
42 name
43
44 :   Name einer Domain
45
46 user
47
48 :   Name des Domain-Admins
49
50 validsubdomainnames
51
52 :   leichtgewichtige Subdomains in diesem Virtual-Host des Webservers,
53     gültige Werte: `*` für beliebige Subdomains oder eine
54     kommaseparierte Liste: `www,blog,other`
55
56 greylisting
57
58 :   E-Mails werden verzögert durch den Mailserver angenommen, siehe
59     `Greylisting`{.interpreted-text role="term"}. Ist die Option
60     deaktivert, werden E-Mails ohne Verzögerung angenommen.
61
62 multiviews
63
64 :   Der Webserver berücksichtigt Einstellungen im Browser beim Abruf
65     einer Domain (z.B. eine bevorzugte Sprache). Die Option kann mit
66     einer `.htaccess`{.interpreted-text role="term"}-Datei für jedes
67     Verzeichnis konfiguriert werden.
68
69 indexes
70
71 :   Der Webserver erzeugt für Verzeichnisse, die keine eigene
72     Index-Datei enthalten, eine Liste mit den im Verzeichnis enthaltenen
73     Dateien. Ist die Option deaktiviert, wird ein Fehler 303 ausgegeben.
74     Die Option kann mit einer .htaccess-Datei für jedes Verzeichnis
75     konfiguriert werden.
76
77 htdocsfallback
78
79 :   Der Webserver leitet auf die Hauptdomain, wenn keine Sub-Domain
80     angelegt ist. Ist die Option deaktivert, wird ein Fehler 404
81     ausgegeben: Seite nicht gefunden.
82
83 includes
84
85 :   Der Webserver erkennt `SSI`{.interpreted-text role="term"}-Komandos
86     und -Dateien. Die Option kann mit einer .htaccess-Datei für jedes
87     Verzeichnis konfiguriert werden.
88
89 backupmxforexternalmx
90
91 :   Der Paket-Hive wird als Weiterleitung (transport) beim
92     Mail-In-Server eingetragen. Ist die Option aktiv, ist der
93     Hostsharing-Mail-In-Server Backup-MX. Der eigentliche Mailserver
94     befindet sich außerhalb der Infrastruktur von Hostsharing (z.B.
95     anderer Provider, DSL-Anschluss mit fester IP)
96
97 letsencrypt
98
99 :   Es wird automatisch ein TLS Zertifikat für diese Domain und alle im
100     Feld „validsubdomainnames" angegebenen Subdomains erzeugt
101
102 autoconfig
103
104 :   Eine Unterstützung für die Konfiguration von E-Mail-Programmen durch
105     die Verfahren \"Autoconfig\" (Mozilla) und \"Autodiscover\"
106     (Microsoft) wird für die Domain eingeschaltet
107
108 ::: note
109 ::: title
110 Note
111 :::
112
113 Die Option `backupmxforexternalmx` erfordert Änderungen am
114 `Zonefile<../zonefile/index>`{.interpreted-text role="doc"} einer
115 Domain.
116 :::
117
118 ## Beispiele
119
120 Mit dem folgenden Befehl schalten wir die Domain `hs-example.de` auf und
121 ordnen Sie dem Domain-Admin `xyz00-hsexample` zu.
122
123 ``` console
124 xyz00@hsadmin> domain.add({set:{name:'hs-example.de',user:'xyz00-hsexample'}})
125 ```
126
127 Mit dem Befehl `domain.search`{.interpreted-text role="option"} werden
128 alle Informationen zu einer Domain angezeigt. Die gesuchte Domain wird
129 mit dem Befehlsausdruck `where` ausgewählt.
130
131 ``` console
132 xyz00@hsadmin> domain.search({where:{name:'hs-example.de'}})
133 ```
134
135 Und mit dem Befehl `domain.remove`{.interpreted-text role="option"}
136 können wir eine Domain entfernen.
137
138 ``` console
139 xyz00@hsadmin> domain.remove({where:{name:'hs-example.de'}})
140 ```
141
142 Mit dem Befehl `domain.update`{.interpreted-text role="option"} lassen
143 sich die Einstellungen für eine Domain verändern. Bei einer Änderung der
144 Domain-Optionen, wie im folgenden Beispiel, müssen immer alle Optionen
145 angegeben werden, die gesetzt sein sollen, da der Befehl die bereits
146 gesetzten Domain-Optionen komplett überschreibt.
147
148 ``` console
149 xyz00@hsadmin> domain.update({where:{name:'hs-example.de'},set:{domainoptions:['htdocsfallback','indexes','greylisting','letsencrypt','autoconfig']}})
150 ```