summaryrefslogtreecommitdiff
path: root/vendor/CherryPy-3.2.0/sphinx/source/progguide/files/favicon.rst
blob: b5ffa986f6cb8e174508334f538d166ea337c622 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
*************************
Serving the favorite icon
*************************

By default, CherryPy 3 adds a "favicon_ico" handler method to any root object
which is mounted at "/". This is a staticfile handler, which grabs the
favicon.ico shipped in the CherryPy distribution.

To configure CherryPy to look in another file location, you can, in your server
configuration, do the following::

    [/favicon.ico]
    tools.staticfile.on = True
    tools.staticfile.filename = "/path/to/favicon.ico"

If you want a favicon, but don't want CherryPy to serve it, you can point to an
HTTP URL via a link element in the HTML head. See http://www.w3.org/2005/10/howto-favicon
and http://en.wikipedia.org/wiki/Favicon for instructions.