Skip to content
Draft
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: 0 additions & 1 deletion docs/_static/env-vars/auth-guest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ storage:
token_manager:
jwt_secret: ""
jwt:
secret: ""
cookie_name: __Host-oc_guest_session
ttl: 24h0m0s
service_account:
Expand Down
1 change: 0 additions & 1 deletion docs/_static/env-vars/auth-guest_configvars.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
|`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.`|`""`|
|`AUTH_GUEST_TOKENS_STORAGE_ROOT`| next |string|`The directory where the guest share tokens are stored. If not defined, the root directory derives from $OC_BASE_DATA_PATH/auth-guest.`|`"/var/lib/opencloud/auth-guest"`|
|`OC_JWT_SECRET`<br/>`AUTH_GUEST_JWT_SECRET`| next |string|`The secret to mint and validate jwt tokens.`|`""`|
|`AUTH_GUEST_SESSION_JWT_SECRET`| next |string|`The secret used to sign and validate guest session tokens. It must differ from OC_JWT_SECRET.`|`""`|
|`AUTH_GUEST_JWT_COOKIE_NAME`| next |string|`The name of the session cookie set when a guest token is redeemed.`|`"__Host-oc_guest_session"`|
|`AUTH_GUEST_JWT_TTL`| next |Duration|`The lifetime of a redeemed guest session token.`|`"24h0m0s"`|
|`OC_SERVICE_ACCOUNT_ID`<br/>`AUTH_GUEST_SERVICE_ACCOUNT_ID`| next |string|`The ID of the service account the service should use. See the 'auth-service' service description for more details.`|`""`|
Expand Down
5 changes: 3 additions & 2 deletions docs/_static/env-vars/auth-guest_readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,11 @@ the event consumer, set `AUTH_GUEST_HTTP_DISABLED=true`.

Relevant options:

- `AUTH_GUEST_SESSION_JWT_SECRET` — secret used to sign guest session tokens.
It must differ from `OC_JWT_SECRET`.
- `AUTH_GUEST_JWT_COOKIE_NAME`, `AUTH_GUEST_JWT_TTL` — session cookie name and
lifetime.
- Guest session tokens are signed with a key derived from `OC_JWT_SECRET`. There
is no separate secret to configure; rotating `OC_JWT_SECRET` invalidates all
guest sessions.
- `AUTH_GUEST_TOKENS_STORAGE_ROOT` — where guest link token records are stored.
- `AUTH_GUEST_SERVICE_ACCOUNT_ID`, `AUTH_GUEST_SERVICE_ACCOUNT_SECRET` — service
account used to query the gateway for share metadata.
Expand Down
2 changes: 1 addition & 1 deletion docs/_static/env-vars/frontend_configvars.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

2026-10-07-00-08-40
2026-10-10-00-08-08

## Deprecation Notice

Expand Down
95 changes: 48 additions & 47 deletions docs/_static/env-vars/global_configvars.md

Large diffs are not rendered by default.

6 changes: 4 additions & 2 deletions docs/_static/env-vars/proxy_readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -405,8 +405,8 @@ The following metrics are exposed by the proxy service:
| `opencloud_proxy_concurrent_service_requests` | • `service`: identifier of the service the request is proxied to | Counts the number of in-flight requests that are being processed at a given time |
| `opencloud_proxy_routing_failure_count` | | Counts the number of inbound requests that cannot be proxied due to a failure of determining how to route it |
| `opencloud_proxy_duration_seconds` | • `service`: identifier of the service the request is proxied to | Classic histogram that measures the duration of proxied HTTP requests, per service |
| `opencloud_proxy_request_total` | • `method`: the HTTP method<br />• `result`: one of `success` (&lt;=299), `client-error` (&lt;= 499), `server-error` (>= 500), depending on the status code in the response of the proxied HTTP request<br />• `services`: identifier of the service the request is proxied to | Counts the number of proxied requests |
| `opencloud_proxy_request_duration_seconds_bucket` | • `method`: the HTTP method<br />• `result`: one of `success`, `client-error`, `server-error`, depending on the status code in the response of the proxied HTTP request<br />• `services`: identifier of the service the request is proxied to | Native histogram that measures the duration of proxied HTTP requests, per service |
| `opencloud_proxy_request_total` | • `method`: the HTTP method<br>• `result`: one of `success` (<=299), `client-error` (<= 499), `server-error` (>= 500), depending on the status code in the response of the proxied HTTP request<br>• `services`: identifier of the service the request is proxied to | Counts the number of proxied requests |
| `opencloud_proxy_request_duration_seconds_bucket` | • `method`: the HTTP method<br>• `result`: one of `success`, `client-error`, `server-error`, depending on the status code in the response of the proxied HTTP request<br>• `services`: identifier of the service the request is proxied to | Native histogram that measures the duration of proxied HTTP requests, per service |
| `opencloud_proxy_build_info` | • `version`: build version of the proxy | A gauge with a constant value of `1` |

