Plugins Directory » Redmine Chat

Author: Tigergm Wu
Code repository:
Registered on: 2016-08-13 (over 7 years ago)
Current version: 0.0.8
Compatible with: Redmine 3.2.x
User ratings:   (0)

This plugin has not been under developing. It will be replaced by redmine_layim plugin( Thank you and please support the new plugin.

Hello redminers. I am planning to start developing chat plugin. I know this is a bit complicated such as the configuration. I planned to use faye gem(websocket). The redmine's development enviroments may be upgraded to rails 5, we can take advantage of new features of action cable to achieve real-time communication. But the current plan is to use traditional methods.

At present I have completed the primary prototype structure referring to an example. I will organize source code into the repository initial later.

The purpose of this plugin is to build an open chat room for online users of each project and real-time to discussion using IM embed in browser. Of course I just started drawing up a code structure that supports point-to-point chat which will be transformed in the future.

Thanks a lot.

Installation notes

As the initial version, you'd better having some experiences in the development of skills. Please note the following constraints:
Only deployed in a production mode, http instead of https
Tested only on sqlite3, later test for mysql,
Currently only supporting 3.2.0

First briefly talk to you, it's not recommended to install it unless the future version of 0.1.0
1.the installation process
Git from bitbucket in the plugins direction: git clone
Or download it from bitbucket and expand zip file into the plugins directory and name it by redmine_chat
In redmine home directory, run: bundle install --without development test.
Please run bundle update private_pub if you have bundled from tigergm's github
In redmine home directory, run: RAILS_ENV=production rails g private_pub:install. It will generate a few template files
Edit file in redmine home directory, such as changes to the mysql sqlite3
Edit private_pub.yml file in config directory, such as the server production according to the the server's ip or domain name
In redmine main directory, start faye server, distribute and monitor chat messages, it may be necessary preceded bundle exec. You can add "-D" in the end as backgound daemon. Run:
rackup -s thin -E production
Other example if you want to listen all:
rackup -o -s thin -E production
Migrate database files in redmine home directory, run:
bundle exec rake redmine:plugins:migrate NAME=redmine_chat RAILS_ENV=production
Restart redmine and use the plugin.

2.Version Planning
Currently limited in the chat section, it will be extended to all pages
Currently automatic pop-up chat mode is maximized, it will be changed to minimize mode to prevent from interference with work
Online status updated in real time in the future, the current state of the background is real-time, but front page refreshes to update the status only
The chat will flash when new message arrived
Support more databases
If redmine is upgraded to rails 5, the plugin will enable action cable mechanism
Support issue, wiki links in conversations, etc.
Conversation's history can be searched


0.0.8 (2016-08-29)

Compatible with Redmine 3.2.x.

fixed the bug that twice triggered when click the min or max title icon in js
auto-pop message only when the project's message arrived

0.0.7 (2016-08-27)

Compatible with Redmine 3.2.x.

message's body length limted in 1024
optimized the chat_user online status' process through rm_private_pub gem

0.0.6 (2016-08-26)

Compatible with Redmine 3.2.x.

mysql2 supported
adjusted the project module's name
the issue's number can be auto-linked
added the permissions for secure of the page accessing
fix the avater's shown in chat box
bugs known:
it sometimes doesn't work that minimizing or maximizing the chat box on my development enviroment. it will be fixed in the future
when leave from the client(disconnected from faye channel) the online's recored maybe not be destroyed. it will be optimized in the future

0.0.5 (2016-08-25)

Compatible with Redmine 3.2.x.

the default chat of auto-pop is first minimized unless it's mannual launched

0.0.4 (2016-08-24)

Compatible with Redmine 3.2.x.

optimised for the chat quick auto-pop feature when every page loading
it works in chrome with the max or min state but only open max in IE

0.0.3 (2016-08-24)

Compatible with Redmine 3.2.x.

extended the chat box to other main pages

0.0.2 (2016-08-20)

Compatible with Redmine 3.2.x.

began to custome the private_pub gem for redmine_chat plugin
finished the basic chat function

1.png (45.6 KB) 1.png Tigergm Wu, 2016-08-20 15:49
2.png (19.4 KB) 2.png Tigergm Wu, 2016-08-20 15:49

0.0.1 (2016-08-13)

Compatible with Redmine 3.3.x, 3.2.x.

init propotype

chat_init.png (41.9 KB) chat_init.png Tigergm Wu, 2016-08-13 15:47