Changes between Version 12 and Version 13 of TracSecDlPlugin


Ignore:
Timestamp:
Apr 20, 2017, 6:47:49 PM (7 years ago)
Author:
figaro
Comment:

Further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • TracSecDlPlugin

    v12 v13  
    99== Description
    1010
    11 This plugin adds a download section to Trac. It was inspired by and offers nearly all the features of the [wiki:DownloadsPlugin]. !TracSecDl currently lacks integration with the [wiki:TagsPlugin TagsPlugin] and [wiki:TracAdmin TracAdmin], and there is only a version for ''0.11'' available.
     11This plugin adds a download section to Trac. It was inspired by and offers nearly all the features of the [wiki:DownloadsPlugin]. !TracSecDl currently lacks integration with the [wiki:TagsPlugin TagsPlugin] and [wiki:TracAdmin TracAdmin], and there is only a version available for Trac version 0.11.
    1212
    1313Key features:
     
    2121 * hidden downloads, only visible to users with the appropriate [#Permissions permission]
    2222 * automatic calculation of MD5 and SHA512 checksums for uploaded files
    23  * configurable limits for file size, total file size, total number of files... (see [#Configuration below] for more options)
     23 * configurable limits siuch as for file size, total file size, total number of files, see [#Configuration below] for more options
    2424 * [wiki:TracWiki Wiki] and [wiki:TracTimeline Timeline] integration
     25
     26The admin interface looks as follows:
     27
     28[[Image(admin.png)]]
     29
     30To take a look at the regular user interface go to the download section on !TracSecDl's homepage.
    2531
    2632== Bugs And Feature Requests
     
    3945Trac 0.11 is required, other versions are currently not supported.
    4046
    41 Basically, 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:
     47Basically, download the source, extract it somewhere, change to the extracted directory `TracSecDl/0.11/`, the one containing the `setup.py` file, and run the following:
    4248{{{#!python
    4349python setup.py bdist_egg
    4450}}}
    4551
    46 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).
     52This 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, for example the [wiki:TracEnvironment environment's] `plugins/` directory.
    4753
    48 Enable the plugin by putting the following in your ''[wiki:TracIni trac.ini]'':
     54Enable the plugin by putting the following in your [wiki:TracIni trac.ini] file:
    4955{{{#!ini
    5056[components]
     
    6369    If this is set the plugin will generate a URL suited for Lighttpd's mod_secdownload and redirect the browser to the generated URL.
    6470 {{{regular_downloads}}}::
    65     If this is enabled, the plugin will generate a regular URL (ie. without a mod_secdownload specific part) and redirect the browser to it.
     71    If this is enabled, the plugin will generate a regular URL, ie without a mod_secdownload specific part, and redirect the browser to it.
    6672 {{{trac_downloads}}}::
    6773    If this is enabled, the plugin (or rather Trac) will send the file to the client by itself.
    68  ''else''::
     74 else::
    6975    If none of the above was set, an error page will be displayed.
    7076
     
    7278
    7379 * {{{<prefix>}}} will be the value of the {{{lighty_prefix}}} configuration option
    74  * {{{<checksum>}}} and {{{<timestamp>}}} are calculated automatically and will protect the download (see the mod_secdownload documentation] for details)
     80 * {{{<checksum>}}} and {{{<timestamp>}}} are calculated automatically and will protect the download, see the mod_secdownload documentation for details
    7581 * {{{<file path>}}} will be set by the plugin, it is determined by the path of the environment, the uploaded file's name and its download ID
    7682
    77 In the second case ({{{regular_downloads}}}) the URL will be {{{<prefix>/<file path>}}}, both parts are exactly the same as described above (and, though it is server-independent, the {{{lighty_secret}}} option sets the {{{<prefix>}}}).
     83In the second case ({{{regular_downloads}}}) the URL will be {{{<prefix>/<file path>}}}, both parts are exactly the same as described above, and, though it is server-independent, the {{{lighty_secret}}} option sets the {{{<prefix>}}}.
    7884
    7985In both cases you have to make sure that requests to the {{{<prefix>}}} path are handled by the server itself and not by Trac, it depends on the server how to do that, see the appropriate documentation. Also, make sure that the directory specified by the {{{upload_dir}}} option is mapped accordingly to the {{{<prefix>}}} location.
     
    8591== Configuration
    8692
    87 The plugin uses the following configuration options, the section in ''trac.ini'' is called {{{[secdl]}}}:
     93The plugin uses the following configuration options, the section in `trac.ini` is called {{{[secdl]}}}:
    8894
    8995 {{{duplicate}}}::
     
    141147
    142148To change the order of the main navigation bar items use the {{{'secdl'}}} keyword, for example:
    143 {{{
    144 #!ini
     149{{{#!ini
    145150[trac]
    146151mainnav = wiki,secdl,timeline,roadmap,browser,tickets,newticket,search
     
    166171The examples above assume that {{{'download'}}} is included in the {{{wiki_prefix}}} [#Configuration configuration] option.
    167172
    168 == Screenshots
    169 
    170 The admin interface:
    171 
    172 [[Image(admin.png)]]
    173 
    174 To take a look at the regular user interface go to the download section on !TracSecDl's homepage.
    175 
    176173== Author
    177174