The Apijs plugin for Redmine

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.fr/apijs.

This plugin allows:

• to sort out attachments in alphabetical order
• to display a photo/video gallery from attachments
• to display videos in streaming (HTTP 206 Partial Content)
• to keep the animation of GIF/PNG/WEBP images thanks to Pillow
• to redefine the date of creation of the photos from the EXIF date
• to modify the description of attachments
• to rename and remove attachments

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 in Administration » Plugins » Redmine Apijs plugin » Configure.
Available anywhere, especially in all attachments lists.

Installation

The following programs are necessary for the proper functioning of the plugin:

• python-pil
• python-scour
• libimage-exiftool-perl
• ffmpegthumbnailer (optional)
• python3, nproc, du -hs | cut -f1

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

Manual

Debian/Ubuntu → sudo apt install python3-pil python3-scour libimage-exiftool-perl ffmpegthumbnailer
Fedora → sudo dnf install python3-pillow python3-scour perl-image-exiftool ffmpegthumbnailer
Mac/Windows → python3 -m pip install --upgrade pip pillow scour

For Redmine 1.4, extract src folder content in REDMINE/vendor/plugins/redmine_apijs/ and restart Redmine.
For Redmine 2.x, extract src folder content in REDMINE/plugins/redmine_apijs/ and restart Redmine.
For Redmine 3.x, extract src folder content in REDMINE/plugins/redmine_apijs/ and restart Redmine.
For Redmine 4.x, extract src folder content in REDMINE/plugins/redmine_apijs/ and restart Redmine.
For Redmine 5.x, extract src folder content in REDMINE/plugins/redmine_apijs/ and restart Redmine.

deb package manager

Ubuntu/Debian

Run: sudo add-apt-repository ppa:luigifab/packages ; sudo apt update ; sudo apt install redmine-plugin-apijs
Then, restart Redmine.

gem package manager

RubyGems

Run: sudo gem install redmine_apijs
Then, install dependencies: sudo apt install python3-pil python3-scour libimage-exiftool-perl ffmpegthumbnailer
Then, add in Redmine Gemfile: require "redmine_apijs"
Then, restart Redmine.

For Redmine 4.1+ (Plugin not found. The directory for plugin ... should be ...), read #31110.

rpm package manager

openSUSE

zst package manager

Arch Linux

Plugin download

Download of the latest version: redmine-apijs-6.9.6.tar.gz
See also: github - redmine - rubygems - archlinux - opensuse - ppa − geany - rubymine

• Current version: 6.9.6 (01/01/2024)
• Compatibility: Redmine 1.4 / 2.0 / 2.1 / 2.2 / 2.3 / 2.4 / 2.5 / 2.6 / 3.0 / 3.1 / 3.2 / 3.3 / 3.4 / 4.0 / 4.1 / 4.2 / 5.0 / 5.1, Python 3.3+
• Client compatibility: Firefox 36+, Chrome 32+, Opera 19+, Edge 16+, Safari 9+
• Animated PNG compatibility: Firefox 3+, Chrome 59+, Opera 46+, Edge 79+, Safari 8+, Pillow 7.1.0+
• Animated WEBP compatibility: Firefox 65+, Chrome 32+, Opera 19+, Edge 18+, Safari 14+, Pillow 5.0.0+
• Translations: English (en), French (fr-FR/fr-CA), German (de), Italian (it), Portuguese (pt-PT/pt-BR), Spanish (es) / Chinese (zh), Czech (cs), Dutch (nl), Greek (el), Hungarian (hu), Japanese (ja), Polish (pl), Romanian (ro), Russian (ru), Slovak (sk), Turkish (tr), Ukrainian (uk)
• License: GNU GPL 2.0+
• Read absolutely: the README file

6.9.6

-- Debian Testing 64 -- Docker 20.10 --
Tested with Firefox 36/114, Chrome 32/106, Edge 106, Opera 19/91 on Redmine 5.1.1 with Python 3.11.2 and Ruby 3.2.2-p53 and Rails 6.1.7 (Debian 12).
Tested with Firefox 114 with Redmine 5.0.2 with Python 3.9.2 and Ruby 3.1.2-p20 and Rails 6.1.6 (Debian 11).
Tested with Firefox 105 with Redmine 4.2.1 with Python 3.7.3 and Ruby 2.7.3-p183 and Rails 5.2.5 (Debian 10).
Tested with Firefox 105 with Redmine 4.1.1 with Python 3.7.3 and Ruby 2.6.6-p146 and Rails 5.2.4 (Debian 10).
Tested with Firefox 105 with Redmine 4.0.7 with Python 3.7.3 and Ruby 2.6.6-p146 and Rails 5.2.4 (Debian 10).
Tested with Firefox 105 with Redmine 3.4.13 with Python 3.7.3 and Ruby 2.4.10-p364 and Rails 4.2.11 (Debian 10).
Tested with Firefox 105 with Redmine 3.3.9 with Python 3.5.3 and Ruby 2.3.8-p459 and Rails 4.2.11 (Debian 9).
Tested with Firefox 105 with Redmine 3.2.9 with Python 3.4.2 and Ruby 2.2.10-p489 and Rails 4.2.7 (Debian 8).
Tested with Firefox 105 with Redmine 3.1.7 with Python 3.4.2 and Ruby 2.2.8-p477 and Rails 4.2.7 (Debian 8).
Tested with Firefox 105 with Redmine 3.0.7 with Python 3.4.2 and Ruby 2.2.5-p319 and Rails 4.2.3 (Debian 8).
Tested with Firefox 105 with Redmine 2.6.10 with Python 3.4.2 and Ruby 2.2.5-p319 and Rails 3.2.22 (Debian 8).

If you like this plugin, take some of your time to improve the translations.