More Mailman virtual host stuff
[hcoop/domtool2.git] / lib / domain.dtl
CommitLineData
095de39e
AC
1{{Configuring shared daemons with respect to a particular Internet domain name}}
2
f8dfbbcc
AC
3extern type no_spaces;
4{{Any string with no space characters}}
5
d5754b53
AC
6extern type no_newlines;
7{{Any string with no newline characters}}
8
6ae327f8
AC
9extern type ip;
10{{An IP address}}
11
12extern type host;
13{{A hostname; that is, (more or less) an alphanumeric string}}
14
095de39e
AC
15extern type domain;
16{{An Internet domain name}}
17
12adf55a
AC
18extern type your_domain;
19{{A domain that you're allowed to configure}}
20
edd38024
AC
21extern type your_domain_host;
22{{Some host (as a fully-qualified domain name) in one of your domains}}
23
e0b0abd2
AC
24extern type node;
25{{The name of a server controlled by domtool}}
26
15e529d6
AC
27extern val ip_of_node : node -> ip;
28{{Look up the IP address of a node.}}
29
2aeb9eec
AC
30extern type user;
31extern type group;
32{{UNIX users and groups}}
33
8a7c40fa
AC
34extern type your_user;
35extern type your_group;
12adf55a
AC
36{{UNIX users and groups that you're allowed to run as}}
37
8a7c40fa 38extern type your_path;
998ed174 39{{A filesystem path that you're allowed to write to.
8a7c40fa
AC
40 The set of permitted values is generated from a set of roots by closing it
41 under the subdirectory relation.}}
12adf55a 42
998ed174
AC
43extern type readable_path;
44{{Like [your_path], but also includes some paths that everyone is allowed to
45 read.}}
46
095de39e
AC
47context Domain;
48{{Configuration directives specific to an Internet domain}}
49
6ae327f8
AC
50extern type serial;
51{{Domain zone serial numbers}}
52extern val serialAuto : serial;
7e197d72 53{{Whenever DNS data changes, choose a sensible serial number automatically.}}
6ae327f8
AC
54extern val serialConst : int -> serial;
55{{Use this particular serial number.}}
56
57extern type soa;
58{{DNS start-of-authority record}}
59extern val soa : domain -> serial -> int -> int -> int -> int -> soa;
60
728f7033 61val defaultSoa = soa "deleuze.hcoop.net" serialAuto 172800 900 1209600 3600;
325285ab 62
be1bea4c
AC
63extern type dns_node;
64{{A node offering DNS services}}
65extern val dns_node_to_node : dns_node -> node;
66
e0b0abd2
AC
67extern type master;
68{{Information on the master DNS server for a domain}}
69extern val externalMaster : ip -> master;
70{{A server not controlled by domtool will serve as master.}}
be1bea4c 71extern val internalMaster : dns_node -> master;
e0b0abd2
AC
72{{A server controlled by domtool will serve as master.}}
73
6ae327f8
AC
74extern type dnsKind;
75{{How should DNS for this domain be handled?}}
be1bea4c 76extern val useDns : soa -> master -> [dns_node] -> dnsKind;
e0b0abd2
AC
77{{We do want DNS services for this domain. Specify the SOA record, information
78 on the server in charge of zone data, and a list of slave servers.}}
6ae327f8 79extern val noDns : dnsKind;
e0b0abd2 80{{No DNS services for this domain.}}
6ae327f8 81
e0b80e65 82extern val domain : your_domain -> Domain => [Root] {Aliases : [your_domain], DNS : dnsKind, TTL : int};
095de39e 83{{Configure a domain to which you have access rights.}}
8c142ff5
AC
84
85extern type mail_node;
86{{A node offering SMTP services}}
87extern val mail_node_to_node : mail_node -> node;