lib/moin: update for 1.9.9, fix config order
[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 37extern val php5 : php_version;
42782c79 38extern val fast_php : php_version;
313442ed 39{{FastCGI based php5. Much faster than regular php5.}}
e7482df3 40
8a7c40fa 41extern val vhost : host -> Vhost => [Domain]
ae272cb5
AC
42 {WebPlaces : [web_place],
43 SSL : ssl,
44 User : your_user,
45 Group : your_group,
46 DocumentRoot : your_path,
47 ServerAdmin : email,
e7482df3
AC
48 SuExec : suexec_flag,
49 PhpVersion : php_version};
f8dfbbcc
AC
50{{Add a new named Apache virtual host, specifying which nodes' Apache servers
51 should answer requests for this host, whether it should use SSL, what UNIX
52 user and group dynamic content generators should be run as, the filesystem
53 path to the static content root, and the e-mail address to which error pages
54 should direct visitors.}}
2882ee37 55
57e066bb
AC
56extern val vhostDefault : Vhost => [Domain]
57 {WebPlaces : [web_place],
58 SSL : ssl,
59 User : your_user,
60 Group : your_group,
61 DocumentRoot : your_path,
62 ServerAdmin : email,
e7482df3
AC
63 SuExec : suexec_flag,
64 PhpVersion : php_version};
57e066bb
AC
65{{Like <tt>vhost</tt>, but for, e.g., <tt>yourdomain.com</tt> instead of
66 <tt>www.yourdomain.com</tt>}}
67
2882ee37
AC
68context Location;
69
70extern type location;
71{{A valid URI prefix}}
72
36578c0c 73extern val location : location -> ^Vhost & Location => [Vhost & !Location];
2882ee37
AC
74extern val directory : your_path -> ^Vhost & Location => [Vhost & !Location];
75{{Set some configuration specific to a URI prefix or filesystem directory,
76 respectively.}}
edd38024 77
767fe695
AC
78extern type regexp;
79{{PCRE regular expression}}
80
81extern val filesMatch : regexp -> ^Vhost & Location => [Vhost & !Location];
82{{Mark nested configuration to only apply to filenames matching the regexp.}}
83
5210d78d 84extern val serverAliasHost : your_domain_host -> [Vhost];
edd38024 85{{Give an alternate hostname for this vhost.}}
5210d78d 86extern val serverAlias : host -> [Vhost];
e519d696
AC
87{{Like serverAliasHost, but adds an alias for the given hostname at every domain
88 being configured.}}
5210d78d 89extern val serverAliasDefault : [Vhost];
e519d696
AC
90{{Like serverAliasDefault, but adds aliases for the domains being configured
91 instead of any of their hosts/"subdomains".}}
ecc307a0
AC
92
93extern val testNoHtaccess : [Location];
ef5ad69a
CE
94
95extern val sslCertificateChainFile : ssl_cacert_path -> [Vhost];
96{{Intermediate file to serve as part of the chain of authority for
97 your ssl certificate}}