CKEditor 生态系统文档
Search
主页/云服务/本地部署

guide协作功能

协作功能包含在本地部署服务器中，以启用以下功能

  • 文档存储，
  • 导入和导出，
  • 连接优化

这些功能的完整文档可以在 介绍 指南中找到。

协作功能提供的功能与 SaaS 版本的功能相同。但是，必须对其进行正确配置。
目前，协作功能支持多个驱动程序，以便将文档及其数据存储在不同的位置。

支持

# 可靠性

协作功能消耗大量 CPU 资源。如果大量使用这些功能，建议使用外部 CKEditor 协作工作者 来提高可靠性。

# 配置

要配置协作功能，需要设置相应的环境变量。

COLLABORATION_STORAGE_DRIVER             - optional (default: "database")
COLLABORATION_STORAGE_LOCATION           - optional (default: "/var/cs/easyimage" if "filesystem" driver chosen, required for file system driver)
COLLABORATION_STORAGE_ACCESS_KEY_ID      - optional (required for AWS S3 driver)
COLLABORATION_STORAGE_SECRET_ACCESS_KEY  - optional (required for AWS S3 driver)
COLLABORATION_STORAGE_REGION             - optional (required for AWS S3 driver)
COLLABORATION_STORAGE_ENDPOINT           - optional (required for AWS S3 driver)
COLLABORATION_STORAGE_BUCKET             - optional (required for AWS S3 driver)
COLLABORATION_STORAGE_ACCOUNT_NAME       - optional (required for Azure Blob Storage driver)
COLLABORATION_STORAGE_ACCOUNT_KEY        - optional (required for Azure Blob Storage driver)
COLLABORATION_STORAGE_CONTAINER          - optional (required for Azure Blob Storage driver)

# 数据库（默认）

要将协作功能数据保存在 SQL 数据库中，只需设置驱动程序即可。文档将以 blob 的形式保存，保存在数据库配置中配置的数据库中（目前支持 MySQL 和 Postgres）。

COLLABORATION_STORAGE_DRIVER=database

# 文件系统

要使用文件系统保存协作功能数据，请将（collaboration_storage_driver）驱动程序设置为 filesystem，并指定（collaboration_storage_location）路径。

如果运行应用程序的多个实例，并使用负载均衡器在实例之间分配流量，则必须记住，文档应保存到一个共享位置。可以使用 NFS 磁盘或其他解决方案。

您还可以使用其他驱动程序，例如 AWS S3、Azure Blob 存储 或 数据库。

COLLABORATION_STORAGE_DRIVER=filesystem
COLLABORATION_STORAGE_LOCATION=/var/cs/documents

始终应挂载 /path/to/your/dir:/var/cs/documents 卷，以便在容器被删除时保留上传的文件。

COLLABORATION_STORAGE_LOCATION 变量指定保存文档的路径，但这是容器中的路径。因此，应给出挂载卷的路径。

# AWS S3

要将协作功能数据保存在 AWS S3 中，请将驱动程序（collaboration_storage_driver）设置为 s3，并指定 AWS S3 的配置。要配置 AWS S3，请提供以下变量的数据

  • collaboration_storage_region - 发送服务请求的区域，

  • collaboration_storage_access_key_id - 您的 AWS 访问密钥 ID，

  • collaboration_storage_secret_access_key - 您的 AWS 秘密访问密钥，

  • collaboration_storage_endpoint - 发送请求的端点 URI。例如，可以使用与 S3 兼容的服务（例如 MinIO、localstack 等）。端点必须指定其协议，例如 s3://、https:// 等。
    默认情况下，它以格式 https://s3.[COLLABORATION_STORAGE_REGION].amazonaws.com 生成。

COLLABORATION_STORAGE_DRIVER=s3
COLLABORATION_STORAGE_REGION=[AWS_REGION]
COLLABORATION_STORAGE_ACCESS_KEY_ID=[AWS_ACCESS_KEY_ID]
COLLABORATION_STORAGE_SECRET_ACCESS_KEY=[AWS_SECRET_ACCESS_KEY]
COLLABORATION_STORAGE_BUCKET=[AWS_S3_BUCKET]
COLLABORATION_STORAGE_ENDPOINT=[AWS_S3_ENDPOINT]

# Azure Blob 存储

要将协作功能数据保存在 Azure Blob 存储中，请将（collaboration_storage_driver）驱动程序设置为 azure，并指定 Azure Blob 存储的配置。要配置 Azure Blob 存储，请提供以下变量的数据

  • collaboration_storage_account_name - 您的 Azure 帐户名称，

  • collaboration_storage_account_key - 您的 Azure 帐户密钥，

  • collaboration_storage_container - 您的 Azure Blob 存储容器名称。

  • collaboration_storage_endpoint - 发送请求的端点 URI。端点必须指定其协议，例如 https://。
    默认情况下，它以格式 https://[COLLABORATION_STORAGE_ACCOUNT_NAME].blob.core.windows.net 生成。

COLLABORATION_STORAGE_DRIVER=azure
COLLABORATION_STORAGE_ACCOUNT_NAME=[AZURE_ACCOUNT_NAME]
COLLABORATION_STORAGE_ACCOUNT_KEY=[AZURE_ACCOUNT_KEY]
COLLABORATION_STORAGE_CONTAINER=[AZURE_CONTAINER]
COLLABORATION_STORAGE_ENDPOINT=[AZURE_ENDPOINT]