Html5as usage and documentation.
[slapos.git] / software / html5as / README.md
1 # Html5 Application Server #\r
2 \r
3 ## Presentation ##\r
4 \r
5 * Fast hosting software for static website (html5)\r
6 \r
7 * Use Nginx server\r
8 \r
9 ## Parameter ##\r
10 \r
11 download_url (string)\r
12 \r
13 usage: \r
14 \r
15 `<instance>\r
16   <parameter id="download_url">{{ your website tarball }}</parameter>\r
17 </instance>`\r
18 \r
19 Details :\r
20 \r
21 * Instance must have [download_url] parameter\r
22 \r
23 * Only tarball (tar) is supported\r
24 \r
25 * Compressed format is gunzip (optional)\r
26 \r
27 * Tarball must contain an index.html at its root\r
28 \r
29 ## How it works ##\r
30 \r
31 Each time you (re)start your instance, html5as will remove previous website then download tarball and extract it in docroot directory.