wiki:DownloadsPlugin

Version 6 (modified by Blackhex, 9 years ago) (diff)

Tags and content updated.

Downloads Plugin

Description

This plugin provides downloads section which may contain release or other files. It is administrable via WebAdminPlugin and shows information about uploaded files such as description, component, version, size, architecture and type which is download related to. It collects information about number of downloads too.

Bugs/Feature Requests

Existing bugs and feature requests for DownloadsPlugin are here.

If you have any issues, create a new ticket but read BugReporting page first, please.

Download

Download the zipped source from [download:downloadsplugin here].

Source

You can check out DownloadsPlugin from here using Subversion, or 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:

[downloads]

title = Downloads
path = /var/lib/trac/downloads
ext = zip gz bz2 rar
visible_fields = id file description size time count author tags component version \
  architecture platform type # Currently not implemented.
unique_filename = False

Variable title sets text of main navigation bar button. path is location where uploaded downloads are stored. It has to be accesible 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. Finally, visibled_field variable controls appearance of downloads table columns in Downloads section.

If you run Trac in environment which needs to enable plugins explicitly put in trac.ini these lines:

[components]
tracdownloads.api.DownloadsApi = enabled
tracdownloads.admin.DownloadsWebAdmin = enabled
tracdownloads.core.DownloadsCore = enabled
tracdownloads.init.DownloadsInit = enabled
tracdownloads.timeline.DownloadsTimeline = enabled
tracdownloads.wiki.DownloadsWiki = enabled

The next step is to upgrade your environment:

# trac-admin <path_to_environment> upgrade

Permissions

DownloadsPlugin defines two permissions: DOWNLOADS_VIEW for normal users and DOWNLOADS_ADMIN for people who uploads and administrates downloads.

You can grant them using these commands:

# trac-admin <path_to_environment> permission add <user> DOWNLOADS_VIEW
# trac-admin <path_to_environment> permission add <user> DOWNLOADS_ADMIN

Macros

There is only macro with two possible evocations for downloads referencing on wiki pages:

[download:<download_id> <text>] or
[download:<download_filename> <text>]

Recent Changes

16023 by rjollos on 2016-11-28 11:19:46
1.0.0dev: Conform to PEP8 and fix minor defects
16022 by rjollos on 2016-11-28 09:28:22
1.0.0dev: Remove duplicate path option

Refs #7031, #9609.

16021 by rjollos on 2016-11-28 09:26:04
1.0.0dev: Remove title option

The title can be renamed using the label attribute of
[mainnav], as described in TracNavigation.

(more)

Author/Contributors

Author: Blackhex
Contributors: