Skip to content
Merged
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
58 changes: 28 additions & 30 deletions docs/_static/env-vars/frontend_configvars.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,35 @@

2026-11-17-00-06-48

## Deprecation Notice

| Deprecation Info | Deprecation Version | Removal Version | Deprecation Replacement |
|---|---|---|:---|
| FRONTEND_MAX_CONCURRENCY is deprecated and will be removed in a future version. Please use SHARING_MAX_CONCURRENCY (sharing service) instead. | 8.0.0 | next-prod | SHARING_MAX_CONCURRENCY |
| The OCS API is deprecated | 1.0.0 | next-prod | |
| The OCS API is deprecated | 1.0.0 | next-prod | |
| The OCS API is deprecated | 1.0.0 | next-prod | |
| The OCS API is deprecated | 1.0.0 | next-prod | |
| FRONTEND_OCS_STAT_CACHE_STORE, the OCS API is deprecated | 1.0.0 | next-prod | |
| FRONTEND_OCS_STAT_CACHE_STORE_NODES, the OCS API is deprecated | 1.0.0 | next-prod | |
| The OCS API is deprecated | 1.0.0 | next-prod | |
| FRONTEND_OCS_STAT_CACHE_TTL, the OCS API is deprecated | 1.0.0 | next-prod | |
| FRONTEND_OCS_STAT_CACHE_DISABLE_PERSISTENCE, the OCS API is deprecated | 1.0.0 | next-prod | |
| FRONTEND_OCS_STAT_CACHE_AUTH_USERNAME, the OCS API is deprecated | 1.0.0 | next-prod | |
| FRONTEND_OCS_STAT_CACHE_AUTH_PASSWORD, the OCS API is deprecated | 1.0.0 | next-prod | |
| The OCS API is deprecated | 1.0.0 | next-prod | |
| FRONTEND_OCS_LIST_OCM_SHARES, the OCS API is deprecated | 1.0.0 | next-prod | |
| FRONTEND_OCS_INCLUDE_OCM_SHAREES, the OCS API is deprecated | 1.0.0 | next-prod | |
| FRONTEND_OCS_PUBLIC_SHARE_MUST_HAVE_PASSWORD, the OCS API is deprecated | 1.0.0 | next-prod | |
| FRONTEND_OCS_PUBLIC_WRITABLE_SHARE_MUST_HAVE_PASSWORD, the OCS API is deprecated | 1.0.0 | next-prod | |
| FRONTEND_EVENTS_ENDPOINT is deprecated and will be removed in a future version. Please use SHARING_EVENTS_ENDPOINT (sharing service) instead. | 8.0.0 | next-prod | SHARING_EVENTS_ENDPOINT |
| FRONTEND_EVENTS_CLUSTER is deprecated and will be removed in a future version. Please use SHARING_EVENTS_CLUSTER (sharing service) instead. | 8.0.0 | next-prod | SHARING_EVENTS_CLUSTER |
| FRONTEND_EVENTS_TLS_INSECURE is deprecated and will be removed in a future version. Please use SHARING_EVENTS_TLS_INSECURE (sharing service) instead. | 8.0.0 | next-prod | SHARING_EVENTS_TLS_INSECURE |
| FRONTEND_EVENTS_TLS_ROOT_CA_CERTIFICATE is deprecated and will be removed in a future version. Please use SHARING_EVENTS_TLS_ROOT_CA_CERTIFICATE (sharing service) instead. | 8.0.0 | next-prod | SHARING_EVENTS_TLS_ROOT_CA_CERTIFICATE |
| FRONTEND_EVENTS_ENABLE_TLS is deprecated and will be removed in a future version. Please use SHARING_EVENTS_ENABLE_TLS (sharing service) instead. | 8.0.0 | next-prod | SHARING_EVENTS_ENABLE_TLS |
| FRONTEND_EVENTS_AUTH_USERNAME is deprecated and will be removed in a future version. Please use SHARING_EVENTS_AUTH_USERNAME (sharing service) instead. | 8.0.0 | next-prod | SHARING_EVENTS_AUTH_USERNAME |
| FRONTEND_EVENTS_AUTH_PASSWORD is deprecated and will be removed in a future version. Please use SHARING_EVENTS_AUTH_PASSWORD (sharing service) instead. | 8.0.0 | next-prod | SHARING_EVENTS_AUTH_PASSWORD |
| FRONTEND_AUTO_ACCEPT_SHARES is deprecated and will be removed in a future version. Please use SHARING_AUTO_ACCEPT_SHARES (sharing service) instead. | 8.0.0 | next-prod | SHARING_AUTO_ACCEPT_SHARES |
| FRONTEND_SERVICE_ACCOUNT_ID is deprecated and will be removed in a future version. Please use SHARING_SERVICE_ACCOUNT (sharing service) instead. | 8.0.0 | next-prod | SHARING_SERVICE_ACCOUNT |
| FRONTEND_SERVICE_ACCOUNT_SECRET is deprecated and will be removed in a future version. Please use SHARING_SERVICE_ACCOUNT_SECRET (sharing service) instead. | 8.0.0 | next-prod | SHARING_SERVICE_ACCOUNT_SECRET |
| FRONTEND_MAX_CONCURRENCY is deprecated and will be removed in a future version. Please use SHARING_MAX_CONCURRENCY (sharing service) instead. | 8.0.0 | 9.1.1 | SHARING_MAX_CONCURRENCY |
| The OCS API is deprecated | 1.0.0 | 9.1.1 | |
| The OCS API is deprecated | 1.0.0 | 9.1.1 | |
| The OCS API is deprecated | 1.0.0 | 9.1.1 | |
| The OCS API is deprecated | 1.0.0 | 9.1.1 | |
| FRONTEND_OCS_STAT_CACHE_STORE, the OCS API is deprecated | 1.0.0 | 9.1.1 | |
| FRONTEND_OCS_STAT_CACHE_STORE_NODES, the OCS API is deprecated | 1.0.0 | 9.1.1 | |
| The OCS API is deprecated | 1.0.0 | 9.1.1 | |
| FRONTEND_OCS_STAT_CACHE_TTL, the OCS API is deprecated | 1.0.0 | 9.1.1 | |
| FRONTEND_OCS_STAT_CACHE_DISABLE_PERSISTENCE, the OCS API is deprecated | 1.0.0 | 9.1.1 | |
| FRONTEND_OCS_STAT_CACHE_AUTH_USERNAME, the OCS API is deprecated | 1.0.0 | 9.1.1 | |
| FRONTEND_OCS_STAT_CACHE_AUTH_PASSWORD, the OCS API is deprecated | 1.0.0 | 9.1.1 | |
| The OCS API is deprecated | 1.0.0 | 9.1.1 | |
| FRONTEND_OCS_LIST_OCM_SHARES, the OCS API is deprecated | 1.0.0 | 9.1.1 | |
| FRONTEND_OCS_INCLUDE_OCM_SHAREES, the OCS API is deprecated | 1.0.0 | 9.1.1 | |
| FRONTEND_OCS_PUBLIC_SHARE_MUST_HAVE_PASSWORD, the OCS API is deprecated | 1.0.0 | 9.1.1 | |
| FRONTEND_OCS_PUBLIC_WRITABLE_SHARE_MUST_HAVE_PASSWORD, the OCS API is deprecated | 1.0.0 | 9.1.1 | |
| FRONTEND_EVENTS_ENDPOINT is deprecated and will be removed in a future version. Please use SHARING_EVENTS_ENDPOINT (sharing service) instead. | 8.0.0 | 9.1.1 | SHARING_EVENTS_ENDPOINT |
| FRONTEND_EVENTS_CLUSTER is deprecated and will be removed in a future version. Please use SHARING_EVENTS_CLUSTER (sharing service) instead. | 8.0.0 | 9.1.1 | SHARING_EVENTS_CLUSTER |
| FRONTEND_EVENTS_TLS_INSECURE is deprecated and will be removed in a future version. Please use SHARING_EVENTS_TLS_INSECURE (sharing service) instead. | 8.0.0 | 9.1.1 | SHARING_EVENTS_TLS_INSECURE |
| FRONTEND_EVENTS_TLS_ROOT_CA_CERTIFICATE is deprecated and will be removed in a future version. Please use SHARING_EVENTS_TLS_ROOT_CA_CERTIFICATE (sharing service) instead. | 8.0.0 | 9.1.1 | SHARING_EVENTS_TLS_ROOT_CA_CERTIFICATE |
| FRONTEND_EVENTS_ENABLE_TLS is deprecated and will be removed in a future version. Please use SHARING_EVENTS_ENABLE_TLS (sharing service) instead. | 8.0.0 | 9.1.1 | SHARING_EVENTS_ENABLE_TLS |
| FRONTEND_EVENTS_AUTH_USERNAME is deprecated and will be removed in a future version. Please use SHARING_EVENTS_AUTH_USERNAME (sharing service) instead. | 8.0.0 | 9.1.1 | SHARING_EVENTS_AUTH_USERNAME |
| FRONTEND_EVENTS_AUTH_PASSWORD is deprecated and will be removed in a future version. Please use SHARING_EVENTS_AUTH_PASSWORD (sharing service) instead. | 8.0.0 | 9.1.1 | SHARING_EVENTS_AUTH_PASSWORD |
| FRONTEND_AUTO_ACCEPT_SHARES is deprecated and will be removed in a future version. Please use SHARING_AUTO_ACCEPT_SHARES (sharing service) instead. | 8.0.0 | 9.1.1 | SHARING_AUTO_ACCEPT_SHARES |
| FRONTEND_SERVICE_ACCOUNT_ID is deprecated and will be removed in a future version. Please use SHARING_SERVICE_ACCOUNT (sharing service) instead. | 8.0.0 | 9.1.1 | SHARING_SERVICE_ACCOUNT |
| FRONTEND_SERVICE_ACCOUNT_SECRET is deprecated and will be removed in a future version. Please use SHARING_SERVICE_ACCOUNT_SECRET (sharing service) instead. | 8.0.0 | 9.1.1 | SHARING_SERVICE_ACCOUNT_SECRET |

