From 0cd2f1ba3e8c4fbfe522c647c9a6bdf6e06874c1 Mon Sep 17 00:00:00 2001 From: Nicolas Pepin-Perreault Date: Thu, 4 Dec 2025 11:58:01 +0100 Subject: [PATCH 1/2] docs: add pre-configured path for volume mounts --- .../concepts/document-handling/configuration/docker.md | 10 +++++----- .../concepts/document-handling/configuration/index.md | 1 + 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/self-managed/concepts/document-handling/configuration/docker.md b/docs/self-managed/concepts/document-handling/configuration/docker.md index ec1f9170f38..7e41a0e4236 100644 --- a/docs/self-managed/concepts/document-handling/configuration/docker.md +++ b/docs/self-managed/concepts/document-handling/configuration/docker.md @@ -135,16 +135,16 @@ DOCUMENT_DEFAULT_STORE_ID=inmemory -| Store variable | Required | Description | -| ---------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `DOCUMENT_STORE_LOCAL_CLASS` | Yes | The class for instantiating the local store. This must always be `io.camunda.document.store.localstorage.LocalStorageDocumentStoreProvider` | -| `DOCUMENT_STORE_LOCAL_PATH` | Yes | The path to the directory which will host the uploaded files. | +| Store variable | Required | Description | +| ---------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `DOCUMENT_STORE_LOCAL_CLASS` | Yes | The class for instantiating the local store. This must always be `io.camunda.document.store.localstorage.LocalStorageDocumentStoreProvider` | +| `DOCUMENT_STORE_LOCAL_PATH` | Yes | The path to the directory which will host the uploaded files. **Use `/usr/local/camunda/documents` as it is pre-created with the right permissions for the process user.** | **Example:** ``` DOCUMENT_STORE_LOCAL_CLASS=io.camunda.document.store.localstorage.LocalStorageDocumentStoreProvider -DOCUMENT_STORE_LOCAL_PATH=/usr/local/camunda +DOCUMENT_STORE_LOCAL_PATH=/usr/local/camunda/documents DOCUMENT_DEFAULT_STORE_ID=local ``` diff --git a/docs/self-managed/concepts/document-handling/configuration/index.md b/docs/self-managed/concepts/document-handling/configuration/index.md index 4f6c1d67004..5cfa7efef15 100644 --- a/docs/self-managed/concepts/document-handling/configuration/index.md +++ b/docs/self-managed/concepts/document-handling/configuration/index.md @@ -29,6 +29,7 @@ Camunda 8 Run is a fast way for users to test the capabilities of the platform, - **Local storage** can be configured for a cluster to store documents in a local folder. - It can be used only for local development with [Camunda 8 Run](/self-managed/quickstart/developer-quickstart/c8run.md). - Local storage is not suitable for production use, as pods and file paths are not shared across components. This prevents components like Tasklist and Zeebe from accessing the same data. Files are stored locally, and their retention must be managed manually. + - If you're use a container image and a mounted volume for your storage, you can use the path `/usr/local/camunda/documents` as the mount path, as it will already have the right permissions for the Camunda process to read and write to it. - **In-memory** storage can be used to store documents during the application's runtime. When the application is stopped, documents are lost. - It can be used with [Camunda 8 Run](/self-managed/quickstart/developer-quickstart/c8run.md), [Docker Compose](/self-managed/quickstart/developer-quickstart/docker-compose.md) and [Helm](/self-managed/deployment/helm/install/quick-install.md). - In-memory storage is not suitable for production use, as pods and memory are not shared across components. Files stored in memory are not persisted and will be lost on application restart. From e9a6605858e32cf10f658235f1bd1fe79117c31b Mon Sep 17 00:00:00 2001 From: Christina Ausley <84338309+christinaausley@users.noreply.github.com> Date: Thu, 4 Dec 2025 10:26:39 -0700 Subject: [PATCH 2/2] Update docs/self-managed/concepts/document-handling/configuration/index.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../concepts/document-handling/configuration/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/self-managed/concepts/document-handling/configuration/index.md b/docs/self-managed/concepts/document-handling/configuration/index.md index 5cfa7efef15..776cca78285 100644 --- a/docs/self-managed/concepts/document-handling/configuration/index.md +++ b/docs/self-managed/concepts/document-handling/configuration/index.md @@ -29,7 +29,7 @@ Camunda 8 Run is a fast way for users to test the capabilities of the platform, - **Local storage** can be configured for a cluster to store documents in a local folder. - It can be used only for local development with [Camunda 8 Run](/self-managed/quickstart/developer-quickstart/c8run.md). - Local storage is not suitable for production use, as pods and file paths are not shared across components. This prevents components like Tasklist and Zeebe from accessing the same data. Files are stored locally, and their retention must be managed manually. - - If you're use a container image and a mounted volume for your storage, you can use the path `/usr/local/camunda/documents` as the mount path, as it will already have the right permissions for the Camunda process to read and write to it. + - If you're using a container image and a mounted volume for your storage, you can use the path `/usr/local/camunda/documents` as the mount path, as it will already have the right permissions for the Camunda process to read and write to it. - **In-memory** storage can be used to store documents during the application's runtime. When the application is stopped, documents are lost. - It can be used with [Camunda 8 Run](/self-managed/quickstart/developer-quickstart/c8run.md), [Docker Compose](/self-managed/quickstart/developer-quickstart/docker-compose.md) and [Helm](/self-managed/deployment/helm/install/quick-install.md). - In-memory storage is not suitable for production use, as pods and memory are not shared across components. Files stored in memory are not persisted and will be lost on application restart.