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