Changes between Version 8 and Version 9 of TracSecDlPlugin


Ignore:
Timestamp:
Mar 22, 2015, 1:09:06 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with license

Legend:

Unmodified
Added
Removed
Modified

  • TracSecDlPlugin

    v8 v9  
    1 = Download plugin with advanced features =
     1[[PageOutline(2-5,Contents,pullout)]]
    22
    3 [[PageOutline(2)]]
     3= Download plugin with advanced features
    44
    55----
    66{{{
    77#!html
    8 <div class="system-message"><b>This plugin is actually hosted at <a href="https://bitbucket.org/goeb/tracsecdl">Bitbucket</a>, please visit this page for up to date information.</b></div>
     8<div class="system-message"><b>This plugin is hosted at <a href="https://bitbucket.org/goeb/tracsecdl">Bitbucket</a>, please visit this page for up to date information.</b></div>
    99}}}
    1010
    11 ''The text below is basically a copy of the actual homepage, note however that I can only post five external links here, so you should visit the URL mentioned above for working links to the project's bug tracker etc.''
     11''The text below is a copy of the actual homepage, note however that I can only post five external links here, so you should visit the URL mentioned above for working links to the project's bug tracker etc.''
    1212----
    1313
    14 == Description ==
     14== Description
    1515
    16 This plugin adds a download section to Trac. It was inspired by (and offers nearly all the features of) the [wiki:DownloadsPlugin DownloadsPlugin] (!TracSecDl currently lacks integration with the [wiki:TagsPlugin TagsPlugin] and [wiki:TracAdmin TracAdmin], and there is only a version for ''0.11'' available).
     16This plugin adds a download section to Trac. It was inspired by and offers nearly all the features of the [wiki:DownloadsPlugin DownloadsPlugin]. !TracSecDl currently lacks integration with the [wiki:TagsPlugin TagsPlugin] and [wiki:TracAdmin TracAdmin], and there is only a version for ''0.11'' available.
    1717
    18 The main features are:
     18Key features:
    1919
    2020 * multiple ways to send a requested file to the client:
    … …  
    2929 * [wiki:TracWiki Wiki] and [wiki:TracTimeline Timeline] integration
    3030
    31 == Bugs And Feature Requests ==
     31== Bugs And Feature Requests
    3232
    3333Existing bugs and feature requests for !TracSecDl can be found at [https://bitbucket.org/goeb/tracsecdl/issues its bug tracker]. If you have any issues, please create a new ticket.
    3434
    35 == Download And Source Code ==
     35== Download And Source Code
    3636
    3737Visit the plugin's homepage and check the download section for available files. You can also clone the repository with {{{git}}}:
    … …  
    4040}}}
    4141
    42 == Dependencies ==
     42== Dependencies
    4343
    4444Trac 0.11 is required, other versions are currently not supported.
    4545
    46 == Installation ==
     46== Installation
    4747
    48 Basically, download the source, extract it somewhere, change to the extracted directory ''!TracSecDl/0.11/'' (that one containing the ''setup.py'' file) and run
     48Basically, download the source, extract it somewhere, change to the extracted directory ''!TracSecDl/0.11/'' (that one containing the ''setup.py'' file) and run the following:
    4949{{{
     50#!python
    5051python setup.py bdist_egg
    5152}}}
    52 This will create an ''.egg'' file somewhere (probably in the ''dist/'' folder). Place this file in a plugin directory where it can be found by Trac (eg. the [wiki:TracEnvironment environment's] ''plugins/'' directory). Enable the plugin by putting the following in your ''[wiki:TracIni trac.ini]'' (please do not disable individual parts of the plugin, this is not well tested):
     53
     54This will create an ''.egg'' file somewhere (probably in the ''dist/'' folder). Place this file in a plugin directory where it can be found by Trac (eg. the [wiki:TracEnvironment environment's] ''plugins/'' directory).
     55
     56Enable the plugin by putting the following in your ''[wiki:TracIni trac.ini]'':
    5357{{{
    5458#!ini
    … …  
    5761}}}
    5862
     63Please do not disable individual parts of the plugin, this is not well tested.
     64
    5965Check the [wiki:TracPlugins TracPlugins installation guide], especially if you have trouble installing the plugin.
    6066
    61 == Download Processing ==
     67== Download Processing
    6268
    6369When a user requests a download, the plugin will first check if the user's [#Permissions permissions] are sufficient to access the download. If the requested download is a remote one (ie. no file uploaded to the server but a remote URL specified instead) the plugin will simply send a 302 redirect to the remote URL. If it is a local download, the following three configuration options are checked (in that order):
    … …  
    8692The recommended setup is Lighttpd with mod_secdownload (hence the plugin's name), if you do not need to protect your downloads (if they are all public anyway) you can also use the regular download option. It is not recommended to use the {{{trac_downloads}}} option for FastCGI setups, since the number of FastCGI processes is usually limited and this will block one process for the time of the download.
    8793
    88 == Configuration ==
     94== Configuration
    8995
    9096The plugin uses the following configuration options, the section in ''trac.ini'' is called {{{[secdl]}}}:
    … …  
    141147    Comma separated list of prefixes used in the wiki to link to the downloads. The default value is {{{'download,secdownload'}}}.
    142148
    143 === Additional Options ===
     149=== Additional Options
    144150
    145151To change the order of the main navigation bar items use the {{{'secdl'}}} keyword, for example:
    … …  
    150156}}}
    151157
    152 == Permissions ==
     158== Permissions
    153159
    154160The plugin defines three permissions:
    … …  
    158164 * {{{SECDL_ADMIN}}}: access the [#Screenshots admin interface] to manage downloads (includes the other permissions)
    159165
    160 == Macros ==
     166== Macros
    161167
    162168On wiki pages, the following macros can be used:
    … …  
    169175The examples above assume that {{{'download'}}} is included in the {{{wiki_prefix}}} [#Configuration configuration] option.
    170176
    171 == Screenshots ==
     177== Screenshots
    172178
    173179The admin interface:
    … …  
    177183To take a look at the regular user interface go to the download section on !TracSecDl's homepage.
    178184
    179 == Author ==
     185== Author
    180186
    181187'''Author:''' Stefan Göbel
    182188
    183 == License ==
     189== License
    184190
    185191Copyright © 2010 Stefan Göbel