File

mod_http_dir_listing/README.markdown @ 5931:d194d1012fd3

Updating dox for mod_rest. Ideas expressed / clarified: 1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component. 2) Understanding some of the implications of this choice: A) Changes to user authentication B) How it affects subdomains 3) More consistent use of domain names for clarity. 4) Using different heading sizes to show scope of section. Essentially, I added all the tidbits I had to clarify in getting this to work in my own example.
author Ben Smith <bens@effortlessis.com>
date Mon, 13 May 2024 13:25:13 -0700
parent 5523:a0a4413e55b8
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