view mod_http_dir_listing/README.markdown @ 5705:9bbf5b0673a2

mod_audit: Fix use of util.ip Yes, weirdly named 'new' function
author Kim Alvefur <zash@zash.se>
date Mon, 13 Nov 2023 11:36:56 +0100
parents a0a4413e55b8
children
line wrap: on
line source

---
rockspec:
  build:
    copy_directories:
    - http_dir_listing/resources
    modules:
      mod_http_dir_listing: http_dir_listing/mod_http_dir_listing.lua
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
=============

  version   status
  --------- --------
  trunk     Works
  0.12      Works
  0.11      Works