From f14b1ccf0519fd3744f2c7603a46716d5ca348be Mon Sep 17 00:00:00 2001 From: wearepariah <66043052+wearepariah@users.noreply.github.com> Date: Thu, 11 Dec 2025 09:48:27 +1100 Subject: [PATCH 1/2] Change environment variable in docker-compose-base.md Changed environment variable name from OC_CONFIG_DIR to OC_CONF_DIR due to dual use of the same variable name causing issues in edge cases (per #1279) --- .../container/docker-compose/docker-compose-base.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-4.0.0/admin/getting-started/container/docker-compose/docker-compose-base.md b/versioned_docs/version-4.0.0/admin/getting-started/container/docker-compose/docker-compose-base.md index 451502fe..c327adfb 100644 --- a/versioned_docs/version-4.0.0/admin/getting-started/container/docker-compose/docker-compose-base.md +++ b/versioned_docs/version-4.0.0/admin/getting-started/container/docker-compose/docker-compose-base.md @@ -149,7 +149,7 @@ In production, you should mount persistent local directories for configuration a Update your `.env` file with custom paths: ```env -OC_CONFIG_DIR=/your/local/path/opencloud/config +OC_CONF_DIR=/your/local/path/opencloud/config OC_DATA_DIR=/your/local/path/opencloud/data ``` From 2bc6faf0b2c527d09dfb922032f90d188a30ceb8 Mon Sep 17 00:00:00 2001 From: wearepariah <66043052+wearepariah@users.noreply.github.com> Date: Thu, 11 Dec 2025 12:12:00 +1100 Subject: [PATCH 2/2] Change all other references to OC_CONFIG_DIR Changed environment variable name from OC_CONFIG_DIR to OC_CONF_DIR due to dual use of the same variable name causing issues in edge cases (per #1279 https://github.com/opencloud-eu/opencloud/issues/1279) --- .../container/docker-compose/docker-compose-base.md | 2 +- static/env-vars/extended_configvars.md | 2 +- static/env-vars/frontend_readme.md | 2 +- static/env-vars/ocm_configvars.md | 2 +- static/env-vars/policies_readme.md | 6 +++--- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/admin/getting-started/container/docker-compose/docker-compose-base.md b/docs/admin/getting-started/container/docker-compose/docker-compose-base.md index 451502fe..c327adfb 100644 --- a/docs/admin/getting-started/container/docker-compose/docker-compose-base.md +++ b/docs/admin/getting-started/container/docker-compose/docker-compose-base.md @@ -149,7 +149,7 @@ In production, you should mount persistent local directories for configuration a Update your `.env` file with custom paths: ```env -OC_CONFIG_DIR=/your/local/path/opencloud/config +OC_CONF_DIR=/your/local/path/opencloud/config OC_DATA_DIR=/your/local/path/opencloud/data ``` diff --git a/static/env-vars/extended_configvars.md b/static/env-vars/extended_configvars.md index 9e1abaec..ab82b2a2 100644 --- a/static/env-vars/extended_configvars.md +++ b/static/env-vars/extended_configvars.md @@ -9,5 +9,5 @@ `MICRO_REGISTRY_ADDRESS` | string | 127.0.0.1:9233 | The bind address of the internal natsjs registry. Only change on supervision of openCloud Support. | `MICRO_REGISTRY_AUTH_PASSWORD` | string | | Optional when using nats to authenticate with the nats cluster. | `OC_BASE_DATA_PATH` | string | | The base directory location used by several services and for user data. See the General Info section in the documentation for more details on defaults. Services can have, if available, an individual setting with an own environment variable. | -`OC_CONFIG_DIR` | string | | The default directory location for config files. See the General Info section in the documentation for more details on defaults. | +`OC_CONF_DIR` | string | | The default directory location for config files. See the General Info section in the documentation for more details on defaults. | `OC_GRPC_MAX_RECEIVED_MESSAGE_SIZE` | integer | 10240000 | Sets the maximum message size in bytes the GRPC client can receive. | \ No newline at end of file diff --git a/static/env-vars/frontend_readme.md b/static/env-vars/frontend_readme.md index 578de0bc..43477f7c 100644 --- a/static/env-vars/frontend_readme.md +++ b/static/env-vars/frontend_readme.md @@ -112,7 +112,7 @@ With the password policy, mandatory criteria for the password can be defined via Generally, a password can contain any UTF-8 characters, however some characters are regarded as special since they are not used in ordinary texts. Which characters should be treated as special is defined by "The OWASP® Foundation" [password-special-characters](https://owasp.org/www-community/password-special-characters) (between double quotes): ```" !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~"``` -The validation against the banned passwords list can be configured via a text file with words separated by new lines. If a user tries to set a password listed in the banned passwords list, the password can not be used (is invalid) even if the other mandatory criteria are passed. The admin can define the path of the banned passwords list file. If the file doesn't exist in a location, OpenCloud tries to load a file from the `OC_CONFIG_DIR/OC_PASSWORD_POLICY_BANNED_PASSWORDS_LIST`. An option will be enabled when the file has been loaded successfully. +The validation against the banned passwords list can be configured via a text file with words separated by new lines. If a user tries to set a password listed in the banned passwords list, the password can not be used (is invalid) even if the other mandatory criteria are passed. The admin can define the path of the banned passwords list file. If the file doesn't exist in a location, OpenCloud tries to load a file from the `OC_CONF_DIR/OC_PASSWORD_POLICY_BANNED_PASSWORDS_LIST`. An option will be enabled when the file has been loaded successfully. Following environment variables can be set to define the password policy behaviour: diff --git a/static/env-vars/ocm_configvars.md b/static/env-vars/ocm_configvars.md index 1d65d444..4775cb63 100644 --- a/static/env-vars/ocm_configvars.md +++ b/static/env-vars/ocm_configvars.md @@ -44,7 +44,7 @@ Environment variables for the **ocm** service |`OCM_OCM_INVITE_MANAGER_TIMEOUT`| 1.0.0 |Duration|`Timeout specifies a time limit for requests made to OCM endpoints.`|`30s`| |`OCM_OCM_INVITE_MANAGER_INSECURE`| 1.0.0 |bool|`Disable TLS certificate validation for the OCM connections. Do not set this in production environments.`|`false`| |`SHARING_OCM_PROVIDER_AUTHORIZER_DRIVER`| 1.0.0 |string|`Driver to be used to persist ocm invites. Supported value is only 'json'.`|`json`| -|`OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE`| 1.0.0 |string|`Path to the JSON file where ocm invite data will be stored. Defaults to $OC_CONFIG_DIR/ocmproviders.json.`|`/etc/opencloud/ocmproviders.json`| +|`OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE`| 1.0.0 |string|`Path to the JSON file where ocm invite data will be stored. Defaults to $OC_CONF_DIR/ocmproviders.json.`|`/etc/opencloud/ocmproviders.json`| |`OCM_OCM_SHARE_PROVIDER_DRIVER`| 1.0.0 |string|`Driver to be used for the OCM share provider. Supported value is only 'json'.`|`json`| |`OCM_OCM_SHAREPROVIDER_JSON_FILE`| 1.0.0 |string|`Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OC_BASE_DATA_PATH/storage.`|`/var/lib/opencloud/storage/ocm/ocmshares.json`| |`OCM_OCM_SHARE_PROVIDER_INSECURE`| 1.0.0 |bool|`Disable TLS certificate validation for the OCM connections. Do not set this in production environments.`|`false`| diff --git a/static/env-vars/policies_readme.md b/static/env-vars/policies_readme.md index 6b35fd49..cd64a397 100644 --- a/static/env-vars/policies_readme.md +++ b/static/env-vars/policies_readme.md @@ -177,16 +177,16 @@ In order to extend this list, OpenCloud must be provided with the path to a cust The location for the file must be accessible by all instances of the policy service. As a rule of thumb, use the directory where the OpenCloud configuration files are stored. Note that existing mappings from the host are extended by the definitions from the mime types file, but not replaced. -The path to that file can be provided via a yaml configuration or an environment variable. Note to replace the `OC_CONFIG_DIR` string by an existing path. +The path to that file can be provided via a yaml configuration or an environment variable. Note to replace the `OC_CONF_DIR` string by an existing path. ```shell -export POLICIES_ENGINE_MIMES=OC_CONFIG_DIR/mime.types +export POLICIES_ENGINE_MIMES=OC_CONF_DIR/mime.types ``` ```yaml policies: engine: - mimes: OC_CONFIG_DIR/mime.types + mimes: OC_CONF_DIR/mime.types ``` A good example of how such a file should be formatted can be found in the [Apache svn repository](https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types).