Plugin Redproject

This plugin display a roadmap and some other informations of your project in Dokuwiki :

Name and Description of project
Link to homepage define in Redmine
Versions available (with creation and update date, total issues, open and closed)
Members and Roles of the project
Some different links to redmine, like the issues, subproject, mail of members,...
Compatible with Bootstrap (need Bootstrap3 Template).
Handle multiple redmine server

Requirements

Redproject needs Php-Redmine-API to work. Download it inside your shared folder of php, like /usr/share/php or in the redproject's folder. If you use redissue the first option is better, as you have just to install it one time.

$ mkdir vendor
$ cd vendor
$ git clone https://github.com/kbsali/php-redmine-api.git
$ cd php-redmine-api
$ git checkout v1.5.5

Don't forget to install the requirements of PhP-Redmine-API :

$ sudo apt-get install php5-curl php5-common

Install

Download this plugin into your ${dokuwiki_root}/lib/plugins folder and restart dokuwiki.

Configuration

You can configure the plugin in the Config Manager of DokuWiki :

redproject.url : Put your Redmine's url server, without a slash ending. Example : http://myredmine.com. This setting can be override by server option.
redproject.API : Set your Redmine API's key, preference Administrator key. This setting can be override by server option.
redproject.view : Choose the view you want to display. This will depend on the wiki user's access rights in Redmine.
- Impersonate : select this if your wiki's users have the same UID as Redmine's users. e.g. : LDAP authentication. Redproject then will manage rights based on private or public projects.
- Userview : doesn't manage access rights and display project even if it's in private project.

Syntax

There is two way to use this plugin :

Basic Syntax :

<redproject proj="identifier_project" />

Where proj value is the project identifier (Available in the settings of redmine project).

Multiple Servers

You can, as in redissue, select another redmine server in syntax. This server should be defined in the server.json file of the plugin.

Example of server.json file:

{
    "first": {
        "url": "http://myfirst.redmine.com",
        "api_token": "abcdefghijklmnopqrstuvwxyz0123456789"
    },
    "second": {
        "url": "http://mysecond.redmine.com",
        "api_token": "zyxwvutsrqponmlkjihgfedcba9876543210"
    }
}

Then simply add your server in redproject syntax:

<redproject proj="identifier_project" server="first" />

Note: By default, redproject will take the data defined in Dokuwiki settings.

Preview

Here is a preview of redproject :

Name, homepage and description of project:

Each Versions with their issues progression:

Last détails and Members.

For further information, see also Redproject on dokuwiki.org

algorys / redproject