Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/helpyio/helpy

Helpy is a modern, open source helpdesk customer support application. Features include knowledgebase, community discussions and support tickets integrated with email.
https://github.com/helpyio/helpy

forum hacktoberfest helpdesk knowledge-base support ticketing

Last synced: 13 days ago
JSON representation

Helpy is a modern, open source helpdesk customer support application. Features include knowledgebase, community discussions and support tickets integrated with email.

Awesome Lists containing this project

README 

        
Helpy: A Modern Helpdesk Platform

====================================



Helpy is a modern help desk platform written in Ruby on Rails and released under the MIT license.  The goal of Helpy is to power your support email and ticketing, integrate seamlessly with your app, and run an amazing customer helpcenter.



[![Build Status](https://img.shields.io/travis/helpyio/helpy/master.svg)](https://travis-ci.org/helpyio/helpy) [![Code Climate](https://codeclimate.com/github/helpyio/helpy/badges/gpa.svg)](https://codeclimate.com/github/helpyio/helpy)



![](https://helpy.io/images/github-main-image.png)



Sponsor/Support Helpy

========



Helpy is licensed under the MIT license, and is an open-core project. This means that the core functionality is 100% open source and fully hackable or even re-sellable under the MIT license.  See the features comparison below to understand what is included.



Helpy is a large system and cannot exist purely as a hobby project. If you use it in a money generating capacity, it makes good sense to support the project financially or by becoming an official sponsor or supporter.



https://www.patreon.com/helpyio



Open Source Features

========



Helpy is an integrated support solution- combining and leveraging synergies between support ticketing, Knowledgebase and a public community.  Each feature is optional however, and can be easily disabled.



- **Multichannel ticketing:** Integrated with inbound email via Sendgrid, Mandrill, Mailgun, etc.

- **Knowledgebase:** Full text searchable and SEO optimized to help users answer questions before they contact you.

- **Mobile-friendly:** Support requests come at all times, and Helpy works on all devices out of the box so you can delight customers with prompt answers, from anywhere and at anytime!

- **Community Support Forums:** Customers and Agents can both answer questions in a publicly accessible forum, and vote both threads and replies up or down accordingly.

- **Embed Widget:** Helpy Includes a lightweight javascript widget that allows your users to contact you from just about anywhere.

- **Multi-lingual:** Helpy is fully multi-lingual and can provide support in multiple languages at the same time.  Currently the app includes translations for 19 languages and is easy to translate.

- **Themeable:** Customize the look and functionality of your Helpy without disturbing the underlying system that makes it all work. Helpy comes with two additional themes, and we hope to add more and get more from the community as time goes on.

- **Sends HTML email:** Responses to customers can include html, emojis and attachments.

- **Customizable:** Set colors to match your brand both on the helpcenter, and in the ticketing UI.

- **GDPR Compliant:** Comply with GDPR right to be forgotten requests by deleting users and their history, or by anonymizing them.



Pro Version

=========



We also offer a pro version with additional features designed to make your helpcenter even more awesome. This is available as either a turn-key SaaS or AWS/Azure marketplace product.  Both spin up in seconds. Proceeds go directly towards supporting the continued development of the project. Some of the things found in the pro version:



- **Triggers:** Insert events at any point in the ticket lifecycle. This includes an outbound JSON API.

- **Notifications:** Browser notifications when new tickets are received, you are assigned to a ticket, etc.

- **Real time UI:** When tickets arrive, they are automatically added to the UI

- **Custom Views:** Add additional Ticketing queues to highlight just the tickets you need to see

- **Advanced reporting:** A suite of additional reports on the performance of your ticketing and helpcenter knowledgebase

- **Advanced search:** Easily filter and find tickets or customers when you have thousands

- **Customizable Request Forms:** Easily Add questions to the ticket creation forms

- **AI Support Chatbot:** Create a chatbot for your website to answer up 90% of tier one questions autonomously



Getting Started:

=========



**Helpy Pro - 30 Second one-click install via DigitalOcean**



You can launch the free tier of Helpy Pro using the DigitalOcean Marketplace.  This "one click" marketplace image spins up a dedicated VM within 30 seconds, running Ubuntu. [Launch DigitalOcean Marketplace Image](https://marketplace.digitalocean.com/apps/helpy-pro?refcode=1368cfa70df6).  Use of all features requires either a trial or paid license code, available here: [Helpy License Center](https://support.helpy.io/orders)



**Install Helpy via Docker**



Docker is the recommended way to quickly test or run Helpy in production.



1) Install [Docker](https://get.docker.com/) and docker-compose

2) Create config file from template `cp docker/.env.sample docker/.env` and edit `docker/.env` to match your needs

3) Edit `docker/Caddyfile` to include your URL or turn on SSL

4) Build Helpy from local git checkout `docker-compose build`

5) Run `docker-compose up -d` to start all of the services



**Install Helpy on your Local System**



