wiki:StaticDocsPlugin

Version 2 (modified by dairiki, 2 years ago) (diff)

uploaded to PyPI

StaticDocs Plugin

Description

The staticdocs-plugin allows one 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 (e.g. project documentation) using trac’s authentication and authorization system.

Configuration

Somewhere in your trac configs put a section like:

[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, you will want to enable the plugin. Probably like this:

[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.

Downloads

The package can be installed from PyPI using, e.g., pip:

pip install staticdocs-plugin

Source, Downloads Bugs

The source in on github. You can also file tickets there if you find any bugs.

The code is released under the BSD license.

Author

Jeff Dairiki