Reduce toplevel environment decls and allow them in user config
[hcoop/domtool2.git] / lib / apache.dtl
1 {{Apache web server configuration}}
2
3 extern type web_node;
4 {{Nodes that accept Apache configuration from you}}
5
6 extern val web_node_to_node : web_node -> node;
7
8 extern type web_place;
9 extern val web_place_default : web_node -> web_place;
10 extern val web_place : web_node -> your_ip -> web_place;
11 extern val web_place_to_web_node : web_place -> web_node;
12 extern val web_place_to_node : web_place -> node;
13 extern val web_place_to_ip : web_place -> ip;
14 {{Web places are combinations of web nodes (servers on which you are allowed to
15 run web sites) and IP addresses on which those servers should listen for
16 requests.}}
17
18 context Vhost;
19 {{A WWW virtual host}}
20
21 extern type suexec_flag;
22 {{Whether or not to use Suexec with a vhost.
23 For users with the 'www' privilege, this type is identical to [bool].
24 For others, it has only one value, [true].}}
25
26 extern type ssl_cert_path;
27 {{Filesystem path to an SSL certificate in your 'cert' list}}
28
29 extern type ssl_cacert_path;
30 {{Filesystem path to an intermediate CA certificate in your 'cacert' list}}
31
32 extern type ssl;
33 extern val no_ssl : ssl;
34 extern val use_cert : ssl_cert_path -> ssl;
35
36 extern type php_version;
37 extern val php5 : php_version;
38
39 extern val vhost : host -> Vhost => [Domain]
40 {WebPlaces : [web_place],
41 SSL : ssl,
42 User : your_user,
43 Group : your_group,
44 DocumentRoot : your_path,
45 ServerAdmin : email,
46 SuExec : suexec_flag,
47 PhpVersion : php_version};
48 {{Add a new named Apache virtual host, specifying which nodes' Apache servers
49 should answer requests for this host, whether it should use SSL, what UNIX
50 user and group dynamic content generators should be run as, the filesystem
51 path to the static content root, and the e-mail address to which error pages
52 should direct visitors.}}
53
54 extern val vhostDefault : Vhost => [Domain]
55 {WebPlaces : [web_place],
56 SSL : ssl,
57 User : your_user,
58 Group : your_group,
59 DocumentRoot : your_path,
60 ServerAdmin : email,
61 SuExec : suexec_flag,
62 PhpVersion : php_version};
63 {{Like <tt>vhost</tt>, but for, e.g., <tt>yourdomain.com</tt> instead of
64 <tt>www.yourdomain.com</tt>}}
65
66 context Location;
67
68 extern type location;
69 {{A valid URI prefix}}
70
71 extern val location : location -> ^Vhost & Location => [Vhost & !Location];
72 extern val directory : your_path -> ^Vhost & Location => [Vhost & !Location];
73 {{Set some configuration specific to a URI prefix or filesystem directory,
74 respectively.}}
75
76 extern type regexp;
77 {{PCRE regular expression}}
78
79 extern val filesMatch : regexp -> ^Vhost & Location => [Vhost & !Location];
80 {{Mark nested configuration to only apply to filenames matching the regexp.}}
81
82 extern val serverAliasHost : your_domain_host -> [Vhost];
83 {{Give an alternate hostname for this vhost.}}
84 extern val serverAlias : host -> [Vhost];
85 {{Like serverAliasHost, but adds an alias for the given hostname at every domain
86 being configured.}}
87 extern val serverAliasDefault : [Vhost];
88 {{Like serverAliasDefault, but adds aliases for the domains being configured
89 instead of any of their hosts/"subdomains".}}
90
91 extern val testNoHtaccess : [Location];
92
93 extern val sslCertificateChainFile : ssl_cacert_path -> [Vhost];
94 {{Intermediate file to serve as part of the chain of authority for
95 your ssl certificate}}