Cloud Projects
概述
概览标签页显示您最近的部署情况,包括构建和部署日志。在这里,您可以查看实时URL、部署详细信息(如时间戳和提交哈希)以及部署状态。您还可以手动触发重新部署,这将使用当前配置重新构建项目。
Cloud 项目概览页面的截图。
数据库
您的 Payload Cloud 项目配备了 MongoDB serverless Atlas 数据库实例或专用 Atlas 集群,具体取决于您的订阅计划。要与云数据库交互,您将获得一个 MongoDB 连接字符串。这可以在项目的数据库标签页下找到。
mongodb+srv://your_connection_string
文件存储
Payload Cloud 为您提供由 Cloudflare 作为 CDN 支持的 S3 文件存储,此插件扩展了 Payload,使所有媒体文件都将存储在 S3 而非本地。
AWS Cognito 用于对您的 S3 存储桶进行身份验证。Payload Cloud 插件会自动获取这些值。这些值仅在您需要在 Payload Cloud 之外直接访问文件时使用。
在 Payload Cloud 外部访问文件
若要在 Payload Cloud 外部访问你的文件,你需要从项目设置中获取一些值并将它们放入环境变量。在 Payload Cloud 中,导航至 File Storage 选项卡,使用复制按钮复制这些值。将这些值放入你的 .env 文件中。同时单独复制 Cognito 密码值并同样放入你的 .env 文件。
完成后,你的 .env 文件中应包含以下值:
PAYLOAD_CLOUD=true
PAYLOAD_CLOUD_ENVIRONMENT=prod
PAYLOAD_CLOUD_COGNITO_USER_POOL_CLIENT_ID=
PAYLOAD_CLOUD_COGNITO_USER_POOL_ID=
PAYLOAD_CLOUD_COGNITO_IDENTITY_POOL_ID=
PAYLOAD_CLOUD_PROJECT_ID=
PAYLOAD_CLOUD_BUCKET=
PAYLOAD_CLOUD_BUCKET_REGION=
PAYLOAD_CLOUD_COGNITO_PASSWORD=
插件将获取这些值并使用它们来访问你的文件。
构建设置
你可以从项目的 Settings 选项卡更新设置。对构建设置的更改将触发项目的重新部署。
环境变量
在 Settings 选项卡的 Environment Variables 页面,你可以添加、更新和删除项目使用的变量。与构建设置类似,这些更改将触发项目的重新部署。
注意:出于安全考虑,任何你想提供给 Admin Panel 的变量都必须以 NEXT_PUBLIC_
为前缀。更多详情。
自定义域名
通过 Payload Cloud,你可以为项目添加自定义域名。操作步骤如下:首先进入项目设置中的 Domains 页面,在这里你可以看到默认域名。要添加新域名,只需输入你想使用的域名。
注意:不要包含协议(http:// 或 https://)或任何路径(/page)。 只需输入域名和扩展名,可选择性地包含子域名。例如: your-domain.com backend.your-domain.com
点击保存后,系统会为你的域名生成一个 DNS 记录,指向你的线上项目。将此记录添加到你的 DNS 提供商处,待记录解析生效后(有时可能需要 1 小时至 48 小时),你的域名就会指向线上项目。
你还需要配置 Payload 项目以使用指定的域名。在 payload.config.ts
文件中,使用你的域名指定 serverURL
:
export default buildConfig({
serverURL: 'https://example.com',
// 其余配置
})
电子邮件功能
Payload Cloud 内置了由 Resend 提供支持的电子邮件功能,开箱即用。无需额外配置,你可以直接使用 payload.sendEmail()
从 Payload 应用中发送邮件。要了解更多关于 Payload 发送邮件的功能,请查看电子邮件配置概述。
如果你使用的是 Pro 或 Enterprise 计划,可以添加自己的自定义电子邮件域名。在项目设置的 Email 页面,添加你希望用于邮件发送的域名。系统会生成一组 DNS 记录。将这些记录添加到你的 DNS 提供商处,然后点击验证按钮检查记录是否解析正确。验证通过后,你的邮件就会从自定义域名发送。
本地开发
要对项目进行修改,你需要将项目设置中定义的代码仓库克隆到本地机器。为了在本地运行项目,首先需要配置本地开发环境。请参考代码仓库中的 README.md
文件,查看针对特定模板所需的步骤。
完成上述准备后,你就可以开始对项目进行更新了。当准备好将更改发布时,只需将修改提交到项目设置中指定的分支,你的应用就会自动触发重新部署,并基于最新提交进行构建。
云插件
从模板生成的项目会预装官方 Cloud Plugin,但如果你使用自己的代码仓库,则需要手动将其添加到项目中。为此,请将插件添加到你的 Payload 配置中:
pnpm add @payloadcms/payload-cloud
import { payloadCloudPlugin } from '@payloadcms/payload-cloud'
import { buildConfig } from 'payload'
export default buildConfig({
plugins: [payloadCloudPlugin()],
// 其余配置
})
注意: 如果你的 Payload 配置中已经设置了带有 transport 的 email 配置, 该配置将优先于 Payload Cloud 的邮件服务。
小知识:Payload Cloud Plugin 之前的名称为
@payloadcms/plugin-cloud
。如果你正在使用该插件,应该更新到新的包名称。
可选配置
如果你想禁用任何 Payload 云功能,该插件也接受相应的配置选项。
payloadCloud({
storage: false, // 禁用文件存储功能
email: false, // 禁用邮件发送功能
})