Download template files using software release.
[slapos.git] / slapos / recipe / README.apache_frontend.txt
1 apache_frontend
2 ==========
3
4 Frontend using Apache, allowing to rewrite and proxy URLs like
5 myinstance.myfrontenddomainname.com to real IP/URL of myinstance.
6
7 apache_frontend works using the master instance / slave instance design.
8 It means that a single main instance of Apache will be used to act as frontend
9 for many slaves.
10
11
12 How to use
13 ========
14 First, you will need to request a "master" instance of Apache Frontend with
15 "domain" parameter, like : 
16 <?xml version='1.0' encoding='utf-8'?>
17 <instance>
18  <parameter id="domain">moulefrite.com</parameter>
19  <parameter id="port">443</parameter>
20 </instance>
21
22 Then, it is possible to request many slave instances
23 (currently only from slapconsole, UI doesn't work yet)
24 of Apache Frontend, like : 
25 instance = request(
26        software_release=apache_frontend,
27        partition_reference='frontend2',
28        shared=True,
29        partition_parameter_kw={"url":"https://[1:2:3:4]:1234/someresource"}
30      )
31 Those slave instances will be redirected to the "master" instance,
32 and you will see on the "master" instance the associated RewriteRules of
33 all slave instances.
34
35 Finally, the slave instance will be accessible from :
36 https://someidentifier.moulefrite.com.