Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/_static/env-vars/auth-basic.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ auth_providers:
display_name: cn
group_name: cn
member: member
lookup_cache_ttl: 10s
owncloudsql:
db_username: owncloud
db_password: ""
Expand Down
1 change: 1 addition & 0 deletions docs/_static/env-vars/auth-basic_configvars.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
|`OC_LDAP_GROUP_SCHEMA_DISPLAYNAME`<br/>`AUTH_BASIC_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`<br/>`AUTH_BASIC_LDAP_GROUP_SCHEMA_GROUPNAME`| 1.0.0 |string|`LDAP Attribute to use for the name of groups.`|`"cn"`|
|`OC_LDAP_GROUP_SCHEMA_MEMBER`<br/>`AUTH_BASIC_LDAP_GROUP_SCHEMA_MEMBER`| 1.0.0 |string|`LDAP Attribute that is used for group members.`|`"member"`|
|`OC_LDAP_LOOKUP_CACHE_TTL`<br/>`AUTH_BASIC_LDAP_LOOKUP_CACHE_TTL`| next |Duration|`The time to live for the in-memory cache of LDAP lookups. This cache is used to reduce the number of LDAP queries for user and group lookups.`|`"10s"`|
|`AUTH_BASIC_OWNCLOUDSQL_DB_USERNAME`| 1.0.0 |string|`Database user to use for authenticating with the owncloud database.`|`"owncloud"`|
|`AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD`| 1.0.0 |string|`Password for the database user.`|`""`|
|`AUTH_BASIC_OWNCLOUDSQL_DB_HOST`| 1.0.0 |string|`Hostname of the database server.`|`"mysql"`|
Expand Down
9 changes: 0 additions & 9 deletions docs/_static/env-vars/collaboration.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,6 @@ store:
enable_tls: false
tls_insecure: false
tls_root_ca_certificate: ""
events:
endpoint: 127.0.0.1:9233
cluster: opencloud-cluster
tls_insecure: false
tls_root_ca_certificate: ""
enable_tls: false
username: ""
password: ""
token_manager:
jwt_secret: ""
grpc:
Expand Down Expand Up @@ -66,4 +58,3 @@ debug:
token: ""
pprof: false
zpages: false
machine_auth_api_key: ""
8 changes: 0 additions & 8 deletions docs/_static/env-vars/collaboration_configvars.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,6 @@
|`OC_PERSISTENT_STORE_ENABLE_TLS`<br/>`COLLABORATION_STORE_ENABLE_TLS`| 7.3.0 |bool|`Enable TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured.`|`"false"`|
|`OC_INSECURE`<br/>`OC_PERSISTENT_STORE_TLS_INSECURE`<br/>`COLLABORATION_STORE_TLS_INSECURE`| 7.3.0 |bool|`Whether to verify the server TLS certificates.`|`"false"`|
|`OC_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE`<br/>`COLLABORATION_STORE_TLS_ROOT_CA_CERTIFICATE`| 7.3.0 |string|`The root CA certificate used to validate the server's TLS certificate. If provided COLLABORATION_STORE_TLS_INSECURE will be seen as false.`|`""`|
|`OC_EVENTS_ENDPOINT`<br/>`COLLABORATION_EVENTS_ENDPOINT`| 7.3.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_CLUSTER`<br/>`COLLABORATION_EVENTS_CLUSTER`| 7.3.0 |string|`The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system.`|`"opencloud-cluster"`|
|`OC_INSECURE`<br/>`OC_EVENTS_TLS_INSECURE`<br/>`COLLABORATION_EVENTS_TLS_INSECURE`| 7.3.0 |bool|`Whether to verify the server TLS certificates.`|`"false"`|
|`OC_EVENTS_TLS_ROOT_CA_CERTIFICATE`<br/>`COLLABORATION_EVENTS_TLS_ROOT_CA_CERTIFICATE`| 7.3.0 |string|`The root CA certificate used to validate the server's TLS certificate. If provided COLLABORATION_EVENTS_TLS_INSECURE will be seen as false.`|`""`|
|`OC_EVENTS_ENABLE_TLS`<br/>`COLLABORATION_EVENTS_ENABLE_TLS`| 7.3.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_AUTH_USERNAME`<br/>`COLLABORATION_EVENTS_AUTH_USERNAME`| 7.3.0 |string|`The username to authenticate with the events broker. The events broker is the OpenCloud service which receives and delivers events between the services.`|`""`|
|`OC_EVENTS_AUTH_PASSWORD`<br/>`COLLABORATION_EVENTS_AUTH_PASSWORD`| 7.3.0 |string|`The password to authenticate with the events broker. The events broker is the OpenCloud service which receives and delivers events between the services.`|`""`|
|`OC_JWT_SECRET`<br/>`COLLABORATION_JWT_SECRET`| 1.0.0 |string|`The secret to mint and validate jwt tokens.`|`""`|
|`COLLABORATION_GRPC_ADDR`| 1.0.0 |string|`The bind address of the GRPC service.`|`"127.0.0.1:9301"`|
|`OC_GRPC_PROTOCOL`<br/>`COLLABORATION_GRPC_PROTOCOL`| 1.0.0 |string|`The transport protocol of the GRPC service.`|`"tcp"`|
Expand All @@ -52,4 +45,3 @@
|`COLLABORATION_DEBUG_TOKEN`| 1.0.0 |string|`Token to secure the metrics endpoint.`|`""`|
|`COLLABORATION_DEBUG_PPROF`| 1.0.0 |bool|`Enables pprof, which can be used for profiling.`|`"false"`|
|`COLLABORATION_DEBUG_ZPAGES`| 1.0.0 |bool|`Enables zpages, which can be used for collecting and viewing in-memory traces.`|`"false"`|
|`OC_MACHINE_AUTH_API_KEY`<br/>`COLLABORATION_MACHINE_AUTH_API_KEY`| 7.3.0 |string|`The machine auth API key used to validate internal requests necessary to access resources from other services.`|`""`|
2 changes: 2 additions & 0 deletions docs/_static/env-vars/eventhistory.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ debug:
grpc:
addr: 127.0.0.1:9274
tls: null
disabled: false
grpc_client_tls: null
events:
endpoint: 127.0.0.1:9233
Expand All @@ -19,6 +20,7 @@ events:
enable_tls: false
username: ""
password: ""
disabled: false
store:
store: nats-js-kv
nodes:
Expand Down
2 changes: 2 additions & 0 deletions docs/_static/env-vars/eventhistory_configvars.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,15 @@
|`EVENTHISTORY_DEBUG_PPROF`| 1.0.0 |bool|`Enables pprof, which can be used for profiling.`|`"false"`|
|`EVENTHISTORY_DEBUG_ZPAGES`| 1.0.0 |bool|`Enables zpages, which can be used for collecting and viewing in-memory traces.`|`"false"`|
|`EVENTHISTORY_GRPC_ADDR`| 1.0.0 |string|`The bind address of the GRPC service.`|`"127.0.0.1:9274"`|
|`EVENTHISTORY_GRPC_DISABLED`| %NEXT% |bool|`Disables the GRPC service. Set this to true if the service should only handle events.`|`"false"`|
|`OC_EVENTS_ENDPOINT`<br/>`EVENTHISTORY_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_CLUSTER`<br/>`EVENTHISTORY_EVENTS_CLUSTER`| 1.0.0 |string|`The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system.`|`"opencloud-cluster"`|
|`OC_INSECURE`<br/>`OC_EVENTS_TLS_INSECURE`<br/>`EVENTHISTORY_EVENTS_TLS_INSECURE`| 1.0.0 |bool|`Whether to verify the server TLS certificates.`|`"false"`|
|`OC_EVENTS_TLS_ROOT_CA_CERTIFICATE`<br/>`EVENTHISTORY_EVENTS_TLS_ROOT_CA_CERTIFICATE`| 1.0.0 |string|`The root CA certificate used to validate the server's TLS certificate. Will be seen as empty if NOTIFICATIONS_EVENTS_TLS_INSECURE is provided.`|`""`|
|`OC_EVENTS_ENABLE_TLS`<br/>`EVENTHISTORY_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_AUTH_USERNAME`<br/>`EVENTHISTORY_EVENTS_AUTH_USERNAME`| 1.0.0 |string|`The username to authenticate with the events broker. The events broker is the OpenCloud service which receives and delivers events between the services.`|`""`|
|`OC_EVENTS_AUTH_PASSWORD`<br/>`EVENTHISTORY_EVENTS_AUTH_PASSWORD`| 1.0.0 |string|`The password to authenticate with the events broker. The events broker is the OpenCloud service which receives and delivers events between the services.`|`""`|
|`EVENTHISTORY_EVENTS_DISABLED`| %NEXT% |bool|`Disables listening for events. Set this to true if the service should only handle GRPC requests.`|`"false"`|
|`OC_PERSISTENT_STORE`<br/>`EVENTHISTORY_STORE`| 1.0.0 |string|`The type of the store. Supported values are: 'memory', 'nats-js-kv', 'redis-sentinel', 'noop'. See the text description for details.`|`"nats-js-kv"`|
|`OC_PERSISTENT_STORE_NODES`<br/>`EVENTHISTORY_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]"`|
|`EVENTHISTORY_STORE_DATABASE`| 1.0.0 |string|`The database name the configured store should use.`|`"eventhistory"`|
Expand Down
2 changes: 0 additions & 2 deletions docs/_static/env-vars/frontend.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,6 @@ archiver:
max_num_files: 10000
max_size: 1073741824
insecure: false
data_gateway:
prefix: data
ocs:
prefix: ocs
share_prefix: /Shares
Expand Down
3 changes: 1 addition & 2 deletions docs/_static/env-vars/frontend_configvars.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

