mirror of
https://github.com/logto-io/logto.git
synced 2024-12-16 20:26:19 -05:00
chore(connector): remove Apple/SMTP connector README files CHN part (#4256)
* chore(connector): remove apple/smtp Chinese part from README * refactor: update README.md --------- Co-authored-by: Gao Sun <gao@silverhand.io>
This commit is contained in:
Darcy Ye
GitHub
parent
a8a26a5299
commit
fe54bbafe2
2 changed files with 0 additions and 179 deletions
|
|
@ -2,8 +2,6 @@
|
|||
|
||||
The official Logto connector for Apple social sign-in.
|
||||
|
||||
Apple 社交登录 Logto 官方连接器 [中文文档](#apple-连接器)
|
||||
|
||||
**Table of contents**
|
||||
|
||||
- [Apple connector](#apple-connector)
|
||||
|
|
@ -12,12 +10,6 @@ Apple 社交登录 Logto 官方连接器 [中文文档](#apple-连接器)
|
|||
- [Create an identifier](#create-an-identifier)
|
||||
- [Enable Sign in with Apple for your identifier](#enable-sign-in-with-apple-for-your-identifier)
|
||||
- [Test Apple connector](#test-apple-connector)
|
||||
- [Apple 连接器](#apple-连接器)
|
||||
- [开始上手](#开始上手)
|
||||
- [为你的应用启用「通过 Apple 登录」](#为你的应用启用通过-apple-登录)
|
||||
- [创建一个 identifier](#创建一个-identifier)
|
||||
- [为你的 identifier 启用「通过 Apple 登录」](#为你的-identifier-启用通过-apple-登录)
|
||||
- [测试 Apple 连接器](#测试-apple-连接器)
|
||||
|
||||
## Get started
|
||||
|
||||
|
|
@ -78,65 +70,3 @@ Click "Next" then "Done" to close the modal. Click "Continue" on the top-right c
|
|||
## Test Apple connector
|
||||
|
||||
That's it. The Apple connector should be available in both web and native apps. Don't forget to [Enable connector in sign-in experience](https://docs.logto.io/docs/tutorials/get-started/passwordless-sign-in-by-adding-connectors#enable-social-sign-in).
|
||||
|
||||
# Apple 连接器
|
||||
|
||||
## 开始上手
|
||||
|
||||
如果你还不知道连接器的概念，或者还不知道如何将本连接器添加至你的「登录体验」，请先参见 [Logto 教程](https://docs.logto.io/zh-cn/docs/tutorials/get-started/enable-social-sign-in)。
|
||||
|
||||
> ℹ️ **Note**
|
||||
>
|
||||
> 如果你的应用有其他的社交登录方式，AppStore 要求必须同时有 Apple 登录。
|
||||
> 如果同时提供 Android 应用，在 Android 设备上同时提供 Apple 登录会让用户体验很棒。
|
||||
|
||||
在继续前，你需要加入 [Apple Developer Program](https://developer.apple.com/programs/)。
|
||||
|
||||
### 为你的应用启用「通过 Apple 登录」
|
||||
|
||||
> ⚠️ **Caution**
|
||||
>
|
||||
> 即使你只想在 web 应用中实现「通过 Apple 登录」，你仍需要拥有一个拥抱 AppStore 生态的应用（即：有一个有效的 App ID）。
|
||||
|
||||
你可以通过 Xcode -> Project settings -> Signing & Capabilities 来启用，或者访问 [Certificates, Identifiers & Profiles](https://developer.apple.com/account/resources/identifiers/list/bundleId)。
|
||||
|
||||
|
||||
|
||||
参见 [Apple 官方文档](https://developer.apple.com/documentation/sign_in_with_apple/configuring_your_environment_for_sign_in_with_apple) 里的「Enable an App ID」章节以了解更多。
|
||||
|
||||
### 创建一个 identifier
|
||||
|
||||
1. 访问 [Certificates, Identifiers & Profiles](https://developer.apple.com/account/resources/identifiers/list/serviceId)，并点按在「Identifier」旁边的「+」按钮。
|
||||
2. 在「Register a new identifier」页面，选择「Services IDs」并点按「Continue」。
|
||||
3. 填写「Description」与「Identifier」（例如 `Logto Test` 和 `io.logto.test`），并点按「Continue」。
|
||||
4. 再次检查相关信息并点按「Register」。
|
||||
|
||||
### 为你的 identifier 启用「通过 Apple 登录」
|
||||
|
||||
点按你刚刚创建的 identifier。在详情页勾选「Sign in with Apple」并点按「Configure」。
|
||||
|
||||
|
||||
|
||||
在打开的对话框中，选择刚刚启用了「通过 Apple 登录」的 App ID。
|
||||
|
||||
输入你的 Logto 实例域名（不含协议和端口），例如 `your.logto.domain`；并输入「Return URL」（即 Redirect URI）。Return URL 的值是 Logto URL 加上 `/callback/${connector_id}`，例如 `https://your.logto.domain/callback/apple-universal`。在管理控制台创建了 Apple 连接器之后，在详情页可以找到生成的随机 `connector_id`。
|
||||
|
||||
|
||||
|
||||
点按「Next」以及「Done」以关闭对话框。点按右上角的「Continue」，接着点按「Save」以保存你的配置。
|
||||
|
||||
> ⚠️ **Caution**
|
||||
>
|
||||
> Apple _不允许_ HTTP 协议或 `localhost` 域名作为 Return URL。
|
||||
>
|
||||
> 如果你想在本地进行测试，你需要编辑 `/etc/hosts` 文件以映射 localhost 到一个自定义域名，并设置一个本地的 HTTPS 环境。[mkcert](https://github.com/FiloSottile/mkcert) 可以帮助你设置本地 HTTPS。
|
||||
|
||||
> ℹ️ **Note**
|
||||
>
|
||||
> 本连接器暂时不支持自定义 `scope`（例如 name，email）。因为在 `scope` 非空时，Apple 要求 `response_mode` 为 `form_post`，与现在连接器的设计不兼容。
|
||||
>
|
||||
> 我们将稍后解决这个问题。
|
||||
|
||||
## 测试 Apple 连接器
|
||||
|
||||
大功告成。Apple 连接器应该在 web 和原生应用中都可用了。别忘了 [在登录体验中启用本连接器](https://docs.logto.io/docs/tutorials/get-started/passwordless-sign-in-by-adding-connectors#enable-social-sign-in)。
|
||||
|
|
|
|||
|
|
@ -2,8 +2,6 @@
|
|||
|
||||
The official Logto connector for SMTP.
|
||||
|
||||
SMTP Logto 官方连接器 [中文文档](#smtp-连接器)
|
||||
|
||||
**Table of contents**
|
||||
|
||||
- [SMTP connector](#smtp-connector)
|
||||
|
|
@ -14,16 +12,6 @@ SMTP Logto 官方连接器 [中文文档](#smtp-连接器)
|
|||
- [Configure with Aliyun direct mail account](#configure-with-aliyun-direct-mail-account)
|
||||
- [Test SMTP connector](#test-smtp-connector)
|
||||
- [Config types](#config-types)
|
||||
- [References](#references)
|
||||
- [SMTP 连接器](#smtp-连接器)
|
||||
- [开始上手](#开始上手)
|
||||
- [设置 SMTP 连接器](#设置-smtp-连接器)
|
||||
- [SMTP 连接器对接 Gmail 的配置](#smtp-连接器对接-gmail-的配置)
|
||||
- [集成 SendGrid SMTP API](#集成-sendgrid-smtp-api)
|
||||
- [针对阿里云邮件帐号的配置](#针对阿里云邮件帐号的配置)
|
||||
- [测试 SMTP 连接器](#测试-smtp-连接器)
|
||||
- [配置类型](#配置类型)
|
||||
- [参考](#参考)
|
||||
|
||||
## Get started
|
||||
|
||||
|
|
@ -102,100 +90,3 @@ That's it. Don't forget to [Enable connector in sign-in experience](https://docs
|
|||
You can also configure [OAuth2 Auth Options](https://nodemailer.com/smtp/oauth2/) and other advanced configurations. See [here](https://nodemailer.com/smtp/) for more details.
|
||||
|
||||
We gave an example config with all configurable parameters in the text box to help you to set up own configuration. (You are responsible to the configuration, some values are for demonstration purpose and may not fit your use case.)
|
||||
|
||||
## References
|
||||
|
||||
- [Gmail - Send email from a printer, scanner, or app](https://support.google.com/a/answer/176600)
|
||||
- [SendGrid - Integrating with the SMTP API](https://docs.sendgrid.com/for-developers/sending-email/integrating-with-the-smtp-api)
|
||||
- [Aliyun Direct Mail - Send emails using SMTP](https://www.alibabacloud.com/help/en/directmail/latest/send-emails-using-smtp)
|
||||
- [Aliyun Direct Mail - SMTP Reference](https://www.alibabacloud.com/help/en/directmail/latest/smtp-reference)
|
||||
- [Nodemailer - SMTP Transport](https://nodemailer.com/smtp/)
|
||||
|
||||
# SMTP 连接器
|
||||
|
||||
## 开始上手
|
||||
|
||||
SMTP（简单邮件传输协议）是一种在网络中传输电子邮件的标准通信协议。邮件服务器和其他信息传输代理用 SMTP 来收发邮件。
|
||||
|
||||
## 设置 SMTP 连接器
|
||||
|
||||
SMTP 是一个所有邮件服务提供商通用的传输协议。
|
||||
|
||||
我们提供了 SMTP 连接器用于以下几种邮件服务提供商的使用指南，帮助你有更好的理解：
|
||||
|
||||
- _Gmail_ 是世界上最受欢迎的邮件服务商
|
||||
- _阿里云邮件_ 和 _SendGrid_（Logto 提供了对接这两个服务商的连接器，因此你们也许会对这两个服务商比较熟悉并有一个基本概念）
|
||||
|
||||
希望在浏览了以下几个案例之后，你能够处理大部分其他邮件服务的配置 :rocket:
|
||||
|
||||
### SMTP 连接器对接 Gmail 的配置
|
||||
|
||||
你可以使用已有的 Gmail 邮箱或者通过 [Gmail](https://mail.google.com/) 创建一个新的账号。
|
||||
|
||||
前往这篇 [Gmail 官方帮助文档](https://support.google.com/a/answer/176600)，查看如何得到 SMTP 连接器调用 Gmail 服务所 **必须的** 属性。
|
||||
|
||||
### 集成 SendGrid SMTP API
|
||||
|
||||
我们假设你已经有了 SendGrid 账号，否则就在 [SendGrid](https://app.sendgrid.com/) 创建新账号。
|
||||
|
||||
在 [集成 SendGrid SMTP API](https://docs.sendgrid.com/for-developers/sending-email/integrating-with-the-smtp-api) 可以找到详尽的集成指南。
|
||||
|
||||
开发者可以前往 [_Sender Management_](https://mc.sendgrid.com/senders) 以访问相应的 _sender_ 详情。
|
||||
|
||||
### 针对阿里云邮件帐号的配置
|
||||
|
||||
登录 [阿里云](https://cn.aliyun.com/) 并创建新账号。
|
||||
|
||||
跟随 [使用 SMTP 发送邮件](https://www.alibabacloud.com/help/zh/directmail/latest/send-emails-using-smtp)，完成里面的各个步骤以获取需要的配置和信息。
|
||||
|
||||
前往 [SMTP 服务地址](https://www.alibabacloud.com/help/zh/directmail/latest/smtp-service-address) 并选择合适的 SMTP 服务地址与端口号。
|
||||
|
||||
在 [阿里云工作台](https://dm.console.aliyun.com/) 侧边栏中找到「发信地址」，在这里你可以找到 `Sender address` 和 `SMTP Password`。
|
||||
|
||||
> ℹ️ **注意**
|
||||
>
|
||||
> 简单起见，前面提及的所有例子都只给出了一个模板样例。如果要满足其他更多场景的使用，你需要自己添加更多模板。
|
||||
> 用尖括号 "<" 和 ">" 包起来的值需要根据 Google，SendGrid 或阿里云账号来重新填写，其他的设置可以按需进行调整。
|
||||
> 在模板的内容中加上 `{{code}}` 的占位符以在所发送邮件正文的相同位置插入随机验证码。
|
||||
|
||||
### 测试 SMTP 连接器
|
||||
|
||||
你可以在「保存并完成」之前输入一个手机号码并点按「发送」来测试配置是否可以正常工作。
|
||||
|
||||
大功告成！快去 [启用短信或邮件验证码登录](https://docs.logto.io/docs/tutorials/get-started/passwordless-sign-in-by-adding-connectors#enable-sms-or-email-passwordless-sign-in) 吧。
|
||||
|
||||
### 配置类型
|
||||
|
||||
| 名称 | 类型 |
|
||||
|-----------|------------|
|
||||
| host | string |
|
||||
| port | string |
|
||||
| fromEmail | string |
|
||||
| templates | Template[] |
|
||||
|
||||
| 模板属性 | 类型 | 枚举值 |
|
||||
|-------------|-------------|------------------------------------------------------|
|
||||
| subject | string | N/A |
|
||||
| content | string | N/A |
|
||||
| usageType | enum string | 'Register' \| 'SignIn' \| 'ForgotPassword' \| 'Generic' |
|
||||
| contentType | enum string | 'text/plain' \| 'text/html' |
|
||||
|
||||
**用户名密码的授权配置**
|
||||
|
||||
| 模板属性 | 类型 | 枚举值 |
|
||||
|----------|------------------------|---------|
|
||||
| user | string | N/A |
|
||||
| pass | string | N/A |
|
||||
| type | enum string (OPTIONAL) | 'login' |
|
||||
|
||||
你也可以使用 [OAuth2 授权配置](https://nodemailer.com/smtp/oauth2/) 和其他高级的 SMTP 配置。点按 [这里](https://nodemailer.com/smtp/) 了解更多.
|
||||
|
||||
我们在文本输入框预填的配置样例里预填了所有可配置的参数，以便你可以用来参考并建立自己的配置。（你需要对自己的配置负责，样例配置中展示的一些值是为了示意，可能并不适用你的用户场景。）
|
||||
|
||||
## 参考
|
||||
|
||||
- [Gmail - 从打印机、扫描仪或应用发送电子邮件](https://support.google.com/a/answer/176600?hl=zh-Hans)
|
||||
- [SendGrid - Integrating with the SMTP API](https://docs.sendgrid.com/for-developers/sending-email/integrating-with-the-smtp-api)
|
||||
- [阿里云邮件推送 - 使用 SMTP 发送邮件](https://www.alibabacloud.com/help/zh/directmail/latest/send-emails-using-smtp)
|
||||
- [阿里云邮件推送 - SMTP 参考](https://www.alibabacloud.com/help/zh/directmail/latest/smtp-reference)
|
||||
- [Nodemailer - SMTP Transport](https://nodemailer.com/smtp/)
|
||||
|
|
|
|||
Loading…
Reference in a new issue