helpyio/helpypro

Helpy: 现代帮助台平台

Helpy是一个用Ruby on Rails编写的现代帮助台平台，基于MIT许可证发布。Helpy的目标是支持您的支持电子邮件和工单系统，与您的应用程序无缝集成，并运行出色的客户帮助中心。

!https://img.shields.io/travis/helpyio/helpy/master.svg !https://codeclimate.com/github/helpyio/helpy/badges/gpa.svg

!Helpy界面

赞助/支持Helpy

Helpy采用MIT许可证，是一个开放核心项目。这意味着核心功能100%开源，完全可定制，甚至可以在MIT许可证下重新销售。请参阅下面的功能比较以了解包含的内容。

Helpy是一个大型系统，不能纯粹作为业余项目存在。如果您在商业环境中使用它，从财务上支持该项目或成为官方赞助商是非常有意义的。

[***]

开源功能

Helpy是一个集成的支持解决方案，结合了支持工单、知识库和公共社区，并利用它们之间的协同作用。每个功能都是可选的，可以轻松禁用。

• 多渠道工单：通过Sendgrid、Mandrill、Mailgun等集成入站电子邮件
• 知识库：全文搜索和SEO优化，帮助用户在联系您之前自行解答问题
• 移动友好：支持请求随时可能到来，Helpy开箱即用地在所有设备上运行，让您可以随时随地为客户提供及时的答案
• 社区支持论坛：客户和代理都可以在公开访问的论坛中回答问题，并对主题和回复进行投票
• 嵌入小部件：Helpy包含一个轻量级JavaScript小部件，允许您的用户从任何地方联系您
• 多语言支持：Helpy完全支持多语言，可以同时提供多种语言的支持。目前应用程序包含19种语言的翻译，并且易于翻译
• 可主题化：自定义Helpy的外观和功能，而不会影响其底层系统。Helpy附带两个额外的主题，我们希望随着时间的推移添加更多并从社区获得更多
• 发送HTML电子邮件：对客户的回复可以包含HTML、表情符号和附件
• 可定制：设置颜色以匹配您的品牌，无论是在帮助中心还是在工单UI中
• GDPR合规：通过删除用户及其历史记录或***化来遵守GDPR的"被遗忘权"请求

专业版

我们还提供专业版，具有其他功能，旨在使您的帮助中心更加出色。这可以作为交钥匙SaaS或AWS/Azure市场产品提供。两者都能在几秒钟内启动。收益直接用于支持项目的持续开发。专业版中的一些功能：

• 触发器：在工单生命周期的任何点插入事件。包括出站JSON API
• 通知：收到新工单、被分配工单等时的浏览器通知
• 实时UI：工单到达时，会自动添加到UI中
• 自定义视图：添加额外的工单队列，突出显示您需要查看的工单
• 高级报告：关于您的工单和帮助中心知识库性能的一套额外报告
• 高级搜索：当您有成千上万的工单或客户时，轻松筛选和查找
• 可定制的请求表单：轻松向工单创建表单添加问题
• AI支持聊天机器人：为您的网站创建聊天机器人，自主回答高达90%的一级问题

快速开始

Helpy专业版 - 通过AWS 30秒一键安装

您可以在AWS上免费试用14天的Helpy专业版。这是一个"一键式"市场镜像，可在30秒内启动一个运行Ubuntu的专用VM。https://aws.amazon.com/marketplace/pp/B07WCNQGZ3?ref=_ptnr_web_github

通过Docker安装Helpy

Docker是快速测试或在生产环境中运行Helpy的推荐方式。

1. 安装https://get.docker.com/%E5%92%8Cdocker-compose
2. 从模板创建配置文件 cp docker/.env.sample docker/.env 并编辑 docker/.env 以满足您的需求
3. 编辑 docker/Caddyfile 以包含您的URL或启用SSL
4. 从本地git checkout构建Helpy docker-compose build
5. 运行 docker-compose up -d 启动所有服务

在本地系统上安装Helpy

虽然不是必需的，但强烈建议在本地安装，这将使您更容易自定义设置、颜色和徽标以匹配您的网站标识。首先，从官方仓库克隆Helpy到您的本地系统：

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

