指南CKBox 本地部署

# 2.6.0 (2024-10-10)

# 功能

  • 添加了为非图像资产设置自定义缩略图的功能

    添加了一个新的端点 POST:/assets/{{assetId}}/thumbs,允许上传作为资产自定义缩略图的图像。

  • 添加了私有类别

    此功能将使管理员能够将某些资产类别标记为私有,限制选定用户或组对其内容的访问,从而在内容共享方面增加了控制层级。

# 其他变更

  • 更新了依赖项

    已将选定的依赖项更新到最新版本,提高了性能和安全性。

# 2.5.0 (2024-08-27)

# 功能

  • 引入了权限功能

    权限允许对用户访问特定功能和操作进行细粒度的控制。通过分配权限,管理员可以规范用户与资产、类别和文件夹的交互。权限引入了对以下方面的控制:

    • 访问类别
    • 创建资产
    • 删除资产
    • 修改资产
    • 修改资产元数据
    • 创建文件夹
    • 修改文件夹元数据
    • 删除文件夹
  • 添加了一个配置选项来指示 CKBox 在上传期间允许的最大文件大小

    一个新的 CKBox 本地部署配置选项 max_file_size_in_bytes_limit 将允许将最大文件上传大小从默认的 32GB 限制限制到配置中指示的大小。

# 修复

  • 提高了工作区性能

    工作区信息以更优化的方式获取。

  • 改进了 Webhook 功能中的错误处理

  • 提高了将多个文件上传到文件夹的性能

    增强了多个文件的上传进度,尤其是在目标文件夹时。

  • 更新了依赖项

    已将选定的依赖项更新到最新版本,提高了性能和安全性。

# 2.4.3 (2024-07-16)

# 其他变更

  • 更新了依赖项

    已将选定的依赖项更新到最新版本,提高了性能和安全性。

# 2.4.2 (2024-06-04)

# 修复

  • 更新了资产更新期间资产 MIME 类型的处理

    解决了在更新资产数据时更新 MIME 类型的错误。MIME 类型将根据新的文件扩展名正确更新。

# 其他变更

  • 更新了依赖项

    已将选定的依赖项更新到最新版本,提高了性能和安全性。

# 2.4.1 (2024-04-23)

# 其他变更

  • 提高了整体性能

    增强了特定操作的响应速度和速度。

  • 更新了依赖项

    已将选定的依赖项更新到最新版本,提高了性能和安全性。

# 2.4.0 (2024-03-12)

# 功能

  • 引入了 Webhook

    我们在应用程序中添加了对 webhook 的支持。通过集成 Webhook,第三方应用程序将能够在以下情况时收到通知:

    • 资产被修改时,
    • 资产被覆盖时,
    • 资产被复制时,
    • 资产缓存应失效时,
    • 文件夹被创建时,
    • 文件夹被修改时,
    • 文件夹被删除时。
  • 更改了上传文件的要求

    在将资产上传到 CKBox 时,不再需要 categoryId。现在 categoryIdfolderId 都是可选的,目标上传类别根据管理员定义的类别设置推断。

# 修复

  • 修复了请求带有大写扩展名的图像的问题

    现在包含大写扩展名(例如 JPG)的图像 URL 被视为有效。

  • 提高了整体性能

    增强了选定操作的响应速度和速度。

  • 更新了依赖项

    已将选定的依赖项更新到最新版本,提高了性能和安全性。

# 2.3.1 (2024-01-23)

# 修复

  • 修复了与上传大型文件相关的问题,解决了随机超时错误

    将实际上传超时时间增加到 4 小时,确保大型文件上传能够成功完成,而不会遇到超时错误。

  • 修复了突然关闭连接的问题

    实施了措施以防止意外连接中断,例如,在上传过程中关闭 CKBox 时,正确处理突然关闭的连接。

  • 提高了整体性能

    增强了工作区的响应速度和速度。

# 其他变更

  • 更新了依赖项

    已将选定的依赖项更新到最新版本,提高了性能和安全性。

# 2.3.0 (2023-12-19)

# 其他变更

  • 改进了与 CKBox 应用程序的集成

    一些用于工作区的内部机制已被调整,以允许通过 CKBox 的图像编辑器编辑外部 Web 图像。

  • 更新了依赖项

    已将选定的依赖项更新到最新版本,提高了性能和安全性。

# 2.2.0 (2023-11-14)

# 功能

  • 添加了全局限制环境中所有工作区允许的扩展名的选项

    添加了用于更改全局扩展名限制的新端点

    • GET:/admin/environmentConfig 返回一个描述环境扩展名限制的对象,其中包含属性

      • allowedExtensions,它是一个包含允许在环境中上传的扩展名的字符串数组
      • isAllowedExtensionsEnabled,它是一个标志,指示在环境中限制扩展名是启用还是禁用
    • PUT:/superadmin/environmentConfig 允许修改整个环境的允许扩展名配置
      注意:以上端点仅对 SuperAdmin 用户可用。

  • 扩展了获取工作区列表 GET:/workspaces 响应的有效负载

    该端点现在将包含其他属性

    • allowedExtensions 是一个包含环境中所有工作区允许的所有扩展名的字符串数组
    • extensionsInUse 是一个包含当前环境中所有工作区正在使用的资产扩展名列表的字符串数组

    注意:扩展后的响应仅对 SuperAdmin 用户可用。

