view mod_http_favicon/README.markdown @ 2597:805fa6ca062b

luacheckrc: List all module API methods (reqires luacheck 1.19)
author Kim Alvefur <zash@zash.se>
date Mon, 06 Mar 2017 00:43:06 +0100
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
  ------- --------------