[[PageOutline(2-5, Contents, pullout)]] = !DownloadPlugin Adds a downloads section to the Trac system. == Description 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. == Bugs/Feature Requests Existing bugs and feature requests for !DownloadsPlugin are [report:9?COMPONENT=DownloadsPlugin here]. If you have any issues, create a [http://trac-hacks.org/newticket?component=DownloadsPlugin new ticket] but read BugReporting page first, please. == Download Download the zipped source from [download:downloadsplugin here]. == Source You can [http://trac-hacks.org/svn/downloadsplugin check out] !DownloadsPlugin using Subversion, or [source:downloadsplugin browse the source] with Trac. == Dependencies !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. == Installation After installing plugin's egg you can set up few configuration variables in {{{trac.ini}}}. Their default values are displayed bellow: {{{#!ini [downloads] title = Downloads path = /var/lib/trac/downloads ext = zip gz bz2 rar # For 0.10 and 0.11 branch. ext = zip,gz,bz2,rar # For 0.12 branch. additional_tags = author,component,version,architecture,platform,type # 0.12 branch only. visible_fields = id file description size time count author tags component version \ architecture platform type # For 0.10 and 0.11 branch. visible_fields = id,file,description,size,time,count,author,tags,component,version, \ architecture,platform,type # For 0.12 branch. unique_filename = False consoleadmin_user = anonymous # Branch 0.12 only. }}} Variable {{{title}}} sets text of main navigation bar button. {{{path}}} is location where uploaded downloads are stored. It has to be accessible for writing to web server. Setting {{{ext}}} variable restricts allowed extensions of uploaded files. If {{{unique_filename}}} is enabled, plugin checks if file name of download file is not already occupied by any other download file. {{{visible_fields}}} variable controls appearance of downloads table columns in Downloads section. Finally, {{{consoleadmin_user}}} option serves for permission checks when listing, adding or removing downlads using {{{trac-admin}}}. This option is available only in 0.12 branch. Another option available only in 0.12 branch is {{{additional_tags}}} that configures from which fields should be also generated download tags. '''Note:''' Don't miss that {{{ext}}} and {{{visible_fields}}} options has changed to comma separated lists in 0.12 branch of the plugin. If you run Trac in environment which needs to enable plugins explicitly put in {{{trac.ini}}} these lines: {{{#!ini [components] tracdownloads.api.DownloadsApi = enabled tracdownloads.core.DownloadsCore = enabled tracdownloads.init.DownloadsInit = enabled tracdownloads.timeline.DownloadsTimeline = enabled tracdownloads.wiki.DownloadsWiki = enabled tracdownloads.admin.DownloadsWebAdmin = enabled # Branch 0.10 and 0.11. tracdownloads.webadmin.DownloadsWebAdmin = enabled # Branch 0.12 only. tracdownloads.consoleadmin.DownloadsConsoleAdmin = enabled # Branch 0.12 only. tracdownloads.core.DownloadsDownloads = enabled # Branch 0.12 only. tracdownloads.tags.DownloadsTags = enabled # With TagsPlugin installed. }}} In 0.12 branch, the {{{DownloadsCore}}} component was splited into the {{{DownloadsDownloads}}} component, which handles Downloads section of Trac, and the {{{DownloadsCore}}} component that serves file download requests and other core features. This means that you can disable the {{{DownloadsDownloads}}} component to hide Downloads section from users. {{{admin}}} module was renamed to {{{consoleadmin}}}. The next step is to upgrade your environment: {{{#!sh # trac-admin upgrade }}} '''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): {{{#!ini [trac] use_xsendfile = True }}} == Permissions !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. You can grant them using these commands: {{{#!sh # trac-admin permission add DOWNLOADS_VIEW # trac-admin permission add DOWNLOADS_ADD # Branch 0.12 only. # trac-admin permission add DOWNLOADS_ADMIN }}} == Macros There are few wiki macros available: {{{ [download: ] or [download: ] }}} Displays link to download identified by ID {{{}}} or filename {{{}}} with text {{{}}}. {{{ [[DownloadsCount(1)]] [[DownloadsCount(1, 2, 3)]] [[DownloadsCount(foo.zip)]] [[DownloadsCount(1, foo.zip, bar.rar, 3)]] [[DownloadsCount()]] [[DownloadsCount(0)]] }}} Displays sum of number of downloads for downloads identified by comma separated list of IDs or filenames. If there is empty list or any zero (last two examples), sum of all number of downloads for all downloads is returned. Non-existing downloads silently counts as zero. Works with branch 0.12 only. {{{ [[ListDownloads()]] }}} Displays same table that is displayed in Downloads section of the Trac on a wiki page. Works with branch 0.12 only. == Inteface to `trac-admin` There is ability to list, insert or delete downloads from server's console/script with following commands: {{{#!sh # trac-admin download list # trac-admin download add description= \ author= tags=" ..." component= version= \ architecture= platform= type= # trac-admin download remove # trac-admin download remove }}} 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. == Recent Changes [[ChangeLog(downloadsplugin, 3)]] == Author/Contributors == '''Author:''' [wiki:Blackhex] [[BR]] '''Maintainer:''' [[Maintainer]] [[BR]] '''Contributors:'''