# 修复

  • 改进了资产处理的性能

  • 修复了将大型文件上传到 CKBox 的问题

    已修复上传可能需要超过 30 分钟才能上传的文件时出现的超时问题。

# 其他变更

  • 更新了依赖项

    已将选定的依赖项更新到最新版本,提高了性能和安全性。

# 2.1.0 (2023-09-27)

# 功能

  • 在 CKBox 中添加了全局环境配置管理

    添加了用于更改全局环境配置的新端点

    • GET:/superadmin/workspacesTemplate 返回一个应在环境中创建的新工作区中创建的类别列表
    • PUT:/superadmin/workspacesTemplate 允许修改在新建工作区中创建的类别列表

# 修复

  • 修复了与复合图像编辑操作有关的问题

    引入了图像编辑端点 POST:/assets/{assetId}/editImage 的版本 2,该版本在所有图像文件格式中都保留了操作顺序

    1. 翻转在任何其他操作之前应用。
    2. 然后应用旋转。
    3. 然后应用裁剪。
    4. 然后应用调整大小。

    这修复了如果先前翻转或旋转了图像,则图像部分被错误裁剪的问题。

  • 修复了通过 TLS 连接连接到数据库时出现的问题

    TLS 连接不可用,现在可以正确使用 TLS。

# 其他变更

  • 在一些与资产相关的端点中弃用了查询参数 workspaceId

    workspaceId 参数以前在我们的端点中用作查询参数,现已弃用,不再要求用于以下端点:GET:/assets/{assetId}/offsetPOST:/assets/{assetId}PATCH:/assets/{assetId}PATCH:/assets/{assetId}/metadata

  • 为 CKBox 中的图像编辑添加了最大宽度和高度的验证规则

    现在将已编辑图像的最大尺寸(宽度或高度)限制为 16383px

  • 改进了释放未使用数据库连接的机制

  • 更新了依赖项

    已将选定的依赖项更新到最新版本,提高了性能和安全性。

# 2.0.0 (2023-08-22)

注意:CKBox 本地部署 2.0.0 不包含任何重大更改,版本控制仅与 CKBox 的前端部分共享,该部分包含重大更改。

# 修复

  • 修复了处理文件名中包含某些 UNICODE 组合重音的文件的问题

  • 修复了在带有 Postgres 数据库的 CKBox 配置中同时上传多个文件的问题

# 其他变更

  • 调整了图像编辑的过程

    如果已编辑图像保存为新文件,则资产的描述和分配的标签现在将复制到新创建的资产。

  • 提高了图像缩放的性能

    调整了图像处理,以加快图像处理速度并提高缩放性能。

  • 优化了 CPU 使用率

  • 更新了依赖项

    已将选定的依赖项更新到最新版本,提高了性能和安全性。

# 1.6.0 (2023-07-13)

# 功能

  • 在资产的元数据中添加了 metadataProcessingStatus 属性

    新属性提供有关处理图像元数据状态的信息。

  • 添加了资产覆盖功能

    添加了一个新的 POST:/assets/:assetId 端点,使用户能够覆盖资产的文件内容。

  • 添加了资产偏移功能

    添加了一个新的 GET:/assets/:assetId/offset 端点,提供功能来确定资产在类别或文件夹中的位置偏移,该位置偏移基于特定的排序条件。

  • 添加了工作区功能

工作区在同一个环境中创建了完全独立的 CKBox 实例,这实际上与使用独立环境所能实现的效果非常接近。

新增了 4 个专门用于工作区管理的端点。

  • POST:/superadmin/workspaces 在环境中创建新的工作区。
  • PUT:/superadmin/workspaces/:workspaceId 修改工作区。
  • DELETE:/superadmin/workspaces/:workspaceId 删除工作区。
  • GET:/workspaces 返回用户有权访问的所有工作区列表。
  • 添加了图像编辑功能。

    图像编辑 API 允许对图像资源执行各种操作。编辑操作可以通过新的端点 POST:/assets/:assetId/edit 执行。

    此类 API 支持的一些常见图像操作包括:

    • 裁剪:此操作可以选择图像的指定部分,并删除其余部分。这有助于将注意力集中在特定主题或删除不需要的元素。
    • 调整大小:此操作允许更改图像的尺寸(宽度和高度),可以按比例进行,也可以指定自定义尺寸。
    • 旋转:此操作允许将图像以设定的角度旋转。顺时针或逆时针旋转 90 度。
    • 翻转:翻转允许用户水平或垂直镜像图像。

# 修复

  • 修复了 Redis 集群 TLS 选项。

    修复了 Redis 集群的 TLS 选项,使本地连接到 Redis 集群成为可能。

  • 提高了图像处理的性能。

# 其他更改

  • 更新了依赖项

    已将选定的依赖项更新到最新版本,提高了性能和安全性。

# 1.5.0 (2023-05-30)

