view mod_http_dir_listing2/README.markdown @ 5551:8bfcedd93a72

mod_rest: List all error conditions in OpenAPI spec These are not handled by datamanager but by util.stanza and util.error, so they are not represented in the JSON schema file.
author Kim Alvefur <zash@zash.se>
date Sat, 17 Jun 2023 16:26:33 +0200
parents 87268f4e6a2e
children
line wrap: on
line source

---
summary: HTTP directory listing
rockspec:
  build:
    copy_directories:
      - resources
---

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