annotate mod_http_dir_listing2/README.markdown @ 5620:efdaffc878a9

mod_invites_page: Produce URL without config from prosodyctl in trunk Requires Prosody trunk rev 5884d58707fa or later.
author Kim Alvefur <zash@zash.se>
date Wed, 26 Jul 2023 16:23:13 +0200
parents 87268f4e6a2e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
1 ---
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
2 summary: HTTP directory listing
5524
7eab8b0d69e5 mod_http_dir_listing2: Include html resources with plugin installer
Kim Alvefur <zash@zash.se>
parents: 3004
diff changeset
3 rockspec:
7eab8b0d69e5 mod_http_dir_listing2: Include html resources with plugin installer
Kim Alvefur <zash@zash.se>
parents: 3004
diff changeset
4 build:
7eab8b0d69e5 mod_http_dir_listing2: Include html resources with plugin installer
Kim Alvefur <zash@zash.se>
parents: 3004
diff changeset
5 copy_directories:
5525
87268f4e6a2e mod_http_dir_listing2: Fix wrong name for resource directory
Kim Alvefur <zash@zash.se>
parents: 5524
diff changeset
6 - resources
5524
7eab8b0d69e5 mod_http_dir_listing2: Include html resources with plugin installer
Kim Alvefur <zash@zash.se>
parents: 3004
diff changeset
7 ---
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
9 Introduction
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
10 ============
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
12 This module generates directory listings when invoked by
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
13 `mod_http_files`. See [documentation on
1820
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
14 `mod_http_files`](http://prosody.im/doc/modules/mod_http_files).
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15
3004
693d16c18e29 mod_http_dir_listing2: Add README based the one from mod_http_dir_listing
Kim Alvefur <zash@zash.se>
parents: 1820
diff changeset
16 It uses the [`util.interpolation`][doc:developers:util:interpolation]
693d16c18e29 mod_http_dir_listing2: Add README based the one from mod_http_dir_listing
Kim Alvefur <zash@zash.se>
parents: 1820
diff changeset
17 template engine included with Prosody since 0.10.
693d16c18e29 mod_http_dir_listing2: Add README based the one from mod_http_dir_listing
Kim Alvefur <zash@zash.se>
parents: 1820
diff changeset
18
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
19 Configuration
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
20 =============
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
21
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
22 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: 1782
diff changeset
23 the it along with `mod_http_files`.
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
25 modules_enabled = {
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
26 ...
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
28 "http_files";
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
29 "http_dir_listing";
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
30 }
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
31
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
32 http_dir_listing = true;
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
33
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
34 The layout, CSS and icons in the `resources/` directory can be
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
35 customized or replaced. All resources are cached in memory when the
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
36 module is loaded and the images are inlined in the CSS.
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
37
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
38 Compatibility
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
39 =============
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
40
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
41 ------- --------------
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
42 trunk Works
3004
693d16c18e29 mod_http_dir_listing2: Add README based the one from mod_http_dir_listing
Kim Alvefur <zash@zash.se>
parents: 1820
diff changeset
43 0.10 Works
693d16c18e29 mod_http_dir_listing2: Add README based the one from mod_http_dir_listing
Kim Alvefur <zash@zash.se>
parents: 1820
diff changeset
44 0.9 Doesn't work
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
45 ------- --------------