File

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
parent 1820:mod_http_dir_listing/README.markdown@8de50be756e5
child 5524:7eab8b0d69e5
line wrap: on
line source

---
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).

It uses the [`util.interpolation`][doc:developers:util:interpolation]
template engine included with Prosody since 0.10.

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.10    Works
  0.9     Doesn't work
  ------- --------------