view mod_http_favicon/README.markdown @ 5907: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
parents 4d73a1a6ba68
children
line wrap: on
line source

---
summary: HTTP favicon
...

Introduction
============

This simple module serves a `favicon.ico` from prosodys HTTP server and
nothing else.

Configuring
===========

Simply load the module. The icon can be replaced by adding a `favicon`
option to the config.

    modules_enabled = {
        ...
        "favicon";
    }

    favicon = "/path/to/my-favicon.ico" -- Override the built in one

Compatibility
=============

  ------- --------------
  trunk   Works
  0.9     Works
  0.8     Doesn't work
  ------- --------------