# 功能

  • 添加了对 REDIS_USER 的支持。

    环境变量允许在连接到 Redis 实例时设置用户。
    更多详细信息可以在在线文档中找到。

# 修复

  • 修复了使用特定方向的资源元数据。

    CKBox 现在将正确保存关于图像尺寸的元数据,同时考虑 EXIF 中包含的方向。

  • 改进了 API 文档中 POST:/assets 端点的示例。

    调整了 API 文档示例,以更好地反映端点返回数据的接口。

  • 添加了复制/移动功能的 REST API 文档。

    REST API 文档现在包含与在 CKBox 中复制/移动资源相关的 3 个新端点的详细文档和示例。

    • POST:/assets/copy
    • POST:/assets/move
    • POST:/assets/namesExist
  • 提高了复制/移动操作的整体性能。

  • 改进了对损坏或空文件的错误处理。

# 1.4.0 (2023-04-18)

跳过了 1.3.0 版本,以统一 CKBox 本地版本与基于云的应用程序的版本控制。

# 功能

  • 添加了复制资源功能。

    现在可以在类别和文件夹之间复制资源。添加了新的 POST:/assets/copy 端点,允许用户复制资源。此端点还支持在操作期间执行的操作(替换或重命名)。

  • 添加了移动资源功能。

    现在可以在类别和文件夹之间移动资源。添加了新的 POST:/assets/move 端点,允许用户移动资源。此端点还支持在操作期间执行的操作(替换或重命名)。

  • 添加了资源存在功能。

    添加了新的 POST:/assets/namesExist 端点,可用于检查目标位置中是否存在同名资源。此操作在复制或移动资源时解决冲突时非常有用。

  • GET:/folders/:folderId 端点响应中添加了 parentId 属性。

    GET:/folders/:folderId 现在将在每个文件夹中包含有关祖先文件夹标识符的信息。

  • 在文件夹和类别中添加了资源数量。

    GET:/categories/categoryIdassetsCount 属性的行为已更改,以仅反映该类别的资源数量,不包括子文件夹。此外,添加了新的 totalAssetsCount 属性,提供所有资源的数量,包括给定类别的子文件夹。

  • GET:/folders/:folderId 端点添加了 assetsCount 属性。

    GET:/folders/:folderId 端点现在包含额外的 assetsCount 属性,该属性包含该特定文件夹中的资源数量。

# 修复

  • 在检查允许的扩展名时忽略了扩展名字母的大小写。

    资源操作现在不区分大小写,修复了一些验证问题。

  • /limits 端点上禁用了签名检查。

  • GET:/assets/:assetId 请求中禁用了将资源标记为最近的选项。

# 其他更改

  • 改进了文件夹的 API 文档。

  • 提高了统计资源数量的性能。

  • 提高了处理 GIF 和 BMP 的性能。

  • 更新了依赖项

    已将选定的依赖项更新到最新版本,提高了性能和安全性。

# 1.2.0 (2023-02-28)

# 功能

  • 在文件夹中添加了自然排序。

    所有 REST API 端点上返回的文件夹现在按自然顺序排序。

  • 添加了在检索文件夹分支时将后代返回到 n 深度的可能性。

    GET:/folder/:folderId/branch 端点现在将接受一个额外的查询参数 depth,该参数将控制返回的文件夹树的深度。

  • 在子文件夹中的资源和文件夹对象中包含 categoryId

    文件夹结构中的所有文件夹现在将包含有关父类别的附加信息。在此之前,此信息仅返回到根文件夹。

  • 从 REST API 中删除了 GET /assets/:assetId/metadata 端点。

    用于返回资源元数据的 GET /assets/:assetId/metadata 端点现在已弃用,不再运行。

  • PATCH /assets/:assetId 端点中删除了属性 categoryId

    categoryId 属性已从该端点支持的有效负载属性中删除。

# 修复

  • 修复了与将错误的 Content-Type 有效负载上传到 CKBox 相关的问题。

  • 修复了向 POST:/search 发送空 JSON 时响应挂起的问题。

  • 修复了与将文件上传到文件夹时验证不匹配相关的问题。

# 其他更改

  • 添加了文件夹功能的 REST API 文档。

# 1.1.0 (2023-01-23)

# 功能

  • 添加了 /search API。

    新的 /search API 允许通过名称、类别、标签和时间范围等各种属性搜索资源。
    更多信息可以在 CKBox REST API 文档中找到。

  • 在资源中添加了 tags 属性。

    新属性允许通过标签对资源进行分类。
    标签已添加到资源响应中,可用于筛选搜索结果。

  • 添加了指标日志。

    新的日志允许监控 CKBox 本地版本的性能和稳定性。

# 其他更改

  • 改进了管理面板中 Insight Panel 视图的用户体验。

    现在可以为日志设置相对时间范围,例如,可以检查最近一小时的日志。

  • 更新了依赖项

    已将选定的依赖项更新到最新版本,提高了性能和安全性。

# 1.0.0 (2022-09-09)

# 功能

  • 添加了 CKBox 的本地版本。

    该服务允许管理文件资源并提供图像的响应版本。