Diff

mod_http_dir_listing/README.markdown @ 1803:4d73a1a6ba68

Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parent 1782:29f3d6b7ad16
child 1820:8de50be756e5
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_http_dir_listing/README.markdown	Fri Aug 28 18:03:58 2015 +0200
@@ -0,0 +1,39 @@
+---
+labels:
+summary: HTTP directory listing
+...
+
+Introduction
+============
+
+This module generates directory listings when invoked by
+`mod_http_files`. See [documentation on
+`mod\_http\_files`](http://prosody.im/doc/modules/mod_http_files).
+
+Configuration
+=============
+
+The module itself doesn't have any configuration of its own, just enable
+the it along with `mod_http_files`.
+
+    modules_enabled = {
+        ...
+
+        "http_files";
+        "http_dir_listing";
+    }
+
+    http_dir_listing = true;
+
+The layout, CSS and icons in the `resources/` directory can be
+customized or replaced. All resources are cached in memory when the
+module is loaded and the images are inlined in the CSS.
+
+Compatibility
+=============
+
+  ------- --------------
+  trunk   Works
+  0.9     Works
+  0.8     Doesn't work
+  ------- --------------