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.
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.
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.
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:
Helpy Pro - 30 Second one-click install via AWS
You can take a 14 day free trial of the Pro version of Helpy on AWS. This is a "one click" marketplace image and spins up a dedicated VM within 30 seconds, running Ubuntu. Launch AWS Marketplace Image
Install Helpy via Docker
Docker is the recommended way to quickly test or run Helpy in production.
cp docker/.env.sample docker/.envand edit
docker/.envto match your needs
docker/Caddyfileto include your URL or turn on SSL
docker-compose up -dto 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
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
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 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 to see how.
There is also a live demo with fake data available at http://demo.helpy.io
email@example.com and password:
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
Helpy leverages two external services to help out:
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:
en.ymland any other locales you can.
If you have found a vulnerability or other security problem in Helpy, please do not open an issue on GitHub. Instead, contact [firstname.lastname@example.org](mailto: email@example.com) directly by email. See the SECURITY guide to learn more and see a hall of fame of security reporters.
Copyright 2016-2020, 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.