comparison mod_http_dir_listing2/README.markdown @ 3004:693d16c18e29

mod_http_dir_listing2: Add README based the one from mod_http_dir_listing
author Kim Alvefur <zash@zash.se>
date Mon, 16 Apr 2018 21:21:51 +0200
parents mod_http_dir_listing/README.markdown@8de50be756e5
children
comparison
equal deleted inserted replaced
3003:ec2984aa53db 3004:693d16c18e29
1 ---
2 summary: HTTP directory listing
3 ...
4
5 Introduction
6 ============
7
8 This module generates directory listings when invoked by
9 `mod_http_files`. See [documentation on
10 `mod_http_files`](http://prosody.im/doc/modules/mod_http_files).
11
12 It uses the [`util.interpolation`][doc:developers:util:interpolation]
13 template engine included with Prosody since 0.10.
14
15 Configuration
16 =============
17
18 The module itself doesn't have any configuration of its own, just enable
19 the it along with `mod_http_files`.
20
21 modules_enabled = {
22 ...
23
24 "http_files";
25 "http_dir_listing";
26 }
27
28 http_dir_listing = true;
29
30 The layout, CSS and icons in the `resources/` directory can be
31 customized or replaced. All resources are cached in memory when the
32 module is loaded and the images are inlined in the CSS.
33
34 Compatibility
35 =============
36
37 ------- --------------
38 trunk Works
39 0.10 Works
40 0.9 Doesn't work
41 ------- --------------