Skip to main content

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.

Requirements

This has been tested under trac 0.12. It may well work in earlier versions. It probably requires python >= 2.6.

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.

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 400 Bad Request response.)

Content Types

Currently, mimetype.guess_type is used to deduced the content type.

Directory Indexes

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.

Other Hints

The NavAddPlugin (from trac-hacks) will let you add links to your static docs (or anywhere else) to the trac navigation bar.

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.

Author

Jeff Dairiki.

Changes

Release 0.1 (2012-02-14)

Happy Valentine’s Day!

Metadata

Release files for staticdocs-plugin 0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for staticdocs-plugin 0.1
File Size Uploaded
staticdocs-plugin-0.1.tar.gz 7.3 kB Details

Release files / staticdocs-plugin-0.1.tar.gz

Download URL staticdocs-plugin-0.1.tar.gz
Size 7.3 kB
Tags Source
SHA-256 checksum
How to use checksums
e1a0d31b31a99c7dee5d7ee5af283a2edf4cd6ef9ef5872327b33f779bcd5e73
BLAKE2b-256 checksum
How to use checksums
8de9004b4410087fe88e27e1f757f2d63da981ceb6c4843d0f01e319c2cda238
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page