## Environment variables for the **frontend** service

Expand Down Expand Up @@ -135,5 +133,5 @@
|`OC_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS`<br/>`FRONTEND_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS`| 1.0.0 |int|`Define the minimum number of characters from the special characters list to be present. Defaults to 1 if not set.`|`"1"`|
|`OC_PASSWORD_POLICY_BANNED_PASSWORDS_LIST`<br/>`FRONTEND_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.`|`""`|
|`FRONTEND_CONFIGURABLE_NOTIFICATIONS`| 1.0.0 |bool|`Allow configuring notifications via web client.`|`"true"`|
|`OC_CLAIM_MANAGED_SPACES_ENABLED`| next |bool|`Mark spaces as managed by the server. Clients like the web UI then block adding or removing users to or from spaces. See the text description for more details.`|`"false"`|
|`OC_CLAIM_MANAGED_SPACES_ENABLED`| 9.2.0 |bool|`Mark spaces as managed by the server. Clients like the web UI then block adding or removing users to or from spaces. See the text description for more details.`|`"false"`|
|`FRONTEND_GROUPWARE_ENABLED`| 3.7.0 |bool|`Enable groupware features. Defaults to false.`|`"false"`|
11 changes: 0 additions & 11 deletions docs/_static/env-vars/gateway.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,6 @@ cache:
provider_cache_enable_tls: false
provider_cache_tls_insecure: false
provider_cache_tls_root_ca_certificate: ""
create_home_cache_store: memory
create_home_cache_nodes:
- 127.0.0.1:9233
create_home_cache_database: cache-createhome
create_home_cache_ttl: 5m0s
create_home_cache_disable_persistence: false
create_home_cache_auth_username: ""
create_home_cache_auth_password: ""
create_home_cache_enable_tls: false
create_home_cache_tls_insecure: false
create_home_cache_tls_root_ca_certificate: ""
frontend_public_url: https://localhost:9200
users_endpoint: eu.opencloud.api.users
groups_endpoint: eu.opencloud.api.groups
Expand Down
10 changes: 0 additions & 10 deletions docs/_static/env-vars/gateway_configvars.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,6 @@
|`OC_CACHE_ENABLE_TLS`<br/>`GATEWAY_PROVIDER_CACHE_ENABLE_TLS`| 7.3.0 |bool|`Enable TLS for the connection to file metadata cache.`|`"false"`|
|`OC_INSECURE`<br/>`OC_CACHE_TLS_INSECURE`<br/>`GATEWAY_PROVIDER_CACHE_TLS_INSECURE`| 7.3.0 |bool|`Whether to verify the server TLS certificates.`|`"false"`|
|`OC_CACHE_TLS_ROOT_CA_CERTIFICATE`<br/>`GATEWAY_PROVIDER_CACHE_TLS_ROOT_CA_CERTIFICATE`| 7.3.0 |string|`The root CA certificate used to validate the server's TLS certificate. If provided GATEWAY_PROVIDER_CACHE_TLS_INSECURE will be seen as false.`|`""`|
|`OC_CACHE_STORE`<br/>`GATEWAY_CREATE_HOME_CACHE_STORE`| 1.0.0 |string|`The type of the cache store. Supported values are: 'memory', 'nats-js-kv', 'noop'. See the text description for details.`|`"memory"`|
|`OC_CACHE_STORE_NODES`<br/>`GATEWAY_CREATE_HOME_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-createhome"`|
|`OC_CACHE_TTL`<br/>`GATEWAY_CREATE_HOME_CACHE_TTL`| 1.0.0 |Duration|`Default time to live for user info in the cache. Only applied when access tokens has no expiration. See the Environment Variable Types description for more details.`|`"5m0s"`|
|`OC_CACHE_DISABLE_PERSISTENCE`<br/>`GATEWAY_CREATE_HOME_CACHE_DISABLE_PERSISTENCE`| 1.0.0 |bool|`Disables persistence of the create home cache. Only applies when store type 'nats-js-kv' is configured. Defaults to false.`|`"false"`|
|`OC_CACHE_AUTH_USERNAME`<br/>`GATEWAY_CREATE_HOME_CACHE_AUTH_USERNAME`| 1.0.0 |string|`The username to use for authentication. Only applies when store type 'nats-js-kv' is configured.`|`""`|
|`OC_CACHE_AUTH_PASSWORD`<br/>`GATEWAY_CREATE_HOME_CACHE_AUTH_PASSWORD`| 1.0.0 |string|`The password to use for authentication. Only applies when store type 'nats-js-kv' is configured.`|`""`|
|`OC_CACHE_ENABLE_TLS`<br/>`GATEWAY_CREATE_HOME_CACHE_ENABLE_TLS`| 7.3.0 |bool|`Enable TLS for the connection to file metadata cache.`|`"false"`|
|`OC_INSECURE`<br/>`OC_CACHE_TLS_INSECURE`<br/>`GATEWAY_CREATE_HOME_CACHE_TLS_INSECURE`| 7.3.0 |bool|`Whether to verify the server TLS certificates.`|`"false"`|
|`OC_CACHE_TLS_ROOT_CA_CERTIFICATE`<br/>`GATEWAY_CREATE_HOME_CACHE_TLS_ROOT_CA_CERTIFICATE`| 7.3.0 |string|`The root CA certificate used to validate the server's TLS certificate. If provided GATEWAY_CREATE_HOME_CACHE_TLS_INSECURE will be seen as false.`|`""`|
|`OC_URL`<br/>`GATEWAY_FRONTEND_PUBLIC_URL`| 1.0.0 |string|`The public facing URL of the OpenCloud frontend.`|`"https://localhost:9200"`|
|`GATEWAY_USERS_ENDPOINT`| 1.0.0 |string|`The endpoint of the users service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol.`|`"eu.opencloud.api.users"`|
|`GATEWAY_GROUPS_ENDPOINT`| 1.0.0 |string|`The endpoint of the groups service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol.`|`"eu.opencloud.api.groups"`|
Expand Down
12 changes: 6 additions & 6 deletions docs/_static/env-vars/gateway_readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ The gateway service is responsible for passing requests to the storage providers

