The Apijs plugin for Redmine

Contents

  1. Plugin presentation
    1. Description
    2. Access and configuration
  2. Installation
    1. Dependencies
    2. Providing
    3. Troubleshooting
  3. Plugin download and demo
  4. Support

Don't forget that the present documentation is only about the latest version of the plugin.
Don't forget to read this page entirely.

Plugin presentation

Description

Integrates apijs javascript library into Redmine.
For more information about the library, go to luigifab.info/apijs.

This plugin allows:

Editing and removing attachments are configured with Redmine roles and permissions.
Everything else is configurable on the configuration page of the plugin.

It is important to note that this plugin uses external programs to work (see details later).

Access and configuration

Available anywhere, especially in all attachments lists.
Available in Administration » Plugins » Redmine Apijs plugin » Configure.

Screenshot of the configuration page
Screenshot of the configuration page (1/6)
Screenshot of an issue
Screenshot of an issue (2/6)
Screenshot of a news
Screenshot of a news (3/6)
Screenshot of a document
Screenshot of a document (4/6)
Screenshot of a wiki page
Screenshot of a wiki page (5/6)
Screenshot of a post in the forum
Screenshot of a post in the forum (6/6)

Installation

Dependencies

The following programs are necessary for the proper functioning of the plugin (the versions are given for informational purposes only):

To install these programs with Debian/Ubuntu:

sudo aptitude install python-pil libimage-exiftool-perl ffmpegthumbnailer ruby-zip

About ruby-zip installation, it is possible to install it with bundle once the plugin is in it's file:

bundle update

Providing

For Redmine 1.4, unzip content in REDMINE/vendor/plugins/redmine_apijs/ and restart Redmine.
For Redmine 2.x, unzip content in REDMINE/plugins/redmine_apijs/ and restart Redmine.
For Redmine 3.x, unzip content in REDMINE/plugins/redmine_apijs/ and restart Redmine.

Troubleshooting

All called commands are saved in the log file.
To find them easily, just look for APIJS:: in the file.

Plugin download and demo

Demo: n/a

Download of the latest version: apijs-5.3.0.tar.gz (md5 827b838a36940e4796cda5ec643068f6)
See also: redmine.org/plugins/apijs
GitHub repository: github.com

Tested with Firefox 22/45, Chrome 55, Opera 42, IE 11 on Redmine 3.2.0 / 3.3.1 with Ruby 2.3.3-p222 and Rails 4.2.7.
Previous version (5.2.0) tested with Firefox 38 with Redmine 1.4.7 / 2.0.0 / 2.1.0 / 2.2.0 / 2.3.0 / 2.4.0 / 2.5.0 / 2.6.0 / 3.0.1 with Ruby 1.9.3-p194 / 1.9.3-p484 / 2.1.2-p95 / 2.1.5-p273 and Rails 3.2.17 / 3.2.18 / 3.2.19.

Support

Contact

A problem? A question? Is something not working? Is there a bug? Contact me (in French or in English), if I am not on holiday and not far from my mailbox, I will answer you within a few hours.

You will find my email address in the README file, read it!

Why choose us?

Because we are the best! You will like our minified files shipped with our modules.