= Add static pages to your Trac pages

== Description

This plugin allows you to serve one more more directories of static web documents through Trac.
The motivation for writing this was to be able to control access to static files, eg project documentation, using Trac's authentication and authorisation system.

== Source, Bugs

The source in on [https://github.com/dairiki/staticdocs-plugin github].
You can also [https://github.com/dairiki/staticdocs-plugin/issues file tickets] there if you find any bugs.

The code is released under the [http://www.opensource.org/licenses/bsd-license.php BSD license].

== Downloads

The package can be installed from [pypi:staticdocs-plugin PyPI] using, eg
[http://www.pip-installer.org/en/latest/index.html pip]:

{{{#!sh
pip install staticdocs-plugin
}}}

== Configuration

In your `trac.ini` file put a section like:

{{{#!ini
[staticdocs]

# (Optional) Set the required permission for viewing static docs
# The default is WIKI_VIEW
permission = WIKI_VIEW

# Set up some aliases: you need at least one alias for this plugin to be worthwhile
alias./docs/ = /path/to/docs/
alias./docs/other/ = /path/to/other/docs/

# (Optional) Override the required permission for a specific alias
permission./docs/other/ = TICKET_VIEW
}}}

Also, enable the plugin by adding the following to your `trac.ini` file:

{{{#!ini
[components]
staticdocsplugin.* = enabled
}}}

Now if you visit, e.g., `http://example.com/yourtrac/docs/file.html`, you will get served the file `/path/to/docs/file.html`.

== Author

[mailto:dairiki@dairiki.org Jeff Dairiki]