## Caching

The gateway service is using caching as it is highly frequented with the same requests. As of now it uses two different caches:
- the `provider cache` is caching requests to list or get storage providers.
- the `create home cache` is caching requests to create personal spaces (as they only need to be executed once).
The gateway service is using caching as it is highly frequented with the same requests. It uses the `provider cache` to cache requests to list or get storage providers.

Both caches can be configured via the `OC_CACHE_*` envvars (or `GATEWAY_PROVIDER_CACHE_*` and `GATEWAY_CREATE_HOME_CACHE_*` respectively).
The `provider cache` can be configured via the `OC_CACHE_*` envvars (or the `GATEWAY_PROVIDER_CACHE_*` envvars).

Use `OC_CACHE_STORE` (`GATEWAY_PROVIDER_CACHE_STORE`, `GATEWAY_CREATE_HOME_CACHE_STORE`) to define the type of cache to use:
- `memory`: Basic in-memory store and the default.
Requests to create personal spaces are no longer cached by a configurable `create home cache`, the `GATEWAY_CREATE_HOME_CACHE_*` envvars have been removed. Instead, the `proxy` service remembers in memory which users already have a personal space and only sends a create request for the others.

Use `OC_CACHE_STORE` (`GATEWAY_PROVIDER_CACHE_STORE`) to define the type of cache to use:
- `memory`: Basic in-memory store.
- `nats-js-kv`: Stores data using key-value-store feature of [nats jetstream](https://docs.nats.io/nats-concepts/jetstream/key-value-store)
- `noop`: Stores nothing. Useful for testing. Not recommended in production environments.

Expand Down
Loading
Loading