From cb033222f443c19e868aeacec0535d927f58312e Mon Sep 17 00:00:00 2001 From: Martin Mattel Date: Mon, 2 Sep 2024 13:18:38 +0200 Subject: [PATCH] [docs-only] Small ocm text fix --- services/ocm/README.md | 6 +++--- services/ocm/pkg/config/config.go | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/services/ocm/README.md b/services/ocm/README.md index 8231cf647..a4ea54eba 100644 --- a/services/ocm/README.md +++ b/services/ocm/README.md @@ -15,11 +15,11 @@ Internal GRPC APIs: ## Enable OCM -To enable OpenCloudMesh you have to set three environment variables. The path `/etc/ocis` in the example below depends on the installation type and derives, if not otherwise defined from the `OCIS_CONFIG_DIR` envvar. +To enable OpenCloudMesh, you have to set the following environment variables. The path `/etc/ocis/` in the example below depends on the installation type and derives, if not otherwise defined, from the `OCIS_CONFIG_DIR` envvar. + ```console export OCIS_ENABLE_OCM=true export OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE="/etc/ocis/ocmproviders.json" -export OCIS_ADD_RUN_SERVICES="ocm" ``` {{< hint info >}} @@ -135,4 +135,4 @@ OCM Shares are currently created using the ocs API, just like regular shares. Th See [Create share flow](create_share_flow) for the according sequence diagram. -The data backends of the `ocmshareprovider` and `ocmcore` services are configurable. The only supported backend currently is `json` which stores the data in a json file on disk. \ No newline at end of file +The data backends of the `ocmshareprovider` and `ocmcore` services are configurable. The only supported backend currently is `json` which stores the data in a json file on disk. diff --git a/services/ocm/pkg/config/config.go b/services/ocm/pkg/config/config.go index f7c00a6c8..86b687498 100644 --- a/services/ocm/pkg/config/config.go +++ b/services/ocm/pkg/config/config.go @@ -103,7 +103,7 @@ type OCMInviteManagerDrivers struct { } type OCMInviteManagerJSONDriver struct { - File string `yaml:"file" env:"OCM_OCM_INVITE_MANAGER_JSON_FILE" desc:"Path to the JSON file where OCM invite data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage." introductionVersion:"5.0"` + File string `yaml:"file" env:"OCM_OCM_INVITE_MANAGER_JSON_FILE" desc:"Path to the JSON file where OCM invite data will be stored. This file is maintained by the instance and must not be changed manually. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage." introductionVersion:"5.0"` } type OCMProviderAuthorizerDrivers struct {