mod_http_dir_listing/README.markdown
author Kim Alvefur <zash@zash.se>
Mon, 17 Apr 2023 08:26:20 +0200
changeset 5355 c35f3c1762b5
parent 5149 885d696473d2
child 5527 a0a4413e55b8
permissions -rw-r--r--
mod_audit: Move underscore to avoid luacheck warning Underscore as prefix is taken as a signal that the variable is unused, but then it is used and luacheck makes noise about that.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
     1
---
5148
606f6c6535bb mod_http_dir_listing: Add metadata to fix plugin package build
Kim Alvefur <zash@zash.se>
parents: 1824
diff changeset
     2
rockspec:
606f6c6535bb mod_http_dir_listing: Add metadata to fix plugin package build
Kim Alvefur <zash@zash.se>
parents: 1824
diff changeset
     3
  build:
606f6c6535bb mod_http_dir_listing: Add metadata to fix plugin package build
Kim Alvefur <zash@zash.se>
parents: 1824
diff changeset
     4
    copy_directories:
606f6c6535bb mod_http_dir_listing: Add metadata to fix plugin package build
Kim Alvefur <zash@zash.se>
parents: 1824
diff changeset
     5
    - mod_http_dir_listing/http_dir_listing/resources
606f6c6535bb mod_http_dir_listing: Add metadata to fix plugin package build
Kim Alvefur <zash@zash.se>
parents: 1824
diff changeset
     6
    modules:
606f6c6535bb mod_http_dir_listing: Add metadata to fix plugin package build
Kim Alvefur <zash@zash.se>
parents: 1824
diff changeset
     7
      mod_http_dir_listing: mod_http_dir_listing/http_dir_listing/mod_http_dir_listing.lua
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
     8
summary: HTTP directory listing
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
     9
...
1786
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    10
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    11
Introduction
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    12
============
1786
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    13
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    14
This module generates directory listings when invoked by
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    15
`mod_http_files`. See [documentation on
1824
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1807
diff changeset
    16
`mod_http_files`](http://prosody.im/doc/modules/mod_http_files).
1786
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    17
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    18
Configuration
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    19
=============
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    20
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    21
The module itself doesn't have any configuration of its own, just enable
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    22
the it along with `mod_http_files`.
1786
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    23
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    24
    modules_enabled = {
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    25
        ...
1786
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    26
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    27
        "http_files";
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    28
        "http_dir_listing";
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    29
    }
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    30
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    31
    http_dir_listing = true;
1786
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    32
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    33
The layout, CSS and icons in the `resources/` directory can be
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    34
customized or replaced. All resources are cached in memory when the
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    35
module is loaded and the images are inlined in the CSS.
1786
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    36
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    37
Compatibility
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    38
=============
1786
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    39
5149
885d696473d2 mod_http_dir_listing: Update Compatibility section
Kim Alvefur <zash@zash.se>
parents: 5148
diff changeset
    40
  version   status
885d696473d2 mod_http_dir_listing: Update Compatibility section
Kim Alvefur <zash@zash.se>
parents: 5148
diff changeset
    41
  --------- --------
885d696473d2 mod_http_dir_listing: Update Compatibility section
Kim Alvefur <zash@zash.se>
parents: 5148
diff changeset
    42
  trunk     Works
885d696473d2 mod_http_dir_listing: Update Compatibility section
Kim Alvefur <zash@zash.se>
parents: 5148
diff changeset
    43
  0.12      Works
885d696473d2 mod_http_dir_listing: Update Compatibility section
Kim Alvefur <zash@zash.se>
parents: 5148
diff changeset
    44
  0.11      Works