Skip to content
forked from ivaldi/brimir

Email helpdesk built using Ruby on Rails and Zurb Foundation

License

Notifications You must be signed in to change notification settings

basschoen/brimir

 
 

Repository files navigation

Brimir Build Status Coverage Status

Brimir is a simple helpdesk system that can be used to handle support requests via incoming email. Brimir is currently used in production at Ivaldi.

Installation

Brimir is a rather simple Ruby on Rails application. The only difficulty in setting things up is how to get incoming email to work. See the next section for details.

To install brimir you first have to create a database and modify the config file in config/database.yml to reflect the details.

Now install the required gems by running:

bundle install --without development:test

Next, load the database schema and some defaults:

rake db:migrate

Last thing left to do before logging in is making a user and adding some statuses. You can do this by running:

rails console
Status.create([ { name: 'Open', default: true }, { name: 'Closed' }, { name: 'Deleted' } ])
Priority.create([ { name: 'None', default: true }, { name: 'Low' }, { name: 'Medium' }, { name: 'High' } ])
u = User.new({ email: '[email protected]', password: 'somepassword', password_confirmation: 'somepassword' }); u.agent = true; u.save!

Incoming email

Incoming emails can be posted to the tickets url. First make a script like this on your mailserver:

#!/bin/bash
exec curl --data-urlencode message@- https://yourbrimirurl.com/tickets

Save it in /etc/postfix/brimir.sh for example.

Next, create an alias in your /etc/aliases file like this:

brimir: "|/bin/bash /etc/postfix/brimir.sh"

Now sending an email to [email protected] should start curl and post the email to your brimir installation.

Contributing

We appreciate all contributions! If you would like to contribute, please follow these steps:

  • Fork the repo.
  • Create a branch with a name that describes the change.
  • Make your changes in the branch.
  • Submit a pull-request to merge your feature-branch in our master branch.

Requested features

Some users have made requests for the following features. If you would like to contribute, you could add any of these.

  • Switchable property to support threads by using special tags in the subject line instead of relying on mail headers.
  • Grouping issues by project.
  • Managing users from within Brimir.
  • Ability to create issues from within Brimir, instead of only via email.
  • Support for hosted incoming mail services (Sendgrid, Mandrill), possibly using griddler gem.

License

Brimir is licensed under the GNU Affero General Public License Version 3.

About

Email helpdesk built using Ruby on Rails and Zurb Foundation

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 89.1%
  • JavaScript 5.5%
  • Shell 3.3%
  • CSS 2.1%