domtool-config: dump nodes, site domain, and certificate paths
[hcoop/domtool2.git] / lib / apache.dtl
CommitLineData
8a7c40fa
AC
1{{Apache web server configuration}}
2
60695e99
AC
3extern type web_node;
4{{Nodes that accept Apache configuration from you}}
5
6extern val web_node_to_node : web_node -> node;
7
128e7b0b
AC
8extern type web_place;
9extern val web_place_default : web_node -> web_place;
10extern val web_place : web_node -> your_ip -> web_place;
11extern val web_place_to_web_node : web_place -> web_node;
12extern val web_place_to_node : web_place -> node;
13extern 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
8a7c40fa
AC
18context Vhost;
19{{A WWW virtual host}}
20
00a13ad8 21extern type suexec_flag;
00a13ad8 22{{Whether or not to use Suexec with a vhost.
434a7b1f
AC
23For users with the 'www' privilege, this type is identical to [bool].
24For others, it has only one value, [true].}}
25
26extern type ssl_cert_path;
27{{Filesystem path to an SSL certificate in your 'cert' list}}
28
ef5ad69a
CE
29extern type ssl_cacert_path;
30{{Filesystem path to an intermediate CA certificate in your 'cacert' list}}
31
434a7b1f
AC
32extern type ssl;
33extern val no_ssl : ssl;
34extern val use_cert : ssl_cert_path -> ssl;
00a13ad8 35
e7482df3 36extern type php_version;
e7482df3
AC
37extern val php5 : php_version;
38
8a7c40fa 39extern val vhost : host -> Vhost => [Domain]
ae272cb5
AC
40 {WebPlaces : [web_place],
41 SSL : ssl,
42 User : your_user,
43 Group : your_group,
44 DocumentRoot : your_path,
45 ServerAdmin : email,
e7482df3
AC
46 SuExec : suexec_flag,
47 PhpVersion : php_version};
f8dfbbcc
AC
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.}}
2882ee37 53
57e066bb
AC
54extern 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,
e7482df3
AC
61 SuExec : suexec_flag,
62 PhpVersion : php_version};
57e066bb
AC
63{{Like <tt>vhost</tt>, but for, e.g., <tt>yourdomain.com</tt> instead of
64 <tt>www.yourdomain.com</tt>}}
65
2882ee37
AC
66context Location;
67
68extern type location;
69{{A valid URI prefix}}
70
36578c0c 71extern val location : location -> ^Vhost & Location => [Vhost & !Location];
2882ee37
AC
72extern val directory : your_path -> ^Vhost & Location => [Vhost & !Location];
73{{Set some configuration specific to a URI prefix or filesystem directory,
74 respectively.}}
edd38024 75
767fe695
AC
76extern type regexp;
77{{PCRE regular expression}}
78
79extern val filesMatch : regexp -> ^Vhost & Location => [Vhost & !Location];
80{{Mark nested configuration to only apply to filenames matching the regexp.}}
81
5210d78d 82extern val serverAliasHost : your_domain_host -> [Vhost];
edd38024 83{{Give an alternate hostname for this vhost.}}
5210d78d 84extern val serverAlias : host -> [Vhost];
e519d696
AC
85{{Like serverAliasHost, but adds an alias for the given hostname at every domain
86 being configured.}}
5210d78d 87extern val serverAliasDefault : [Vhost];
e519d696
AC
88{{Like serverAliasDefault, but adds aliases for the domains being configured
89 instead of any of their hosts/"subdomains".}}
ecc307a0
AC
90
91extern val testNoHtaccess : [Location];
ef5ad69a
CE
92
93extern val sslCertificateChainFile : ssl_cacert_path -> [Vhost];
94{{Intermediate file to serve as part of the chain of authority for
95 your ssl certificate}}