云服务管理
您可以使用云服务管理面板
或通过云服务管理 REST API
来管理协作服务器本地部署中的环境。
# 云服务管理面板
# 功能
云服务管理面板
应用程序可用于
- 创建、修改和删除环境。
- 向现有环境添加访问密钥或删除它。
- 管理 Webhooks 配置。
- 管理 API 密钥。
# 运行
云服务管理面板
位于/panel/
。 因此,如果应用程序在localhost
上的8000
端口启动,则面板位于https://127.0.0.1:8000/panel/
。
如果您使用 SSL 连接,您可能会遇到混合内容:位于 'https://you-domain-example.com/panel#/login' 的页面通过 HTTPS 加载,但请求了一个不安全的 XMLHttpRequest 端点...
错误。
在这种情况下,请参阅反向代理部分,详细了解X-Forwarded-Proto
标头或APPLICATION_EXTERNAL_ENDPOINT
配置变量。
# 使用
在启动应用程序后,即可通过云服务管理面板
管理环境。 您只需要在第一个屏幕上输入密钥,以允许面板与应用程序进行通信。
密钥是协作服务器本地部署配置中设置的ENVIRONMENTS_MANAGEMENT_SECRET_KEY
变量。
登录后,将显示第一个屏幕,其中列出了可管理的环境。
进入所选环境后,即可查看每个环境的详细信息,并可对其进行配置更改、密钥管理等操作。
# 安全
登录时提供的密钥会保存一个小时,在此时间过后,您需要再次输入密钥。 然而,云服务管理面板
是内置于应用程序中的,并且位于/panel/
。 因此,我们建议您在负载均衡器级别为面板地址添加身份验证。
为负载均衡器中的/panel/
URL 添加 HTTP 基本身份验证。
# 云服务管理 REST API
# 功能
云服务管理 REST API
包含与云服务管理面板
相同的功能,但没有提供 Web 界面。 然而,它可能对通过脚本自动管理环境非常有用。
# 运行
云服务管理 REST API
包含两个 API。 一个 API 用于管理环境,其文档可以在/environments/docs
找到。 另一个独立的 API 用于管理 Webhooks 配置,其文档可以在/webhooks/docs
找到。
# 使用
在启动应用程序后,即可立即使用云服务管理 REST API
。 但是,请注意,每个请求都必须包含授权标头。
有关授权的更多信息,请参阅安全部分。
在创建环境时,您需要指定环境支持的服务。 我们建议创建支持所有服务的环境。 此过程在面板中是自动化的,但 REST API 没有默认值,因此需要传递服务。 我们建议添加启用以下服务的环境:collaboration
、easy-image
。
有关使用服务创建环境的示例,请参阅此处。
每个 API 都以 API Explorer 的形式提供其文档。 API Explorer 展示了所有版本的文档,并会自动更新,其中包括一个有用的工具,用于探索和测试端点。 因此,可以从文档中直接使用/测试端点。
# 安全
发送到云服务管理 REST API
的每个请求都应包含授权标头(X-CS-Signature
和X-CS-Timestamp
)。 这与Restful API中描述的算法相同,此处有详细说明。