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