# CKBox On-Premises ## 2.13.1 (2026-09-08) ### Bug fixes * Fixed uploads hanging for some TIFF files Previously, uploading a TIFF file could hang until the request timed out. Such files now upload correctly. * Fixed category restrictions while overwriting an asset Previously, in some cases the category file type restrictions were not correctly applied when overwriting an asset. This has been fixed. ### Other changes * Improved a reliability of License Module Queued usage reports are no longer sent inside a database transaction, so a slow or unavailable License Server no longer holds database connections and locks, and no longer delays other requests. * Improved Semantic Search for multilingual queries Semantic search now returns more accurate results for queries written in languages other than English. * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.13.0 (2026-07-28) ### Bug fixes * Fixed conversion to WebP failing for images larger than the maximum allowed size Previously, converting an image to WebP could fail when either dimension of the result exceeded the maximum supported size. This affected conversions from any source format to WebP, including WebP to WebP. Image dimensions are now bounded before conversion so it succeeds, while smaller images are left unchanged. ### Other changes * Relaxed MIME type matching when overwriting an asset Overwriting an asset no longer requires an exact extension match. Files sharing the same base type (for example, any `image/*`) are now accepted when overwriting the contents of existing files. * Improved API documentation Endpoint descriptions have been improved, providing clearer access-rule and permission context in the API documentation. * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.12.0 (2026-06-16) ### Features * Added File Versioning feature Introduced the ability to manage versions of assets. Users can now review the linear history of a file, see how it changed over time, including who created each revision and its size.\ Accordingly, the following has been added: New endpoints: * `GET:/assets/{assetId}/revisions` - returns the list of all available revisions for a given asset. * `GET:/{workspaceId}/assets/{assetId}/revisions/{revisionId}/file` - returns the binary content of a specific asset revision. * `POST:/assets/{assetId}/revisions` - restores an asset to the selected revision. * `DELETE:/assets/{assetId}/revisions/{revisionId}` - removes the selected revision. New permissions and webhooks for asset revision operations: * Asset Revision Change * Asset Revision Delete For more details, please refer to the [CKBox documentation](../../../../ckbox/latest/index.md) and [CKBox API documentation](https://api.ckbox.io/api/docs). ### Bug fixes * Enforced matching file extension when overwriting an asset Previously, overwriting assets in various formats was allowed. Now the uploaded file’s extension must match the original asset’s extension. * Improved AI processing pipeline Previously, image assets that did not include required attributes were rejected by the AI worker. Image assets now always include the attributes required for AI analysis. ### Other changes * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.11.0 (2026-04-28) ### Features * Added Semantic Search feature The new feature allows users to search for images by visual similarity, enabling the discovery of similar images based on their content rather than just filenames or tags. For more details, please refer to the [CKBox documentation](../../../../ckbox/latest/index.md). ### Bug fixes * Fixed asset uploads failing when no destination category was specified Previously, when no destination category was specified, the service picked one based on allowed file types only, which could result in a HTTP 403 error even when another suitable category was available. Destination selection now also considers the user’s permissions. * Fixed CDN cache invalidation for trashed and restored assets Previously, the CDN cache was not invalidated when an asset was moved to the trash or restored from it, so the asset could remain stale in the cache. The CDN cache is now invalidated in both cases. * Improved semantic search performance and result relevance Semantic search now responds faster and returns more relevant results. * Fixed rendering issues in the API documentation Previously, parts of the API documentation could fail to render correctly. The affected sections have been corrected. * Fixed management panel connectivity to CKBox in on-premises deployments Previously, the management panel could fail to reach CKBox in certain on-premises configurations. This issue has been fixed. ### Other changes * Grouped trash endpoints under a dedicated Trash tag in the API documentation Trash-related endpoints are now listed under a dedicated `Trash` tag, making them easier to find in the API documentation. * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.10.3 (2026-03-13) ### Bug fixes * Fixed webhooks retry mechanism An issue was discovered where webhooks were not being retried if the target receiver server returned an error response (non-2xx status code). This patch ensures that the retry mechanism correctly triggers according to the configuration, improving the reliability of event delivery to external services. ### Other changes * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.10.2 (2026-01-29) ### Bug fixes * Improved Latin-1 Character Encoding Fixed an issue where Latin-1 Supplement characters were not correctly encoded in the `Content-Disposition` header,\ which could lead to improperly handled filenames. ### Other changes * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.10.1 (2025-12-08) ### Other changes * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.10.0 (2025-12-02) ### Features * Added workspace list pagination and searching Added a new `GET:/v3/workspaces` endpoint that addresses performance issues and potential query timeouts\ when retrieving a large number of workspaces, and enables support for searching particular workspaces. ### Bug fixes * Fixed AI reprocessing bug after image edit Fixed an issue where images uploaded before AI features were enabled were not sent for AI processing\ when edited and saved as a new asset in an AI-enabled workspace. The newly created asset now correctly\ triggers the AI processing workflow. * Changed filename on download/view Fixed an issue where files served directly via their link used a generic filename (`file`) in the browser\ instead of using the original file’s name from the metadata. The original filename is now correctly used. ### Other changes * Updated dependencies\ Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.9.0 (2025-10-22) ### Features * Added AI-powered features When enabled, image-like assets will receive automatically generated descriptions and tags via generative AI. ### Bug fixes * Fixed asset restoration tags bug When an asset was restored from trash, its original tags could be overwritten. Now tags are correctly preserved and restored along with the asset. * Fixed the problem with editing images in folders When an image in a folder was edited and saved as a new file, it could trigger validation errors. This issue has been fixed, and such operation now completes successfully. ### Other changes * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.8.3 (2025-09-02) ### Bug fixes * Fixed a problem with handling malformed `form-data` in private category authorization Previously, corrupted or incomplete form submissions caused an uncaught error. Such cases are now properly handled and return 400 Bad Request. * Fixed a problem with invalid asset ID validation in image requests Requests with asset IDs that were too short or too long incorrectly returned 500 Internal Server Error. They now return the correct 400 Bad Request. ### Other changes * Improved and clarified REST API documentation for better developer experience * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.8.2 (2025-07-22) ### Fixes * Fixed problem with MP4 files detection Previously the MP4 video files were incorrectly served with the `application/mp4` MIME type.\ Now the correct `video/mp4` MIME type is used. ### Other changes * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.8.1 (2025-07-01) ### Fixes * Fixed Authorization for the Management Panel The Authorization for the Management Panel wasn’t verified properly.\ Now, the correct password is required to access the Management Panel. The issue was reported by Adam Wójs from [Ibexa](https://www.ibexa.co/). Thank you! ## 2.8.0 (2025-06-10) ### Features * Added the Trash bin feature The new feature introduces a soft-delete mechanism for assets, allowing users to recover accidentally deleted files,\ auto-purge old items, and better manage asset lifecycle ### Fixes * Fixed the problem with DISTRIBUTION\_ID configuration value being pulled incorrectly for CDN configuration in CKBox On-Premises The value of `CDN_SECRET_ACCESS_KEY` was used instead of the `DISTRIBUTION_ID` while initializing CloudFront invalidation requests.\ This caused a cache invalidation calls to fail with authorization errors and incorrect resource ARNs.\ The fix ensures that the correct `DISTRIBUTION_ID` is now used while performing the cache invalidation operations. ### Other changes * Updated NodeJS to version 22 * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.7.2 (2025-04-24) ### Fixes * Fixed an issue where file uploads could fail in setups using AWS S3 The bug made larger files impossible to upload to CKBox. This typically affected files over 5MB in size.\ It was caused by a changed mechanism for checking the integrity of multipart uploads in one of dependencies,\ leading to failed uploads without visible service interruptions. ## 2.7.1 (2025-04-22) ### Fixes * Fixed handling streams and premature connection interruptions Fixed issues where uploads or downloads interrupted mid-process (e.g., closed tabs or dropped connections) could cause service instability. ### Other changes * Improved logging Introduced better log entries to enhance monitoring, debugging, and overall service observability. * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.7.0 (2025-03-11) ### Features * Added explicit character set to the `Content-Type` header Character set information specifying the encoding standard for all text-based MIME types\ (e.g., `text/plain`, `text/html`) will be included in the `Content-Type` header to ensure\ proper character encoding interpretation. ### Other changes * Improved performance of workspaces Optimized workspace handling to reduce database load and enhance overall performance across\ multiple endpoints, resulting in faster response times and improved efficiency. * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.6.2 (2025-01-28) ### Other changes * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.6.1 (2024-11-19) ### Other changes * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.6.0 (2024-10-10) ### Features * Added the ability to set a custom thumbnail for non-image assets Added a new endpoint `POST:/assets/{{assetId}}/thumbs` which allows to upload an image that would become a custom thumbnail for the asset. * Added Private Categories The feature will give administrators the ability to mark certain categories of assets as private, restricting access to its content to selected users or groups, adding an additional layer of control over content sharing. ### Other changes * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.5.0 (2024-08-27) ### Features * Introduced the Permissions feature Permissions enable fine-grained control over user access to specific features and actions. By assigning permissions, admins can regulate user interactions with assets, categories, and folders. Permissions introduce control over: * Accessing a Category * Creating an Asset * Deleting an Asset * Modifying an Asset * Modifying Asset Metadata * Creating a Folder * Modifying a Folder Metadata * Deleting a Folder * Added a configuration option to indicate the maximum file size that CKBox can allow during upload A new CKBox On-Premises configuration option `max_file_size_in_bytes_limit` will allow to limit a maximum file upload size from the default 32GB limit to that indicated by the configuration. ### Fixes * Improved the performance of workspaces Workspace information is fetched in a more optimized way. * Improved error handling in Webhooks feature * Improved the performance of uploading multiple files to a folder Enhanced the upload progress of multiple files, especially when targeting folders. * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.4.3 (2024-07-16) ### Other changes * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.4.2 (2024-06-04) ### Fixes * Updated handling of asset mime-type during asset update Resolved an issue with updating mimetypes when asset data is updated. The mimetype will be correctly updated in accordance with the new file extension. ### Other changes * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.4.1 (2024-04-23) ### Other changes * Improved overall performance Enhanced responsiveness and speed of particular actions. * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.4.0 (2024-03-12) ### Features * Introduced Webhooks We have added support for webhooks within the application. By integrating Webhooks, third party apps will be able to be notified whenever: * an asset is modified, * an asset is overwritten, * an asset is copied, * an asset cache should be invalidated, * a folder is created, * a folder is modified, * a folder wis removed. * Changed requirements for uploading files `categoryId` is required no more while uploading assets to CKBox. Both `categoryId` and `folderId` are now optional, and target upload category is deduced from the category settings defined by admins. ### Fixes * Fixed issues with requesting images with capitalized extensions Image URL containing capitalized extension such as `JPG` is now considered valid. * Improved overall performance Enhanced responsiveness and speed of selected actions. * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.3.1 (2024-01-23) ### Fixes * Fixed issues related to uploading huge files, resolving random timeout errors Increased actual upload timeout to 4 hours, ensuring successful completion of large file uploads without encountering timeout errors. * Fixed problems with abruptly closed connections Implemented measures to prevent unexpected connection interruptions, properly handling abruptly closed connections, for example, while closing CKBox during upload. * Improved overall performance Enhanced responsiveness and speed of the workspaces. ### Other changes * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.3.0 (2023-12-19) ### Other changes * Improved integration with CKBox application Some of the internal mechanisms for workspaces were adapted to allow editing external web images via CKBox’s Image Editor. * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.2.0 (2023-11-14) ### Features * Added an option to globally limit allowed extensions for all workspaces in the environment New endpoints for changing global extensions limits were added: * `GET:/admin/environmentConfig` returns an object describing environment extensions limit containing properties: * `allowedExtensions` which is an array of strings containing extensions that are allowed to upload in the environment * `isAllowedExtensionsEnabled` which is a flag indicating whether limiting extensions in the environment is enabled or disabled * `PUT:/superadmin/environmentConfig` allows to modify the configuration of allowed extensions for the entire environment\ Note: The above endpoint is accessible for `SuperAdmin` users only. * Extended the payload of the response of fetching workspaces list `GET:/workspaces` The endpoint will now include additional properties: * `allowedExtensions` is an array of strings containing all extensions that are allowed in all workspaces in the environment * `extensionsInUse` is an array of strings containing a list of the asset extensions that are currently in use for all workspaces in the environment Note: Extended response is accessible for `SuperAdmin` users only. ### Fixes * Improved performance of the assets processing * Fixed the problem of uploading large files to CKBox Timeout issues during upload of files that could take >30 min to upload have been fixed. ### Other changes * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.1.0 (2023-09-27) ### Features * Added global environment configuration management in CKBox New endpoints for changing global environment configuration were added: * `GET:/superadmin/workspacesTemplate` returns a list of categories that should be created in new workspaces created in the environment * `PUT:/superadmin/workspacesTemplate` allows to modify the list of categories created in a new workspace ### Fixes * Fixed the problem with composite image editing operations Introduced version 2 of the image editing endpoint `POST:/assets/{assetId}/editImage` that preserves the order of the operations throughout all image file formats: 1. Flip is applied before anything else. 2. Then rotation is applied. 3. Then crop is applied. 4. Then resize is applied. This fixes the problem of incorrectly cropped image part if it was previously flipped or rotated. * Fixed a problem while connecting with a database thru the TLS connection The TLS connection wasn’t possible, now TLS can be used properly. ### Other changes * Deprecated query parameter `workspaceId` in some of the assets-related endpoints The `workspaceId` parameter, which was previously used as a query parameter in our endpoints, has been deprecated and is not required anymore for the following endpoints: `GET:/assets/{assetId}/offset`, `POST:/assets/{assetId}`, `PATCH:/assets/{assetId}`, `PATCH:/assets/{assetId}/metadata`. * Added validation rules for maximum width and height in Image Editing in CKBox Maximum edited image dimension (width or height) is now limited to `16383px`. * Improved mechanism to release unused database connections * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 2.0.0 (2023-08-22) Note: The CKBox On-premises 2.0.0 does not contain any breaking changes, the versioning is simply shared with the frontend part of the CKBox, which contains a breaking change. ### Fixes * Fixed the problem with handling files containing some of UNICODE combined accents in the filename * Fixed problems with uploading multiple files at once in CKBox configuration with a Postgres database ### Other changes * Adjusted the process of image editing The description and the tags assigned to an asset will now be copied to the newly created asset if the edited image is saved as a new file. * Improved the performance of image rescaling Adjusted image processing to speed up image processing and increase the rescaling performance. * Optimized CPU usage * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 1.6.0 (2023-07-13) ### Features * Added `metadataProcessingStatus` property to the asset’s metadata The new property provides information about the status of processing image metadata. * Added the Asset overwrite feature A new `POST:/assets/:assetId` endpoint has been added to enable users to overwrite the asset’s file content. * Added the Asset offset feature A new `GET:/assets/:assetId/offset` endpoint has been added providing functionality to determine the position offset of an asset in a category or folder based on specific sorting conditions. * Added the Workspaces feature Workspaces create completely separate instances of CKBox within one environment, which is effectively close to what can be achieved using separate environments. Added 4 new endpoints dedicated to workspace management: * `POST:/superadmin/workspaces` creates a new workspace within the environment * `PUT:/superadmin/workspaces/:workspaceId` modifies the workspace * `DELETE:/superadmin/workspaces/:workspaceId` deletes the workspace * `GET:/workspaces` returns the list of all workspaces to which the user has access to - Added the Image Editing feature: An image editing API allows to perform various operations on image assets. The editing operation can be performed via a new endpoint `POST:/assets/:assetId/edit`. Some common image operations supported by such an API include: * Crop: This operation can select a specified portion of an image, removing the rest of it. This helps focus on a particular subject or remove unwanted elements. * Resize: This operation allows to change the dimensions (width and height) of an image, either proportionally or by specifying custom dimensions. * Rotate: This operation enables the rotation of an image by a set angle. 90 degrees clockwise or counterclockwise. * Flip: Flipping allows the user to mirror an image horizontally or vertically ### Fixes * Fixed Redis cluster TLS options Fixed TLS options for a Redis cluster to make the connection to a Redis cluster possible for on-premises. * Improved the performance of image processing ### Other changes * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 1.5.0 (2023-05-30) ### Features * Added support for `REDIS_USER` The environmental variable allows to set the user while connecting to the Redis instance.\ More details can be found in the online documentation. ### Fixes * Fixed the asset metadata that used specific orientation CKBox will now correctly save metadata about the image’s dimensions, taking into account the orientation contained in the EXIF. * Improved sample in API docs for the `POST:/assets` endpoint Adjusted the API docs sample to better reflect the interface of the data returned from the endpoint. * Added REST API documentation for the copy/move feature The REST API documentation now contains detailed docs and samples for 3 new endpoints related to copying/moving assets in CKBox: * `POST:/assets/copy` * `POST:/assets/move` * `POST:/assets/namesExist` * Improved the overall performance of copy/move operations * Improved the error handling of corrupted or empty files ## 1.4.0 (2023-04-18) The 1.3.0 version was skipped to unify the versioning of CKBox On-premises with the cloud-based application. ### Features * Added the Copy assets feature Assets can now be copied between categories and folders. A new `POST:/assets/copy` endpoint has been added to enable users to copy assets. This endpoint also supports the action (replace or rename) to be performed during the operation. * Added the Move assets feature Assets can now be moved between categories and folders. A new `POST:/assets/move` endpoint has been added to enable users to move assets. This endpoint also supports the action (replace or rename) to be performed during the operation. * Added the Assets exist feature A new `POST:/assets/namesExist` endpoint has been added, which can be used to check whether assets with the same names exist in the target location. Such operation becomes useful when resolving conflicts when copying or moving assets. * Added the `parentId` property to the `GET:/folders/:folderId` endpoint response `GET:/folders/:folderId` will now include information about the identifier of the ancestor folder in each folder. * Added the assets count in folders and categories The behavior of the `assetsCount` property in `GET:/categories/categoryId` has been changed to reflect the assets count only for that category, without descendants folders. Additionally, a new `totalAssetsCount` property has been added, providing the number of all assets, taking into account the descendant folders of a given category. * Added the `assetsCount` property to the `GET:/folders/:folderId` endpoint The `GET:/folders/:folderId` endpoint now includes the additional `assetsCount` property containing the number of assets in that particular folder. ### Fixes * Ignored extension letter case when checking for allowed extensions Assets operations are now case-insensitive, it fixed some of the validation issues. * Disabled signature check on the `/limits` endpoint * Disabled marking assets as recent on `GET:/assets/:assetId` requests ### Other changes * Improved API docs for folders * Improved performance of counting assets * Improved performance of processing GIFs and BMP * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 1.2.0 (2023-02-28) ### Features * Added natural sorting to folders Folders returned on all REST API endpoints are now sorted in the natural order. * Added possibility to return descendants to n-depth when retrieving folder branch `GET:/folder/:folderId/branch` endpoint will now accept an additional query parameter `depth` which will control the depth of the returned folder tree. * Included `categoryId` in assets and folder objects in subfolders All folders within the folder structure will now include additional information about the parent category. Before this information was only returned to the root folders. * Removed `GET /assets/:assetId/metadata` endpoint from REST API The `GET /assets/:assetId/metadata` endpoint for returning metadata for the asset is now deprecated and no longer operational. * Removed property `categoryId` from the `PATCH /assets/:assetId` endpoint The `categoryId` property was removed from the supported payload properties in that endpoint. ### Fixes * Fixed an issue related to uploading the wrong `Content-Type` payload to CKBox * Fixed an issue with response hangup upon sending empty JSON to `POST:/search` * Fixed an issue related to validation mismatch when uploading a file to a folder ### Other changes * Added REST API documentation for the folders feature ## 1.1.0 (2023-01-23) ### Features * Added the `/search` API The new `/search` API allows searching assets by various properties like name, category, tags, and time range.\ More information can be found in the CKBox REST API documentation. * Added `tags` property to assets The new property allows for classifying your assets by tags.\ The tags are added to asset responses and can be used to filter search results. * Added metrics logs The new logs allow monitoring of the performance and stability of the CKBox On-premises. ### Other changes * Improved UX of the Insight Panel view in the management panel It is now possible to set a relative time frame for logs, so e.g. logs from the last hour can be checked. * Updated dependencies Selected dependencies have been updated to the latest versions, improving performance and security. ## 1.0.0 (2022-09-09) ### Features * Added On-Premise version of CKBox. The service allows for managing file assets and providing responsive versions of images. --- Full index of the Cloud Services documentation: [llms.txt](../../../llms.txt)