firesphere / stripeslack
轻松邀请新用户加入您的 Slack 群组
Requires
- silverstripe/cms: ~3.1
- silverstripe/framework: ~3.1
Requires (Dev)
This package is auto-updated.
Last update: 2024-09-16 06:53:10 UTC
README
邀请用户加入您的公共 Slack 频道非常难以自动化。
此模块旨在至少使这一过程变得容易一些。
尽管最初步骤看似令人望而却步,但我已尽可能详细地描述了它们。一旦完成一次,下次就会变得轻而易举。
为什么选择 StripeSlack
与其他需要第三方完全管理访问 Slack 工作空间的服务的不同,StripeSlack 完全由您控制。您无需信任第三方,无需担心它们仅仅是为了收集电子邮件地址而运营。
尽管提交内容存储在数据库中,但这是在您自己的服务器上。存储的原因是,如果您出现错误,可以重新发送邀请。
免责声明
除非您添加复选框让用户也注册您的通讯稿,否则此模块明确不打算添加此功能,因此请勿滥用存储电子邮件地址为此目的。
做一个有教养的人。
先决条件
您的团队中需要有人是 Slack 用户组的管理员,或者与管理员有联系,以便设置。
注意事项
看起来很难设置 Slack。您需要跳过很多步骤。请仔细遵循说明。完成之后,您会发现其实并没有那么难,只是几步看起来有点令人困惑。
安装
- 选项 1,使用 Composer
composer require firesphere/stripeslack
- 选项 2,下载
从 GitHub 下载 zip 文件
最后,运行 https://yourdomain.com/dev/build?flush=all
设置 Slack
注意
- 为此,您需要是 Slack 频道的管理员。
- 执行步骤的管理员将是发送邀请的人。
- 不要对需要完成的步骤数量感到惊讶。我已经尽可能详细地描述了。
- 转到 Slack API 网站。
- 滚动到 认证 部分,然后点击 注册应用程序。
- 您将看到一个模态窗口,您可以在其中为应用程序命名,并从下拉菜单中选择应用程序要为哪个组工作。
- 创建后,您将看到一个 基本信息 屏幕。
- 点击 添加功能和功能。
- 点击 权限。
- 滚动到 重定向 URL。
- 输入应用程序将从中操作的网络地址,例如
https://www.silverstripe.org
。最好是https
网站。 - 点击 保存 URL 按钮。
- 继续向下滚动到 作用域。
- 在 选择权限作用域 下,选择 管理工作空间。
- 点击 保存更改。
- 向上滚动到顶部,然后点击按钮 将应用程序安装到工作空间。
- 在左侧,点击 基本信息 返回到基本信息。
- 现在您已完成 Slack 的设置。
设置 StripeSlack
在设置 Slack 后,还需要进行一些其他步骤。
- 在新标签页或窗口中,打开您的 CMS 并转到 设置。
- 选择 Slack 选项卡。
- 输入您的 Slack 工作空间网址(例如
https://silverstripe-users.slack.com
)。 - 选择您希望用户被邀请的默认频道(通常是通用频道)。
- 您可以通过右键点击您的频道并选择“复制链接”来获取ID。
- 在浏览器中打开复制的链接,并复制“messages/”后面的部分。
- 将此代码粘贴到您的频道ID字段。
- 返回您的Slack应用在基本信息部分,向下滚动查看应用凭证。
- 复制客户端ID。
- 将客户端ID粘贴到CMS的客户端ID字段。
- 回到Slack应用,点击显示下的客户端密钥。
- 复制现在可见的客户端密钥。
- 将客户端密钥粘贴到CMS的客户端密钥字段。(注意:它将以密码形式粘贴,请放心,它会被正确存储)。
- 选择成功发送邀请后用户将被重定向到的网页,以及失败时的情况。
- 保存网站设置
- 您将看到一个可以点击的链接,以授权您的应用。
- 点击链接将被重定向到Slack,它将要求您为此应用提供管理员权限。
- 权限完全由您控制,并且应用是本地安装的
- 第三方将无法获得管理员访问权限。
- 此存储库不会从您那里收集任何数据。
- 接受后,您将被重定向回CMS。您的应用现在可以使用了。
将表单添加到您的网站
您可以创建一个StripeSlackPage类型,这将帮助您设置一切。它允许您设置成功和错误消息。
例如,如果您想将注册表单放在页脚中,您可以在选择添加表单的位置简单地包括$SlackForm
到您的模板中(如果需要,您可能需要添加$Top
)然后表单应该会出现。
文本更改可以在您的基项目中一个翻译文件中进行。请参见stripeslack\lang\en.yml
的示例。
表单的样式和设计
表单完全依赖于提供的FormField
模板。所以样式完全取决于您。
待办事项
- [|] 添加测试
- 将邀请发送到特定的频道
- 通过CMS重新发送邀请
- 从使用
RestfulService
(已在SS4中删除)转移到使用Guzzle
- SilverStripe 4兼容版本
- 添加一个短代码以在CMS中使用[slackform]
牛?
/( ,,,,, )\
_\,;;;;;;;,/_
.-"; ;;;;;;;;; ;"-.
'.__/`_ / \ _`\__.'
| (')| |(') |
| .--' '--. |
|/ o o \|
| |
/ \ _..=.._ / \
/:. '._____.' \
;::' / \ .;
| _|_ _|_ ::|
.-| '==o==' '|-.
/ | . / \ | \
| | ::| | | .|
| ( ') (. )::|
|: | |; U U ;|:: | `|
|' | | \ U U / |' | |
##V| |_/`"""`\_| |V##
##V## ##V##
许可
版权所有2017 Firesphere
重新分发和使用源代码和二进制代码,无论是否修改,只要满足以下条件:
-
源代码重新分发必须保留上述版权声明、本条款清单和以下免责声明。
-
二进制形式的重新分发必须复制上述版权声明、本条款清单和以下免责声明在随分发提供的文档或其他材料中。
-
未经版权所有者或其贡献者事先书面许可,不得使用版权所有者的名称或其贡献者的名称来认可或推广由此软件衍生出的产品。
本软件按“原样”提供,并明确或暗示地放弃任何明示或暗示的保证,包括但不限于适销性和针对特定目的的适用性的暗示保证。在任何情况下,版权所有者或贡献者均不对任何直接、间接、偶然、特殊、示范性或后果性的损害(包括但不限于替代商品或服务的采购;使用、数据或利润的丧失;或业务中断)负责,无论此类损害是否由于本软件的使用或此类损害的可能性。
第三方许可
CMS中用于Slack的图片是Slack提供的灰度官方图片。图片的版权属于Slack Ltd。