Helpy 是一个用 Ruby on Rails 编写的现代帮助台平台，并根据 MIT 许可证发布。Helpy 的目标是为您的支持电子邮件和票务提供支持，与您的应用程序无缝集成，并运行一个令人惊叹的客户帮助中心。

Helpy 已获得 MIT 许可，并且是一个开放核心项目。这意味着核心功能是 100% 开源的，并且完全可破解，甚至可以在 MIT 许可下重新销售。请参阅下面的功能比较以了解其中包含的内容。

Helpy 是一个大型系统，不能纯粹作为一个业余爱好项目而存在。如果您将其用于创收能力，那么在经济上支持该项目或成为官方赞助商或支持者是很有意义的。

https://www.patreon.com/helpyio

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

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

我们还提供带有附加功能的专业版，旨在使您的帮助中心更加出色。它可以作为交钥匙 SaaS 或 AWS/Azure 市场产品提供。两者都在几秒钟内旋转起来。收益直接用于支持项目的持续发展。专业版中发现的一些内容：

• 触发器：在工单生命周期的任意时刻插入事件。这包括出站 JSON API。
• 通知：收到新工单、为您分配工单等时的浏览器通知。
• 实时用户界面：当票证到达时，它们会自动添加到用户界面中
• 自定义视图：添加额外的票务队列以突出显示您需要查看的票证
• 高级报告：关于票务和帮助中心知识库性能的一套附加报告
• 高级搜索：当您有数千个门票或客户时，可以轻松过滤和查找门票或客户
• 可定制的请求表单：轻松将问题添加到票证创建表单中
• AI 支持聊天机器人：为您的网站创建一个聊天机器人，自动回答 90% 的一级问题

Helpy Pro - 通过 DigitalOcean 30 秒一键安装

您可以使用 DigitalOcean Marketplace 启动 Helpy Pro 的免费套餐。这个“一键式”市场镜像会在 30 秒内启动一个运行 Ubuntu 的专用虚拟机。启动 DigitalOcean 市场图像。使用所有功能需要试用或付费许可证代码，可在此处获取：帮助许可证中心

通过 Docker 安装 Helpy

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

1. 安装Docker和 docker-compose
2. 从模板创建配置文件cp docker/.env.sample docker/.env并进行编辑docker/.env以满足您的需求
3. 编辑docker/Caddyfile以包含您的 URL 或打开 SSL
4. 从本地 git checkout 构建 Helpydocker-compose build
5. 运行docker-compose up -d以启动所有服务

在本地系统上安装 Helpy

尽管不是必需的，但强烈建议您进行本地安装，这样您可以更轻松地自定义设置、颜色和徽标等内容，以匹配您的站点标识。首先，将 Helpy 从官方存储库克隆到本地系统：

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

配置基本设置

管理面板中有一个设置选项，用于设置 i18n、系统名称、颜色、可嵌入小部件等。完整的设置指南位于：配置您的帮助设置

支持多种语言（可选）

Helpy 包括对多语言帮助网站和多语言知识库文章的支持。本页面介绍了如何启用 Helpy 的国际功能，并概述了这为 Helpy 添加了哪些功能：如何设置多语言 Helpy 支持知识库

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

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

配置 oAuth（可选）

Helpy 支持 Omniauth 登录功能。这意味着您可以允许您的支持用户通过任何 Omniauth 提供商（即）单击一下即可登录。Facebook、Twitter、Gmail 或许多其他。请阅读为帮助者设置 Oauth以了解具体操作方法。

http:https://demo.helpy.io上还有一个带有虚假数据的实时演示 管理员用户：[email protected]和密码：12345678

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

要求是：

• 红宝石 2.4+
• 导轨 4.2.x
• Postgres
• 像 Unicorn、Puma 或 Passenger 这样的服务器

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

• 像 Sendgrid 这样的电子邮件提供商
• Google Analytics 统计（可选）

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

• 报告或修复错误
• 重构
• 提高测试覆盖率-与任何大型且不断增长的代码库一样，测试覆盖率并不总是那么好。帮助提高测试覆盖率总是受欢迎的，并将帮助您了解 Helpy 的工作原理。我们专门使用 Minitest。
• 翻译项​​目 - 社区已经将 Helpy 翻译成 18 种语言，但还有更多语言等待。我们需要帮助将 Helpy 翻译成尽可能多的语言环境！详情请参阅翻译指南。
• 构建新功能。我们希望看到大量积压的新功能被构建。请查看我们的路线图，了解更多相关信息，如果您想参与其中，请与我们联系，以确保尚未有人参与其中。

一般准则：

• 加入我们的 Slack。让我知道您希望做出贡献。
• 让你的 PR 更加细化。每个 PR 应该只包含一项功能。
• 检查路线图：Trello如果您想构建一项功能，请联系我们以确保没有其他人正在开发它
• 您必须提供通过测试的覆盖率。我们使用 minitest，请参阅http:https://www.rubypigeon.com/posts/minitest-cheat-sheet/?utm_source=rubyweekly&utm_medium=email
• 您还必须向 API 公开功能。我们用葡萄。API 方法也应该进行测试。
• 如果您的功能/错误修复/增强添加或更改了项目中的文本，请在en.yml以及任何其他可以创建的语言环境中创建 i18n 字符串。
• 我们非常关心用户体验和良好的用户界面。通常，这意味着我们可能会拿走您贡献的内容并“打扮一下”或要求您做同样的事情。

如果您在 Helpy 中发现漏洞或其他安全问题，请不要在 GitHub 上打开问题。相反，请直接通过电子邮件联系 [ [email protected] ](mailto: [email protected] )。请参阅安全指南以了解更多信息并查看安全记者的名人堂。

版权所有 2016-2021，Helpy.io, LLC、Scott Miller 和贡献者。Helpy Core 是根据 MIT 开源许可证发布的。请回馈您所做的任何改进。另外，如果您在页脚中保留“由 Helpy 提供支持”的简介，我将不胜感激。这有助于我跟踪有多少人在使用 Helpy。