Changes between Version 23 and Version 24 of DownloadsPlugin
- Timestamp:
- Nov 15, 2014, 9:03:45 AM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
DownloadsPlugin
v23 v24 1 1 [[PageOutline(2-5, Contents, pullout)]] 2 2 3 = !DownloadPlugin =3 = !DownloadPlugin 4 4 5 5 Adds a downloads section to the Trac system. 6 6 7 == Description ==7 == Description 8 8 9 9 This plugin provides downloads section which may contain releases or other files. It is administrated via WebAdminPlugin and there is an interface to the {{{trac-admin}}} tool that may help during automatic server maintenance. The Downloads section of Trac displays a table with information about the uploaded files such as description, component, version, size, architecture, type and optionally assigned tags which the download is related to. It also collects information about number of downloads which can be displayed on wiki page together with direct links to the specified download. 10 10 11 == Bugs/Feature Requests ==11 == Bugs/Feature Requests 12 12 13 13 Existing bugs and feature requests for !DownloadsPlugin are … … 15 15 16 16 If you have any issues, create a 17 [http://trac-hacks.org/newticket?component=DownloadsPlugin &owner=rjollosnew ticket] but read BugReporting page first, please.17 [http://trac-hacks.org/newticket?component=DownloadsPlugin new ticket] but read BugReporting page first, please. 18 18 19 == Download ==19 == Download 20 20 21 21 Download the zipped source from [download:downloadsplugin here]. 22 22 23 == Source ==23 == Source 24 24 25 25 You can [http://trac-hacks.org/svn/downloadsplugin check out] !DownloadsPlugin using Subversion, or [source:downloadsplugin browse the source] with Trac. 26 26 27 == Dependencies ==27 == Dependencies 28 28 29 29 !DownloadsPlugin for Trac 0.10 depends on WebAdminPlugin since many configuration options are avaiable only on apropriate WebAdminPlugin's pages. On Trac 0.11 this is supported by Trac itself. Optionally !DownloadsPlugin uses TagsPlugin for tags support. 30 30 31 == Installation ==31 == Installation 32 32 33 33 After installing plugin's egg you can set up few configuration variables in {{{trac.ini}}}. Their default values are displayed bellow: 34 34 35 {{{ 36 #!ini 35 {{{#!ini 37 36 [downloads] 38 37 … … 56 55 If you run Trac in environment which needs to enable plugins explicitly put in {{{trac.ini}}} these lines: 57 56 58 {{{ 59 #!ini 57 {{{#!ini 60 58 [components] 61 59 tracdownloads.api.DownloadsApi = enabled … … 75 73 The next step is to upgrade your environment: 76 74 77 {{{ 78 #!sh 75 {{{#!sh 79 76 # trac-admin <path_to_environment> upgrade 80 77 }}} 81 78 82 79 '''Note:''' Some environments might not handle download of large files gracefully. Notably the fcgi wrapper may timeout. A possible work around, that also adds HTTP "Range:" header support is telling Trac to use "X-Sendfile" (which may require configuration of your HTTP server as well): 83 {{{ 84 #!ini 80 {{{#!ini 85 81 [trac] 86 82 use_xsendfile = True 87 83 }}} 88 84 89 == Permissions ==85 == Permissions 90 86 91 87 !DownloadsPlugin defines three permissions: {{{DOWNLOADS_VIEW}}} for normal users and {{{DOWNLOADS_ADD}}} and {{{DOWNLOADS_ADMIN}}} for people who uploads and administrates downloads. {{{DOWNLOADS_ADD}}} permission is implemented since 0.12 branch and allows user to upload downloads without access to WebAdmin interface. … … 93 89 You can grant them using these commands: 94 90 95 {{{ 96 #!sh 91 {{{#!sh 97 92 # trac-admin <path_to_environment> permission add <user> DOWNLOADS_VIEW 98 93 # trac-admin <path_to_environment> permission add <user> DOWNLOADS_ADD # Branch 0.12 only. … … 100 95 }}} 101 96 102 == Macros ==97 == Macros 103 98 104 99 There are few wiki macros available: … … 128 123 Displays same table that is displayed in Downloads section of the Trac on a wiki page. Works with branch 0.12 only. 129 124 130 == Inteface to {{{trac-admin}}} ==125 == Inteface to `trac-admin` 131 126 132 127 There is ability to list, insert or delete downloads from server's console/script with following commands: 133 128 134 {{{ 135 #!sh 129 {{{#!sh 136 130 # trac-admin <path_to_environment> download list 137 131 # trac-admin <path_to_environment> download add <path_to_file> description=<description> \ … … 144 138 All download attributes of {{{download add}}} command are optional only the file must be specified. {{{console_admin}}} {{{trac.ini}}} option must be setted to any user who has permission to do apropriate action. 145 139 146 == Recent Changes ==140 == Recent Changes 147 141 148 142 [[ChangeLog(downloadsplugin, 3)]] … … 151 145 152 146 '''Author:''' [wiki:Blackhex] [[BR]] 153 '''Maintainer:''' [ wiki:rjollos] [[BR]]147 '''Maintainer:''' [[Maintainer]] [[BR]] 154 148 '''Contributors:'''