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
4 changes: 4 additions & 0 deletions docs/_static/env-vars/frontend.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,11 @@ password_policy:
min_digits: 1
min_special_characters: 1
banned_passwords_list: ""
validation:
max_tag_length: 100
configurable_notifications: true
disable_new_user_shares: false
disable_new_public_links: false
server_managed_spaces: false
groupware:
enabled: false
3 changes: 3 additions & 0 deletions docs/_static/env-vars/frontend_configvars.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,9 @@
|`OC_PASSWORD_POLICY_MIN_DIGITS`<br/>`FRONTEND_PASSWORD_POLICY_MIN_DIGITS`| 1.0.0 |int|`Define the minimum number of digits. Defaults to 1 if not set.`|`"1"`|
|`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.`|`""`|
|`OC_MAX_TAG_LENGTH`| next |int|`The maximum length of a single tag, in characters. Longer tags are rejected when they are assigned; tags that already exist are not affected. Clients are told the limit through the graph.tags.max_tag_length capability, which is why the graph and frontend services share this setting: when setting it in the configuration files of the services instead, set it to the same value for both. Set to 0 to not limit the length of tags.`|`"100"`|
|`FRONTEND_CONFIGURABLE_NOTIFICATIONS`| 1.0.0 |bool|`Allow configuring notifications via web client.`|`"true"`|
|`OC_DISABLE_NEW_USER_SHARES`| next |bool|`Reject the creation of new user, group and federated shares. Existing shares keep working. Adding members to spaces is not affected. The sharee search returns no results and the capabilities announce that user sharing is disabled.`|`"false"`|
|`OC_DISABLE_NEW_PUBLIC_LINKS`| next |bool|`Reject the creation of new public links and turning internal links into public links. Internal links and existing public links keep working.`|`"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"`|
3 changes: 3 additions & 0 deletions docs/_static/env-vars/global_configvars.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
| `OC_CORS_ALLOW_ORIGINS` | 1.0.0 | []string | A list of allowed CORS origins. See following chapter for more details: *Access-Control-Allow-Origin* at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. See the Environment Variable Types description for more details. | "[*]" |
| `OC_DECOMPOSEDFS_PROPAGATOR` | 1.0.0 | string | The propagator used for decomposedfs. At the moment, only 'sync' is fully supported, 'async' is available as an experimental option. | "sync" |
| `OC_DEFAULT_LANGUAGE` | 1.0.0 | string | The default language used by services and the WebUI. If not defined, English will be used as default. See the documentation for more details. | "en" |
| `OC_DISABLE_NEW_PUBLIC_LINKS` | next | bool | Reject the creation of new public links and turning internal links into public links. Internal links and existing public links keep working. | "false" |
| `OC_DISABLE_NEW_USER_SHARES` | next | bool | Reject the creation of new user, group and federated shares. Existing shares keep working. Adding members to spaces is not affected. The sharee search returns no results and the capabilities announce that user sharing is disabled. | "false" |
| `OC_DISABLE_VERSIONING` | 1.0.0 | bool | Disables versioning of files. When set to true, new uploads with the same filename will overwrite existing files instead of creating a new version. | "false" |
| `OC_ENABLE_OCM` | 1.0.0 | bool | Changing this value is NOT supported. Enables support for incoming federated sharing for clients. The backend behaviour is not changed. | "false" |
| `OC_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. | "" |
Expand Down Expand Up @@ -82,6 +84,7 @@
| `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. | "0" |
| `OC_MAX_TAG_LENGTH` | next | int | The maximum length of a single tag, in characters. Longer tags are rejected when they are assigned; tags that already exist are not affected. Clients are told the limit through the graph.tags.max_tag_length capability, which is why the graph and frontend services share this setting: when setting it in the configuration files of the services instead, set it to the same value for both. Set to 0 to not limit the length of tags. | "100" |
| `OC_METADATA_PREFIX` | 9.0.0 | string | The attribute key prefix of the metadata on disk. Defaults to the native 'user.oc.' prefix. It applies to all storage drivers of the instance, they must share the prefix because it is set process wide. | "" |
| `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` | 6.0.0 | []string | The OIDC client scopes the Android app should request. | "[openid profile email offline_access]" |
Expand Down
3 changes: 3 additions & 0 deletions docs/_static/env-vars/graph.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ api:
graph_assign_default_user_role: true
graph_identity_search_min_length: 3
show_email_in_results: false
disable_new_user_shares: false
export_personal_data_rate_limit: 5
reva:
address: eu.opencloud.api.gateway
Expand Down Expand Up @@ -160,6 +161,8 @@ keycloak:
service_account:
service_account_id: ""
service_account_secret: ""
validation:
max_tag_length: 100
machine_auth_api_key: ""
metadata_config:
gateway_addr: eu.opencloud.api.storage-system
Expand Down
2 changes: 2 additions & 0 deletions docs/_static/env-vars/graph_configvars.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
|`GRAPH_ASSIGN_DEFAULT_USER_ROLE`| 1.0.0 |bool|`Whether to assign newly created users the default role 'User'. Set this to 'false' if you want to assign roles manually, or if the role assignment should happen at first login. Set this to 'true' (the default) to assign the role 'User' when creating a new user.`|`"true"`|
|`GRAPH_IDENTITY_SEARCH_MIN_LENGTH`| 1.0.0 |int|`The minimum length the search term needs to have for unprivileged users when searching for users or groups.`|`"3"`|
|`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_DISABLE_NEW_USER_SHARES`| next |bool|`Reject the creation of new user, group and federated shares. Existing shares keep working. Adding members to spaces is not affected.`|`"false"`|
|`GRAPH_EXPORT_PERSONAL_DATA_RATE_LIMIT`| 9.2.0 |int|`The maximum number of personal data exports a user can start per minute. Each instance of the graph service counts on its own, so with several instances, a user can start up to this number of exports on each of them. Set it to 0 to disable the limit.`|`"5"`|
|`OC_REVA_GATEWAY`| 1.0.0 |string|`The CS3 gateway endpoint.`|`"eu.opencloud.api.gateway"`|
|`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.`|`""`|
Expand Down Expand Up @@ -122,6 +123,7 @@
|`OC_KEYCLOAK_INSECURE_SKIP_VERIFY`<br/>`GRAPH_KEYCLOAK_INSECURE_SKIP_VERIFY`| 1.0.0 |bool|`Disable TLS certificate validation for Keycloak connections. Do not set this in production environments.`|`"false"`|
|`OC_SERVICE_ACCOUNT_ID`<br/>`GRAPH_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`<br/>`GRAPH_SERVICE_ACCOUNT_SECRET`| 1.0.0 |string|`The service account secret.`|`""`|
|`OC_MAX_TAG_LENGTH`| next |int|`The maximum length of a single tag, in characters. Longer tags are rejected when they are assigned; tags that already exist are not affected. Clients are told the limit through the graph.tags.max_tag_length capability, which is why the graph and frontend services share this setting: when setting it in the configuration files of the services instead, set it to the same value for both. Set to 0 to not limit the length of tags.`|`"100"`|
|`OC_MACHINE_AUTH_API_KEY`<br/>`GRAPH_MACHINE_AUTH_API_KEY`| 7.5.0 |string|`Machine auth API key used to validate internal requests necessary for the access to resources from other services.`|`""`|
|`GRAPH_STORAGE_GATEWAY_GRPC_ADDR`<br/>`STORAGE_GATEWAY_GRPC_ADDR`| 4.0.0 |string|`GRPC address of the STORAGE-SYSTEM service.`|`"eu.opencloud.api.storage-system"`|
|`GRAPH_STORAGE_GRPC_ADDR`<br/>`STORAGE_GRPC_ADDR`| 4.0.0 |string|`GRPC address of the STORAGE-SYSTEM service.`|`"eu.opencloud.api.storage-system"`|
Expand Down
1 change: 1 addition & 0 deletions docs/_static/env-vars/ocm.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ ocm_share_provider:
file: /var/lib/opencloud/storage/ocm/ocmshares.json
insecure: false
webapp_template: ""
disable_new_user_shares: false
ocm_core:
driver: json
drivers:
Expand Down
1 change: 1 addition & 0 deletions docs/_static/env-vars/ocm_configvars.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
|`OCM_OCM_SHAREPROVIDER_JSON_FILE`| 1.0.0 |string|`Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OC_BASE_DATA_PATH/storage.`|`"/var/lib/opencloud/storage/ocm/ocmshares.json"`|
|`OCM_OCM_SHARE_PROVIDER_INSECURE`| 1.0.0 |bool|`Disable TLS certificate validation for the OCM connections. Do not set this in production environments.`|`"false"`|
|`OCM_WEBAPP_TEMPLATE`| 1.0.0 |string|`Template for the webapp url.`|`""`|
|`OC_DISABLE_NEW_USER_SHARES`| next |bool|`Reject the creation of new federated shares. Existing shares keep working.`|`"false"`|
|`OCM_OCM_CORE_DRIVER`| 1.0.0 |string|`Driver to be used for the OCM core. Supported value is only 'json'.`|`"json"`|
|`OCM_OCM_CORE_JSON_FILE`| 1.0.0 |string|`Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OC_BASE_DATA_PATH/storage.`|`"/var/lib/opencloud/storage/ocm/ocmshares.json"`|
|`OCM_OCM_STORAGE_PROVIDER_INSECURE`| 1.0.0 |bool|`Disable TLS certificate validation for the OCM connections. Do not set this in production environments.`|`"false"`|
Expand Down
2 changes: 2 additions & 0 deletions docs/_static/env-vars/sharing.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,5 @@ password_policy:
min_digits: 1
min_special_characters: 1
banned_passwords_list: ""
disable_new_user_shares: false
disable_new_public_links: false
2 changes: 2 additions & 0 deletions docs/_static/env-vars/sharing_configvars.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,5 @@
|`OC_PASSWORD_POLICY_MIN_DIGITS`<br/>`SHARING_PASSWORD_POLICY_MIN_DIGITS`| 1.0.0 |int|`Define the minimum number of digits. Defaults to 1 if not set.`|`"1"`|
|`OC_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS`<br/>`SHARING_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/>`SHARING_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_DISABLE_NEW_USER_SHARES`| next |bool|`Reject the creation of new user and group shares. Existing shares keep working. Adding members to spaces is not affected.`|`"false"`|
|`OC_DISABLE_NEW_PUBLIC_LINKS`| next |bool|`Reject the creation of new public links and turning internal links into public links. Internal links and existing public links keep working.`|`"false"`|
10 changes: 10 additions & 0 deletions docs/_static/env-vars/sharing_readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The `sharing` service provides the CS3 Sharing API for OpenCloud. It manages use
* [Share Types](#share-types)
* [Configuration](#configuration)
* [Auto-Accept Shares](#auto-accept-shares)
* [Disable Creating New Shares](#disable-creating-new-shares)
* [Scalability](#scalability)

## Overview
Expand Down Expand Up @@ -55,6 +56,15 @@ incoming shares will be accepted automatically. Users can overwrite this
setting individually in their profile. The deprecated
`FRONTEND_AUTO_ACCEPT_SHARES` is still supported for backwards compatibility.

### Disable Creating New Shares

Two global switches stop users from creating new shares. Everything that already exists keeps working: existing shares and links can still be used, changed and deleted.

- `OC_DISABLE_NEW_USER_SHARES=true` rejects new user, group and federated shares. Adding members to a space is still possible. The OCS sharee search returns no results and the capabilities announce that user sharing is disabled.
- `OC_DISABLE_NEW_PUBLIC_LINKS=true` rejects new public links and turning an internal link into a public link. Internal links can still be created. The capabilities announce that public links are disabled, so the web UI hides the link section.

Both are read by the `frontend`, `graph`, `sharing` and (for federated shares) `ocm` services. When the services run separately, set them for all of them.

## Scalability

The sharing service depends on the configured storage backends for share metadata. Scalability characteristics depend on the chosen storage backend configuration.
Expand Down