配置基本设置

管理面板中有一个设置选项，可以设置i18n、系统名称、颜色、可嵌入小部件等。有关设置的完整指南，请访问：配置您的Helpy设置

支持多种语言（可选）

Helpy支持多语言帮助站点和多语言知识库文章。此页面解释了如何启用Helpy的国际功能，并概述了这为Helpy添加了哪些功能：如何设置多语言Helpy支持知识库

设置Helpy发送和接收电子邮件（可选）

Helpy能够在您的支持电子邮件地址接收电子邮件，并将消息导入到Web界面中的工单。每当您或用户回复电子邮件线程时，Helpy都会捕获讨论并相应地发送消息。按照设置您的Helpy安装以发送和接收电子邮件上的教程进行设置。

配置oAuth（可选）

Helpy支持Omniauth登录功能。这意味着您可以允许您的支持用户通过任何Omniauth提供商（即***、***、Gmail或许多其他提供商）一键登录。阅读https://github.com/helpyio/helpy/wiki/SSO--Configuring-OAUTH%E4%BA%86%E8%A7%A3%E5%A6%82%E4%BD%95%E6%93%8D%E4%BD%9C%E3%80%82

实时演示

还有一个带有虚假数据的实时演示，可在[***] 管理员用户：admin@test.com，密码：12345678

安装要求

Helpy设计用于现代云提供商，尽管它应该可以在任何基于Linux的系统上运行。Wiki中有完整的Helpy安装指南：https://github.com/helpyio/helpy/wiki

要求：

• Ruby 2.4+
• Rails 4.2.x
• Postgres
• 服务器如Unicorn、Puma或Passenger

Helpy利用两个外部服务来提供帮助：

• 电子邮件提供商如Sendgrid
• Google Analytics用于统计（可选）

贡献

欢迎并感谢您为Helpy做出贡献。我们一起正在构建世界上最好的客户支持平台。以下是您可以贡献的一些方式：

• 报告或修复错误
• 重构
• 提高测试覆盖率 - 与任何大型且不断增长的代码库一样，测试覆盖率并不总是尽可能好。帮助提高测试覆盖率总是受欢迎的，并且将帮助您了解Helpy的工作原理。我们专门使用Minitest。
• 翻译项目 - 社区已经将Helpy翻译成18种语言，但还有更多等待翻译。我们需要帮助将Helpy翻译成尽可能多的语言环境！https://github.com/helpyio/helpy/wiki/How-to-translate-Helpy-into-your-language%E4%BA%86%E8%A7%A3%E6%9B%B4%E5%A4%9A%E8%AF%A6%E6%83%85%E3%80%82
• 构建新功能。我们有一个希望构建的新功能积压。查看我们的路线图以获取更多见解，如果您想承担其中一个，请与我们联系，以确保没有人已经在处理它。

一般准则：

• 加入我们的Slack。让我知道您希望做出贡献。https://helpyioslackin.herokuapp.com/badge.svg]([***]
• 使您的PRs具体化。每个PR应只包含一个功能。
• 查看路线图：Trello如果您想构建功能，请联系我们确保没有其他人已经在处理它
• 您必须提供通过的测试覆盖率。我们使用minitest，请参见[***]
• 您还必须将功能暴露给API。我们使用Grape。API方法也应进行测试。
• 如果您的功能/错误修复/增强添加或更改了项目中的文本，请在en.yml和您可以的任何其他语言环境中创建i18n字符串。
• 我们非常关注用户体验和良好的UI。通常这意味着我们可能会采用您贡献的内容并"打扮"它，或者要求您这样做。

安全问题

如果您在Helpy中发现漏洞或其他安全问题，请不要在GitHub上打开issue。相反，请通过电子邮件直接联系***。请参阅SECURITY指南了解更多信息，并查看安全报告者的名人堂。

许可证

版权所有2016-2020，Helpy.io, LLC，Scott Miller和贡献者。Helpy Core根据MIT开源许可证发布。请将您所做的任何增强贡献回来。此外，如果您保留页脚中的"由Helpy提供支持"字样，我将不胜感激。这有助于我跟踪有多少人在使用Helpy。