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 extern type ipv6;
  12 {{An IPv6 address}}
  13
  14 extern type your_ip;
  15 extern val your_ip_to_ip : your_ip -> ip;
  16 {{An IP address that you're authorized to use; e.g., for an SSL web host}}
  17
  18 extern type your_ipv6;
  19 extern val your_ipv6_to_ipv6 : your_ipv6 -> ipv6;
  20 {{An IPv6 address that you're authorized to use; e.g., for an SSL web host}}
  21
  22 extern type host;
  23 {{A hostname; that is, (more or less) an alphanumeric string}}
  24
  25 extern type domain;
  26 {{An Internet domain name}}
  27
  28 extern type your_domain;
  29 {{A domain that you're allowed to configure}}
  30
  31 extern type your_domain_host;
  32 {{Some host (as a fully-qualified domain name) in one of your domains}}
  33
  34 extern type node;
  35 {{The name of a server controlled by domtool}}
  36
  37 extern val ip_of_node : node -> ip;
  38 {{Look up the IP address of a node.}}
  39
  40 extern val ipv6_of_node : node -> ipv6;
  41 {{Look up the IPv6 address of a node.}}
  42
  43 extern type user;
  44 extern type group;
  45 {{UNIX users and groups}}
  46
  47 extern type your_user;
  48 extern type your_group;
  49 {{UNIX users and groups that you're allowed to run as}}
  50
  51 extern type your_path;
  52 {{A filesystem path that you're allowed to write to.
  53   The set of permitted values is generated from a set of roots by closing it
  54   under the subdirectory relation.}}
  55 extern val end_in_slash : your_path -> your_path;
  56 {{Add a slash at the end of a path, if there isn't one already.}}
  57
  58 extern type readable_path;
  59 {{Like [your_path], but also includes some paths that everyone is allowed to
  60   read.}}
  61
  62 context Domain;
  63 {{Configuration directives specific to an Internet domain}}
  64
  65 extern type serial;
  66 {{Domain zone serial numbers}}
  67 extern val serialAuto : serial;
  68 {{Whenever DNS data changes, choose a sensible serial number automatically.}}
  69 extern val serialConst : int -> serial;
  70 {{Use this particular serial number.}}
  71
  72 extern type soa;
  73 {{DNS start-of-authority record}}
  74 extern val soa : domain -> serial -> int -> int -> int -> int -> soa;
  75
  76 val defaultSoa = soa "gibran.hcoop.net" serialAuto 86400 1800 1209600 3600;
  77
  78 extern type dns_node;
  79 {{A node offering DNS services}}
  80 extern val dns_node_to_node : dns_node -> node;
  81
  82 extern type master;
  83 {{Information on the master DNS server for a domain}}
  84 extern val externalMaster : ip -> master;
  85 {{A server not controlled by domtool will serve as master.}}
  86 extern val internalMaster : dns_node -> master;
  87 {{A server controlled by domtool will serve as master.}}
  88
  89 extern type dnsKind;
  90 {{How should DNS for this domain be handled?}}
  91 extern val useDns : soa -> master -> [dns_node] -> dnsKind;
  92 {{We do want DNS services for this domain. Specify the SOA record, information
  93   on the server in charge of zone data, and a list of slave servers.}}
  94 extern val noDns : dnsKind;
  95 {{No DNS services for this domain.}}
  96
  97 extern val domain : your_domain -> Domain => [Root] {Aliases : [your_domain], DNS : dnsKind, TTL : int};
  98 {{Configure a domain to which you have access rights.}}
  99
 100 extern type mail_node;
 101 {{A node offering SMTP services}}
 102 extern val mail_node_to_node : mail_node -> node;
 103
 104 extern val domainHost : host -> [Domain] {} => { Hostname : domain };
 105 {{Appends the current domain onto a host.}}