From 33f5ed903591ec57e53c938794a8173f01e009ee Mon Sep 17 00:00:00 2001 From: Juergen Weigert Date: Tue, 24 Sep 2024 03:22:27 +0200 Subject: [PATCH 1/4] fix: remove colons after an env var, to form proper path names in descriptions. --- docs/helpers/env_vars.yaml | 74 +++++++++---------- .../env-var-deltas/4.0.0-5.0.0-added.adoc | 8 +- .../env-var-deltas/4.0.0-5.0.0-added.md | 8 +- services/ocm/pkg/config/config.go | 8 +- 4 files changed, 49 insertions(+), 49 deletions(-) diff --git a/docs/helpers/env_vars.yaml b/docs/helpers/env_vars.yaml index 97f93bb0910..fb41a9315f8 100644 --- a/docs/helpers/env_vars.yaml +++ b/docs/helpers/env_vars.yaml @@ -1589,7 +1589,7 @@ AUTH_BASIC_LDAP_CACERT: type: string description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root - directory derives from $OCIS_BASE_DATA_PATH:/idm. + directory derives from $OCIS_BASE_DATA_PATH/idm. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -5079,7 +5079,7 @@ GRAPH_LDAP_CACERT: type: string description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root - directory derives from $OCIS_BASE_DATA_PATH:/idm. + directory derives from $OCIS_BASE_DATA_PATH/idm. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -5713,7 +5713,7 @@ GROUPS_LDAP_CACERT: type: string description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root - directory derives from $OCIS_BASE_DATA_PATH:/idm. + directory derives from $OCIS_BASE_DATA_PATH/idm. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -6144,7 +6144,7 @@ IDM_DATABASE_PATH: defaultValue: /var/lib/ocis/idm/ocis.boltdb type: string description: Full path to the IDM backend database. If not defined, the root directory - derives from $OCIS_BASE_DATA_PATH:/idm. + derives from $OCIS_BASE_DATA_PATH/idm. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -6211,7 +6211,7 @@ IDM_LDAPS_CERT: defaultValue: /var/lib/ocis/idm/ldap.crt type: string description: File name of the TLS server certificate for the LDAPS listener. If - not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm. + not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idm. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -6221,7 +6221,7 @@ IDM_LDAPS_KEY: defaultValue: /var/lib/ocis/idm/ldap.key type: string description: File name for the TLS certificate key for the server certificate. If - not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm. + not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idm. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -6412,7 +6412,7 @@ IDP_ENCRYPTION_SECRET_FILE: type: string description: Path to the encryption secret file, if unset, a new certificate will be autogenerated upon each restart, thus invalidating all existing sessions. If - not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idp. + not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idp. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -6571,7 +6571,7 @@ IDP_LDAP_TLS_CACERT: type: string description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root - directory derives from $OCIS_BASE_DATA_PATH:/idp. + directory derives from $OCIS_BASE_DATA_PATH/idp. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -6721,7 +6721,7 @@ IDP_SIGNING_PRIVATE_KEY_FILES: defaultValue: '[/var/lib/ocis/idp/private-key.pem]' type: '[]string' description: A list of private key files for signing IDP requests. If not defined, - the root directory derives from $OCIS_BASE_DATA_PATH:/idp. See the Environment + the root directory derives from $OCIS_BASE_DATA_PATH/idp. See the Environment Variable Types description for more details. introductionVersion: pre5.0 deprecationVersion: "" @@ -6781,7 +6781,7 @@ IDP_TRANSPORT_TLS_CERT: defaultValue: /var/lib/ocis/idp/server.crt type: string description: Path/File name of the TLS server certificate (in PEM format) for the - IDP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idp. + IDP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idp. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -6792,7 +6792,7 @@ IDP_TRANSPORT_TLS_KEY: type: string description: Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the IDP service. If not defined, the root directory - derives from $OCIS_BASE_DATA_PATH:/idp. + derives from $OCIS_BASE_DATA_PATH/idp. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -7221,7 +7221,7 @@ NATS_NATS_STORE_DIR: defaultValue: /var/lib/ocis/nats type: string description: The directory where the filesystem storage will store NATS JetStream - data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/nats. + data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/nats. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -7231,7 +7231,7 @@ NATS_TLS_CERT: defaultValue: /var/lib/ocis/nats/tls.crt type: string description: Path/File name of the TLS server certificate (in PEM format) for the - NATS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/nats. + NATS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/nats. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -7241,7 +7241,7 @@ NATS_TLS_KEY: defaultValue: /var/lib/ocis/nats/tls.key type: string description: Path/File name for the TLS certificate key (in PEM format) for the - NATS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/nats. + NATS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/nats. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -7921,7 +7921,7 @@ OCIS_ASSET_THEMES_PATH: defaultValue: /var/lib/ocis/web/assets/themes type: string description: Serve ownCloud themes from a path on the filesystem instead of the - builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/web/assets/themes + builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/web/assets/themes introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" @@ -9358,7 +9358,7 @@ OCM_OCM_CORE_JSON_FILE: defaultValue: /var/lib/ocis/storage/ocm/ocmshares.json type: string description: Path to the JSON file where OCM share data will be stored. If not defined, - the root directory derives from $OCIS_BASE_DATA_PATH:/storage. + the root directory derives from $OCIS_BASE_DATA_PATH/storage. introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" @@ -9388,7 +9388,7 @@ OCM_OCM_INVITE_MANAGER_JSON_FILE: type: string description: 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/ocm. + the root directory derives from $OCIS_BASE_DATA_PATH/storage/ocm. introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" @@ -9416,7 +9416,7 @@ OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE: defaultValue: /etc/ocis/ocmproviders.json type: string description: Path to the JSON file where ocm invite data will be stored. Defaults - to $OCIS_CONFIG_DIR:/ocmproviders.json. + to $OCIS_CONFIG_DIR/ocmproviders.json. introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" @@ -9456,7 +9456,7 @@ OCM_OCM_SHAREPROVIDER_JSON_FILE: defaultValue: /var/lib/ocis/storage/ocm/ocmshares.json type: string description: Path to the JSON file where OCM share data will be stored. If not defined, - the root directory derives from $OCIS_BASE_DATA_PATH:/storage. + the root directory derives from $OCIS_BASE_DATA_PATH/storage. introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" @@ -10986,7 +10986,7 @@ PROXY_TRANSPORT_TLS_CERT: defaultValue: /var/lib/ocis/proxy/server.crt type: string description: Path/File name of the TLS server certificate (in PEM format) for the - external http services. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/proxy. + external http services. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/proxy. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -10997,7 +10997,7 @@ PROXY_TRANSPORT_TLS_KEY: type: string description: Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the external http services. If not defined, the - root directory derives from $OCIS_BASE_DATA_PATH:/proxy. + root directory derives from $OCIS_BASE_DATA_PATH/proxy. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -11077,7 +11077,7 @@ SEARCH_ENGINE_BLEVE_DATA_PATH: defaultValue: /var/lib/ocis/search type: string description: The directory where the filesystem will store search data. If not defined, - the root directory derives from $OCIS_BASE_DATA_PATH:/search. + the root directory derives from $OCIS_BASE_DATA_PATH/search. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -11485,7 +11485,7 @@ SETTINGS_DATA_PATH: defaultValue: /var/lib/ocis/settings type: string description: The directory where the filesystem storage will store ocis settings. - If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/settings. + If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/settings. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -12019,7 +12019,7 @@ SHARING_PUBLIC_JSON_FILE: type: string description: Path to the JSON file where public share meta-data will be stored. This JSON file contains the information about public shares that have been created. - If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. + If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -12186,7 +12186,7 @@ SHARING_USER_JSON_FILE: defaultValue: /var/lib/ocis/storage/shares.json type: string description: Path to the JSON file where shares will be persisted. If not defined, - the root directory derives from $OCIS_BASE_DATA_PATH:/storage. + the root directory derives from $OCIS_BASE_DATA_PATH/storage. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -13157,7 +13157,7 @@ STORAGE_SYSTEM_OCIS_ROOT: defaultValue: /var/lib/ocis/storage/metadata type: string description: Path for the directory where the STORAGE-SYSTEM service stores it's - persistent data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. + persistent data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -13839,7 +13839,7 @@ STORAGE_USERS_OCIS_ROOT: defaultValue: /var/lib/ocis/storage/users type: string description: The directory where the filesystem storage will store blobs and metadata. - If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/users. + If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/users. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -13867,7 +13867,7 @@ STORAGE_USERS_OWNCLOUDSQL_DATADIR: defaultValue: /var/lib/ocis/storage/owncloud type: string description: The directory where the filesystem storage will store SQL migration - data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/owncloud. + data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/owncloud. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -13941,7 +13941,7 @@ STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR: defaultValue: /var/lib/ocis/storage/uploadinfo type: string description: The directory where the filesystem will store uploads temporarily. - If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/uploadinfo. + If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/uploadinfo. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -13998,7 +13998,7 @@ STORAGE_USERS_POSIX_ROOT: defaultValue: "" type: string description: The directory where the filesystem storage will store its data. If - not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/users. + not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/users. introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" @@ -14294,7 +14294,7 @@ STORAGE_USERS_S3NG_ROOT: defaultValue: /var/lib/ocis/storage/users type: string description: The directory where the filesystem storage will store metadata for - blobs. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/users. + blobs. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/users. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -14429,7 +14429,7 @@ STORE_DATA_PATH: defaultValue: /var/lib/ocis/store type: string description: The directory where the filesystem storage will store ocis settings. - If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/store. + If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/store. introductionVersion: pre5.0 deprecationVersion: "5.0" removalVersion: 7.0.0 @@ -14661,7 +14661,7 @@ THUMBNAILS_FILESYSTEMSTORAGE_ROOT: defaultValue: /var/lib/ocis/thumbnails type: string description: The directory where the filesystem storage will store the thumbnails. - If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/thumbnails. + If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/thumbnails. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -15333,7 +15333,7 @@ USERS_LDAP_CACERT: type: string description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root - directory derives from $OCIS_BASE_DATA_PATH:/idm. + directory derives from $OCIS_BASE_DATA_PATH/idm. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -15775,7 +15775,7 @@ WEB_ASSET_APPS_PATH: defaultValue: /var/lib/ocis/web/assets/apps type: string description: Serve ownCloud Web apps assets from a path on the filesystem instead - of the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/web/assets/apps + of the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/web/assets/apps introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" @@ -15785,7 +15785,7 @@ WEB_ASSET_CORE_PATH: defaultValue: /var/lib/ocis/web/assets/core type: string description: Serve ownCloud Web assets from a path on the filesystem instead of - the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/web/assets/core + the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/web/assets/core introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" @@ -15805,7 +15805,7 @@ WEB_ASSET_THEMES_PATH: defaultValue: /var/lib/ocis/web/assets/themes type: string description: Serve ownCloud themes from a path on the filesystem instead of the - builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/web/assets/themes + builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/web/assets/themes introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" diff --git a/docs/services/general-info/env-var-deltas/4.0.0-5.0.0-added.adoc b/docs/services/general-info/env-var-deltas/4.0.0-5.0.0-added.adoc index dd7f27a2959..7f09381b12a 100644 --- a/docs/services/general-info/env-var-deltas/4.0.0-5.0.0-added.adoc +++ b/docs/services/general-info/env-var-deltas/4.0.0-5.0.0-added.adoc @@ -466,10 +466,10 @@ | Disable TLS certificate validation for the OCM connections. Do not set this in production environments.| | | `OCM_OCM_INVITE_MANAGER_JSON_FILE` -| 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.| +| 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.| | | `OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE` -| 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.| +| 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.| | | `OCM_OCM_PROVIDER_AUTHORIZER_VERIFY_REQUEST_HOSTNAME` | Verify the hostname of the request against the hostname of the OCM provider.| @@ -484,7 +484,7 @@ | Directory where the ocm storage provider persists its data like tus upload info files.| | | `OCM_OCM_CORE_JSON_FILE` -| Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage.| +| Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage.| | | `OCM_OCM_SHARE_PROVIDER_DRIVER` | Driver to be used to persist ocm shares. Supported value is only 'json'.| `json` @@ -496,7 +496,7 @@ | Template for the webapp url.| | | `OCM_OCM_SHAREPROVIDER_JSON_FILE` -| Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage.| +| Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage.| | | `OCM_DEBUG_ADDR` diff --git a/docs/services/general-info/env-var-deltas/4.0.0-5.0.0-added.md b/docs/services/general-info/env-var-deltas/4.0.0-5.0.0-added.md index 3e273a99a47..bc23e85dc00 100644 --- a/docs/services/general-info/env-var-deltas/4.0.0-5.0.0-added.md +++ b/docs/services/general-info/env-var-deltas/4.0.0-5.0.0-added.md @@ -122,17 +122,17 @@ | | `OCM_OCMD_EXPOSE_RECIPIENT_DISPLAY_NAME` | Expose the display name of OCM share recipients. | | | | `OCM_OCM_INVITE_MANAGER_DRIVER` | Driver to be used to persist ocm invites. Supported value is only 'json'. | `json` | | | `OCM_OCM_INVITE_MANAGER_INSECURE` | Disable TLS certificate validation for the OCM connections. Do not set this in production environments. | | -| | `OCM_OCM_INVITE_MANAGER_JSON_FILE` | 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. | | -| | `OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE` | 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. | | +| | `OCM_OCM_INVITE_MANAGER_JSON_FILE` | 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. | | +| | `OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE` | 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. | | | | `OCM_OCM_PROVIDER_AUTHORIZER_VERIFY_REQUEST_HOSTNAME` | Verify the hostname of the request against the hostname of the OCM provider. | | | | `OCM_OCM_CORE_DRIVER` | Driver to be used to persist ocm shares. Supported value is only 'json'. | `json` | | | `OCM_OCM_STORAGE_PROVIDER_INSECURE` | Disable TLS certificate validation for the OCM connections. Do not set this in production environments. | | | | `OCM_OCM_STORAGE_PROVIDER_STORAGE_ROOT` | Directory where the ocm storage provider persists its data like tus upload info files. | | -| | `OCM_OCM_CORE_JSON_FILE` | Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. | | +| | `OCM_OCM_CORE_JSON_FILE` | Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage. | | | | `OCM_OCM_SHARE_PROVIDER_DRIVER` | Driver to be used to persist ocm shares. Supported value is only 'json'. | `json` | | | `OCM_OCM_SHARE_PROVIDER_INSECURE` | Disable TLS certificate validation for the OCM connections. Do not set this in production environments. | | | | `OCM_WEBAPP_TEMPLATE` | Template for the webapp url. | | -| | `OCM_OCM_SHAREPROVIDER_JSON_FILE` | Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. | | +| | `OCM_OCM_SHAREPROVIDER_JSON_FILE` | Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage. | | | services/ocm/pkg/config/debug.go | `OCM_DEBUG_ADDR` | Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. | | | | `OCM_DEBUG_TOKEN` | Token to secure the metrics endpoint. | | | | `OCM_DEBUG_PPROF` | Enables pprof, which can be used for profiling. | | diff --git a/services/ocm/pkg/config/config.go b/services/ocm/pkg/config/config.go index b41c6eaf007..54ff647cd90 100644 --- a/services/ocm/pkg/config/config.go +++ b/services/ocm/pkg/config/config.go @@ -106,7 +106,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. 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/ocm." 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/ocm." introductionVersion:"5.0"` } type OCMProviderAuthorizerDrivers struct { @@ -114,7 +114,7 @@ type OCMProviderAuthorizerDrivers struct { } type OCMProviderAuthorizerJSONDriver struct { - Providers string `yaml:"providers" env:"OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE" desc:"Path to the JSON file where ocm invite data will be stored. Defaults to $OCIS_CONFIG_DIR:/ocmproviders.json." introductionVersion:"5.0"` + Providers string `yaml:"providers" env:"OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE" desc:"Path to the JSON file where ocm invite data will be stored. Defaults to $OCIS_CONFIG_DIR/ocmproviders.json." introductionVersion:"5.0"` VerifyRequestHostname bool `yaml:"verify_request_hostname" env:"OCM_OCM_PROVIDER_AUTHORIZER_VERIFY_REQUEST_HOSTNAME" desc:"Verify the hostname of the incoming request against the hostname of the OCM provider." introductionVersion:"5.0"` } @@ -132,7 +132,7 @@ type OCMCoreDrivers struct { } type OCMCoreJSONDriver struct { - File string `yaml:"file" env:"OCM_OCM_CORE_JSON_FILE" desc:"Path to the JSON file where OCM share 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_CORE_JSON_FILE" desc:"Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage." introductionVersion:"5.0"` } type OCMShareProvider struct { @@ -147,7 +147,7 @@ type OCMShareProviderDrivers struct { } type OCMShareProviderJSONDriver struct { - File string `yaml:"file" env:"OCM_OCM_SHAREPROVIDER_JSON_FILE" desc:"Path to the JSON file where OCM share 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_SHAREPROVIDER_JSON_FILE" desc:"Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage." introductionVersion:"5.0"` } // Events combine the configuration options for the event bus. From 0d719a7c7274e7b4dffe3e0e4db872d244f09e45 Mon Sep 17 00:00:00 2001 From: Juergen Weigert Date: Tue, 24 Sep 2024 17:51:20 +0200 Subject: [PATCH 2/4] fix: more colons after variables found. cd owncloud/ocis/services vi $(grep -l -r '[A-Z][A-Z][A-Z]:/') --- services/auth-basic/pkg/config/config.go | 2 +- services/graph/pkg/config/config.go | 2 +- services/groups/pkg/config/config.go | 2 +- services/idm/pkg/config/config.go | 6 +++--- services/idp/pkg/config/config.go | 6 +++--- services/idp/pkg/config/http.go | 4 ++-- services/nats/README.md | 2 +- services/nats/pkg/config/config.go | 6 +++--- services/proxy/pkg/config/http.go | 4 ++-- services/search/pkg/config/engine.go | 2 +- services/sharing/pkg/config/config.go | 4 ++-- services/storage-system/pkg/config/config.go | 2 +- services/storage-users/pkg/config/config.go | 10 +++++----- services/thumbnails/pkg/config/config.go | 2 +- services/users/pkg/config/config.go | 2 +- services/web/pkg/config/config.go | 6 +++--- 16 files changed, 31 insertions(+), 31 deletions(-) diff --git a/services/auth-basic/pkg/config/config.go b/services/auth-basic/pkg/config/config.go index 3d2e3ea7738..5c1558679fb 100644 --- a/services/auth-basic/pkg/config/config.go +++ b/services/auth-basic/pkg/config/config.go @@ -63,7 +63,7 @@ type JSONProvider struct { type LDAPProvider struct { URI string `yaml:"uri" env:"OCIS_LDAP_URI;AUTH_BASIC_LDAP_URI" desc:"URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://'" introductionVersion:"pre5.0"` - CACert string `yaml:"ca_cert" env:"OCIS_LDAP_CACERT;AUTH_BASIC_LDAP_CACERT" desc:"Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm." introductionVersion:"pre5.0"` + CACert string `yaml:"ca_cert" env:"OCIS_LDAP_CACERT;AUTH_BASIC_LDAP_CACERT" desc:"Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idm." introductionVersion:"pre5.0"` Insecure bool `yaml:"insecure" env:"OCIS_LDAP_INSECURE;AUTH_BASIC_LDAP_INSECURE" desc:"Disable TLS certificate validation for the LDAP connections. Do not set this in production environments." introductionVersion:"pre5.0"` BindDN string `yaml:"bind_dn" env:"OCIS_LDAP_BIND_DN;AUTH_BASIC_LDAP_BIND_DN" desc:"LDAP DN to use for simple bind authentication with the target LDAP server." introductionVersion:"pre5.0"` BindPassword string `yaml:"bind_password" env:"OCIS_LDAP_BIND_PASSWORD;AUTH_BASIC_LDAP_BIND_PASSWORD" desc:"Password to use for authenticating the 'bind_dn'." introductionVersion:"pre5.0"` diff --git a/services/graph/pkg/config/config.go b/services/graph/pkg/config/config.go index 7c6c277c062..20f46b8b1b7 100644 --- a/services/graph/pkg/config/config.go +++ b/services/graph/pkg/config/config.go @@ -52,7 +52,7 @@ type Spaces struct { type LDAP struct { URI string `yaml:"uri" env:"OCIS_LDAP_URI;GRAPH_LDAP_URI" desc:"URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://'" introductionVersion:"pre5.0"` - CACert string `yaml:"cacert" env:"OCIS_LDAP_CACERT;GRAPH_LDAP_CACERT" desc:"Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm." introductionVersion:"pre5.0"` + CACert string `yaml:"cacert" env:"OCIS_LDAP_CACERT;GRAPH_LDAP_CACERT" desc:"Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idm." introductionVersion:"pre5.0"` Insecure bool `yaml:"insecure" env:"OCIS_LDAP_INSECURE;GRAPH_LDAP_INSECURE" desc:"Disable TLS certificate validation for the LDAP connections. Do not set this in production environments." introductionVersion:"pre5.0"` BindDN string `yaml:"bind_dn" env:"OCIS_LDAP_BIND_DN;GRAPH_LDAP_BIND_DN" desc:"LDAP DN to use for simple bind authentication with the target LDAP server." introductionVersion:"pre5.0"` BindPassword string `yaml:"bind_password" env:"OCIS_LDAP_BIND_PASSWORD;GRAPH_LDAP_BIND_PASSWORD" desc:"Password to use for authenticating the 'bind_dn'." introductionVersion:"pre5.0"` diff --git a/services/groups/pkg/config/config.go b/services/groups/pkg/config/config.go index b08c1703d69..fa6804aa768 100644 --- a/services/groups/pkg/config/config.go +++ b/services/groups/pkg/config/config.go @@ -62,7 +62,7 @@ type Drivers struct { type LDAPDriver struct { URI string `yaml:"uri" env:"OCIS_LDAP_URI;GROUPS_LDAP_URI" desc:"URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://'" introductionVersion:"pre5.0"` - CACert string `yaml:"ca_cert" env:"OCIS_LDAP_CACERT;GROUPS_LDAP_CACERT" desc:"Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm." introductionVersion:"pre5.0"` + CACert string `yaml:"ca_cert" env:"OCIS_LDAP_CACERT;GROUPS_LDAP_CACERT" desc:"Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idm." introductionVersion:"pre5.0"` Insecure bool `yaml:"insecure" env:"OCIS_LDAP_INSECURE;GROUPS_LDAP_INSECURE" desc:"Disable TLS certificate validation for the LDAP connections. Do not set this in production environments." introductionVersion:"pre5.0"` BindDN string `yaml:"bind_dn" env:"OCIS_LDAP_BIND_DN;GROUPS_LDAP_BIND_DN" desc:"LDAP DN to use for simple bind authentication with the target LDAP server." introductionVersion:"pre5.0"` BindPassword string `yaml:"bind_password" env:"OCIS_LDAP_BIND_PASSWORD;GROUPS_LDAP_BIND_PASSWORD" desc:"Password to use for authenticating the 'bind_dn'." introductionVersion:"pre5.0"` diff --git a/services/idm/pkg/config/config.go b/services/idm/pkg/config/config.go index 8aecb07c2de..df1782c4feb 100644 --- a/services/idm/pkg/config/config.go +++ b/services/idm/pkg/config/config.go @@ -28,9 +28,9 @@ type Config struct { type Settings struct { LDAPSAddr string `yaml:"ldaps_addr" env:"IDM_LDAPS_ADDR" desc:"Listen address for the LDAPS listener (ip-addr:port)." introductionVersion:"pre5.0"` - Cert string `yaml:"cert" env:"IDM_LDAPS_CERT" desc:"File name of the TLS server certificate for the LDAPS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm." introductionVersion:"pre5.0"` - Key string `yaml:"key" env:"IDM_LDAPS_KEY" desc:"File name for the TLS certificate key for the server certificate. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm." introductionVersion:"pre5.0"` - DatabasePath string `yaml:"database" env:"IDM_DATABASE_PATH" desc:"Full path to the IDM backend database. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm." introductionVersion:"pre5.0"` + Cert string `yaml:"cert" env:"IDM_LDAPS_CERT" desc:"File name of the TLS server certificate for the LDAPS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idm." introductionVersion:"pre5.0"` + Key string `yaml:"key" env:"IDM_LDAPS_KEY" desc:"File name for the TLS certificate key for the server certificate. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idm." introductionVersion:"pre5.0"` + DatabasePath string `yaml:"database" env:"IDM_DATABASE_PATH" desc:"Full path to the IDM backend database. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idm." introductionVersion:"pre5.0"` } type ServiceUserPasswords struct { diff --git a/services/idp/pkg/config/config.go b/services/idp/pkg/config/config.go index 893ea068e02..4d17011d1a3 100644 --- a/services/idp/pkg/config/config.go +++ b/services/idp/pkg/config/config.go @@ -34,7 +34,7 @@ type Config struct { // Ldap defines the available LDAP configuration. type Ldap struct { URI string `yaml:"uri" env:"OCIS_LDAP_URI;IDP_LDAP_URI" desc:"Url of the LDAP service to use as IDP." introductionVersion:"pre5.0"` - TLSCACert string `yaml:"cacert" env:"OCIS_LDAP_CACERT;IDP_LDAP_TLS_CACERT" desc:"Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idp." introductionVersion:"pre5.0"` + TLSCACert string `yaml:"cacert" env:"OCIS_LDAP_CACERT;IDP_LDAP_TLS_CACERT" desc:"Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idp." introductionVersion:"pre5.0"` BindDN string `yaml:"bind_dn" env:"OCIS_LDAP_BIND_DN;IDP_LDAP_BIND_DN" desc:"LDAP DN to use for simple bind authentication with the target LDAP server." introductionVersion:"pre5.0"` BindPassword string `yaml:"bind_password" env:"OCIS_LDAP_BIND_PASSWORD;IDP_LDAP_BIND_PASSWORD" desc:"Password to use for authenticating the 'bind_dn'." introductionVersion:"pre5.0"` @@ -90,7 +90,7 @@ type Settings struct { AllowClientGuests bool `yaml:"allow_client_guests" env:"IDP_ALLOW_CLIENT_GUESTS" desc:"Allow guest clients to access oCIS." introductionVersion:"pre5.0"` AllowDynamicClientRegistration bool `yaml:"allow_dynamic_client_registration" env:"IDP_ALLOW_DYNAMIC_CLIENT_REGISTRATION" desc:"Allow dynamic client registration." introductionVersion:"pre5.0"` - EncryptionSecretFile string `yaml:"encrypt_secret_file" env:"IDP_ENCRYPTION_SECRET_FILE" desc:"Path to the encryption secret file, if unset, a new certificate will be autogenerated upon each restart, thus invalidating all existing sessions. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idp." introductionVersion:"pre5.0"` + EncryptionSecretFile string `yaml:"encrypt_secret_file" env:"IDP_ENCRYPTION_SECRET_FILE" desc:"Path to the encryption secret file, if unset, a new certificate will be autogenerated upon each restart, thus invalidating all existing sessions. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idp." introductionVersion:"pre5.0"` Listen string @@ -105,7 +105,7 @@ type Settings struct { SigningKid string `yaml:"signing_kid" env:"IDP_SIGNING_KID" desc:"Value of the KID (Key ID) field which is used in created tokens to uniquely identify the signing-private-key." introductionVersion:"pre5.0"` SigningMethod string `yaml:"signing_method" env:"IDP_SIGNING_METHOD" desc:"Signing method of IDP requests like 'PS256'" introductionVersion:"pre5.0"` - SigningPrivateKeyFiles []string `yaml:"signing_private_key_files" env:"IDP_SIGNING_PRIVATE_KEY_FILES" desc:"A list of private key files for signing IDP requests. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idp. See the Environment Variable Types description for more details." introductionVersion:"pre5.0"` + SigningPrivateKeyFiles []string `yaml:"signing_private_key_files" env:"IDP_SIGNING_PRIVATE_KEY_FILES" desc:"A list of private key files for signing IDP requests. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idp. See the Environment Variable Types description for more details." introductionVersion:"pre5.0"` ValidationKeysPath string `yaml:"validation_keys_path" env:"IDP_VALIDATION_KEYS_PATH" desc:"Path to validation keys for IDP requests." introductionVersion:"pre5.0"` CookieBackendURI string diff --git a/services/idp/pkg/config/http.go b/services/idp/pkg/config/http.go index 5577aa3858f..7c3f36dcf48 100644 --- a/services/idp/pkg/config/http.go +++ b/services/idp/pkg/config/http.go @@ -5,7 +5,7 @@ type HTTP struct { Addr string `yaml:"addr" env:"IDP_HTTP_ADDR" desc:"The bind address of the HTTP service." introductionVersion:"pre5.0"` Root string `yaml:"root" env:"IDP_HTTP_ROOT" desc:"Subdirectory that serves as the root for this HTTP service." introductionVersion:"pre5.0"` Namespace string `yaml:"-"` - TLSCert string `yaml:"tls_cert" env:"IDP_TRANSPORT_TLS_CERT" desc:"Path/File name of the TLS server certificate (in PEM format) for the IDP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idp." introductionVersion:"pre5.0"` - TLSKey string `yaml:"tls_key" env:"IDP_TRANSPORT_TLS_KEY" desc:"Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the IDP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idp." introductionVersion:"pre5.0"` + TLSCert string `yaml:"tls_cert" env:"IDP_TRANSPORT_TLS_CERT" desc:"Path/File name of the TLS server certificate (in PEM format) for the IDP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idp." introductionVersion:"pre5.0"` + TLSKey string `yaml:"tls_key" env:"IDP_TRANSPORT_TLS_KEY" desc:"Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the IDP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idp." introductionVersion:"pre5.0"` TLS bool `yaml:"tls" env:"IDP_TLS" desc:"Disable or Enable HTTPS for the communication between the Proxy service and the IDP service. If set to 'true', the key and cert files need to be configured and present." introductionVersion:"pre5.0"` } diff --git a/services/nats/README.md b/services/nats/README.md index e8568e7b43c..3a9da526cf7 100644 --- a/services/nats/README.md +++ b/services/nats/README.md @@ -16,7 +16,7 @@ Note that when `MICRO_REGISTRY` is configured using `kubernetes`, the NATS servi ## Persistance -To be able to deliver events even after a system or service restart, nats will store events in a folder on the local filesystem. This folder can be specified by setting the `NATS_NATS_STORE_DIR` enviroment variable. If not set, the service will fall back to `$OCIS_BASE_DATA_PATH:/nats`. +To be able to deliver events even after a system or service restart, nats will store events in a folder on the local filesystem. This folder can be specified by setting the `NATS_NATS_STORE_DIR` enviroment variable. If not set, the service will fall back to `$OCIS_BASE_DATA_PATH/nats`. ## TLS Encryption diff --git a/services/nats/pkg/config/config.go b/services/nats/pkg/config/config.go index 2a6ba16b634..421e936afa8 100644 --- a/services/nats/pkg/config/config.go +++ b/services/nats/pkg/config/config.go @@ -24,9 +24,9 @@ type Nats struct { Host string `yaml:"host" env:"NATS_NATS_HOST" desc:"Bind address." introductionVersion:"pre5.0"` Port int `yaml:"port" env:"NATS_NATS_PORT" desc:"Bind port." introductionVersion:"pre5.0"` ClusterID string `yaml:"clusterid" env:"NATS_NATS_CLUSTER_ID" desc:"ID of the NATS cluster." introductionVersion:"pre5.0"` - StoreDir string `yaml:"store_dir" env:"NATS_NATS_STORE_DIR" desc:"The directory where the filesystem storage will store NATS JetStream data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/nats." introductionVersion:"pre5.0"` - TLSCert string `yaml:"tls_cert" env:"NATS_TLS_CERT" desc:"Path/File name of the TLS server certificate (in PEM format) for the NATS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/nats." introductionVersion:"pre5.0"` - TLSKey string `yaml:"tls_key" env:"NATS_TLS_KEY" desc:"Path/File name for the TLS certificate key (in PEM format) for the NATS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/nats." introductionVersion:"pre5.0"` + StoreDir string `yaml:"store_dir" env:"NATS_NATS_STORE_DIR" desc:"The directory where the filesystem storage will store NATS JetStream data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/nats." introductionVersion:"pre5.0"` + TLSCert string `yaml:"tls_cert" env:"NATS_TLS_CERT" desc:"Path/File name of the TLS server certificate (in PEM format) for the NATS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/nats." introductionVersion:"pre5.0"` + TLSKey string `yaml:"tls_key" env:"NATS_TLS_KEY" desc:"Path/File name for the TLS certificate key (in PEM format) for the NATS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/nats." introductionVersion:"pre5.0"` TLSSkipVerifyClientCert bool `yaml:"tls_skip_verify_client_cert" env:"OCIS_INSECURE;NATS_TLS_SKIP_VERIFY_CLIENT_CERT" desc:"Whether the NATS server should skip the client certificate verification during the TLS handshake." introductionVersion:"pre5.0"` EnableTLS bool `yaml:"enable_tls" env:"OCIS_EVENTS_ENABLE_TLS;NATS_EVENTS_ENABLE_TLS" desc:"Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services." introductionVersion:"pre5.0"` } diff --git a/services/proxy/pkg/config/http.go b/services/proxy/pkg/config/http.go index f3ddc683f4a..af831ad6972 100644 --- a/services/proxy/pkg/config/http.go +++ b/services/proxy/pkg/config/http.go @@ -5,7 +5,7 @@ type HTTP struct { Addr string `yaml:"addr" env:"PROXY_HTTP_ADDR" desc:"The bind address of the HTTP service." introductionVersion:"pre5.0"` Root string `yaml:"root" env:"PROXY_HTTP_ROOT" desc:"Subdirectory that serves as the root for this HTTP service." introductionVersion:"pre5.0"` Namespace string `yaml:"-"` - TLSCert string `yaml:"tls_cert" env:"PROXY_TRANSPORT_TLS_CERT" desc:"Path/File name of the TLS server certificate (in PEM format) for the external http services. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/proxy." introductionVersion:"pre5.0"` - TLSKey string `yaml:"tls_key" env:"PROXY_TRANSPORT_TLS_KEY" desc:"Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the external http services. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/proxy." introductionVersion:"pre5.0"` + TLSCert string `yaml:"tls_cert" env:"PROXY_TRANSPORT_TLS_CERT" desc:"Path/File name of the TLS server certificate (in PEM format) for the external http services. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/proxy." introductionVersion:"pre5.0"` + TLSKey string `yaml:"tls_key" env:"PROXY_TRANSPORT_TLS_KEY" desc:"Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the external http services. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/proxy." introductionVersion:"pre5.0"` TLS bool `yaml:"tls" env:"PROXY_TLS" desc:"Enable/Disable HTTPS for external HTTP services. Must be set to 'true' if the built-in IDP service an no reverse proxy is used. See the text description for details." introductionVersion:"pre5.0"` } diff --git a/services/search/pkg/config/engine.go b/services/search/pkg/config/engine.go index a1b2f78b652..15cd29a378a 100644 --- a/services/search/pkg/config/engine.go +++ b/services/search/pkg/config/engine.go @@ -8,5 +8,5 @@ type Engine struct { // EngineBleve configures the bleve engine type EngineBleve struct { - Datapath string `yaml:"data_path" env:"SEARCH_ENGINE_BLEVE_DATA_PATH" desc:"The directory where the filesystem will store search data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/search." introductionVersion:"pre5.0"` + Datapath string `yaml:"data_path" env:"SEARCH_ENGINE_BLEVE_DATA_PATH" desc:"The directory where the filesystem will store search data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/search." introductionVersion:"pre5.0"` } diff --git a/services/sharing/pkg/config/config.go b/services/sharing/pkg/config/config.go index 2bc58d850bb..cbb05888ca1 100644 --- a/services/sharing/pkg/config/config.go +++ b/services/sharing/pkg/config/config.go @@ -69,7 +69,7 @@ type UserSharingDrivers struct { } type UserSharingJSONDriver struct { - File string `yaml:"file" env:"SHARING_USER_JSON_FILE" desc:"Path to the JSON file where shares will be persisted. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage." introductionVersion:"pre5.0"` + File string `yaml:"file" env:"SHARING_USER_JSON_FILE" desc:"Path to the JSON file where shares will be persisted. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage." introductionVersion:"pre5.0"` } type UserSharingSQLDriver struct { @@ -117,7 +117,7 @@ type PublicSharingDrivers struct { } type PublicSharingJSONDriver struct { - File string `yaml:"file" env:"SHARING_PUBLIC_JSON_FILE" desc:"Path to the JSON file where public share meta-data will be stored. This JSON file contains the information about public shares that have been created. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage." introductionVersion:"pre5.0"` + File string `yaml:"file" env:"SHARING_PUBLIC_JSON_FILE" desc:"Path to the JSON file where public share meta-data will be stored. This JSON file contains the information about public shares that have been created. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage." introductionVersion:"pre5.0"` } type PublicSharingSQLDriver struct { diff --git a/services/storage-system/pkg/config/config.go b/services/storage-system/pkg/config/config.go index 75d2adcb909..ec4c0f898b5 100644 --- a/services/storage-system/pkg/config/config.go +++ b/services/storage-system/pkg/config/config.go @@ -79,7 +79,7 @@ type Drivers struct { // OCISDriver holds ocis Driver config type OCISDriver struct { // Root is the absolute path to the location of the data - Root string `yaml:"root" env:"STORAGE_SYSTEM_OCIS_ROOT" desc:"Path for the directory where the STORAGE-SYSTEM service stores it's persistent data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage." introductionVersion:"pre5.0"` + Root string `yaml:"root" env:"STORAGE_SYSTEM_OCIS_ROOT" desc:"Path for the directory where the STORAGE-SYSTEM service stores it's persistent data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage." introductionVersion:"pre5.0"` MaxAcquireLockCycles int `yaml:"max_acquire_lock_cycles" env:"STORAGE_SYSTEM_OCIS_MAX_ACQUIRE_LOCK_CYCLES" desc:"When trying to lock files, ocis will try this amount of times to acquire the lock before failing. After each try it will wait for an increasing amount of time. Values of 0 or below will be ignored and the default value of 20 will be used." introductionVersion:"pre5.0"` LockCycleDurationFactor int `yaml:"lock_cycle_duration_factor" env:"STORAGE_SYSTEM_OCIS_LOCK_CYCLE_DURATION_FACTOR" desc:"When trying to lock files, ocis will multiply the cycle with this factor and use it as a millisecond timeout. Values of 0 or below will be ignored and the default value of 30 will be used." introductionVersion:"pre5.0"` diff --git a/services/storage-users/pkg/config/config.go b/services/storage-users/pkg/config/config.go index d9f30aaf1ae..bd272e7444c 100644 --- a/services/storage-users/pkg/config/config.go +++ b/services/storage-users/pkg/config/config.go @@ -119,7 +119,7 @@ type OCISDriver struct { Propagator string `yaml:"propagator" env:"OCIS_DECOMPOSEDFS_PROPAGATOR;STORAGE_USERS_OCIS_PROPAGATOR" desc:"The propagator used for decomposedfs. At the moment, only 'sync' is fully supported, 'async' is available as an experimental option." introductionVersion:"pre5.0"` AsyncPropagatorOptions AsyncPropagatorOptions `yaml:"async_propagator_options"` // Root is the absolute path to the location of the data - Root string `yaml:"root" env:"STORAGE_USERS_OCIS_ROOT" desc:"The directory where the filesystem storage will store blobs and metadata. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/users." introductionVersion:"pre5.0"` + Root string `yaml:"root" env:"STORAGE_USERS_OCIS_ROOT" desc:"The directory where the filesystem storage will store blobs and metadata. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/users." introductionVersion:"pre5.0"` UserLayout string `yaml:"user_layout" env:"STORAGE_USERS_OCIS_USER_LAYOUT" desc:"Template string for the user storage layout in the user directory." introductionVersion:"pre5.0"` PermissionsEndpoint string `yaml:"permissions_endpoint" env:"STORAGE_USERS_PERMISSION_ENDPOINT;STORAGE_USERS_OCIS_PERMISSIONS_ENDPOINT" desc:"Endpoint of the permissions service. The endpoints can differ for 'ocis' and 's3ng'." introductionVersion:"pre5.0"` // PersonalSpaceAliasTemplate contains the template used to construct @@ -145,7 +145,7 @@ type S3NGDriver struct { Propagator string `yaml:"propagator" env:"OCIS_DECOMPOSEDFS_PROPAGATOR;STORAGE_USERS_S3NG_PROPAGATOR" desc:"The propagator used for decomposedfs. At the moment, only 'sync' is fully supported, 'async' is available as an experimental option." introductionVersion:"pre5.0"` AsyncPropagatorOptions AsyncPropagatorOptions `yaml:"async_propagator_options"` // Root is the absolute path to the location of the data - Root string `yaml:"root" env:"STORAGE_USERS_S3NG_ROOT" desc:"The directory where the filesystem storage will store metadata for blobs. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/users." introductionVersion:"pre5.0"` + Root string `yaml:"root" env:"STORAGE_USERS_S3NG_ROOT" desc:"The directory where the filesystem storage will store metadata for blobs. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/users." introductionVersion:"pre5.0"` UserLayout string `yaml:"user_layout" env:"STORAGE_USERS_S3NG_USER_LAYOUT" desc:"Template string for the user storage layout in the user directory." introductionVersion:"pre5.0"` PermissionsEndpoint string `yaml:"permissions_endpoint" env:"STORAGE_USERS_PERMISSION_ENDPOINT;STORAGE_USERS_S3NG_PERMISSIONS_ENDPOINT" desc:"Endpoint of the permissions service. The endpoints can differ for 'ocis' and 's3ng'." introductionVersion:"pre5.0"` Region string `yaml:"region" env:"STORAGE_USERS_S3NG_REGION" desc:"Region of the S3 bucket." introductionVersion:"pre5.0"` @@ -178,11 +178,11 @@ type S3NGDriver struct { // OwnCloudSQLDriver is the storage driver configuration when using 'owncloudsql' storage driver type OwnCloudSQLDriver struct { // Root is the absolute path to the location of the data - Root string `yaml:"root" env:"STORAGE_USERS_OWNCLOUDSQL_DATADIR" desc:"The directory where the filesystem storage will store SQL migration data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/owncloud." introductionVersion:"pre5.0"` + Root string `yaml:"root" env:"STORAGE_USERS_OWNCLOUDSQL_DATADIR" desc:"The directory where the filesystem storage will store SQL migration data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/owncloud." introductionVersion:"pre5.0"` // ShareFolder defines the name of the folder jailing all shares ShareFolder string `yaml:"share_folder" env:"STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER" desc:"Name of the folder jailing all shares." introductionVersion:"pre5.0"` UserLayout string `yaml:"user_layout" env:"STORAGE_USERS_OWNCLOUDSQL_LAYOUT" desc:"Path layout to use to navigate into a users folder in an owncloud data directory" introductionVersion:"pre5.0"` - UploadInfoDir string `yaml:"upload_info_dir" env:"STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR" desc:"The directory where the filesystem will store uploads temporarily. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/uploadinfo." introductionVersion:"pre5.0"` + UploadInfoDir string `yaml:"upload_info_dir" env:"STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR" desc:"The directory where the filesystem will store uploads temporarily. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/uploadinfo." introductionVersion:"pre5.0"` DBUsername string `yaml:"db_username" env:"STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME" desc:"Username for the database." introductionVersion:"pre5.0"` DBPassword string `yaml:"db_password" env:"STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD" desc:"Password for the database." introductionVersion:"pre5.0"` DBHost string `yaml:"db_host" env:"STORAGE_USERS_OWNCLOUDSQL_DB_HOST" desc:"Hostname or IP of the database server." introductionVersion:"pre5.0"` @@ -194,7 +194,7 @@ type OwnCloudSQLDriver struct { // PosixDriver is the storage driver configuration when using 'posix' storage driver type PosixDriver struct { // Root is the absolute path to the location of the data - Root string `yaml:"root" env:"STORAGE_USERS_POSIX_ROOT" desc:"The directory where the filesystem storage will store its data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/users." introductionVersion:"6.0.0"` + Root string `yaml:"root" env:"STORAGE_USERS_POSIX_ROOT" desc:"The directory where the filesystem storage will store its data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/users." introductionVersion:"6.0.0"` PersonalSpacePathTemplate string `yaml:"personalspacepath_template" env:"STORAGE_USERS_POSIX_PERSONAL_SPACE_PATH_TEMPLATE" desc:"Template string to construct the paths of the personal space roots." introductionVersion:"6.0.0"` GeneralSpacePathTemplate string `yaml:"generalspacepath_template" env:"STORAGE_USERS_POSIX_GENERAL_SPACE_PATH_TEMPLATE" desc:"Template string to construct the paths of the projects space roots." introductionVersion:"6.0.0"` PermissionsEndpoint string `yaml:"permissions_endpoint" env:"STORAGE_USERS_PERMISSION_ENDPOINT;STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT" desc:"Endpoint of the permissions service. The endpoints can differ for 'ocis', 'posix' and 's3ng'." introductionVersion:"6.0.0"` diff --git a/services/thumbnails/pkg/config/config.go b/services/thumbnails/pkg/config/config.go index 297ae1cd1a5..99004bc36d6 100644 --- a/services/thumbnails/pkg/config/config.go +++ b/services/thumbnails/pkg/config/config.go @@ -31,7 +31,7 @@ type Config struct { // FileSystemStorage defines the available filesystem storage configuration. type FileSystemStorage struct { - RootDirectory string `yaml:"root_directory" env:"THUMBNAILS_FILESYSTEMSTORAGE_ROOT" desc:"The directory where the filesystem storage will store the thumbnails. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/thumbnails." introductionVersion:"pre5.0"` + RootDirectory string `yaml:"root_directory" env:"THUMBNAILS_FILESYSTEMSTORAGE_ROOT" desc:"The directory where the filesystem storage will store the thumbnails. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/thumbnails." introductionVersion:"pre5.0"` } // Thumbnail defines the available thumbnail related configuration. diff --git a/services/users/pkg/config/config.go b/services/users/pkg/config/config.go index 2dd956c8b34..e6c7ddfdfd1 100644 --- a/services/users/pkg/config/config.go +++ b/services/users/pkg/config/config.go @@ -64,7 +64,7 @@ type JSONDriver struct { } type LDAPDriver struct { URI string `yaml:"uri" env:"OCIS_LDAP_URI;USERS_LDAP_URI" desc:"URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://'" introductionVersion:"pre5.0"` - CACert string `yaml:"ca_cert" env:"OCIS_LDAP_CACERT;USERS_LDAP_CACERT" desc:"Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm." introductionVersion:"pre5.0"` + CACert string `yaml:"ca_cert" env:"OCIS_LDAP_CACERT;USERS_LDAP_CACERT" desc:"Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idm." introductionVersion:"pre5.0"` Insecure bool `yaml:"insecure" env:"OCIS_LDAP_INSECURE;USERS_LDAP_INSECURE" desc:"Disable TLS certificate validation for the LDAP connections. Do not set this in production environments." introductionVersion:"pre5.0"` BindDN string `yaml:"bind_dn" env:"OCIS_LDAP_BIND_DN;USERS_LDAP_BIND_DN" desc:"LDAP DN to use for simple bind authentication with the target LDAP server." introductionVersion:"pre5.0"` BindPassword string `yaml:"bind_password" env:"OCIS_LDAP_BIND_PASSWORD;USERS_LDAP_BIND_PASSWORD" desc:"Password to use for authenticating the 'bind_dn'." introductionVersion:"pre5.0"` diff --git a/services/web/pkg/config/config.go b/services/web/pkg/config/config.go index c0c6f1b96c8..34e5995d0a0 100644 --- a/services/web/pkg/config/config.go +++ b/services/web/pkg/config/config.go @@ -32,9 +32,9 @@ type Config struct { // Asset defines the available asset configuration. type Asset struct { DeprecatedPath string `yaml:"path" env:"WEB_ASSET_PATH" desc:"Serve ownCloud Web assets from a path on the filesystem instead of the builtin assets." introductionVersion:"pre5.0" deprecationVersion:"5.1.0" removalVersion:"%%NEXT_PRODUCTION_VERSION%%" deprecationInfo:"The WEB_ASSET_PATH is deprecated and will be removed in the future." deprecationReplacement:"Use WEB_ASSET_CORE_PATH instead."` - CorePath string `yaml:"core_path" env:"WEB_ASSET_CORE_PATH" desc:"Serve ownCloud Web assets from a path on the filesystem instead of the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/web/assets/core" introductionVersion:"6.0.0"` - ThemesPath string `yaml:"themes_path" env:"OCIS_ASSET_THEMES_PATH;WEB_ASSET_THEMES_PATH" desc:"Serve ownCloud themes from a path on the filesystem instead of the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/web/assets/themes" introductionVersion:"6.0.0"` - AppsPath string `yaml:"apps_path" env:"WEB_ASSET_APPS_PATH" desc:"Serve ownCloud Web apps assets from a path on the filesystem instead of the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/web/assets/apps" introductionVersion:"6.0.0"` + CorePath string `yaml:"core_path" env:"WEB_ASSET_CORE_PATH" desc:"Serve ownCloud Web assets from a path on the filesystem instead of the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/web/assets/core" introductionVersion:"6.0.0"` + ThemesPath string `yaml:"themes_path" env:"OCIS_ASSET_THEMES_PATH;WEB_ASSET_THEMES_PATH" desc:"Serve ownCloud themes from a path on the filesystem instead of the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/web/assets/themes" introductionVersion:"6.0.0"` + AppsPath string `yaml:"apps_path" env:"WEB_ASSET_APPS_PATH" desc:"Serve ownCloud Web apps assets from a path on the filesystem instead of the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/web/assets/apps" introductionVersion:"6.0.0"` } // CustomStyle references additional css to be loaded into ownCloud Web. From fd85e78af707410e1db68448adeca98ba5937960 Mon Sep 17 00:00:00 2001 From: Martin Mattel Date: Wed, 2 Oct 2024 09:11:04 +0200 Subject: [PATCH 3/4] revert two files and rebase --- docs/helpers/env_vars.yaml | 74 +++++++++---------- .../env-var-deltas/4.0.0-5.0.0-added.adoc | 8 +- 2 files changed, 41 insertions(+), 41 deletions(-) diff --git a/docs/helpers/env_vars.yaml b/docs/helpers/env_vars.yaml index fb41a9315f8..97f93bb0910 100644 --- a/docs/helpers/env_vars.yaml +++ b/docs/helpers/env_vars.yaml @@ -1589,7 +1589,7 @@ AUTH_BASIC_LDAP_CACERT: type: string description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root - directory derives from $OCIS_BASE_DATA_PATH/idm. + directory derives from $OCIS_BASE_DATA_PATH:/idm. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -5079,7 +5079,7 @@ GRAPH_LDAP_CACERT: type: string description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root - directory derives from $OCIS_BASE_DATA_PATH/idm. + directory derives from $OCIS_BASE_DATA_PATH:/idm. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -5713,7 +5713,7 @@ GROUPS_LDAP_CACERT: type: string description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root - directory derives from $OCIS_BASE_DATA_PATH/idm. + directory derives from $OCIS_BASE_DATA_PATH:/idm. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -6144,7 +6144,7 @@ IDM_DATABASE_PATH: defaultValue: /var/lib/ocis/idm/ocis.boltdb type: string description: Full path to the IDM backend database. If not defined, the root directory - derives from $OCIS_BASE_DATA_PATH/idm. + derives from $OCIS_BASE_DATA_PATH:/idm. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -6211,7 +6211,7 @@ IDM_LDAPS_CERT: defaultValue: /var/lib/ocis/idm/ldap.crt type: string description: File name of the TLS server certificate for the LDAPS listener. If - not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idm. + not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -6221,7 +6221,7 @@ IDM_LDAPS_KEY: defaultValue: /var/lib/ocis/idm/ldap.key type: string description: File name for the TLS certificate key for the server certificate. If - not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idm. + not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -6412,7 +6412,7 @@ IDP_ENCRYPTION_SECRET_FILE: type: string description: Path to the encryption secret file, if unset, a new certificate will be autogenerated upon each restart, thus invalidating all existing sessions. If - not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idp. + not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idp. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -6571,7 +6571,7 @@ IDP_LDAP_TLS_CACERT: type: string description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root - directory derives from $OCIS_BASE_DATA_PATH/idp. + directory derives from $OCIS_BASE_DATA_PATH:/idp. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -6721,7 +6721,7 @@ IDP_SIGNING_PRIVATE_KEY_FILES: defaultValue: '[/var/lib/ocis/idp/private-key.pem]' type: '[]string' description: A list of private key files for signing IDP requests. If not defined, - the root directory derives from $OCIS_BASE_DATA_PATH/idp. See the Environment + the root directory derives from $OCIS_BASE_DATA_PATH:/idp. See the Environment Variable Types description for more details. introductionVersion: pre5.0 deprecationVersion: "" @@ -6781,7 +6781,7 @@ IDP_TRANSPORT_TLS_CERT: defaultValue: /var/lib/ocis/idp/server.crt type: string description: Path/File name of the TLS server certificate (in PEM format) for the - IDP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/idp. + IDP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idp. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -6792,7 +6792,7 @@ IDP_TRANSPORT_TLS_KEY: type: string description: Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the IDP service. If not defined, the root directory - derives from $OCIS_BASE_DATA_PATH/idp. + derives from $OCIS_BASE_DATA_PATH:/idp. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -7221,7 +7221,7 @@ NATS_NATS_STORE_DIR: defaultValue: /var/lib/ocis/nats type: string description: The directory where the filesystem storage will store NATS JetStream - data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/nats. + data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/nats. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -7231,7 +7231,7 @@ NATS_TLS_CERT: defaultValue: /var/lib/ocis/nats/tls.crt type: string description: Path/File name of the TLS server certificate (in PEM format) for the - NATS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/nats. + NATS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/nats. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -7241,7 +7241,7 @@ NATS_TLS_KEY: defaultValue: /var/lib/ocis/nats/tls.key type: string description: Path/File name for the TLS certificate key (in PEM format) for the - NATS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/nats. + NATS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/nats. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -7921,7 +7921,7 @@ OCIS_ASSET_THEMES_PATH: defaultValue: /var/lib/ocis/web/assets/themes type: string description: Serve ownCloud themes from a path on the filesystem instead of the - builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/web/assets/themes + builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/web/assets/themes introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" @@ -9358,7 +9358,7 @@ OCM_OCM_CORE_JSON_FILE: defaultValue: /var/lib/ocis/storage/ocm/ocmshares.json type: string description: Path to the JSON file where OCM share data will be stored. If not defined, - the root directory derives from $OCIS_BASE_DATA_PATH/storage. + the root directory derives from $OCIS_BASE_DATA_PATH:/storage. introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" @@ -9388,7 +9388,7 @@ OCM_OCM_INVITE_MANAGER_JSON_FILE: type: string description: 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/ocm. + the root directory derives from $OCIS_BASE_DATA_PATH:/storage/ocm. introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" @@ -9416,7 +9416,7 @@ OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE: defaultValue: /etc/ocis/ocmproviders.json type: string description: Path to the JSON file where ocm invite data will be stored. Defaults - to $OCIS_CONFIG_DIR/ocmproviders.json. + to $OCIS_CONFIG_DIR:/ocmproviders.json. introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" @@ -9456,7 +9456,7 @@ OCM_OCM_SHAREPROVIDER_JSON_FILE: defaultValue: /var/lib/ocis/storage/ocm/ocmshares.json type: string description: Path to the JSON file where OCM share data will be stored. If not defined, - the root directory derives from $OCIS_BASE_DATA_PATH/storage. + the root directory derives from $OCIS_BASE_DATA_PATH:/storage. introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" @@ -10986,7 +10986,7 @@ PROXY_TRANSPORT_TLS_CERT: defaultValue: /var/lib/ocis/proxy/server.crt type: string description: Path/File name of the TLS server certificate (in PEM format) for the - external http services. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/proxy. + external http services. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/proxy. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -10997,7 +10997,7 @@ PROXY_TRANSPORT_TLS_KEY: type: string description: Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the external http services. If not defined, the - root directory derives from $OCIS_BASE_DATA_PATH/proxy. + root directory derives from $OCIS_BASE_DATA_PATH:/proxy. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -11077,7 +11077,7 @@ SEARCH_ENGINE_BLEVE_DATA_PATH: defaultValue: /var/lib/ocis/search type: string description: The directory where the filesystem will store search data. If not defined, - the root directory derives from $OCIS_BASE_DATA_PATH/search. + the root directory derives from $OCIS_BASE_DATA_PATH:/search. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -11485,7 +11485,7 @@ SETTINGS_DATA_PATH: defaultValue: /var/lib/ocis/settings type: string description: The directory where the filesystem storage will store ocis settings. - If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/settings. + If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/settings. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -12019,7 +12019,7 @@ SHARING_PUBLIC_JSON_FILE: type: string description: Path to the JSON file where public share meta-data will be stored. This JSON file contains the information about public shares that have been created. - If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage. + If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -12186,7 +12186,7 @@ SHARING_USER_JSON_FILE: defaultValue: /var/lib/ocis/storage/shares.json type: string description: Path to the JSON file where shares will be persisted. If not defined, - the root directory derives from $OCIS_BASE_DATA_PATH/storage. + the root directory derives from $OCIS_BASE_DATA_PATH:/storage. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -13157,7 +13157,7 @@ STORAGE_SYSTEM_OCIS_ROOT: defaultValue: /var/lib/ocis/storage/metadata type: string description: Path for the directory where the STORAGE-SYSTEM service stores it's - persistent data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage. + persistent data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -13839,7 +13839,7 @@ STORAGE_USERS_OCIS_ROOT: defaultValue: /var/lib/ocis/storage/users type: string description: The directory where the filesystem storage will store blobs and metadata. - If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/users. + If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/users. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -13867,7 +13867,7 @@ STORAGE_USERS_OWNCLOUDSQL_DATADIR: defaultValue: /var/lib/ocis/storage/owncloud type: string description: The directory where the filesystem storage will store SQL migration - data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/owncloud. + data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/owncloud. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -13941,7 +13941,7 @@ STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR: defaultValue: /var/lib/ocis/storage/uploadinfo type: string description: The directory where the filesystem will store uploads temporarily. - If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/uploadinfo. + If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/uploadinfo. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -13998,7 +13998,7 @@ STORAGE_USERS_POSIX_ROOT: defaultValue: "" type: string description: The directory where the filesystem storage will store its data. If - not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/users. + not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/users. introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" @@ -14294,7 +14294,7 @@ STORAGE_USERS_S3NG_ROOT: defaultValue: /var/lib/ocis/storage/users type: string description: The directory where the filesystem storage will store metadata for - blobs. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/users. + blobs. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/users. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -14429,7 +14429,7 @@ STORE_DATA_PATH: defaultValue: /var/lib/ocis/store type: string description: The directory where the filesystem storage will store ocis settings. - If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/store. + If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/store. introductionVersion: pre5.0 deprecationVersion: "5.0" removalVersion: 7.0.0 @@ -14661,7 +14661,7 @@ THUMBNAILS_FILESYSTEMSTORAGE_ROOT: defaultValue: /var/lib/ocis/thumbnails type: string description: The directory where the filesystem storage will store the thumbnails. - If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/thumbnails. + If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/thumbnails. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -15333,7 +15333,7 @@ USERS_LDAP_CACERT: type: string description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root - directory derives from $OCIS_BASE_DATA_PATH/idm. + directory derives from $OCIS_BASE_DATA_PATH:/idm. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -15775,7 +15775,7 @@ WEB_ASSET_APPS_PATH: defaultValue: /var/lib/ocis/web/assets/apps type: string description: Serve ownCloud Web apps assets from a path on the filesystem instead - of the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/web/assets/apps + of the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/web/assets/apps introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" @@ -15785,7 +15785,7 @@ WEB_ASSET_CORE_PATH: defaultValue: /var/lib/ocis/web/assets/core type: string description: Serve ownCloud Web assets from a path on the filesystem instead of - the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/web/assets/core + the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/web/assets/core introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" @@ -15805,7 +15805,7 @@ WEB_ASSET_THEMES_PATH: defaultValue: /var/lib/ocis/web/assets/themes type: string description: Serve ownCloud themes from a path on the filesystem instead of the - builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/web/assets/themes + builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/web/assets/themes introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" diff --git a/docs/services/general-info/env-var-deltas/4.0.0-5.0.0-added.adoc b/docs/services/general-info/env-var-deltas/4.0.0-5.0.0-added.adoc index 7f09381b12a..dd7f27a2959 100644 --- a/docs/services/general-info/env-var-deltas/4.0.0-5.0.0-added.adoc +++ b/docs/services/general-info/env-var-deltas/4.0.0-5.0.0-added.adoc @@ -466,10 +466,10 @@ | Disable TLS certificate validation for the OCM connections. Do not set this in production environments.| | | `OCM_OCM_INVITE_MANAGER_JSON_FILE` -| 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.| +| 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.| | | `OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE` -| 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.| +| 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.| | | `OCM_OCM_PROVIDER_AUTHORIZER_VERIFY_REQUEST_HOSTNAME` | Verify the hostname of the request against the hostname of the OCM provider.| @@ -484,7 +484,7 @@ | Directory where the ocm storage provider persists its data like tus upload info files.| | | `OCM_OCM_CORE_JSON_FILE` -| Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage.| +| Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage.| | | `OCM_OCM_SHARE_PROVIDER_DRIVER` | Driver to be used to persist ocm shares. Supported value is only 'json'.| `json` @@ -496,7 +496,7 @@ | Template for the webapp url.| | | `OCM_OCM_SHAREPROVIDER_JSON_FILE` -| Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage.| +| Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage.| | | `OCM_DEBUG_ADDR` From cf4d2d5e03b5dfd5de1ef6bc9a82f72cdfb837dd Mon Sep 17 00:00:00 2001 From: Martin Mattel Date: Wed, 2 Oct 2024 09:12:18 +0200 Subject: [PATCH 4/4] revert another file missed before --- .../general-info/env-var-deltas/4.0.0-5.0.0-added.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/services/general-info/env-var-deltas/4.0.0-5.0.0-added.md b/docs/services/general-info/env-var-deltas/4.0.0-5.0.0-added.md index bc23e85dc00..3e273a99a47 100644 --- a/docs/services/general-info/env-var-deltas/4.0.0-5.0.0-added.md +++ b/docs/services/general-info/env-var-deltas/4.0.0-5.0.0-added.md @@ -122,17 +122,17 @@ | | `OCM_OCMD_EXPOSE_RECIPIENT_DISPLAY_NAME` | Expose the display name of OCM share recipients. | | | | `OCM_OCM_INVITE_MANAGER_DRIVER` | Driver to be used to persist ocm invites. Supported value is only 'json'. | `json` | | | `OCM_OCM_INVITE_MANAGER_INSECURE` | Disable TLS certificate validation for the OCM connections. Do not set this in production environments. | | -| | `OCM_OCM_INVITE_MANAGER_JSON_FILE` | 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. | | -| | `OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE` | 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. | | +| | `OCM_OCM_INVITE_MANAGER_JSON_FILE` | 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. | | +| | `OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE` | 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. | | | | `OCM_OCM_PROVIDER_AUTHORIZER_VERIFY_REQUEST_HOSTNAME` | Verify the hostname of the request against the hostname of the OCM provider. | | | | `OCM_OCM_CORE_DRIVER` | Driver to be used to persist ocm shares. Supported value is only 'json'. | `json` | | | `OCM_OCM_STORAGE_PROVIDER_INSECURE` | Disable TLS certificate validation for the OCM connections. Do not set this in production environments. | | | | `OCM_OCM_STORAGE_PROVIDER_STORAGE_ROOT` | Directory where the ocm storage provider persists its data like tus upload info files. | | -| | `OCM_OCM_CORE_JSON_FILE` | Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage. | | +| | `OCM_OCM_CORE_JSON_FILE` | Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. | | | | `OCM_OCM_SHARE_PROVIDER_DRIVER` | Driver to be used to persist ocm shares. Supported value is only 'json'. | `json` | | | `OCM_OCM_SHARE_PROVIDER_INSECURE` | Disable TLS certificate validation for the OCM connections. Do not set this in production environments. | | | | `OCM_WEBAPP_TEMPLATE` | Template for the webapp url. | | -| | `OCM_OCM_SHAREPROVIDER_JSON_FILE` | Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage. | | +| | `OCM_OCM_SHAREPROVIDER_JSON_FILE` | Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. | | | services/ocm/pkg/config/debug.go | `OCM_DEBUG_ADDR` | Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. | | | | `OCM_DEBUG_TOKEN` | Token to secure the metrics endpoint. | | | | `OCM_DEBUG_PPROF` | Enables pprof, which can be used for profiling. | |