diff --git a/docs/_static/env-vars/extended_configvars.md b/docs/_static/env-vars/extended_configvars.md index c57b7e7c..e15fc66e 100644 --- a/docs/_static/env-vars/extended_configvars.md +++ b/docs/_static/env-vars/extended_configvars.md @@ -2,182 +2,24 @@ | Name | Type | Default Value | Description | |---|---|---|---| -`0` | | | | -`ACK_GINKGO_DEPRECATIONS` | | | | -`ACK_GINKGO_RC` | | | | -`ANSICON` | | | | -`ANSICON_VER` | | | | -`APP_ID` | | | | -`APP_SECRET` | | | | -`AWS_ACCESS_KEY` | | | | -`AWS_ACCESS_KEY_ID` | | | | -`AWS_CONTAINER_AUTHORIZATION_TOKEN` | | | | -`AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE` | | | | -`AWS_CONTAINER_CREDENTIALS_FULL_URI` | | | | -`AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` | | | | -`AWS_PROFILE` | | | | -`AWS_REGION` | | | | -`AWS_ROLE_ARN` | | | | -`AWS_ROLE_SESSION_NAME` | | | | -`AWS_SECRET_ACCESS_KEY` | | | | -`AWS_SECRET_KEY` | | | | -`AWS_SESSION_TOKEN` | | | | -`AWS_SHARED_CREDENTIALS_FILE` | | | | -`AWS_WEB_IDENTITY_TOKEN_FILE` | | | | -`BASH_COMP_DEBUG_FILE` | | | | `CI` | | | | `CI_SYSTEM_NAME` | | | | -`CLICOLOR` | | | | -`CLI_TEMPLATE_ERROR_DEBUG` | | | | -`COLORTERM` | | | | -`COMSPEC` | | | | `CS3_GATEWAY` | | | | `CS3_MACHINE_AUTH_API_KEY` | | | | -`ConEmuANSI` | | | | -`DAYS` | | | | -`DOCKER_AUTH_CONFIG` | | | | -`DOCKER_CONFIG` | | | | -`DOCKER_HOST` | | | | -`ENV_VERIFY` | | | | -`ETCD_CLIENT_DEBUG` | | | | `EXPERIMENTAL_REGISTER_INTERVAL` | duration | 25s | The interval at which services will re-register themselves with the registry to prevent expiry. Only change on supervision of openCloud Support. | `EXPERIMENTAL_REGISTER_TTL` | duration | 30s | The time-to-live for a service registration in the registry. Services must re-register before this time to prevent expiry. Only change on supervision of openCloud Support. | -`EXPERIMENTAL_WASM_OPT` | | | | -`EXPERIMENTAL_WASM_OPT_ARGS` | | | | -`EnvAlacritty` | | | | -`EnvConEmuANSI` | | | | -`EnvLCAll` | | | | -`EnvLCCtype` | | | | -`EnvLang` | | | | -`EnvOverrideAPIVersion` | | | | -`EnvOverrideCertPath` | | | | -`EnvOverrideHost` | | | | -`EnvRuneWidthEastAsian` | | | | -`EnvTLSVerify` | | | | -`EnvTerm` | | | | -`EnvTermProgram` | | | | -`EnvTermProgramWsl` | | | | -`EnvUnixSocketDir` | | | | -`EnvUnixSocketGroup` | | | | -`EnvVTEVersion` | | | | -`EnvVarLabels` | | | | -`EnvVarType` | | | | -`EnvWTProfile` | | | | -`FORCE_COLOR` | | | | -`FSNOTIFY_DEBUG` | | | | -`GINKGO_EDITOR_INTEGRATION` | | | | -`GINKGO_PARALLEL_PROTOCOL` | | | | -`GINKGO_PRESERVE_CACHE` | | | | -`GINKGO_PRUNE_STACK` | | | | -`GINKGO_TIME_FORMAT` | | | | -`GITHUB_ACTIONS` | | | | -`GO15VENDOREXPERIMENT` | | | | -`GODEBUG` | | | | -`GOOS` | | | | -`GOPACKAGESPRINTDRIVERERRORS` | | | | -`GOPROCESS` | | | | -`GOPROTODEBUG` | | | | -`GRACEFUL` | | | | -`GRPC_GO_LOG_FORMATTER` | | | | -`GRPC_GO_LOG_SEVERITY_LEVEL` | | | | -`GRPC_GO_LOG_VERBOSITY_LEVEL` | | | | -`GRPC_TEST_ONLY_GOOGLE_C2P_RESOLVER_TRAFFIC_DIRECTOR_URI` | | | | -`HOME` | | | | -`HOMEDRIVE` | | | | -`HOMEPATH` | | | | -`HOSTNAME` | | | | -`HOST_ROOT` | | | | -`IDENTITY_ENDPOINT` | | | | -`IDENTITY_HEADER` | | | | -`JOURNAL_STREAM` | | | | -`KIDM_TEMPLATE_DEBUG` | | | | -`KOPANO_DEBUG_SERVER_REQUEST_LOG` | | | | -`KUBERNETES_SERVICE_HOST` | | | | -`KUBERNETES_SERVICE_PORT` | | | | -`LANG` | | | | -`LC_ALL` | | | | -`LC_CTYPE` | | | | -`LDAP_BASEDN` | | | | -`LDAP_BINDDN` | | | | -`LDAP_BINDPW` | | | | -`LDAP_EMAIL_ATTRIBUTE` | | | | -`LDAP_FAMILY_NAME_ATTRIBUTE` | | | | -`LDAP_FILTER` | | | | -`LDAP_GIVEN_NAME_ATTRIBUTE` | | | | -`LDAP_LOGIN_ATTRIBUTE` | | | | -`LDAP_NAME_ATTRIBUTE` | | | | -`LDAP_SCOPE` | | | | -`LDAP_SUB_ATTRIBUTES` | | | | -`LDAP_TLS_CACERT` | | | | -`LDAP_UIDNUMBER_ATTRIBUTE` | | | | -`LDAP_URI` | | | | -`LDAP_UUID_ATTRIBUTE` | | | | -`LDAP_UUID_ATTRIBUTE_TYPE` | | | | -`LIBREGRAPH_SCOPED_URIS` | | | | -`LIBREGRAPH_URI` | | | | -`LogEnv` | | | | -`MD2MAN_DEBUG` | | | | `MICRO_LOG_LEVEL` | string | Error | Set the log level for the internal go micro framework. Only change on supervision of openCloud Support. | -`MICRO_NETWORK` | | | | -`MICRO_NETWORK_ADDRESS` | | | | -`MICRO_PROXY` | | | | `MICRO_REGISTRY` | string | nats-js-kv | The type of registry to use. Only change on supervision of openCloud Support. | `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. | -`MINIO_ACCESS_KEY` | | | | -`MINIO_ALIAS` | | | | -`MINIO_GO_TEST_BUCKET_CORS` | | | | -`MINIO_ROOT_PASSWORD` | | | | -`MINIO_ROOT_USER` | | | | -`MINIO_SECRET_KEY` | | | | -`MINT_MODE` | | | | -`MINT_NO_FULL_OBJECT` | | | | -`MOBY_DISABLE_PIGZ` | | | | -`MONTH` | | | | -`MSYSTEM` | | | | -`NOTIFY_ACCOUNTID` | | | | -`NOTIFY_BUCKET` | | | | -`NOTIFY_REGION` | | | | -`NOTIFY_RESOURCE` | | | | -`NOTIFY_SERVICE` | | | | -`NO_COLOR` | | | | +`OC_BASE_DATA_PATH` | | | | `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` | | | | `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_GRPC_MAX_RECEIVED_MESSAGE_SIZE` | integer | 10240000 | Sets the maximum message size in bytes the GRPC client can receive. | -`OPA_VERSION_CHECK_SERVICE_URL` | | | | -`PATH` | | | | -`PLUGIN_CLIENT_CERT` | | | | -`PLUGIN_MAX_PORT` | | | | -`PLUGIN_MIN_PORT` | | | | -`PLUGIN_PROTOCOL_VERSIONS` | | | | -`PSHOME` | | | | -`PWD` | | | | -`REVA_APPPROVIDER_IOPSECRET` | | | | -`REVA_SMTP_SENDER_PASSWORD` | | | | -`RUNEWIDTH_EASTASIAN` | | | | `RUN_CMD_TEST` | | | | -`RUN_ON_FAIL` | | | | -`RYUK_PORT` | | | | -`SHELL` | | | | -`SSH_AUTH_SOCK` | | | | -`SSH_KNOWN_HOSTS` | | | | -`SSL_CERT_FILE` | | | | -`TERM` | | | | -`TERMINAL_EMULATOR` | | | | -`TERM_PROGRAM` | | | | -`TERM_PROGRAM_VERSION` | | | | -`TESTCONTAINERS_HUB_IMAGE_NAME_PREFIX` | | | | -`TESTCONTAINERS_RYUK_CONTAINER_PRIVILEGED` | | | | -`TESTCONTAINERS_RYUK_DISABLED` | | | | -`USER` | | | | -`USERPROFILE` | | | | `USE_TESTCONTAINERS` | | | | -`WSL_DISTRO_NAME` | | | | -`WT_SESSION` | | | | -`XDG_CONFIG_HOME` | | | | -`XDSBootstrapFileContentEnv` | | | | -`XDSBootstrapFileNameEnv` | | | | -`YEAR` | | | | +`_registryAddressEnv` | | | | `_registryAddressEnv` | | | | `_registryEnv` | | | | `_registryPasswordEnv` | | | | @@ -185,51 +27,4 @@ `_registryRegisterTTLEnv` | | | | `_registryUsernameEnv` | | | | `_serverMaxConnectionAgeEnv` | | | | -`accessKey` | | | | -`accessKeyEnvVar` | | | | -`activeHelpEnvVar(cmd.Root(` | | | | -`activeHelpGlobalEnvVar` | | | | -`ansiterm.LogEnv` | | | | -`awsConfigFileEnvVar` | | | | -`awsCredentialsFileEnvVar` | | | | -`awsDomainEnvVar` | | | | -`awsProfileEnvVar` | | | | -`awsRegionEnvVar` | | | | -`awsRoleArnEnvVar` | | | | -`awsWebIdentityTokenFileEnvVar` | | | | -`configEnvVar(cmd.Root(` | | | | -`configEnvVar(configEnvVarGlobalPrefix, suffix` | | | | -`defaultHTTPRequestTimeoutEnv` | | | | -`ecsFullPathEnvVar` | | | | -`ecsRelativePathEnvVar` | | | | -`enableHTTPS` | | | | -`enableKMS` | | | | -`env` | | | | -`envAUTOMEMLIMIT_EXPERIMENT` | | | | -`envMultiplexGRPC` | | | | -`envName` | | | | -`envObservabilityConfig` | | | | -`envObservabilityConfigFile` | | | | -`envStr` | | | | -`envVar` | | | | -`envVerify` | | | | -`key` | | | | -`n` | | | | -`name` | | | | -`opts.MagicCookieKey` | | | | -`parts[0]` | | | | -`prefix + envVar` | | | | -`resourceAttrKey` | | | | -`s` | | | | -`secretKey` | | | | -`secretKeyEnvVar` | | | | -`securityTokenEnvVar` | | | | -`serverEndpoint` | | | | -`sessionTokenEnvVar` | | | | -`skipCERTValidation` | | | | -`strings.ToLower(key` | | | | -`strings.ToUpper(key` | | | | -`svcNameKey` | | | | -`tlsClientCertEnvVar` | | | | -`tlsClientKeyEnvVar` | | | | -`v` | | | | +`parts[0]` | | | | \ No newline at end of file diff --git a/docs/_static/env-vars/frontend_configvars.md b/docs/_static/env-vars/frontend_configvars.md index 2263aab2..2d9f33c1 100644 --- a/docs/_static/env-vars/frontend_configvars.md +++ b/docs/_static/env-vars/frontend_configvars.md @@ -1,5 +1,5 @@ -2026-03-05-00-05-51 +2026-03-10-00-05-50 # Deprecation Notice diff --git a/docs/_static/env-vars/global_configvars.md b/docs/_static/env-vars/global_configvars.md index 5aa44e71..405694d5 100644 --- a/docs/_static/env-vars/global_configvars.md +++ b/docs/_static/env-vars/global_configvars.md @@ -3,7 +3,7 @@ | Name | Introduction Version | Type | Description | Default Value | |---|---|---|---|---| | `IDM_CREATE_DEMO_USERS` | 1.0.0 | bool | Flag to enable or disable the creation of the demo users. | false | -| `OC_ADMIN_USER_ID` | 1.0.0 | string | ID of the user that should receive admin privileges. Consider that the UUID can be encoded in some LDAP deployment configurations like in .ldif files. These need to be decoded beforehand. | | +| `OC_ADMIN_USER_ID` | 1.0.0 | string | ID of the user who collects all necessary information for deletion. Consider that the UUID can be encoded in some LDAP deployment configurations like in .ldif files. These need to be decoded beforehand. | | | `OC_ASYNC_UPLOADS` | 1.0.0 | bool | Enable asynchronous file uploads. | true | | `OC_CACHE_AUTH_PASSWORD` | 1.0.0 | string | The password to use for authentication. Only applies when using the 'nats-js-kv' store type. | | | `OC_CACHE_AUTH_USERNAME` | 1.0.0 | string | The username to use for authentication. Only applies when using the 'nats-js-kv' store type. | | @@ -26,58 +26,58 @@ | `OC_EVENTS_ENABLE_TLS` | 1.0.0 | bool | Enable TLS for the connection to the events broker. The events broker is the OpenCloud service which receives and delivers events between the services. | false | | `OC_EVENTS_ENDPOINT` | 1.0.0 | string | The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. | 127.0.0.1:9233 | | `OC_EVENTS_TLS_INSECURE` | 1.0.0 | bool | Whether to verify the server TLS certificates. | false | -| `OC_EVENTS_TLS_ROOT_CA_CERTIFICATE` | 1.0.0 | string | The root CA certificate used to validate the server's TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. | | +| `OC_EVENTS_TLS_ROOT_CA_CERTIFICATE` | 1.0.0 | string | The root CA certificate used to validate the server's TLS certificate. If provided ANTIVIRUS_EVENTS_TLS_INSECURE will be seen as false. | | | `OC_GATEWAY_GRPC_ADDR` | 1.0.0 | string | The bind address of the gateway GRPC address. | 127.0.0.1:9142 | | `OC_GRPC_CLIENT_TLS_CACERT` | 1.0.0 | string | Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the go-micro based grpc services. | | | `OC_GRPC_CLIENT_TLS_MODE` | 1.0.0 | string | TLS mode for grpc connection to the go-micro based grpc services. Possible values are 'off', 'insecure' and 'on'. 'off': disables transport security for the clients. 'insecure' allows using transport security, but disables certificate verification (to be used with the autogenerated self-signed certificates). 'on' enables transport security, including server certificate verification. | | -| `OC_GRPC_PROTOCOL` | 1.0.0 | string | The transport protocol of the GPRC service. | tcp | +| `OC_GRPC_PROTOCOL` | 1.0.0 | string | The transport protocol of the GRPC service. | tcp | | `OC_HTTP_TLS_CERTIFICATE` | 1.0.0 | string | Path/File name of the TLS server certificate (in PEM format) for the http services. | | | `OC_HTTP_TLS_ENABLED` | 1.0.0 | bool | Activates TLS for the http based services using the server certifcate and key configured via OC_HTTP_TLS_CERTIFICATE and OC_HTTP_TLS_KEY. If OC_HTTP_TLS_CERTIFICATE is not set a temporary server certificate is generated - to be used with PROXY_INSECURE_BACKEND=true. | false | | `OC_HTTP_TLS_KEY` | 1.0.0 | string | Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the http services. | | -| `OC_INSECURE` | 1.0.0 | bool | Allow insecure connections to the frontend. | false | +| `OC_INSECURE` | 1.0.0 | bool | Whether to verify the server TLS certificates. | false | | `OC_JWT_SECRET` | 1.0.0 | string | The secret to mint and validate jwt tokens. | | | `OC_KEYCLOAK_BASE_PATH` | 1.0.0 | string | The URL to access keycloak. | | -| `OC_KEYCLOAK_CLIENT_ID` | 1.0.0 | string | The client ID to authenticate with keycloak. | | +| `OC_KEYCLOAK_CLIENT_ID` | 1.0.0 | string | The client id to authenticate with keycloak. | | | `OC_KEYCLOAK_CLIENT_REALM` | 1.0.0 | string | The realm the client is defined in. | | | `OC_KEYCLOAK_CLIENT_SECRET` | 1.0.0 | string | The client secret to use in authentication. | | | `OC_KEYCLOAK_INSECURE_SKIP_VERIFY` | 1.0.0 | bool | Disable TLS certificate validation for Keycloak connections. Do not set this in production environments. | false | | `OC_KEYCLOAK_USER_REALM` | 1.0.0 | string | The realm users are defined. | | -| `OC_LDAP_BIND_DN` | 1.0.0 | string | LDAP DN to use for simple bind authentication with the target LDAP server. | uid=libregraph,ou=sysusers,o=libregraph-idm | +| `OC_LDAP_BIND_DN` | 1.0.0 | string | LDAP DN to use for simple bind authentication with the target LDAP server. | uid=reva,ou=sysusers,o=libregraph-idm | | `OC_LDAP_BIND_PASSWORD` | 1.0.0 | string | Password to use for authenticating the 'bind_dn'. | | | `OC_LDAP_CACERT` | 1.0.0 | string | 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 $OC_BASE_DATA_PATH/idm. | /root/.opencloud/idm/ldap.crt | | `OC_LDAP_DISABLED_USERS_GROUP_DN` | 1.0.0 | string | The distinguished name of the group to which added users will be classified as disabled when 'disable_user_mechanism' is set to 'group'. | cn=DisabledUsersGroup,ou=groups,o=libregraph-idm | -| `OC_LDAP_DISABLE_USER_MECHANISM` | 1.0.0 | string | An option to control the behavior for disabling users. Supported options are 'none', 'attribute' and 'group'. If set to 'group', disabling a user via API will add the user to the configured group for disabled users, if set to 'attribute' this will be done in the ldap user entry, if set to 'none' the disable request is not processed. Default is 'attribute'. | attribute | +| `OC_LDAP_DISABLE_USER_MECHANISM` | 1.0.0 | string | An option to control the behavior for disabling users. Valid options are 'none', 'attribute' and 'group'. If set to 'group', disabling a user via API will add the user to the configured group for disabled users, if set to 'attribute' this will be done in the ldap user entry, if set to 'none' the disable request is not processed. | attribute | | `OC_LDAP_GROUP_BASE_DN` | 1.0.0 | string | Search base DN for looking up LDAP groups. | ou=groups,o=libregraph-idm | | `OC_LDAP_GROUP_FILTER` | 1.0.0 | string | LDAP filter to add to the default filters for group searches. | | | `OC_LDAP_GROUP_OBJECTCLASS` | 1.0.0 | string | The object class to use for groups in the default group search filter ('groupOfNames'). | groupOfNames | | `OC_LDAP_GROUP_SCHEMA_DISPLAYNAME` | 1.0.0 | string | LDAP Attribute to use for the displayname of groups (often the same as groupname attribute). | cn | | `OC_LDAP_GROUP_SCHEMA_GROUPNAME` | 1.0.0 | string | LDAP Attribute to use for the name of groups. | cn | -| `OC_LDAP_GROUP_SCHEMA_ID` | 1.0.0 | string | LDAP Attribute to use as the unique id for groups. This should be a stable globally unique ID like a UUID. | openCloudUUID | -| `OC_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING` | 1.0.0 | bool | Set this to true if the defined 'ID' attribute for groups is of the 'OCTETSTRING' syntax. This is required when using the 'objectGUID' attribute of Active Directory for the group ID's. | false | +| `OC_LDAP_GROUP_SCHEMA_ID` | 1.0.0 | string | LDAP Attribute to use as the unique id for groups. This should be a stable globally unique id (e.g. a UUID). | openCloudUUID | +| `OC_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING` | 1.0.0 | bool | Set this to true if the defined 'id' attribute for groups is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute of Active Directory for the group IDs. | false | | `OC_LDAP_GROUP_SCHEMA_MAIL` | 1.0.0 | string | LDAP Attribute to use for the email address of groups (can be empty). | mail | | `OC_LDAP_GROUP_SCHEMA_MEMBER` | 1.0.0 | string | LDAP Attribute that is used for group members. | member | -| `OC_LDAP_GROUP_SCOPE` | 1.0.0 | string | LDAP search scope to use when looking up groups. Supported scopes are 'base', 'one' and 'sub'. | sub | +| `OC_LDAP_GROUP_SCOPE` | 1.0.0 | string | LDAP search scope to use when looking up groups. Supported values are 'base', 'one' and 'sub'. | sub | | `OC_LDAP_INSECURE` | 1.0.0 | bool | Disable TLS certificate validation for the LDAP connections. Do not set this in production environments. | false | | `OC_LDAP_SERVER_WRITE_ENABLED` | 1.0.0 | bool | Allow creating, modifying and deleting LDAP users via the GRAPH API. This can only be set to 'true' when keeping default settings for the LDAP user and group attribute types (the 'OC_LDAP_USER_SCHEMA_* and 'OC_LDAP_GROUP_SCHEMA_* variables). | true | | `OC_LDAP_URI` | 1.0.0 | string | URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://' | ldaps://localhost:9235 | | `OC_LDAP_USER_BASE_DN` | 1.0.0 | string | Search base DN for looking up LDAP users. | ou=users,o=libregraph-idm | -| `OC_LDAP_USER_ENABLED_ATTRIBUTE` | 1.0.0 | string | LDAP Attribute to use as a flag telling if the user is enabled or disabled. | openCloudUserEnabled | +| `OC_LDAP_USER_ENABLED_ATTRIBUTE` | 1.0.0 | string | LDAP attribute to use as a flag telling if the user is enabled or disabled. | openCloudUserEnabled | | `OC_LDAP_USER_FILTER` | 1.0.0 | string | LDAP filter to add to the default filters for user search like '(objectclass=openCloudUser)'. | | | `OC_LDAP_USER_OBJECTCLASS` | 1.0.0 | string | The object class to use for users in the default user search filter ('inetOrgPerson'). | inetOrgPerson | -| `OC_LDAP_USER_SCHEMA_DISPLAYNAME` | 1.0.0 | string | LDAP Attribute to use for the display name of users. | displayName | +| `OC_LDAP_USER_SCHEMA_DISPLAYNAME` | 1.0.0 | string | LDAP Attribute to use for the displayname of users. | displayname | | `OC_LDAP_USER_SCHEMA_ID` | 1.0.0 | string | LDAP Attribute to use as the unique ID for users. This should be a stable globally unique ID like a UUID. | openCloudUUID | -| `OC_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING` | 1.0.0 | bool | Set this to true if the defined 'ID' attribute for users is of the 'OCTETSTRING' syntax. This is required when using the 'objectGUID' attribute of Active Directory for the user ID's. | false | +| `OC_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING` | 1.0.0 | bool | Set this to true if the defined 'ID' attribute for users is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute of Active Directory for the user IDs. | false | | `OC_LDAP_USER_SCHEMA_MAIL` | 1.0.0 | string | LDAP Attribute to use for the email address of users. | mail | | `OC_LDAP_USER_SCHEMA_TENANT_ID` | 4.0.0 | string | LDAP Attribute to use for the tenant ID of users. This is used to identify the tenant of a user in a multi-tenant environment. | | | `OC_LDAP_USER_SCHEMA_USERNAME` | 1.0.0 | string | LDAP Attribute to use for username of users. | uid | | `OC_LDAP_USER_SCHEMA_USER_TYPE` | 1.0.0 | string | LDAP Attribute to distinguish between 'Member' and 'Guest' users. Default is 'openCloudUserType'. | openCloudUserType | -| `OC_LDAP_USER_SCOPE` | 1.0.0 | string | LDAP search scope to use when looking up users. Supported scopes are 'base', 'one' and 'sub'. | sub | +| `OC_LDAP_USER_SCOPE` | 1.0.0 | string | LDAP search scope to use when looking up users. Supported values are 'base', 'one' and 'sub'. | sub | | `OC_LOG_LEVEL` | 1.0.0 | string | The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'. | error | | `OC_MACHINE_AUTH_API_KEY` | 1.0.0 | string | The machine auth API key used to validate internal requests necessary to access resources from other services. | | | `OC_MAX_CONCURRENCY` | 1.0.0 | int | Maximum number of concurrent go-routines. Higher values can potentially get work done faster but will also cause more load on the system. Values of 0 or below will be ignored and the default value will be used. | 1 | | `OC_OIDC_CLIENT_ID` | 1.0.0 | string | The OIDC client ID which OpenCloud Web uses. This client needs to be set up in your IDP. Note that this setting has no effect when using the builtin IDP. | web | | `OC_OIDC_CLIENT_SCOPES` | next | []string | The OIDC client scopes the Android app should request. | [openid profile email offline_access] | -| `OC_OIDC_ISSUER` | 1.0.0 | string | The OIDC issuer URL to assign to the demo users. | https://localhost:9200 | +| `OC_OIDC_ISSUER` | 1.0.0 | string | The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. | https://localhost:9200 | | `OC_PASSWORD_POLICY_BANNED_PASSWORDS_LIST` | 1.0.0 | string | Path to the 'banned passwords list' file. This only impacts public link password validation. See the documentation for more details. | | | `OC_PASSWORD_POLICY_DISABLED` | 1.0.0 | bool | Disable the password policy. Defaults to false if not set. | false | | `OC_PASSWORD_POLICY_MIN_CHARACTERS` | 1.0.0 | int | Define the minimum password length. Defaults to 8 if not set. | 8 | @@ -89,7 +89,7 @@ | `OC_PERSISTENT_STORE_AUTH_PASSWORD` | 1.0.0 | string | The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. | | | `OC_PERSISTENT_STORE_AUTH_USERNAME` | 1.0.0 | string | The username to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. | | | `OC_PERSISTENT_STORE_NODES` | 1.0.0 | []string | A list of nodes to access the configured store. This has no effect when 'memory' store is configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. | [127.0.0.1:9233] | -| `OC_PERSISTENT_STORE_TTL` | 1.0.0 | Duration | Time to live for notifications in the store. Defaults to '336h' (2 weeks). See the Environment Variable Types description for more details. | 336h0m0s | +| `OC_PERSISTENT_STORE_TTL` | 1.0.0 | Duration | Time to live for events in the store. Defaults to '336h' (2 weeks). See the Environment Variable Types description for more details. | 336h0m0s | | `OC_REVA_GATEWAY` | 1.0.0 | string | The CS3 gateway endpoint. | eu.opencloud.api.gateway | | `OC_SERVICE_ACCOUNT_ID` | 1.0.0 | string | The ID of the service account the service should use. See the 'auth-service' service description for more details. | | | `OC_SERVICE_ACCOUNT_SECRET` | 1.0.0 | string | The service account secret. | | @@ -97,17 +97,17 @@ | `OC_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD` | 1.0.0 | bool | Set this to true if you want to enforce passwords for writable shares. Only effective if the setting for 'passwords on all public shares' is set to false. | false | | `OC_SHOW_USER_EMAIL_IN_RESULTS` | 1.0.0 | bool | Include user email addresses in responses. If absent or set to false emails will be omitted from results. Please note that admin users can always see all email addresses. | false | | `OC_SPACES_MAX_QUOTA` | 1.0.0 | uint64 | Set the global max quota value in bytes. A value of 0 equals unlimited. The value is provided via capabilities. | 0 | -| `OC_SYSTEM_USER_API_KEY` | 1.0.0 | string | API key for the STORAGE-SYSTEM system user. | | -| `OC_SYSTEM_USER_ID` | 1.0.0 | string | ID of the OpenCloud STORAGE-SYSTEM system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format. | | -| `OC_SYSTEM_USER_IDP` | 1.0.0 | string | IDP of the OpenCloud STORAGE-SYSTEM system user. | internal | +| `OC_SYSTEM_USER_API_KEY` | 4.0.0 | string | API key for the STORAGE-SYSTEM system user. | | +| `OC_SYSTEM_USER_ID` | 4.0.0 | string | ID of the OpenCloud STORAGE-SYSTEM system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format. | | +| `OC_SYSTEM_USER_IDP` | 4.0.0 | string | IDP of the OpenCloud STORAGE-SYSTEM system user. | internal | | `OC_TRANSFER_SECRET` | 1.0.0 | string | Transfer secret for signing file up- and download requests. | | | `OC_TRANSLATION_PATH` | 1.0.0 | string | (optional) Set this to a path with custom translations to overwrite the builtin translations. Note that file and folder naming rules apply, see the documentation for more details. | | -| `OC_URL` | 1.0.0 | string | The public facing URL of the OpenCloud frontend. | https://localhost:9200 | -| `OC_WOPI_DISABLE_CHAT` | 1.0.0 | bool | Disable the chat functionality of the office app. | false | +| `OC_URL` | 1.0.0 | string | The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. | https://localhost:9200 | +| `OC_WOPI_DISABLE_CHAT` | 1.0.0 | bool | Disable chat in the office web frontend. This feature applies to OnlyOffice and Microsoft. | false | | `SEARCH_EVENTS_ACK_WAIT` | 4.0.0 | Duration | The time to wait for an ack before the message is redelivered. This is used to ensure that messages are not lost if the consumer crashes. | 1m0s | | `SEARCH_EVENTS_MAX_ACK_PENDING` | 4.0.0 | int | The maximum number of unacknowledged messages. This is used to limit the number of messages that can be in flight at the same time. | 10000 | -| `STORAGE_GATEWAY_GRPC_ADDR` | 1.0.0 | string | GRPC address of the STORAGE-SYSTEM service. | eu.opencloud.api.storage-system | -| `STORAGE_GRPC_ADDR` | 1.0.0 | string | GRPC address of the STORAGE-SYSTEM service. | eu.opencloud.api.storage-system | +| `STORAGE_GATEWAY_GRPC_ADDR` | 4.0.0 | string | GRPC address of the STORAGE-SYSTEM service. | eu.opencloud.api.storage-system | +| `STORAGE_GRPC_ADDR` | 4.0.0 | string | GRPC address of the STORAGE-SYSTEM service. | eu.opencloud.api.storage-system | | `STORAGE_USERS_ASYNC_PROPAGATOR_PROPAGATION_DELAY` | 1.0.0 | Duration | The delay between a change made to a tree and the propagation start on treesize and treetime. Multiple propagations are computed to a single one. See the Environment Variable Types description for more details. | 0s | | `STORAGE_USERS_PERMISSION_ENDPOINT` | 1.0.0 | string | Endpoint of the permissions service. The endpoints can differ for 'decomposed' and 'decomposeds3'. | eu.opencloud.api.settings | | `WEB_OIDC_CLIENT_ID` | 1.0.0 | string | The OIDC client ID which OpenCloud Web uses. This client needs to be set up in your IDP. Note that this setting has no effect when using the builtin IDP. | web | diff --git a/docs/_static/env-vars/storage-users_configvars.md b/docs/_static/env-vars/storage-users_configvars.md index 959fd672..d63aed61 100644 --- a/docs/_static/env-vars/storage-users_configvars.md +++ b/docs/_static/env-vars/storage-users_configvars.md @@ -1,5 +1,5 @@ -2026-03-05-00-05-51 +2026-03-10-00-05-50 # Deprecation Notice