tiptap 合作模式运行时配置指南

本文档详细介绍了如何在应用中动态配置合作模式设置。这些设置允许您灵活管理协作环境，无需重启应用。

合作模式设置概览

可以动态调整的几个 键 值有：

• secret: JWT 令牌的密钥，首次启动时自动生成.
• api_secret: API 调用的密钥，用于 Authorization 头，初次启动时自动生成.
• webhook_url: 可选的接收回调的 Webhook URL.
• authentication_disabled: 开关，启用/禁用身份验证（1 表示禁用，0 表示启用，默认为 0）.
• name: 可选的实例名称.
• webhook_version: Webhook 版本.
• default_auto_versioning: 默认开启自动版本控制（1 表示启用，0 表示关闭）.
• default_auto_versioning_interval: 默认版本更新间隔（默认为 30 秒）.

通过 API 管理设置

合作平台提供了一个简单的 API 来管理这些设置：

创建或覆盖设置

要添加或更新设置，使用以下 API 调用：

curl --location --request PUT 'https://YOUR_APP_ID.collab.tiptap.cloud/api/admin/settings/:key' \
--header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA'

将 :key 替换为你想要更新的设置键。

列出当前设置

获取所有当前设置列表，使用此 API 请求：

curl --location 'https://YOUR_APP_ID.collab.tiptap.cloud/api/admin/settings' \
--header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA'

获取特定设置

要获取特定设置的值，使用如下命令：

curl --location 'https://YOUR_APP_ID.collab.tiptap.cloud/api/admin/settings/:key' \
--header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA'

更新特定设置

与创建设置类似，更新也通过以下方式完成：

curl --location --request PUT 'https://YOUR_APP_ID.collab.tiptap.cloud/api/admin/settings/:key' \
--header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA'

删除设置

要删除设置，使用以下 API 调用：

curl --location --request DELETE 'https://YOUR_APP_ID.collab.tiptap.cloud/api/admin/settings/:key' \
--header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA'

服务器性能指标

通过 /api/statistics 端点获取服务器性能洞察和文档统计信息，包括总文档数、并发连接峰值、过去 30 天的总连接数和生命周期连接计数。

curl --location 'https://YOUR_APP_ID.collab.tiptap.cloud/api/statistics' \
--header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA'

注意：过去 30 天的总连接数和生命周期连接计数以字符串形式呈现，因为它们在内部表示为 BIGINT 类型.

本专门的文档页面旨在阐明调整合作模式运行时设置的过程，确保开发者能够有效地管理他们的协作环境。