Although not required, installing locally is highly recommended and will make it easier for you to customize things like settings, colors and logos to match your site identity.  To begin, clone Helpy from the official repo to your local system:



`git clone https://github.com/helpyio/helpy.git`



**Configure Basic Settings**



There is a settings option in the admin panel to set up things like i18n, system names, colors, the embeddable widget, etc.  There is a full guide to getting set up at: [Configuring Your Helpy Settings](http://support.helpy.io/en/knowledgebase/11-Installing-Helpy/docs/22-Configuring-your-Helpy-Settings)



**Support Multiple Languages (optional)**



Helpy includes support for Multilingual help sites, and multi-language knowledgebase articles.  This page explains how to enable Helpy's international capabilities and provides an overview of what functionality this adds to Helpy: [How To Set Up A Multilingual Helpy Support Knowledgebase](http://support.helpy.io/en/knowledgebase/12-Using-Helpy/docs/9-How-to-set-up-a-multilingual-Helpy-support-knowledgebase)



**Set up your Helpy to send and receive email (optional)**



Helpy has the ability to receive email at your support email addresses and import the messages as tickets in the web interface.  Whenever you or the user replies to the email thread, Helpy captures the discussion and sends out messages accordingly. Follow the tutorial on [Setting Up Your Helpy Installation To Send And Receive Email](http://support.helpy.io/en/knowledgebase/11-Installing-Helpy/docs/14-Setting-up-your-Helpy-installation-to-send-and-receive-email) to set this up.



**Configure oAuth (optional)**



Helpy supports Omniauth login capabilities.  This means you can allow your support users to sign in with a single click via any Omniauth provider- ie. Facebook, Twitter, Gmail, or many others. Read [Setting Up Oauth For Your Helpy](https://github.com/helpyio/helpy/wiki/SSO--Configuring-OAUTH) to see how.



Live Demo

=========



There is also a live demo with fake data available at [http://demo.helpy.io](http://demo.helpy.io)

Admin User: `[email protected]` and password: `12345678`



Installation

============



Helpy was designed to run on modern cloud providers, although it should work on

any linux based system.  There is a full guide to installing Helpy in the wiki: https://github.com/helpyio/helpy/wiki



Requirements are:



- Ruby 2.4+

- Rails 4.2.x

- Postgres

- A server like Unicorn, Puma or Passenger



Helpy leverages two external services to help out:



- an email provider like Sendgrid

- Google Analytics for stats (optional)



Contributing

============



Welcome, and thanks for contributing to Helpy.  Together we are building the best customer support platform in the world.  Here are some of the ways you can contribute:



- Report or fix Bugs

- Refactoring

- Improve test coverage-  As with any large and growing codebase, test coverage is not always as good as it could be.  Help improving test coverage is always welcome and will help you learn how Helpy works.  We use Minitest exclusively.

- Translate the project- The community has already translated Helpy into 18 languages, but there are many more waiting.  We need help getting Helpy translated into as many locales as possible! [Please see the guide to translation](https://github.com/helpyio/helpy/wiki/How-to-translate-Helpy-into-your-language) for more details.

- Build new features.  There is a backlog of new features that we’d like to see built.  Check out our [roadmap](https://trello.com/b/NuiWsdmK/helpy) for more insight on this, and if you would like to take one on, please get in touch with us to make sure someone is not already working on it.



**General Guidelines:**



- Join us on Slack.  Let me know you wish to contribute. [![Slack Status](https://helpyioslackin.herokuapp.com/badge.svg)](https://helpyioslackin.herokuapp.com)

- Make your PRs granular.  They should only include one piece of functionality per PR.

- Check the roadmap: [Trello](https://trello.com/b/NuiWsdmK/helpy) If you want to build a feature, contact us to make sure no one else is already working on it

- You must provide passing test coverage.  We use minitest, see http://www.rubypigeon.com/posts/minitest-cheat-sheet/?utm_source=rubyweekly&utm_medium=email

- You also must expose functionality to the API.  We use Grape.  API methods should be tested as well.

- If your feature/bug fix/enhancement adds or changes text in the project, please create i18n strings in `en.yml` and any other locales you can.

- We are hugely concerned with user experience, and a nice UI.  Oftentimes that means we may take what you have contributed and “dress it up” or ask you to do the same.



Security Issues

===============



If you have found a vulnerability or other security problem in Helpy, please *do not open an issue* on GitHub. Instead, contact [[email protected]](mailto: [email protected]) directly by email.  See the [SECURITY](/SECURITY.md) guide to learn more and see a hall of fame of security reporters.



License

=======



Copyright 2016-2021, Helpy.io, LLC, Scott Miller and Contributors. Helpy Core is released under the MIT open source license.  Please contribute back any enhancements you make.  Also, I would appreciate if you kept the "powered by Helpy" blurb in the footer.  This helps me keep track of how many are using Helpy.



[![Analytics](https://ga-beacon.appspot.com/UA-50151-28/helpy/readme?pixel)](https://github.com/igrigorik/ga-beacon)