{ "info": { "author": "Jeff Dairiki", "author_email": "dairiki@dairiki.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Plugins", "Environment :: Web Environment", "Framework :: Trac", "Intended Audience :: System Administrators", "License :: OSI Approved :: BSD License", "Programming Language :: Python :: 2", "Topic :: Internet :: WWW/HTTP" ], "description": "==========================\nStaticdocs Plugin for Trac\n==========================\n\nThe staticdocs-plugin_ allows one to serve a directory of static web documents\nthrough `trac`_. The motivation for writing this was to be able\nto control access to static files (e.g. project documentation)\nusing trac\u2019s authentication and authorization system.\n\n.. _staticdocs-plugin: http://github.com/dairiki/staticdocs-plugin\n.. _trac: http://trac.edgewall.org/\n\nRequirements\n============\n\nThis has been tested under trac 0.12. It may well work in earlier versions.\nIt probably requires python >= 2.6.\n\nConfiguration\n=============\n\nSomewhere in your trac configs put a section like::\n\n [staticdocs]\n\n # (Optional) Set the required permission for viewing static docs\n # The default is WIKI_VIEW\n permission = WIKI_VIEW\n\n # Set up some aliases (you need at least one alias for this plugin\n # to be worthwhile.)\n alias./docs/ = /path/to/docs/\n alias./docs/other/ = /path/to/other/docs/\n\n # (Optional) Override the required permission for a specific alias\n permission./docs/other/ = TICKET_VIEW\n\nAlso, you will want to enable the plugin. Probably like this::\n\n [components]\n\n staticdocsplugin.* = enabled\n\nNow if you visit, e.g.,\n``http://example.com/yourtrac/docs/file.html``, you will get served the\nfile ``/path/to/docs/file.html``.\n\nNotes, Possible Buglets\n========================\n\nHidden and backup files\n^^^^^^^^^^^^^^^^^^^^^^^\n\nAny requests for URLs which have a path component starting with ``.``\nor ending with ``~`` will result in a ``404 Not Found`` response.\n\n(Any request with a path component of ``..`` will result in a ``400\nBad Request`` response.)\n\nContent Types\n^^^^^^^^^^^^^\n\nCurrently, `mimetype.guess_type`_ is used to deduced the content type.\n\n.. _mimetype.guess_type:\n http://docs.python.org/library/mimetypes.html#mimetypes.guess_type\n\nDirectory Indexes\n^^^^^^^^^^^^^^^^^\n\nIf the URL ends in a slash, ``index.html`` is added. This should\nprobably be fixed so as to look for ``index.htm`` as well.\n\n\nOther Hints\n===========\n\nThe NavAddPlugin_ (from trac-hacks_) will let you add links to your\nstatic docs (or anywhere else) to the trac navigation bar.\n\nThe standard ExtraPermissionsProvider_ plugin can be used to add\na new custom permission (say ``STATIC_DOCS_VIEW``) if you would like\none to control access to your static files.\n\n.. _trac-hacks: http://trac-hacks.org/\n.. _NavAddPlugin: http://trac-hacks.org/wiki/NavAddPlugin\n.. _ExtraPermissionsProvider:\n http://trac.edgewall.org/wiki/ExtraPermissionsProvider\n\n\nAuthor\n======\n\n`Jeff Dairiki`__.\n\n__ mailto:dairiki@dairiki.org\n\n\n=======\nChanges\n=======\n\nRelease 0.1 (2012-02-14)\n========================\n\nHappy Valentine\u2019s Day!", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/dairiki/staticdocs-plugin", "keywords": "trac", "license": "BSD", "maintainer": null, "maintainer_email": null, "name": "staticdocs-plugin", "package_url": "https://pypi.org/project/staticdocs-plugin/", "platform": "Any", "project_url": "https://pypi.org/project/staticdocs-plugin/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://github.com/dairiki/staticdocs-plugin" }, "release_url": "https://pypi.org/project/staticdocs-plugin/0.1/", "requires_dist": null, "requires_python": null, "summary": "A Trac plugin to allow access to static documents", "version": "0.1" }, "last_serial": 653433, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "f826a6fe950ae130da505b186cdadb66", "sha256": "e1a0d31b31a99c7dee5d7ee5af283a2edf4cd6ef9ef5872327b33f779bcd5e73" }, "downloads": -1, "filename": "staticdocs-plugin-0.1.tar.gz", "has_sig": false, "md5_digest": "f826a6fe950ae130da505b186cdadb66", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7256, "upload_time": "2012-02-15T06:29:56", "url": "https://files.pythonhosted.org/packages/8d/e9/004b4410087fe88e27e1f757f2d63da981ceb6c4843d0f01e319c2cda238/staticdocs-plugin-0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "f826a6fe950ae130da505b186cdadb66", "sha256": "e1a0d31b31a99c7dee5d7ee5af283a2edf4cd6ef9ef5872327b33f779bcd5e73" }, "downloads": -1, "filename": "staticdocs-plugin-0.1.tar.gz", "has_sig": false, "md5_digest": "f826a6fe950ae130da505b186cdadb66", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7256, "upload_time": "2012-02-15T06:29:56", "url": "https://files.pythonhosted.org/packages/8d/e9/004b4410087fe88e27e1f757f2d63da981ceb6c4843d0f01e319c2cda238/staticdocs-plugin-0.1.tar.gz" } ] }