### Prometheus Configuration
Expand All @@ -433,3 +433,5 @@ scrape_configs:
static_configs:
- targets: ["opencloud:9205"]
```


1 change: 1 addition & 0 deletions docs/_static/env-vars/storage-system.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,5 @@ drivers:
root: /var/lib/opencloud/storage/metadata
max_acquire_lock_cycles: 20
lock_cycle_duration_factor: 30
metadata_prefix: ""
data_server_url: http://localhost:9216/data
1 change: 1 addition & 0 deletions docs/_static/env-vars/storage-system_configvars.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,5 @@
|`STORAGE_SYSTEM_OC_ROOT`| 1.0.0 |string|`Path for the directory where the STORAGE-SYSTEM service stores it's persistent data. If not defined, the root directory derives from $OC_BASE_DATA_PATH/storage.`|`"/var/lib/opencloud/storage/metadata"`|
|`STORAGE_SYSTEM_OC_MAX_ACQUIRE_LOCK_CYCLES`| 1.0.0 |int|`When trying to lock files, OpenCloud 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.`|`"20"`|
|`STORAGE_SYSTEM_OC_LOCK_CYCLE_DURATION_FACTOR`| 1.0.0 |int|`When trying to lock files, OpenCloud 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.`|`"30"`|
|`OC_METADATA_PREFIX`| next |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.`|`""`|
|`STORAGE_SYSTEM_DATA_SERVER_URL`| 1.0.0 |string|`URL of the data server, needs to be reachable by other services using this service.`|`"http://localhost:9216/data"`|
3 changes: 3 additions & 0 deletions docs/_static/env-vars/storage-users.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ drivers:
async_uploads: true
max_quota: 0
disable_versioning: false
metadata_prefix: ""
decomposeds3:
propagator: sync
async_propagator_options:
Expand Down Expand Up @@ -114,6 +115,7 @@ drivers:
max_concurrency: 5
async_uploads: true
disable_versioning: false
metadata_prefix: ""
owncloudsql:
root: /var/lib/opencloud/storage/owncloud
share_folder: /Shares
Expand Down Expand Up @@ -142,6 +144,7 @@ drivers:
lock_cycle_duration_factor: 0
max_concurrency: 0
disable_versioning: false
metadata_prefix: ""
use_space_groups: false
enable_fs_revisions: false
scan_fs: true
Expand Down
5 changes: 4 additions & 1 deletion docs/_static/env-vars/storage-users_configvars.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

2026-10-07-00-08-40
2026-10-10-00-08-08

## Deprecation Notice

Expand Down Expand Up @@ -50,6 +50,7 @@
|`OC_ASYNC_UPLOADS`| 1.0.0 |bool|`Enable asynchronous file uploads.`|`"true"`|
|`OC_SPACES_MAX_QUOTA`<br/>`STORAGE_USERS_DECOMPOSED_MAX_QUOTA`| 1.0.0 |uint64|`Set a global max quota for spaces in bytes. A value of 0 equals unlimited. If not using the global OC_SPACES_MAX_QUOTA, you must define the FRONTEND_MAX_QUOTA in the frontend service.`|`"0"`|
|`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_METADATA_PREFIX`| next |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_DECOMPOSEDFS_PROPAGATOR`<br/>`STORAGE_USERS_DECOMPOSEDS3_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"`|
|`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_DECOMPOSEDS3_ROOT`| 1.0.0 |string|`The directory where the filesystem storage will store metadata for blobs. If not defined, the root directory derives from $OC_BASE_DATA_PATH/storage/users.`|`"/var/lib/opencloud/storage/users"`|
Expand All @@ -76,6 +77,7 @@
|`OC_MAX_CONCURRENCY`<br/>`STORAGE_USERS_DECOMPOSEDS3_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 of 100 will be used.`|`"5"`|
|`OC_ASYNC_UPLOADS`| 1.0.0 |bool|`Enable asynchronous file uploads.`|`"true"`|
|`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_METADATA_PREFIX`| next |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.`|`""`|
|`STORAGE_USERS_OWNCLOUDSQL_DATADIR`| 1.0.0 |string|`The directory where the filesystem storage will store SQL migration data. If not defined, the root directory derives from $OC_BASE_DATA_PATH/storage/owncloud.`|`"/var/lib/opencloud/storage/owncloud"`|
|`STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER`| 1.0.0 |string|`Name of the folder jailing all shares.`|`"/Shares"`|
|`STORAGE_USERS_OWNCLOUDSQL_LAYOUT`| 1.0.0 |string|`Path layout to use to navigate into a users folder in an owncloud data directory`|`"{{.Username}}"`|
Expand All @@ -101,6 +103,7 @@
|`STORAGE_USERS_POSIX_LOCK_CYCLE_DURATION_FACTOR`| 2.0.0 |int|`When trying to lock files, OpenCloud 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 will be used.`|`"0"`|
|`OC_MAX_CONCURRENCY`<br/>`STORAGE_USERS_POSIX_MAX_CONCURRENCY`| 2.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_DISABLE_VERSIONING`| 2.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_METADATA_PREFIX`| next |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.`|`""`|
|`STORAGE_USERS_POSIX_USE_SPACE_GROUPS`| 1.0.0 |bool|`Use space groups to manage permissions on spaces.`|`"false"`|
|`STORAGE_USERS_POSIX_ENABLE_FS_REVISIONS`| 1.0.0 |bool|`Allow for generating revisions from changes done to the local storage. Note: This doubles the number of bytes stored on disk because a copy of the current revision is stored to be turned into a revision later.`|`"false"`|
|`STORAGE_USERS_POSIX_SCAN_FS`| 6.2.0 |bool|`Scan the filesystem at startup for changes and update the metadata accordingly.`|`"true"`|
Expand Down
2 changes: 1 addition & 1 deletion docs/_static/env-vars/web_configvars.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

2026-10-07-00-08-40
2026-10-10-00-08-08

## Deprecation Notice

Expand Down
Loading