69b0f5e37965ab0898efddcf229d77102e6d1677
[hcoop/domtool2.git] / lib / domain.dtl
1 {{Configuring shared daemons with respect to a particular Internet domain name}}
2
3 extern type no_spaces;
4 {{Any string with no space characters}}
5
6 extern type no_newlines;
7 {{Any string with no newline characters}}
8
9 extern type ip;
10 {{An IP address}}
11
12 extern type host;
13 {{A hostname; that is, (more or less) an alphanumeric string}}
14
15 extern type domain;
16 {{An Internet domain name}}
17
18 extern type your_domain;
19 {{A domain that you're allowed to configure}}
20
21 extern type your_domain_host;
22 {{Some host (as a fully-qualified domain name) in one of your domains}}
23
24 extern type node;
25 {{The name of a server controlled by domtool}}
26
27 extern type user;
28 extern type group;
29 {{UNIX users and groups}}
30
31 extern type your_user;
32 extern type your_group;
33 {{UNIX users and groups that you're allowed to run as}}
34
35 extern type your_path;
36 {{A filesystem path that you're allowed to use.
37 The set of permitted values is generated from a set of roots by closing it
38 under the subdirectory relation.}}
39
40 context Domain;
41 {{Configuration directives specific to an Internet domain}}
42
43 extern type serial;
44 {{Domain zone serial numbers}}
45 extern val serialAuto : serial;
46 {{Whenever DNS data changes, choose a sensible serial number automatically.}
47 extern val serialConst : int -> serial;
48 {{Use this particular serial number.}}
49
50 extern type soa;
51 {{DNS start-of-authority record}}
52 extern val soa : domain -> serial -> int -> int -> int -> int -> soa;
53
54 extern type master;
55 {{Information on the master DNS server for a domain}}
56 extern val externalMaster : ip -> master;
57 {{A server not controlled by domtool will serve as master.}}
58 extern val internalMaster : node -> master;
59 {{A server controlled by domtool will serve as master.}}
60
61 extern type dnsKind;
62 {{How should DNS for this domain be handled?}}
63 extern val useDns : soa -> master -> [node] -> dnsKind;
64 {{We do want DNS services for this domain. Specify the SOA record, information
65 on the server in charge of zone data, and a list of slave servers.}}
66 extern val noDns : dnsKind;
67 {{No DNS services for this domain.}}
68
69 extern val domain : your_domain -> Domain => [Root] {DNS : dnsKind, TTL : int};
70 {{Configure a domain to which you have access rights.}}