Staticdocs Plugin for Trac
The staticdocs-plugin allows one to serve a directory 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.
This has been tested under trac 0.12. It may well work in earlier versions. It probably requires python >= 2.6.
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
Notes, Possible Buglets
Hidden and backup files
Any requests for URLs which have a path component starting with
or ending with
~ will result in a
404 Not Found response.
(Any request with a path component of
.. will result in a
Bad Request response.)
Currently, mimetype.guess_type is used to deduce the content type.
If the URL ends in a slash,
index.html is added. This should
probably be fixed so as to look for
index.htm as well.
The standard ExtraPermissionsProvider plugin can be used to add
a new custom permission (say
STATIC_DOCS_VIEW) if you would like
one to control access to your static files.
If you find any, file a ticket.