https://github.com/algorys/redproject
Plugin for Dokuwiki will display roadmap and other information of a redmine's project
https://github.com/algorys/redproject
dokuwiki dokuwiki-plugin redmine
Last synced: 11 months ago
JSON representation
Plugin for Dokuwiki will display roadmap and other information of a redmine's project
- Host: GitHub
- URL: https://github.com/algorys/redproject
- Owner: algorys
- Created: 2015-09-24T16:00:36.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-07-06T08:13:10.000Z (over 7 years ago)
- Last Synced: 2025-01-04T00:24:56.118Z (about 1 year ago)
- Topics: dokuwiki, dokuwiki-plugin, redmine
- Language: PHP
- Homepage:
- Size: 49.8 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](http://getbootstrap.com/) (need [Bootstrap3 Template](https://github.com/LotarProject/dokuwiki-template-bootstrap3/)).
* Handle multiple redmine server
## Requirements
Redproject needs [Php-Redmine-API](https://github.com/kbsali/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](https://www.dokuwiki.org/plugin:redissue) the first option is better, as you have just to install it one time.
```bash
$ 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 :
```bash
$ 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 :
```php
```
Where **proj** value is the project identifier (Available in the settings of redmine project).
### Multiple Servers
You can, as in [redissue](https://github.com/algorys/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:
```json
{
"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:
```php
```
**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](https://www.dokuwiki.org/plugin:redproject)