2026-08-17-00-05-51
2026-08-25-00-04-13

## Deprecation Notice

Expand Down Expand Up @@ -62,7 +62,6 @@
|`FRONTEND_ARCHIVER_MAX_NUM_FILES`| 1.0.0 |int64|`Max number of files that can be packed into an archive.`|`"10000"`|
|`FRONTEND_ARCHIVER_MAX_SIZE`| 1.0.0 |int64|`Max size in bytes of the zip archive the archiver can create.`|`"1073741824"`|
|`OC_INSECURE`<br/>`FRONTEND_ARCHIVER_INSECURE`| 1.0.0 |bool|`Allow insecure connections to the archiver.`|`"false"`|
|`FRONTEND_DATA_GATEWAY_PREFIX`| 1.0.0 |string|`Path prefix for the data gateway.`|`"data"`|
|`FRONTEND_OCS_PREFIX`| 1.0.0 |string|`URL path prefix for the OCS service. Note that the string must not start with '/'.`|`"ocs"`|
|`FRONTEND_OCS_SHARE_PREFIX`| 1.0.0 |string|`Path prefix for shares as part of a CS3 resource. Note that the path must start with '/'.`|`"/Shares"`|
|`FRONTEND_OCS_PERSONAL_NAMESPACE`| 1.0.0 |string|`Home namespace identifier.`|`"/users/{{.Id.OpaqueId}}"`|
Expand Down
2 changes: 0 additions & 2 deletions docs/_static/env-vars/gateway.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@ skip_user_groups_in_token: false
commit_share_to_storage_grant: true
share_folder_name: Shares
disable_home_creation_on_login: true
transfer_secret: ""
transfer_expires: 86400
cache:
provider_cache_store: noop
provider_cache_nodes:
Expand Down
2 changes: 0 additions & 2 deletions docs/_static/env-vars/gateway_configvars.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@
|`GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT`| 1.0.0 |bool|`Commit shares to storage grants. This grants access to shared resources for the share receiver directly on the storage.`|`"true"`|
|`GATEWAY_SHARE_FOLDER_NAME`| 1.0.0 |string|`Name of the share folder in users' home space.`|`"Shares"`|
|`GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN`| 1.0.0 |bool|`Disable creation of the home space on login.`|`"true"`|
|`OC_TRANSFER_SECRET`| 1.0.0 |string|`The storage transfer secret.`|`""`|
|`GATEWAY_TRANSFER_EXPIRES`| 1.0.0 |int|`Expiry for the gateway tokens.`|`"86400"`|
|`OC_CACHE_STORE`<br/>`GATEWAY_PROVIDER_CACHE_STORE`| 1.0.0 |string|`The type of the cache store. Supported values are: 'memory', 'redis-sentinel', 'nats-js-kv', 'noop'. See the text description for details.`|`"noop"`|
|`OC_CACHE_STORE_NODES`<br/>`GATEWAY_PROVIDER_CACHE_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_CACHE_DATABASE`| 1.0.0 |string|`The database name the configured store should use.`|`"cache-providers"`|
Expand Down
Loading