diff --git a/README.md b/README.md index 9672b063..13a5374e 100644 --- a/README.md +++ b/README.md @@ -155,14 +155,14 @@ Four bits of bookkeeping remain: |---------|-------------------|-------| | main | — | ROOT landing component (versionless) | | server | 11.1, 11.0, 10.16 | 11.1 is `latest`, copied from 11.0 (never imported); 11.0 was imported from master | -| ocis | 8.3 (dev), 8.2, 8.1, 8.0, 7.3 | master→8.3 (prerelease); 8.2 branch is `latest` | +| ocis | 9.0 (dev), 8.2, 8.1, 8.0, 7.3 | master→9.0 (prerelease); 8.2 branch is `latest`; developer docs included from 9.0 onwards (previously at owncloud.dev) | | webui | — | single rolling component (versionless) | | desktop | 7.2 (dev), 7.1, 6.0, 5.3 | master→7.2 (prerelease); 7.1 branch is `latest` | | ios | 12.7, 12.6 | 12.7 branch is `latest` (released 2026-05-19) | | android | 4.8 (dev), 4.7 | 4.8 branch imported as prerelease; 4.7 branch is `latest` | > ⚠️ **Dev version numbers are provisional.** The in-development folders -> (`ocis/8.3`, `desktop/7.2`, `android/4.8`, …) are marked `prerelease: true` and +> (`ocis/9.0`, `desktop/7.2`, `android/4.8`, …) are marked `prerelease: true` and > carry a `(dev)` `display_version`. They were the upcoming numbers chosen at > import time — rename the folder + drop `prerelease` on actual release. > diff --git a/content/AGENTS.md b/content/AGENTS.md index 02288622..4ed194b9 100644 --- a/content/AGENTS.md +++ b/content/AGENTS.md @@ -28,6 +28,23 @@ Always write AsciiDoc tables with one cell per line and a blank line between eac - Span rows (e.g. `6+| _Section heading_`) are also followed by a blank line. - Empty cells are written as a bare `|` on its own line. +## Page-Internal Xref Fragment Format + +This repository sets `idprefix: ''` and `idseparator: '-'` in `global-attributes.yml`. Auto-generated section IDs therefore use **lowercase words joined by hyphens** — not the Asciidoctor default of a leading underscore with underscore separators. + +```asciidoc +// Section heading +=== Default and Demo Users + +// Correct page-internal xref (this repo) +xref:#default-and-demo-users[Default and Demo Users] + +// Wrong — Asciidoctor default format, not used here +xref:_default_and_demo_users[Default and Demo Users] +``` + +Rule: strip `idprefix` (empty), lowercase every word, replace spaces with `idseparator` (`-`). Special characters are dropped. When in doubt, build locally and inspect the rendered anchor in the page HTML. + ## Fixing Xrefs After Markdown Migration Content migrated from Markdown often carries broken cross-reference patterns. When you encounter them, apply the corrections below. diff --git a/content/main/modules/ROOT/pages/ocis_release_notes.adoc b/content/main/modules/ROOT/pages/ocis_release_notes.adoc index 1513435e..a858b2eb 100644 --- a/content/main/modules/ROOT/pages/ocis_release_notes.adoc +++ b/content/main/modules/ROOT/pages/ocis_release_notes.adoc @@ -8,6 +8,7 @@ :release-types-url: https://owncloud.dev/ocis/release_roadmap/#release-types :release-roadmap-url: https://owncloud.dev/ocis/release_roadmap/#dates :ocis-releases-url: https://github.com/owncloud/ocis/releases/tag +// do not remove the web-releases-url attribute until all references in this page are gone. :web-releases-url: https://github.com/owncloud/web/releases/tag {description} Also see our {release-roadmap-url}[release roadmap] for additional information. @@ -16,6 +17,224 @@ toc::[] +== Infinite Scale 9.0.0 (Production) - Frances + +Please find the most important changes described here or refer to the changelog for a complete list of changes: + +* Infinite Scale: {ocis-releases-url}/v9.0.0[Changes in 9.0.0, window=_blank] + +[discrete] +=== Summary of Notable Changes + +* Storage Driver Removals: +** The deprecated `posix` storage driver has been completely removed. The `storage-users` service no longer accepts `posix` as a driver value, and all related environment variables are removed. See the Breaking Changes section for details. +** The deprecated `owncloudsql` storage driver has been completely removed. The affected services no longer accept `owncloudsql` as a driver value, and all related environment variables are removed. See the Breaking Changes section for details. + +* Networking and Authentication: +** NATS JWT authentication is now supported for all NATS connections via `OCIS_NATS_CREDS_FILE` and `OCIS_NATS_CREDS`, enabling use of a shared NATS cluster with per-instance accounts. +** TLS support has been added for all NATS store, cache, and service registry connections. +** OIDC requests in the proxy and webfinger services now respect proxy environment variables (`HTTP_PROXY`, `HTTPS_PROXY`, `NO_PROXY`). + +* New and Changed Commands: +** A new `ocis storage-users spaces recalculate-treesize` command has been added to correct drifting quota usage by recalculating the treesize of every directory in a space from the actual data on disk. Infinite Scale must be shut down before running in write mode. +** The `ocis search index` command has been extended with a `--timeout` flag (default `10m`, `0` for no limit) to allow indexing of large spaces or spaces with slow content extractors that previously failed with a timeout error. +** The `ocis storage-users uploads sessions` command has been extended with an `--orphaned` flag to filter sessions whose node metadata is unreadable and that can never complete processing. +** For details see the xref:ocis:admin:migration/upgrading-ocis.adoc[Migration and Upgrade, window=_blank] section of the Infinite Scale admin documentation. + +* User Interface: +** Tags are now colour-coded by name, making it easier to distinguish a file's tags at a glance. +** Vault shares now default to a 30-day expiration. +** Multi-instance guest role mapping can now be derived from claims. + +* Search: +** Apache Tika 4.x is now supported for content extraction in the search service. + +* Spaces: +** A new `GRAPH_MAX_IMAGE_FILE_SIZE` environment variable (default: `50MB`) limits the size of images that can be set as a space image. The value must not exceed `THUMBNAILS_MAX_INPUT_IMAGE_FILE_SIZE` of the Thumbnails service, otherwise accepted images cannot be rendered. + +* Deployment Examples: +** The `ocis_full` and `ocis_ocm` deployment examples now ship a hardened Collabora configuration: Collabora is restricted to the hosts it needs, runs on its own internal network, and the admin console requires explicit credentials (`COLLABORA_ADMIN_USER` and `COLLABORA_ADMIN_PASSWORD` in `.env`). +** The Keycloak realm in `ocis_full` now points its SMTP configuration at the bundled Mailpit instance, so invitation emails (including guest invitations) are delivered correctly. + +* Security: +** Public link brute force protection has been hardened. +** Group member data is now restricted to authorised users only. +** Origin validation has been hardened for delegated authentication in embed mode. + +* Licensing: +** The End-User License Agreement (EULA) that was previously attached to production release assets has been removed. Infinite Scale is now distributed exclusively under the link:https://github.com/owncloud/ocis/blob/master/LICENSE[Apache 2.0] license. + +* Developer Documentation: +** The Infinite Scale developer documentation, previously maintained at `owncloud.dev`, has been migrated into this repository and is now published at https://doc.owncloud.com/ocis/9.0/developer/[doc.owncloud.com] alongside the admin documentation. + +[discrete] +=== Upgrading Infinite Scale + +See the xref:ocis:admin:migration/upgrading-ocis.adoc[Migration and Upgrade, window=_blank] section of the Infinite Scale admin documentation for more details. + +=== Known Issues + +This section will be updated if issues are discovered. + +//[discrete] +=== Deprecations + +* The `posix` and `owncloudsql` storage drivers, deprecated in 8.2.3, have been removed in this release. +* No new deprecations have been introduced in this release. + +//[discrete] +=== Migrations + +See the xref:ocis:admin:migration/upgrading-ocis.adoc[Migration and Upgrade, window=_blank] section of the Infinite Scale admin documentation for more details. + +=== Breaking Changes + +* The `posix` storage driver has been completely removed without replacement. If you are using the `posix` driver, you *must* migrate to `decomposedfs` before upgrading to 9.0. All `STORAGE_USERS_POSIX_*` environment variables are removed and will cause an error if set. See the xref:ocis:admin:migration/upgrading-ocis.adoc[Upgrading Infinite Scale, window=_blank] guide for details. +* The `owncloudsql` storage driver has been completely removed. All related environment variables across the `auth-basic`, `users`, `groups`, `sharing`, and `storage-users` services are removed. + +== Infinite Scale 8.2.3 (Production) + +Please find the most important changes described here or refer to the changelog for a complete list of changes see: {ocis-releases-url}/v8.2.3[Changes in 8.2.3, window=_blank] + +[discrete] +=== Issues Fixed + +This release has security and bugfixes, as well as deprecation notices. + +* Bugfix: Fix a data race in the `web` service on concurrent `GET /themes/*` requests that could corrupt the rendered theme or crash the service: https://github.com/owncloud/ocis/pull/13251[#13251] + +* Deprecation of environment variables +** Change: All environment variables of the `owncloudsql` driver (`OWNCLOUDSQL` name part) are deprecated in `storage-users`, `auth-basic`, `users`, `groups`, and `sharing`. They will be removed together with the driver in oCIS 9.0: https://github.com/owncloud/ocis/pull/13193[#13193] +** Change: All environment variables of the `posixfs` driver (`POSIX` name part) are deprecated in `storage-users`. They will be removed together with the driver in oCIS 9.0: https://github.com/owncloud/ocis/pull/13302[#13302] + +* Security: +** Dependency updates + +== Infinite Scale 8.2.2 (Production) + +Please find the most important changes described here or refer to the changelog for a complete list of changes see: {ocis-releases-url}/v8.2.2[Changes in 8.2.2, window=_blank] + +[discrete] +=== Issues Fixed + +This release has security and bugfixes. + +* Bugfix: Fix AuthApp (app password) and HTTP basic auth requests returning an internal server error when `PROXY_USER_OIDC_CLAIM` was set to a non-default value: https://github.com/owncloud/ocis/pull/13078[#13078] +* Bugfix: Fix `GET /graph/v1.0/me` returning HTTP 500 when the preferred-language settings lookup fails; the Web UI uses this endpoint on every login, so affected users were locked out of oCIS entirely: https://github.com/owncloud/ocis/pull/13188[#13188] +* Bugfix: Fix the LDAP master-ID filter to leave an empty base filter unchanged; previously it was restricted to master-ID users only, breaking cross-instance user search in multi-instance deployments: https://github.com/owncloud/ocis/pull/13096[#13096] + +* Deployment example (ocis_multi only): +** Enhancement: Allow connections to the ownCloud Marketplace domain in the `ocis_multi` deployment example CSP: https://github.com/owncloud/ocis/pull/13090[#13090] + +* Security: +** Dependency updates + +== Infinite Scale 8.2.1 (Production) + +Please find the most important changes described here or refer to the changelog for a complete list of changes see: {ocis-releases-url}/v8.2.1[Changes in 8.2.1, window=_blank] + +[discrete] +=== Issues Fixed + +This release has security and bugfixes, as well as enhancements. + +* Bugfix: Fix share metadata corruption when multiple sharing service replicas processed share operations concurrently for the same user, making all shares inaccessible; the received share cache now uses compare-and-swap (etag) validation to prevent corruption: https://github.com/owncloud/ocis/pull/12621[#12621] +* Bugfix: Fix permanent space delete being silently treated as a disable when using axios >=1.20.0, which strips a header literally named `Purge`; the graph service now also accepts `X-Purge`: https://github.com/owncloud/ocis/pull/13049[#13049] +* Bugfix: Fix transient OIDC userinfo failures (timeouts, network errors, 5xx/429 from IdP) returning HTTP 401 and logging users out; the proxy now returns a retryable 503 with `Retry-After` for transient failures: https://github.com/owncloud/ocis/pull/12999[#12999] +* Bugfix: Cache LDAP instance mapper lookups to eliminate redundant LDAP round-trips per request in multi-instance deployments; configurable via `OCIS_LDAP_INSTANCE_MAPPER_CACHE_TTL` (default 60s): https://github.com/owncloud/ocis/pull/12898[#12898] + +* Security: +** Harden brute force protection for password-protected public links so failed attempts are reliably counted and rate limits consistently enforced: https://github.com/owncloud/ocis/pull/12945[#12945] +** Dependency updates + +== Infinite Scale 8.2.0 (Production) - Ebadi + +Please find the most important changes described here or refer to the changelog for a complete list of changes: + +* Infinite Scale: {ocis-releases-url}/v8.2.0[Changes in 8.2.0, window=_blank] +* Web: Please note, that from this Infinite Scale release onwards, the WebUI is integrated into the ocis repository. This means that there will only be one combined changelog, and the WebUI version shown will most likely be removed in a subsequent release. + +[discrete] +=== Summary of Notable Changes + +* User Interface Changes: +** The icon displayed next to group entries in the 'Share Collaborator' autocomplete list was invisible due to an incorrect text colour. It now uses the correct default text colour, so renders properly again. +** When using the internal IDP, the login, consent, and account chooser pages did not announce error messages when they appeared, and invalid username/password fields gave no indication of their error state. This has been fixed now. +** The optical representation of low-contrast form controls in dark and vault themes has been greatly improved. +** The keyboard navigation in "New" and "Upload" dropdown menus has been fixed. +** The keyboard focus has been removed from purely informational file names in the top bar. These are no longer part of the tab order or interactive elements. +** Even though they don't trigger any action, some icons and date columns in tables (such as the Spaces list and file list) can no longer receive keyboard focus unexpectedly. +** Hover feedback has been restored in high-contrast and dark themes. +** The accessibility focus in the 'File Versions' sidebar is now preserved. +** The Vault navigation labels are now updated when you switch into or out of the Vault. +** A 'select all' checkbox has been added to the 'Tile view' option. + +* User and File Management: +** For administrators, the 'Delete user' action now excludes the current user from the request. This means that all the other selected users will be deleted, but the current user's account will remain untouched. If the admins own account is part of the selection, a message will appear in the deletion confirmation dialogue box to indicate that it will not be deleted. +** The ability to disable public link sharing has been added. +** The ability to disable direct sharing (user/group) has been added. +** It is now allowed to rename, move and edit files with the 'Editor Lite' role. + +* LDAP Configuration: +** It is now possible to disable the last sign-in timestamp update using the environment variables `OCIS_LDAP_UPDATE_LAST_SIGNIN_DATE` or `GRAPH_LDAP_UPDATE_LAST_SIGNIN_DATE`, without disabling all LDAP writes via the environment variable `OCIS_LDAP_SERVER_WRITE_ENABLED`. +** A bounded LDAP connection pool that requires opt-in has been added. This can be configured using environment variables beginning with `OCIS_LDAP_POOL_`. +** There are now options that can be configured using environment variables beginning with `GRAPH_LDAP_RETRY_xxx` for LDAP retry operations against a lagging replica. +** To improve stability, the redundant LDAP read-after-write process has been eliminated for create and update. + +* Authentication and Token Handling: +** Access tokens with expired user info cache entries are now re-verified. +** A new proxy configuration option, `PROXY_OIDC_ACCESS_TOKEN_VERIFY_AUD`, has been added. This allows operators to restrict the JWT access tokens accepted to a list of permitted audiences. + +* The double HTML escaping of notification emails for multiple recipients has been removed. + +* The proxy `/readyz` endpoint now correctly reports NATS reachability instead of always failing due to passing the cluster ID instead of the connection endpoint. + +* Translations have been fixed/updated. + +* New environment variables have been added. See the xref:ocis:admin:migration/upgrading-ocis.adoc[Migration and Upgrade, window=_blank] section of the Infinite Scale admin documentation for more details. + +* CLI Commands: +** New CLI commands have been added or extended, in particular the `Clean Corrupt Public Shares`, the `Compact the Search Index`, the `Reset Password for IDM Users` and `Verify and Inspect a Configured Blobstore` command. For details see the xref:ocis:admin:migration/upgrading-ocis.adoc[Migration and Upgrade, window=_blank] section of the Infinite Scale admin documentation. + +* Several updates were made to the deployment examples: +** Examples of legacy deployment, such as the `oc10_ocis_parallel`, and references to their documentation have been removed. +** Collabora hardening. +** Volume path corrected for Keycloak. + +* Security: +** A rate-limit to export personal GDPR data per user has been added to mitigate DoS attacks and set to 5 requests per user and minute. +** The underlaying Alpine image used for Infinite Scale has been updated to version 3.24.1 +** `go` has been updated to version 1.26.10 +** Password/account changes via PATCH `/graph/v1.0/me` are now blocked. +** Internal error details in WebDAV responses are no longer published. + +[discrete] +=== Upgrading Infinite Scale + +See the xref:ocis:admin:migration/upgrading-ocis.adoc[Migration and Upgrade, window=_blank] section of the Infinite Scale admin documentation for more details. + +* Since the deployment examples have been updated, you *must* update the configuration files, reconfigure them and pull new image versions. No data migration is necessary. + +=== Known Issues + +This section will be updated if issues are discovered. + +//[discrete] +=== Deprecations + +See the xref:ocis:admin:migration/upgrading-ocis.adoc[Migration and Upgrade, window=_blank] section of the Infinite Scale admin documentation for more details. + +* Some features that were deprecated in previous releases have not yet been removed. No new deprecations have been added. + +//[discrete] +=== Migrations + +See the xref:ocis:admin:migration/upgrading-ocis.adoc[Migration and Upgrade, window=_blank] section of the Infinite Scale admin documentation for more details. + +=== Breaking Changes + +There are no breaking changes in Infinite Scale 8.2 + == Infinite Scale 8.1.0 (Production) - Daledda Please find the most important changes described here or refer to the changelog for a complete list of changes: @@ -34,7 +253,7 @@ Please find the most important changes described here or refer to the changelog * Added a new space membership role: `Can edit`. -* The new environment variables have been added. For details see the ... +* New environment variables have been added .See the xref:ocis:admin:migration/upgrading-ocis.adoc[Migration and Upgrade, window=_blank] section of the Infinite Scale admin documentation for more details. * CLI Commands ** New CLI commands have been added, in particular the `Verify and Inspect the Blobstore`, the `Search Index Optimize` and the `Reset Password for System Users` command. For details see the xref:ocis:admin:migration/upgrading-ocis.adoc[Migration and Upgrade, window=_blank] section of the Infinite Scale admin documentation. @@ -98,6 +317,42 @@ See the xref:ocis:admin:migration/upgrading-ocis.adoc[Migration and Upgrade, win There are no breaking changes in Infinite Scale 8.1 +== Infinite Scale 8.0.10 (Production) + +Please find the most important changes described here or refer to the changelog for a complete list of changes see: {ocis-releases-url}/v8.0.10[Changes in 8.0.10, window=_blank] + +[discrete] +=== Issues Fixed + +This release has security, bugfixes and enhancements. + +* Bugfix: Fix gateway provider cache always using persistence due to a wrong config key sent to reva: https://github.com/owncloud/ocis/pull/13220[#13220] +* Bugfix: Skip not-ready gRPC nodes before reusing cached clients to prevent long stalls on dead nodes: https://github.com/owncloud/ocis/pull/13147[#13147] +* Enhancement: Add NATS JWT authentication support via `OCIS_NATS_CREDS_FILE` and `OCIS_NATS_CREDS` for all NATS connections: https://github.com/owncloud/ocis/pull/13220[#13220] +* Security: +** Mask secret values in the proxy debug configuration output: https://github.com/owncloud/ocis/pull/13220[#13220] +** Dependency updates + +== Infinite Scale 8.0.9 (Production) + +Please find the most important changes described here or refer to the changelog for a complete list of changes see: {ocis-releases-url}/v8.0.9[Changes in 8.0.9, window=_blank] + +[discrete] +=== Issues Fixed + +This release has security, bugfixes and enhancements. + +* Bugfix: Drop unmarshalable body field from graph service log messages: https://github.com/owncloud/ocis/pull/12918[#12918] +* Bugfix: Release quota of upload sessions with unreadable node metadata; adds `--orphaned` filter to `storage-users uploads sessions`: https://github.com/owncloud/ocis/pull/12739[#12739] +* Bugfix: Return degraded drive items for shares in `sharedWithMe` instead of silently dropping them on transient stat failures: https://github.com/owncloud/ocis/pull/12430[#12430] +* Bugfix: Return a retryable 503 instead of 401 when the OIDC userinfo call fails transiently: https://github.com/owncloud/ocis/pull/13047[#13047] +* Change: Replace `GRPC_MAX_CONNECTION_AGE` with gRPC client keepalive via `GRPC_CLIENT_KEEPALIVE_TIME` and `GRPC_CLIENT_KEEPALIVE_TIMEOUT`; `GRPC_MAX_CONNECTION_AGE` is removed: https://github.com/owncloud/ocis/pull/13020[#13020] +* Enhancement: Add `OCDAV_DISABLE_PROPFIND_PUBLIC_LINK_RESOLUTION` toggle to skip public link resolution in PROPFIND requests: https://github.com/owncloud/ocis/pull/13020[#13020] +* Enhancement: Make the public share expiry janitor configurable via `OCIS_SHARING_ENABLE_EXPIRED_SHARES_CLEANUP` and `OCIS_SHARING_JANITOR_RUN_INTERVAL`: https://github.com/owncloud/ocis/pull/13020[#13020] +* Enhancement: Add TLS support for the frontend stat cache NATS store connection: https://github.com/owncloud/ocis/pull/12777[#12777] +* Security: +** Dependency updates + == Infinite Scale 8.0.8 (Production) Please find the most important changes described here or refer to the changelog for a complete list of changes: diff --git a/content/ocis/8.1/modules/admin/pages/deployment/services/s-list/search.adoc b/content/ocis/8.1/modules/admin/pages/deployment/services/s-list/search.adoc index ff21bd35..bd8047cd 100644 --- a/content/ocis/8.1/modules/admin/pages/deployment/services/s-list/search.adoc +++ b/content/ocis/8.1/modules/admin/pages/deployment/services/s-list/search.adoc @@ -191,6 +191,17 @@ ocis search index --space $SPACE_ID || --all-spaces ** See the xref:maintenance/space-ids/space-ids.adoc[Listing Space IDs] for how to retrieve a space ID. * The arguments `-space` and `--all-spaces` are mutual exclusive , but one must be provided. +==== Compact the Search Index + +The search performance can degrade over time after bulk reindexing operations that create many small index segments. Use this command to compact the search index by merging Bleve segments without reindexing the content. + +[source,bash] +---- +ocis search optimize +---- + +NOTE: Although this command accesses the search index directly and does not block search queries, it is still recommended that it is issued during a maintenance window. + == Notes The indexing process tries to be self-healing in some situations. diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/activitylog_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/activitylog_configvars.adoc index 3e2e10e0..a7b72c36 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/activitylog_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/activitylog_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the activitylog service [width="100%",cols="~,~,~,~",options="header"] @@ -334,7 +334,7 @@ a|`OCIS_PERSISTENT_STORE_ENABLE_TLS` + `ACTIVITYLOG_STORE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -346,7 +346,7 @@ a|`OCIS_PERSISTENT_STORE_TLS_INSECURE` + `ACTIVITYLOG_STORE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -358,7 +358,7 @@ a|`OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE` + `ACTIVITYLOG_STORE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/antivirus_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/antivirus_configvars.adoc index a4d42116..19689e05 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/antivirus_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/antivirus_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the antivirus service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/app-provider_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/app-provider_configvars.adoc index d7f8991d..f663ce6a 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/app-provider_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/app-provider_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the app-provider service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/app-registry_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/app-registry_configvars.adoc index 35e12047..3b2f30e9 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/app-registry_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/app-registry_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the app-registry service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/audit_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/audit_configvars.adoc index 7cef3cbf..72ddebde 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/audit_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/audit_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the audit service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-app_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-app_configvars.adoc index 3785b522..dc1f16d5 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-app_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-app_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the auth-app service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-basic_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-basic_configvars.adoc index cbe5e6a9..f23ef7f4 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-basic_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-basic_configvars.adoc @@ -2,11 +2,11 @@ // if the generated adoc file is used outside tabs, it renders correctly depending on the attribute set. // if inside, you need to also use the xxx_deprecation.adoc file. attributes can't be defined inside tabs. -:show-deprecation: false +:show-deprecation: true ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the auth-basic service [width="100%",cols="~,~,~,~",options="header"] @@ -15,6 +15,51 @@ ifeval::[{show-deprecation} == true] | Deprecation Version | Removal Version | Deprecation Replacement + +| AUTH_BASIC_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| AUTH_BASIC_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| AUTH_BASIC_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| AUTH_BASIC_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| AUTH_BASIC_OWNCLOUDSQL_IDP is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| AUTH_BASIC_OWNCLOUDSQL_NOBODY is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| AUTH_BASIC_OWNCLOUDSQL_JOIN_USERNAME is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| AUTH_BASIC_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| |=== {empty} + @@ -511,7 +556,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The master instance ID for multi-instance setups. When set, LDAP user filters are enhanced to also match users belonging to the master instance. +The master instance ID for multi-instance setups. When set, LDAP user filters are enhanced to also match users belonging to the master instance. Also set 'user_filter'. Without an explicit 'user_filter', this instance allows login for every user in the shared LDAP directory. a|`OCIS_LDAP_USER_MEMBER_ATTRIBUTE` + @@ -716,7 +761,7 @@ a| [subs=-attributes] Maximum time to wait for a pooled LDAP connection to become available once the pool is exhausted. Defaults to 30s when unset or <= 0. See the Environment Variable Types description for more details. a|`AUTH_BASIC_OWNCLOUDSQL_DB_USERNAME` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -727,7 +772,7 @@ a| [subs=-attributes] Database user to use for authenticating with the owncloud database. a|`AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -738,7 +783,7 @@ a| [subs=-attributes] Password for the database user. a|`AUTH_BASIC_OWNCLOUDSQL_DB_HOST` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -749,7 +794,7 @@ a| [subs=-attributes] Hostname of the database server. a|`AUTH_BASIC_OWNCLOUDSQL_DB_PORT` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -760,7 +805,7 @@ a| [subs=-attributes] Network port to use for the database connection. a|`AUTH_BASIC_OWNCLOUDSQL_DB_NAME` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -771,7 +816,7 @@ a| [subs=-attributes] Name of the owncloud database. a|`AUTH_BASIC_OWNCLOUDSQL_IDP` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -782,7 +827,7 @@ a| [subs=-attributes] The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. a|`AUTH_BASIC_OWNCLOUDSQL_NOBODY` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -793,7 +838,7 @@ a| [subs=-attributes] Fallback number if no numeric UID and GID properties are provided. a|`AUTH_BASIC_OWNCLOUDSQL_JOIN_USERNAME` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -804,7 +849,7 @@ a| [subs=-attributes] Join the user properties table to read usernames a|`AUTH_BASIC_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-basic_deprecation.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-basic_deprecation.adoc index 4b3cef68..e452d9c3 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-basic_deprecation.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-basic_deprecation.adoc @@ -1,2 +1,2 @@ -:show-deprecation: false +:show-deprecation: true diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-bearer_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-bearer_configvars.adoc index e852973a..570b1ee1 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-bearer_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-bearer_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the auth-bearer service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-machine_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-machine_configvars.adoc index 186f0db6..fde82a48 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-machine_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-machine_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the auth-machine service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-service_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-service_configvars.adoc index 7f1bbdc6..6a2fb273 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-service_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/auth-service_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the auth-service service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/clientlog_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/clientlog_configvars.adoc index 20db0dec..fa5adfd3 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/clientlog_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/clientlog_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the clientlog service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/collaboration_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/collaboration_configvars.adoc index 05cc7d8e..3b180513 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/collaboration_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/collaboration_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the collaboration service [width="100%",cols="~,~,~,~",options="header"] @@ -227,7 +227,7 @@ a|`OCIS_PERSISTENT_STORE_ENABLE_TLS` + `COLLABORATION_STORE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -239,7 +239,7 @@ a|`OCIS_PERSISTENT_STORE_TLS_INSECURE` + `COLLABORATION_STORE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -251,7 +251,7 @@ a|`OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE` + `COLLABORATION_STORE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/eventhistory_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/eventhistory_configvars.adoc index 603a1b1c..7149658f 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/eventhistory_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/eventhistory_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the eventhistory service [width="100%",cols="~,~,~,~",options="header"] @@ -352,7 +352,7 @@ a|`OCIS_PERSISTENT_STORE_ENABLE_TLS` + `EVENTHISTORY_STORE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -364,7 +364,7 @@ a|`OCIS_PERSISTENT_STORE_TLS_INSECURE` + `EVENTHISTORY_STORE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -376,7 +376,7 @@ a|`OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE` + `EVENTHISTORY_STORE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/frontend_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/frontend_configvars.adoc index ed7fbb28..a5bbbc29 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/frontend_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/frontend_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the frontend service [width="100%",cols="~,~,~,~",options="header"] @@ -639,7 +639,7 @@ a| [subs=-attributes] Path prefix for the data gateway. a|`OCIS_CACHE_STORE` + -xref:deprecation-note-2026-09-09-11-30-54[Deprecation Note] +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -650,7 +650,7 @@ a| [subs=-attributes] The type of the cache store. Supported values are: 'memory', 'redis-sentinel', 'nats-js-kv', 'noop'. See the text description for details. a|`OCIS_CACHE_STORE_NODES` + -xref:deprecation-note-2026-09-09-11-30-54[Deprecation Note] +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -661,7 +661,7 @@ a| [subs=-attributes] 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. a|`OCIS_CACHE_DATABASE` + -xref:deprecation-note-2026-09-09-11-30-54[Deprecation Note] +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -672,7 +672,7 @@ a| [subs=-attributes] The database name the configured store should use. a|`OCIS_CACHE_TTL` + -xref:deprecation-note-2026-09-09-11-30-54[Deprecation Note] +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -683,7 +683,7 @@ a| [subs=-attributes] 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. a|`OCIS_CACHE_DISABLE_PERSISTENCE` + -xref:deprecation-note-2026-09-09-11-30-54[Deprecation Note] +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++5.0 ++ a| [subs=-attributes] @@ -694,7 +694,7 @@ a| [subs=-attributes] Disable persistence of the cache. Only applies when using the 'nats-js-kv' store type. Defaults to false. a|`OCIS_CACHE_AUTH_USERNAME` + -xref:deprecation-note-2026-09-09-11-30-54[Deprecation Note] +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++5.0 ++ a| [subs=-attributes] @@ -705,7 +705,7 @@ a| [subs=-attributes] The username to use for authentication. Only applies when using the 'nats-js-kv' store type. a|`OCIS_CACHE_AUTH_PASSWORD` + -xref:deprecation-note-2026-09-09-11-30-54[Deprecation Note] +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++5.0 ++ a| [subs=-attributes] @@ -715,8 +715,41 @@ a| [subs=-attributes] a| [subs=-attributes] The password to use for authentication. Only applies when using the 'nats-js-kv' store type. +a|`OCIS_CACHE_ENABLE_TLS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++bool ++ +a| [subs=-attributes] +++false ++ +a| [subs=-attributes] +Activate TLS for the connection to the stat cache store. Only applies when using the 'nats-js-kv' store type. + +a|`OCIS_CACHE_TLS_INSECURE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++bool ++ +a| [subs=-attributes] +++false ++ +a| [subs=-attributes] +Disable TLS certificate verification for the stat cache store connection. Only applies when using the 'nats-js-kv' store type. + +a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to the PEM-encoded root CA certificate for the stat cache store TLS connection. Only applies when using the 'nats-js-kv' store type. + a|`OCIS_ENABLE_OCM` + -xref:deprecation-note-2026-09-09-11-30-54[Deprecation Note] +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++5.0 ++ a| [subs=-attributes] @@ -727,7 +760,7 @@ a| [subs=-attributes] Include OCM shares when listing shares. See the OCM service documentation for more details. a|`OCIS_ENABLE_OCM` + -xref:deprecation-note-2026-09-09-11-30-54[Deprecation Note] +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++5.0 ++ a| [subs=-attributes] @@ -738,7 +771,7 @@ a| [subs=-attributes] Include OCM sharees when listing sharees. a|`OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD` + -xref:deprecation-note-2026-09-09-11-30-54[Deprecation Note] +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++5.0 ++ a| [subs=-attributes] @@ -749,7 +782,7 @@ a| [subs=-attributes] Set this to true if you want to enforce passwords on all public shares. a|`OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD` + -xref:deprecation-note-2026-09-09-11-30-54[Deprecation Note] +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++5.0 ++ a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/gateway_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/gateway_configvars.adoc index ac2ff472..1cd3456b 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/gateway_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/gateway_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the gateway service [width="100%",cols="~,~,~,~",options="header"] @@ -393,7 +393,7 @@ a|`OCIS_CACHE_ENABLE_TLS` + `GATEWAY_PROVIDER_CACHE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -405,7 +405,7 @@ a|`OCIS_CACHE_TLS_INSECURE` + `GATEWAY_PROVIDER_CACHE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -417,7 +417,7 @@ a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + `GATEWAY_PROVIDER_CACHE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/global_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/global_configvars.adoc index 0d5e40ed..826dcfa1 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/global_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/global_configvars.adoc @@ -28,7 +28,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -The default role assignments the demo users should be setup. +Flag to enable or disable the creation of the demo users. a| `OCIS_ADMIN_USER_ID` a| [subs=-attributes] @@ -89,7 +89,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The password to use for authentication. Only applies when store type 'nats-js-kv' is configured. +The password to authenticate with the cache. Only applies when store type 'nats-js-kv' is configured. a| `OCIS_CACHE_AUTH_USERNAME` a| [subs=-attributes] @@ -114,7 +114,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The username to use for authentication. Only applies when store type 'nats-js-kv' is configured. +The username to authenticate with the cache. Only applies when store type 'nats-js-kv' is configured. a| `OCIS_CACHE_DATABASE` a| [subs=-attributes] @@ -133,14 +133,14 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++cache-providers ++ +++storage-system ++ a| [subs=-attributes] The database name the configured store should use. a| `OCIS_CACHE_DISABLE_PERSISTENCE` a| [subs=-attributes] -++5.0 ++ +++pre5.0 ++ a| [subs=attributes+] * xref:{s-path}/frontend.adoc[frontend] + @@ -160,13 +160,14 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Disables persistence of the provider cache. Only applies when store type 'nats-js-kv' is configured. Defaults to false. +Disables persistence of the cache. Only applies when store type 'nats-js-kv' is configured. Defaults to false. a| `OCIS_CACHE_ENABLE_TLS` a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=attributes+] +* xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/gateway.adoc[gateway] + * xref:{s-path}/graph.adoc[graph] + * xref:{s-path}/ocs.adoc[ocs] + @@ -206,7 +207,7 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++noop ++ +++memory ++ a| [subs=-attributes] The type of the cache store. Supported values are: 'memory', 'redis-sentinel', 'nats-js-kv', 'noop'. See the text description for details. @@ -234,13 +235,14 @@ a| [subs=-attributes] ++[127.0.0.1:9233] ++ a| [subs=-attributes] -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. +A list of nodes to access the configured store. This has no effect when 'memory' store are 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. a| `OCIS_CACHE_TLS_INSECURE` a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=attributes+] +* xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/gateway.adoc[gateway] + * xref:{s-path}/graph.adoc[graph] + * xref:{s-path}/ocs.adoc[ocs] + @@ -262,9 +264,10 @@ Disable TLS certificate verification for the cache store connection. Only applie a| `OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=attributes+] +* xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/gateway.adoc[gateway] + * xref:{s-path}/graph.adoc[graph] + * xref:{s-path}/ocs.adoc[ocs] + @@ -304,10 +307,10 @@ a| [subs=-attributes] ++Duration ++ a| [subs=-attributes] -++5m0s ++ +++336h0m0s ++ a| [subs=-attributes] -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. +Time to live for cache records in the graph. Defaults to '336h' (2 weeks). See the Environment Variable Types description for more details. a| `OCIS_CLAIM_MANAGED_SPACES_ENABLED` a| [subs=-attributes] @@ -352,10 +355,10 @@ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] -++false ++ +++true ++ a| [subs=-attributes] -Allow credentials for CORS. See following chapter for more details: *Access-Control-Allow-Credentials* at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials. +Allow credentials for CORS.See following chapter for more details: *Access-Control-Allow-Credentials* at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials. a| `OCIS_CORS_ALLOW_HEADERS` a| [subs=-attributes] @@ -383,7 +386,7 @@ a| [subs=-attributes] ++[]string ++ a| [subs=-attributes] -++[Origin Accept Content-Type Depth Authorization Ocs-Apirequest If-None-Match If-Match Destination Overwrite X-Request-Id X-Requested-With Tus-Resumable Tus-Checksum-Algorithm Upload-Concat Upload-Length Upload-Metadata Upload-Defer-Length Upload-Expires Upload-Checksum Upload-Offset X-HTTP-Method-Override] ++ +++[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id Ocs-Apirequest] ++ a| [subs=-attributes] A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details. @@ -414,7 +417,7 @@ a| [subs=-attributes] ++[]string ++ a| [subs=-attributes] -++[OPTIONS HEAD GET PUT PATCH POST DELETE MKCOL PROPFIND PROPPATCH MOVE COPY REPORT SEARCH] ++ +++[GET] ++ a| [subs=-attributes] A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. See the Environment Variable Types description for more details. @@ -445,7 +448,7 @@ a| [subs=-attributes] ++[]string ++ a| [subs=-attributes] -++[https://localhost:9200] ++ +++[*] ++ a| [subs=-attributes] 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. @@ -482,7 +485,7 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ ++ +++en ++ a| [subs=-attributes] The default language used by services and the WebUI. If not defined, English will be used as default. See the documentation for more details. @@ -539,7 +542,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Changing this value is NOT supported. Enables support for incoming federated sharing for clients. The backend behaviour is not changed. +Include OCM sharees when listing users. a| `OCIS_ENABLE_PUBLIC_SHARING` a| [subs=-attributes] @@ -575,7 +578,7 @@ a| [subs=-attributes] ++true ++ a| [subs=-attributes] -Enables direct sharing with users and groups. When disabled, creating new user or group shares is rejected. Public link sharing is not affected. +Enables direct sharing with users and groups. When disabled, creating new user, group or federated shares via the drive item invite endpoints is rejected. Public link sharing and space membership are not affected. a| `OCIS_ENABLE_VAULT_MODE` a| [subs=-attributes] @@ -594,7 +597,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Set this to true to enable the default rule for vault storage provider configuration. Only applicable if the storage-users-vault service, a specially configured storage-users service, is configured. +Enable vault mode in addition to the regular graph service. This only applies when the additional storage-users-vault service is running, which is a special configured storage-users service. a| `OCIS_EVENTS_AUTH_PASSWORD` a| [subs=-attributes] @@ -1115,7 +1118,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The client ID to authenticate with keycloak. +The client id to authenticate with keycloak. a| `OCIS_KEYCLOAK_CLIENT_REALM` a| [subs=-attributes] @@ -1200,7 +1203,7 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++uid=idp,ou=sysusers,o=libregraph-idm ++ +++uid=libregraph,ou=sysusers,o=libregraph-idm ++ a| [subs=-attributes] LDAP DN to use for simple bind authentication with the target LDAP server. @@ -1243,7 +1246,7 @@ a| [subs=-attributes] ++/var/lib/ocis/idm/ldap.crt ++ a| [subs=-attributes] -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 $OCIS_BASE_DATA_PATH/idp. +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 $OCIS_BASE_DATA_PATH/idm. a| `OCIS_LDAP_DISABLED_USERS_GROUP_DN` a| [subs=-attributes] @@ -1279,7 +1282,7 @@ a| [subs=-attributes] ++attribute ++ a| [subs=-attributes] -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. +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'. a| `OCIS_LDAP_GROUP_BASE_DN` a| [subs=-attributes] @@ -1336,7 +1339,7 @@ a| [subs=-attributes] ++groupOfNames ++ a| [subs=-attributes] -The object class to use for groups in the default group search filter like 'groupOfNames'. +The object class to use for groups in the default group search filter ('groupOfNames'). a| `OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME` a| [subs=-attributes] @@ -1389,10 +1392,10 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ownclouduuid ++ +++owncloudUUID ++ a| [subs=-attributes] -LDAP Attribute to use as the unique ID for groups. This should be a stable globally unique ID like a UUID. +LDAP Attribute to use as the unique id for groups. This should be a stable globally unique ID like a UUID. a| `OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING` a| [subs=-attributes] @@ -1411,7 +1414,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -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 ID's. +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. a| `OCIS_LDAP_GROUP_SCHEMA_MAIL` a| [subs=-attributes] @@ -1467,7 +1470,7 @@ a| [subs=-attributes] ++sub ++ a| [subs=-attributes] -LDAP search scope to use when looking up groups. Supported values are 'base', 'one' and 'sub'. +LDAP search scope to use when looking up groups. Supported scopes are 'base', 'one' and 'sub'. a| `OCIS_LDAP_INSECURE` a| [subs=-attributes] @@ -1582,7 +1585,7 @@ a| [subs=-attributes] ++1 ++ a| [subs=-attributes] -Maximum number of retries for failed LDAP operations. Applies to both read and write operations (with different retryable error sets). Default 1. +Maximum number of retries for failed LDAP operations. Reads retry on transient and network errors; writes retry only when the connection failed before the request was sent (e.g. a reused idle connection found closed), so the request provably never reached the server and cannot be double-applied. Default 1. a| `OCIS_LDAP_RETRY_MAX_DELAY` a| [subs=-attributes] @@ -1638,7 +1641,7 @@ a| [subs=-attributes] ++ldaps://localhost:9235 ++ a| [subs=-attributes] -Url of the LDAP service to use as IDP. +URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://' a| `OCIS_LDAP_USER_BASE_DN` a| [subs=-attributes] @@ -1716,7 +1719,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -LDAP attribute that marks a user as a guest of an instance. +LDAP Attribute to signal the user is guest of an instance. Requires OCIS_MULTI_INSTANCE_ENABLED. a| `OCIS_LDAP_USER_MEMBER_ATTRIBUTE` a| [subs=-attributes] @@ -1735,7 +1738,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -LDAP attribute that marks a user as a member of an instance. +LDAP Attribute to signal the user is member of an instance. Requires OCIS_MULTI_INSTANCE_ENABLED. a| `OCIS_LDAP_USER_OBJECTCLASS` a| [subs=-attributes] @@ -1755,7 +1758,7 @@ a| [subs=-attributes] ++inetOrgPerson ++ a| [subs=-attributes] -LDAP User ObjectClass like 'inetOrgPerson'. +The object class to use for users in the default user search filter ('inetOrgPerson'). a| `OCIS_LDAP_USER_SCHEMA_DISPLAYNAME` a| [subs=-attributes] @@ -1771,10 +1774,10 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++displayname ++ +++displayName ++ a| [subs=-attributes] -LDAP Attribute to use for the displayname of users. +LDAP Attribute to use for the display name of users. a| `OCIS_LDAP_USER_SCHEMA_ID` a| [subs=-attributes] @@ -1791,10 +1794,10 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ownCloudUUID ++ +++owncloudUUID ++ a| [subs=-attributes] -LDAP User UUID attribute like 'uid'. +LDAP Attribute to use as the unique ID for users. This should be a stable globally unique ID like a UUID. a| `OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING` a| [subs=-attributes] @@ -1813,7 +1816,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -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 ID's. +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. a| `OCIS_LDAP_USER_SCHEMA_MAIL` a| [subs=-attributes] @@ -1833,7 +1836,7 @@ a| [subs=-attributes] ++mail ++ a| [subs=-attributes] -LDAP User email attribute like 'mail'. +LDAP Attribute to use for the email address of users. a| `OCIS_LDAP_USER_SCHEMA_USERNAME` a| [subs=-attributes] @@ -1850,10 +1853,10 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++displayName ++ +++uid ++ a| [subs=-attributes] -LDAP User name attribute like 'displayName'. +LDAP Attribute to use for username of users. a| `OCIS_LDAP_USER_SCHEMA_USER_TYPE` a| [subs=-attributes] @@ -2144,7 +2147,7 @@ Machine auth API key used to validate internal requests necessary for the access a| `OCIS_MAX_CONCURRENCY` a| [subs=-attributes] -++7.0.0 ++ +++pre5.0 ++ a| [subs=attributes+] * xref:{s-path}/frontend.adoc[frontend] + @@ -2263,11 +2266,11 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The unique id of this instance +The unique ID of this instance. a| `OCIS_MULTI_INSTANCE_MASTER_ID` a| [subs=-attributes] -++8.1.0 ++ +++7.0 ++ a| [subs=attributes+] * xref:{s-path}/auth-basic.adoc[auth-basic] + @@ -2283,7 +2286,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The master ID that grants access to all instances. Users with this ID in their memberOf or guestOf claims can access any instance. Leave empty to disable. +The master ID that grants access to all instances. Users with this ID in their memberOf or guestOf claims can access any instance. Leave empty to disable. Also set 'OCIS_LDAP_USER_FILTER'. Without an explicit user filter, this instance resolves every user in the shared LDAP directory. a| `OCIS_OIDC_ISSUER` a| [subs=-attributes] @@ -2307,7 +2310,7 @@ a| [subs=-attributes] ++https://localhost:9200 ++ a| [subs=-attributes] -URL of the OIDC issuer. It defaults to URL of the builtin IDP. +The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. a| `OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST` a| [subs=-attributes] @@ -2430,7 +2433,7 @@ Define the minimum number of lowercase letters. Defaults to 1 if not set. a| `OCIS_PERSISTENT_STORE` a| [subs=-attributes] -++7.1.0 ++ +++pre5.0 ++ a| [subs=attributes+] * xref:{s-path}/activitylog.adoc[activitylog] + @@ -2445,14 +2448,14 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++nats-js-kv ++ +++memory ++ a| [subs=-attributes] The type of the store. Supported values are: 'memory', 'nats-js-kv', 'redis-sentinel', 'noop'. See the text description for details. a| `OCIS_PERSISTENT_STORE_AUTH_PASSWORD` a| [subs=-attributes] -++7.1.0 ++ +++5.0 ++ a| [subs=attributes+] * xref:{s-path}/activitylog.adoc[activitylog] + @@ -2474,7 +2477,7 @@ The password to authenticate with the store. Only applies when store type 'nats- a| `OCIS_PERSISTENT_STORE_AUTH_USERNAME` a| [subs=-attributes] -++7.1.0 ++ +++5.0 ++ a| [subs=attributes+] * xref:{s-path}/activitylog.adoc[activitylog] + @@ -2496,7 +2499,7 @@ The username to authenticate with the store. Only applies when store type 'nats- a| `OCIS_PERSISTENT_STORE_ENABLE_TLS` a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=attributes+] * xref:{s-path}/activitylog.adoc[activitylog] + @@ -2518,7 +2521,7 @@ Activate TLS for the connection to the store. Only applies when store type 'nats a| `OCIS_PERSISTENT_STORE_NODES` a| [subs=-attributes] -++7.1.0 ++ +++pre5.0 ++ a| [subs=attributes+] * xref:{s-path}/activitylog.adoc[activitylog] + @@ -2533,14 +2536,14 @@ a| [subs=-attributes] ++[]string ++ a| [subs=-attributes] -++[127.0.0.1:9233] ++ +++[] ++ a| [subs=-attributes] 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. a| `OCIS_PERSISTENT_STORE_TLS_INSECURE` a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=attributes+] * xref:{s-path}/activitylog.adoc[activitylog] + @@ -2562,7 +2565,7 @@ Disable TLS certificate verification for the store connection. Only applies when a| `OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE` a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=attributes+] * xref:{s-path}/activitylog.adoc[activitylog] + @@ -2584,7 +2587,7 @@ Path to the PEM-encoded root CA certificate for the store TLS connection. Only a a| `OCIS_PERSISTENT_STORE_TTL` a| [subs=-attributes] -++7.1.0 ++ +++pre5.0 ++ a| [subs=attributes+] * xref:{s-path}/activitylog.adoc[activitylog] + @@ -2601,7 +2604,7 @@ a| [subs=-attributes] ++336h0m0s ++ a| [subs=-attributes] -Time to live for notifications in the store. Defaults to '336h' (2 weeks). See the Environment Variable Types description for more details. +Time to live for events in the store. Defaults to '336h' (2 weeks). See the Environment Variable Types description for more details. a| `OCIS_REVA_GATEWAY` a| [subs=-attributes] @@ -2645,7 +2648,7 @@ a| [subs=-attributes] ++com.owncloud.api.gateway ++ a| [subs=-attributes] -The CS3 gateway endpoint. +CS3 gateway used to look up user metadata a| `OCIS_SERVICE_ACCOUNT_ID` a| [subs=-attributes] @@ -2749,7 +2752,7 @@ a| [subs=-attributes] ++0 ++ a| [subs=-attributes] -Set the global max quota value in bytes. A value of 0 equals unlimited. The value is provided via capabilities. +Set a global max quota for spaces in bytes. A value of 0 equals unlimited. If not using the global OCIS_SPACES_MAX_QUOTA, you must define the FRONTEND_MAX_QUOTA in the frontend service. a| `OCIS_SYSTEM_USER_API_KEY` a| [subs=-attributes] @@ -3110,7 +3113,7 @@ a| [subs=-attributes] ++https://localhost:9200 ++ a| [subs=-attributes] -The public facing URL of the oCIS frontend. +The public facing URL of WebDAV. a| `OCIS_USER_SEARCH_DISPLAYED_ATTRIBUTES` a| [subs=-attributes] @@ -3127,7 +3130,7 @@ a| [subs=-attributes] ++[] ++ a| [subs=-attributes] -A list of user attributes to display in the user search results. +The attributes to display in the user search results. a| `OCIS_WOPI_DISABLE_CHAT` a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/graph_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/graph_configvars.adoc index abedd09e..c2553b73 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/graph_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/graph_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the graph service [width="100%",cols="~,~,~,~",options="header"] @@ -225,7 +225,7 @@ a|`OCIS_CACHE_ENABLE_TLS` + `GRAPH_CACHE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -237,7 +237,7 @@ a|`OCIS_CACHE_TLS_INSECURE` + `GRAPH_CACHE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -249,7 +249,7 @@ a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + `GRAPH_CACHE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] @@ -399,7 +399,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++[]string ++ a| [subs=-attributes] -++[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id Purge Restore] ++ +++[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id Purge X-Purge Restore] ++ a| [subs=-attributes] A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details. @@ -633,7 +633,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ ++ +++en ++ a| [subs=-attributes] The default language used by services and the WebUI. If not defined, English will be used as default. See the documentation for more details. @@ -1356,6 +1356,17 @@ a| [subs=-attributes] a| [subs=-attributes] Template for the instance URL. Requires OCIS_MULTI_INSTANCE_ENABLED. +a|`OCIS_LDAP_INSTANCE_MAPPER_CACHE_TTL` + + +a| [subs=-attributes] +++8.2.1 ++ +a| [subs=-attributes] +++int ++ +a| [subs=-attributes] +++60000000000 ++ +a| [subs=-attributes] +Max TTL in seconds for the LDAP instance mapper cache. Requires OCIS_MULTI_INSTANCE_ENABLED. + a|`OCIS_ENABLE_OCM` + `GRAPH_INCLUDE_OCM_SHAREES` + @@ -1613,7 +1624,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The master ID that grants access to all instances. Users with this ID in their memberOf or guestOf claims can access any instance. Leave empty to disable. +The master ID that grants access to all instances. Users with this ID in their memberOf or guestOf claims can access any instance. Leave empty to disable. Also set 'OCIS_LDAP_USER_FILTER'. Without an explicit user filter, this instance resolves every user in the shared LDAP directory. a|`OCIS_MULTI_INSTANCE_QUERY_TEMPLATE` + diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/groups_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/groups_configvars.adoc index 7519c189..7e37469e 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/groups_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/groups_configvars.adoc @@ -2,11 +2,11 @@ // if the generated adoc file is used outside tabs, it renders correctly depending on the attribute set. // if inside, you need to also use the xxx_deprecation.adoc file. attributes can't be defined inside tabs. -:show-deprecation: false +:show-deprecation: true ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the groups service [width="100%",cols="~,~,~,~",options="header"] @@ -15,6 +15,56 @@ ifeval::[{show-deprecation} == true] | Deprecation Version | Removal Version | Deprecation Replacement + +| GROUPS_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| GROUPS_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| GROUPS_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| GROUPS_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| GROUPS_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| GROUPS_OWNCLOUDSQL_IDP is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| GROUPS_OWNCLOUDSQL_NOBODY is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| GROUPS_OWNCLOUDSQL_JOIN_USERNAME is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| GROUPS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| |=== {empty} + @@ -487,7 +537,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The master instance ID for multi-instance setups. When set, LDAP user filters are enhanced to also match users belonging to the master instance. +The master instance ID for multi-instance setups. When set, LDAP user filters are enhanced to also match users belonging to the master instance. Also set 'user_filter'. Without an explicit 'user_filter', this instance resolves every user in the shared LDAP directory. a|`OCIS_LDAP_USER_MEMBER_ATTRIBUTE` + @@ -680,7 +730,7 @@ a| [subs=-attributes] Maximum time to wait for a pooled LDAP connection to become available once the pool is exhausted. Defaults to 30s when unset or <= 0. See the Environment Variable Types description for more details. a|`GROUPS_OWNCLOUDSQL_DB_USERNAME` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -691,7 +741,7 @@ a| [subs=-attributes] Database user to use for authenticating with the owncloud database. a|`GROUPS_OWNCLOUDSQL_DB_PASSWORD` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -702,7 +752,7 @@ a| [subs=-attributes] Password for the database user. a|`GROUPS_OWNCLOUDSQL_DB_HOST` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -713,7 +763,7 @@ a| [subs=-attributes] Hostname of the database server. a|`GROUPS_OWNCLOUDSQL_DB_PORT` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -724,7 +774,7 @@ a| [subs=-attributes] Network port to use for the database connection. a|`GROUPS_OWNCLOUDSQL_DB_NAME` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -735,7 +785,7 @@ a| [subs=-attributes] Name of the owncloud database. a|`GROUPS_OWNCLOUDSQL_IDP` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -746,7 +796,7 @@ a| [subs=-attributes] The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. a|`GROUPS_OWNCLOUDSQL_NOBODY` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -757,7 +807,7 @@ a| [subs=-attributes] Fallback number if no numeric UID and GID properties are provided. a|`GROUPS_OWNCLOUDSQL_JOIN_USERNAME` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -768,7 +818,7 @@ a| [subs=-attributes] Join the user properties table to read usernames. a|`GROUPS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -779,7 +829,7 @@ a| [subs=-attributes] Join the user properties table to read user IDs. a|`GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/groups_deprecation.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/groups_deprecation.adoc index 4b3cef68..e452d9c3 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/groups_deprecation.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/groups_deprecation.adoc @@ -1,2 +1,2 @@ -:show-deprecation: false +:show-deprecation: true diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/idm_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/idm_configvars.adoc index 6accca6a..090e420d 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/idm_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/idm_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the idm service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/idp_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/idp_configvars.adoc index 7950b2d6..aea7f83d 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/idp_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/idp_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the idp service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/invitations_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/invitations_configvars.adoc index ecb7b7fa..4c1e4cca 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/invitations_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/invitations_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the invitations service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/nats_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/nats_configvars.adoc index 722e713e..acba273a 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/nats_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/nats_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the nats service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/notifications_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/notifications_configvars.adoc index d0d27985..897faaab 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/notifications_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/notifications_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the notifications service [width="100%",cols="~,~,~,~",options="header"] @@ -386,7 +386,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ ++ +++en ++ a| [subs=-attributes] The default language used by services and the WebUI. If not defined, English will be used as default. See the documentation for more details. @@ -423,6 +423,39 @@ a| [subs=-attributes] a| [subs=-attributes] Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the go-micro based grpc services. +a|`OCIS_GRPC_MAX_RECEIVED_MESSAGE_SIZE` + + +a| [subs=-attributes] +++pre5.0 ++ +a| [subs=-attributes] +++int ++ +a| [subs=-attributes] +++0 ++ +a| [subs=-attributes] +The maximum body size for grpc requests. Defaults to '10240000' bytes (10MB). Note that large values can potentially hide errors but may lead to network timeouts. Should only be changed temporarily to regain access for large folders with 25.000+ files to copy out data. + +a|`GRPC_CLIENT_KEEPALIVE_TIME` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++Duration ++ +a| [subs=-attributes] +++0s ++ +a| [subs=-attributes] +How long a grpc client connection with an ongoing request may stay silent before the server is pinged to check whether it is still answering. Set a duration like '20s' to enable detection of unresponsive peers. Leaving it unset, or at '0', sends no pings at all, which is grpc's own default. Values below '10s' are raised to '10s' by grpc. Make sure to include the unit suffix, a bare number is not a valid duration. + +a|`GRPC_CLIENT_KEEPALIVE_TIMEOUT` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++Duration ++ +a| [subs=-attributes] +++0s ++ +a| [subs=-attributes] +How long a grpc client waits for the answer to a keepalive ping before it considers the connection dead and fails all requests on it. Defaults to '10s'. Has no effect unless GRPC_CLIENT_KEEPALIVE_TIME is set. See GRPC_CLIENT_KEEPALIVE_TIME. + a|`OCIS_SERVICE_ACCOUNT_ID` + `NOTIFICATIONS_SERVICE_ACCOUNT_ID` + @@ -533,7 +566,7 @@ a|`OCIS_PERSISTENT_STORE_ENABLE_TLS` + `NOTIFICATIONS_STORE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -545,7 +578,7 @@ a|`OCIS_PERSISTENT_STORE_TLS_INSECURE` + `NOTIFICATIONS_STORE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -557,7 +590,7 @@ a|`OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE` + `NOTIFICATIONS_STORE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/ocdav_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/ocdav_configvars.adoc index 915f9f59..ba04f016 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/ocdav_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/ocdav_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the ocdav service [width="100%",cols="~,~,~,~",options="header"] @@ -421,5 +421,16 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] Allow the use of depth infinity in PROPFINDS. When enabled, a propfind will traverse through all subfolders. If many subfolders are expected, depth infinity can cause heavy server load and/or delayed response times. + +a|`OCDAV_DISABLE_PROPFIND_PUBLIC_LINK_RESOLUTION` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++bool ++ +a| [subs=-attributes] +++false ++ +a| [subs=-attributes] +Disable the resolution of public link shares when answering PROPFIND requests. When disabled, the oc:share-type property will not be populated with public link share information, which can reduce load on services for large collections. |=== diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/ocm_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/ocm_configvars.adoc index 179d2a67..154edf87 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/ocm_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/ocm_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the ocm service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/ocs_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/ocs_configvars.adoc index 17c5263b..92e3c650 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/ocs_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/ocs_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the ocs service [width="100%",cols="~,~,~,~",options="header"] @@ -338,7 +338,7 @@ a|`OCIS_CACHE_ENABLE_TLS` + `OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -350,7 +350,7 @@ a|`OCIS_CACHE_TLS_INSECURE` + `OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -362,7 +362,7 @@ a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + `OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/policies_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/policies_configvars.adoc index 7c096feb..3ae817d5 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/policies_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/policies_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the policies service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/postprocessing_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/postprocessing_configvars.adoc index d37a9cb4..decba962 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/postprocessing_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/postprocessing_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the postprocessing service [width="100%",cols="~,~,~,~",options="header"] @@ -257,7 +257,7 @@ a|`OCIS_PERSISTENT_STORE_ENABLE_TLS` + `POSTPROCESSING_STORE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -269,7 +269,7 @@ a|`OCIS_PERSISTENT_STORE_TLS_INSECURE` + `POSTPROCESSING_STORE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -281,7 +281,7 @@ a|`OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE` + `POSTPROCESSING_STORE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/proxy_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/proxy_configvars.adoc index e5b62e2f..1ba5e54c 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/proxy_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/proxy_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the proxy service [width="100%",cols="~,~,~,~",options="header"] @@ -426,7 +426,7 @@ a|`OCIS_CACHE_ENABLE_TLS` + `PROXY_OIDC_USERINFO_CACHE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -438,7 +438,7 @@ a|`OCIS_CACHE_TLS_INSECURE` + `PROXY_OIDC_USERINFO_CACHE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -450,7 +450,7 @@ a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + `PROXY_OIDC_USERINFO_CACHE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] @@ -646,7 +646,7 @@ a|`OCIS_CACHE_ENABLE_TLS` + `PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -658,7 +658,7 @@ a|`OCIS_CACHE_TLS_INSECURE` + `PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -670,7 +670,7 @@ a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + `PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/search_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/search_configvars.adoc index d29ad3dc..2b659fe5 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/search_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/search_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the search service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/settings_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/settings_configvars.adoc index 23bb5006..85a4cbad 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/settings_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/settings_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the settings service [width="100%",cols="~,~,~,~",options="header"] @@ -453,7 +453,7 @@ a|`OCIS_CACHE_ENABLE_TLS` + `SETTINGS_CACHE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -465,7 +465,7 @@ a|`OCIS_CACHE_TLS_INSECURE` + `SETTINGS_CACHE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -477,7 +477,7 @@ a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + `SETTINGS_CACHE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] @@ -551,7 +551,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ ++ +++en ++ a| [subs=-attributes] The default language used by services and the WebUI. If not defined, English will be used as default. See the documentation for more details. diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/sharing_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/sharing_configvars.adoc index fcdb60d6..b26620dc 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/sharing_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/sharing_configvars.adoc @@ -2,11 +2,11 @@ // if the generated adoc file is used outside tabs, it renders correctly depending on the attribute set. // if inside, you need to also use the xxx_deprecation.adoc file. attributes can't be defined inside tabs. -:show-deprecation: false +:show-deprecation: true ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the sharing service [width="100%",cols="~,~,~,~",options="header"] @@ -15,6 +15,36 @@ ifeval::[{show-deprecation} == true] | Deprecation Version | Removal Version | Deprecation Replacement + +| SHARING_USER_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| SHARING_USER_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| SHARING_USER_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| SHARING_USER_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| SHARING_USER_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| |=== {empty} + @@ -474,7 +504,7 @@ a| [subs=-attributes] API key for the STORAGE-SYSTEM system user. a|`SHARING_USER_OWNCLOUDSQL_DB_USERNAME` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -485,7 +515,7 @@ a| [subs=-attributes] Username for the database. a|`SHARING_USER_OWNCLOUDSQL_DB_PASSWORD` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -496,7 +526,7 @@ a| [subs=-attributes] Password for the database. a|`SHARING_USER_OWNCLOUDSQL_DB_HOST` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -507,7 +537,7 @@ a| [subs=-attributes] Hostname or IP of the database server. a|`SHARING_USER_OWNCLOUDSQL_DB_PORT` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -518,7 +548,7 @@ a| [subs=-attributes] Port that the database server is listening on. a|`SHARING_USER_OWNCLOUDSQL_DB_NAME` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -529,7 +559,7 @@ a| [subs=-attributes] Name of the database to be used. a|`SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -679,6 +709,30 @@ a| [subs=-attributes] a| [subs=-attributes] Set this to true if you want to enforce passwords on all public shares. +a|`OCIS_SHARING_ENABLE_EXPIRED_SHARES_CLEANUP` + +`SHARING_ENABLE_EXPIRED_SHARES_CLEANUP` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++bool ++ +a| [subs=-attributes] +++true ++ +a| [subs=-attributes] +Enable the periodic removal of expired public shares. When disabled, expired shares are still hidden from listings but never actually deleted. + +a|`OCIS_SHARING_JANITOR_RUN_INTERVAL` + +`SHARING_JANITOR_RUN_INTERVAL` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++int ++ +a| [subs=-attributes] +++3600 ++ +a| [subs=-attributes] +Interval in seconds between two runs of the janitor that permanently deletes expired public shares. Defaults to '3600' (1 hour). Only relevant when OCIS_SHARING_ENABLE_EXPIRED_SHARES_CLEANUP is enabled. + a|`OCIS_ENABLE_USER_SHARING` + a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/sharing_deprecation.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/sharing_deprecation.adoc index 4b3cef68..e452d9c3 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/sharing_deprecation.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/sharing_deprecation.adoc @@ -1,2 +1,2 @@ -:show-deprecation: false +:show-deprecation: true diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/sse_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/sse_configvars.adoc index 4d694c77..6af82f70 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/sse_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/sse_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the sse service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-publiclink_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-publiclink_configvars.adoc index 943db3ef..e0e8ec8b 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-publiclink_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-publiclink_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the storage-publiclink service [width="100%",cols="~,~,~,~",options="header"] @@ -335,7 +335,7 @@ a|`OCIS_PERSISTENT_STORE_ENABLE_TLS` + `STORAGE_PUBLICLINK_STORE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -347,7 +347,7 @@ a|`OCIS_PERSISTENT_STORE_TLS_INSECURE` + `STORAGE_PUBLICLINK_STORE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -359,7 +359,7 @@ a|`OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE` + `STORAGE_PUBLICLINK_STORE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-shares_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-shares_configvars.adoc index 1b34f61c..f2b4caa1 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-shares_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-shares_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the storage-shares service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-system_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-system_configvars.adoc index 1fbbd5dc..3c11610e 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-system_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-system_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the storage-system service [width="100%",cols="~,~,~,~",options="header"] @@ -381,7 +381,7 @@ a|`OCIS_CACHE_ENABLE_TLS` + `STORAGE_SYSTEM_CACHE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -393,7 +393,7 @@ a|`OCIS_CACHE_TLS_INSECURE` + `STORAGE_SYSTEM_CACHE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -405,7 +405,7 @@ a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + `STORAGE_SYSTEM_CACHE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-users_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-users_configvars.adoc index 931155df..84098672 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-users_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-users_configvars.adoc @@ -2,11 +2,11 @@ // if the generated adoc file is used outside tabs, it renders correctly depending on the attribute set. // if inside, you need to also use the xxx_deprecation.adoc file. attributes can't be defined inside tabs. -:show-deprecation: false +:show-deprecation: true ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the storage-users service [width="100%",cols="~,~,~,~",options="header"] @@ -15,6 +15,101 @@ ifeval::[{show-deprecation} == true] | Deprecation Version | Removal Version | Deprecation Replacement + +| STORAGE_USERS_OWNCLOUDSQL_DATADIR is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| STORAGE_USERS_OWNCLOUDSQL_LAYOUT is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| STORAGE_USERS_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| STORAGE_USERS_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| STORAGE_USERS_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| STORAGE_USERS_POSIX_ROOT is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. +| 8.2.0 +| 9.0.0 +| + +| STORAGE_USERS_POSIX_PERSONAL_SPACE_PATH_TEMPLATE is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. +| 8.2.0 +| 9.0.0 +| + +| STORAGE_USERS_POSIX_GENERAL_SPACE_PATH_TEMPLATE is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. +| 8.2.0 +| 9.0.0 +| + +| STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. +| 8.2.0 +| 9.0.0 +| + +| STORAGE_USERS_POSIX_SCAN_DEBOUNCE_DELAY is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. +| 8.2.0 +| 9.0.0 +| + +| STORAGE_USERS_POSIX_USE_SPACE_GROUPS is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. +| 8.2.0 +| 9.0.0 +| + +| STORAGE_USERS_POSIX_WATCH_TYPE is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. +| 8.2.0 +| 9.0.0 +| + +| STORAGE_USERS_POSIX_WATCH_PATH is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. +| 8.2.0 +| 9.0.0 +| + +| STORAGE_USERS_POSIX_WATCH_FOLDER_KAFKA_BROKERS is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. +| 8.2.0 +| 9.0.0 +| |=== {empty} + @@ -836,7 +931,7 @@ a| [subs=-attributes] Disables versioning of files. When set to true, new uploads with the same filename will overwrite existing files instead of creating a new version. a|`STORAGE_USERS_OWNCLOUDSQL_DATADIR` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -847,7 +942,7 @@ a| [subs=-attributes] The directory where the filesystem storage will store SQL migration data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/owncloud. a|`STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -858,7 +953,7 @@ a| [subs=-attributes] Name of the folder jailing all shares. a|`STORAGE_USERS_OWNCLOUDSQL_LAYOUT` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -869,7 +964,7 @@ a| [subs=-attributes] Path layout to use to navigate into a users folder in an owncloud data directory a|`STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -880,7 +975,7 @@ a| [subs=-attributes] The directory where the filesystem will store uploads temporarily. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/uploadinfo. a|`STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -891,7 +986,7 @@ a| [subs=-attributes] Username for the database. a|`STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -902,7 +997,7 @@ a| [subs=-attributes] Password for the database. a|`STORAGE_USERS_OWNCLOUDSQL_DB_HOST` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -913,7 +1008,7 @@ a| [subs=-attributes] Hostname or IP of the database server. a|`STORAGE_USERS_OWNCLOUDSQL_DB_PORT` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -924,7 +1019,7 @@ a| [subs=-attributes] Port that the database server is listening on. a|`STORAGE_USERS_OWNCLOUDSQL_DB_NAME` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -935,7 +1030,7 @@ a| [subs=-attributes] Name of the database to be used. a|`STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -946,7 +1041,7 @@ a| [subs=-attributes] Endpoint of the users provider. a|`STORAGE_USERS_POSIX_ROOT` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++6.0.0 ++ a| [subs=-attributes] @@ -957,7 +1052,7 @@ a| [subs=-attributes] The directory where the filesystem storage will store its data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/users. a|`STORAGE_USERS_POSIX_PERSONAL_SPACE_PATH_TEMPLATE` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++6.0.0 ++ a| [subs=-attributes] @@ -968,7 +1063,7 @@ a| [subs=-attributes] Template string to construct the paths of the personal space roots. a|`STORAGE_USERS_POSIX_GENERAL_SPACE_PATH_TEMPLATE` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++6.0.0 ++ a| [subs=-attributes] @@ -980,7 +1075,7 @@ Template string to construct the paths of the projects space roots. a|`STORAGE_USERS_PERMISSION_ENDPOINT` + `STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++6.0.0 ++ a| [subs=-attributes] @@ -1002,7 +1097,7 @@ a| [subs=-attributes] Enable asynchronous file uploads. a|`STORAGE_USERS_POSIX_SCAN_DEBOUNCE_DELAY` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++6.0.0 ++ a| [subs=-attributes] @@ -1013,7 +1108,7 @@ a| [subs=-attributes] The time in milliseconds to wait before scanning the filesystem for changes after a change has been detected. a|`STORAGE_USERS_POSIX_USE_SPACE_GROUPS` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++6.0.0 ++ a| [subs=-attributes] @@ -1024,7 +1119,7 @@ a| [subs=-attributes] Use space groups to manage permissions on spaces. a|`STORAGE_USERS_POSIX_WATCH_TYPE` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++6.0.0 ++ a| [subs=-attributes] @@ -1035,7 +1130,7 @@ a| [subs=-attributes] Type of the watcher to use for getting notified about changes to the filesystem. Currently available options are 'inotifywait' (default), 'gpfswatchfolder' and 'gpfsfileauditlogging'. a|`STORAGE_USERS_POSIX_WATCH_PATH` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++6.0.0 ++ a| [subs=-attributes] @@ -1046,7 +1141,7 @@ a| [subs=-attributes] Path to the watch directory/file. Only applies to the 'gpfsfileauditlogging' and 'inotifywait' watcher, in which case it is the path of the file audit log file/base directory to watch. a|`STORAGE_USERS_POSIX_WATCH_FOLDER_KAFKA_BROKERS` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++6.0.0 ++ a| [subs=-attributes] @@ -1282,7 +1377,7 @@ a|`OCIS_CACHE_ENABLE_TLS` + `STORAGE_USERS_FILEMETADATA_CACHE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -1294,7 +1389,7 @@ a|`OCIS_CACHE_TLS_INSECURE` + `STORAGE_USERS_FILEMETADATA_CACHE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -1306,7 +1401,7 @@ a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + `STORAGE_USERS_FILEMETADATA_CACHE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] @@ -1401,7 +1496,7 @@ a|`OCIS_CACHE_ENABLE_TLS` + `STORAGE_USERS_ID_CACHE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -1413,7 +1508,7 @@ a|`OCIS_CACHE_TLS_INSECURE` + `STORAGE_USERS_ID_CACHE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -1425,7 +1520,7 @@ a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + `STORAGE_USERS_ID_CACHE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-users_deprecation.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-users_deprecation.adoc index 4b3cef68..e452d9c3 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-users_deprecation.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/storage-users_deprecation.adoc @@ -1,2 +1,2 @@ -:show-deprecation: false +:show-deprecation: true diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/thumbnails_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/thumbnails_configvars.adoc index 75020e5e..af54f0d7 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/thumbnails_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/thumbnails_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the thumbnails service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/userlog_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/userlog_configvars.adoc index 4eaccf47..1dbf7c44 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/userlog_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/userlog_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the userlog service [width="100%",cols="~,~,~,~",options="header"] @@ -316,7 +316,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ ++ +++en ++ a| [subs=-attributes] The default language used by services and the WebUI. If not defined, English will be used as default. See the documentation for more details. @@ -502,7 +502,7 @@ a|`OCIS_PERSISTENT_STORE_ENABLE_TLS` + `USERLOG_STORE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -514,7 +514,7 @@ a|`OCIS_PERSISTENT_STORE_TLS_INSECURE` + `USERLOG_STORE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -526,7 +526,7 @@ a|`OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE` + `USERLOG_STORE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/users_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/users_configvars.adoc index b8c8149f..c7be193d 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/users_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/users_configvars.adoc @@ -2,11 +2,11 @@ // if the generated adoc file is used outside tabs, it renders correctly depending on the attribute set. // if inside, you need to also use the xxx_deprecation.adoc file. attributes can't be defined inside tabs. -:show-deprecation: false +:show-deprecation: true ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the users service [width="100%",cols="~,~,~,~",options="header"] @@ -15,6 +15,56 @@ ifeval::[{show-deprecation} == true] | Deprecation Version | Removal Version | Deprecation Replacement + +| USERS_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| USERS_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| USERS_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| USERS_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| USERS_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| USERS_OWNCLOUDSQL_IDP is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| USERS_OWNCLOUDSQL_NOBODY is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| USERS_OWNCLOUDSQL_JOIN_USERNAME is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| USERS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| + +| USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH is deprecated because the owncloudsql driver is deprecated. +| 8.2.0 +| 9.0.0 +| |=== {empty} + @@ -523,7 +573,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The master instance ID for multi-instance setups. When set, LDAP user filters are enhanced to also match users belonging to the master instance. +The master instance ID for multi-instance setups. When set, LDAP user filters are enhanced to also match users belonging to the master instance. Also set 'user_filter'. Without an explicit 'user_filter', this instance resolves every user in the shared LDAP directory. a|`OCIS_LDAP_USER_MEMBER_ATTRIBUTE` + @@ -728,7 +778,7 @@ a| [subs=-attributes] Maximum time to wait for a pooled LDAP connection to become available once the pool is exhausted. Defaults to 30s when unset or <= 0. See the Environment Variable Types description for more details. a|`USERS_OWNCLOUDSQL_DB_USERNAME` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -739,7 +789,7 @@ a| [subs=-attributes] Database user to use for authenticating with the owncloud database. a|`USERS_OWNCLOUDSQL_DB_PASSWORD` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -750,7 +800,7 @@ a| [subs=-attributes] Password for the database user. a|`USERS_OWNCLOUDSQL_DB_HOST` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -761,7 +811,7 @@ a| [subs=-attributes] Hostname of the database server. a|`USERS_OWNCLOUDSQL_DB_PORT` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -772,7 +822,7 @@ a| [subs=-attributes] Network port to use for the database connection. a|`USERS_OWNCLOUDSQL_DB_NAME` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -783,7 +833,7 @@ a| [subs=-attributes] Name of the owncloud database. a|`USERS_OWNCLOUDSQL_IDP` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -794,7 +844,7 @@ a| [subs=-attributes] The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. a|`USERS_OWNCLOUDSQL_NOBODY` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -805,7 +855,7 @@ a| [subs=-attributes] Fallback number if no numeric UID and GID properties are provided. a|`USERS_OWNCLOUDSQL_JOIN_USERNAME` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -816,7 +866,7 @@ a| [subs=-attributes] Join the user properties table to read usernames a|`USERS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -827,7 +877,7 @@ a| [subs=-attributes] Join the user properties table to read user IDs. a|`USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH` + - +xref:deprecation-note-2026-11-13-09-58-28[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/users_deprecation.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/users_deprecation.adoc index 4b3cef68..e452d9c3 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/users_deprecation.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/users_deprecation.adoc @@ -1,2 +1,2 @@ -:show-deprecation: false +:show-deprecation: true diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/web_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/web_configvars.adoc index c5dea450..da53fac4 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/web_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/web_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the web service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/webdav_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/webdav_configvars.adoc index 4fdfaa1e..91c19a75 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/webdav_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/webdav_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the webdav service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/webfinger_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/webfinger_configvars.adoc index 59cfbfbb..67321bfa 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/webfinger_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/adoc/webfinger_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-30-54] +[#deprecation-note-2026-11-13-09-58-28] [caption=] .Deprecation notes for the webfinger service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/env_var_deltas/8.1.0-8.2.0-added.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/env_var_deltas/8.1.0-8.2.0-added.adoc index b42ed4f2..5f71f2b7 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/env_var_deltas/8.1.0-8.2.0-added.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/env_var_deltas/8.1.0-8.2.0-added.adoc @@ -1,7 +1,7 @@ // # Added Variables between oCIS 8.1.0 and oCIS 8.2.0 // commenting the headline to make it better includable -// table created per 2026.09.10 +// table created per 2026.11.04 // the table should be recreated/updated on source () changes [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/env_var_deltas/8.1.0-8.2.0-deprecated.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/env_var_deltas/8.1.0-8.2.0-deprecated.adoc index 767ca31c..92ee099a 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/env_var_deltas/8.1.0-8.2.0-deprecated.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/env_var_deltas/8.1.0-8.2.0-deprecated.adoc @@ -1,7 +1,7 @@ -// # Deprecated Variables between oCIS 8.1.0 and oCIS 8.2.0 +// # Deprecated Variables between oCIS 8.1.0 and oCIS 8.2.3 // commenting the headline to make it better includable -// table created per 2026.09.10 +// table created per 2026.11.12 // the table should be recreated/updated on source () changes [width="100%",cols="~,~,~,~,~",options="header"] @@ -32,5 +32,329 @@ | %%NEXT_PRODUCTION_VERSION%% | The OCS API is deprecated +| xref:{s-path}/auth-basic.adoc[Auth-Basic] +| AUTH_BASIC_OWNCLOUDSQL_DB_HOST +| Hostname of the database server. +| 9.0.0 +| AUTH_BASIC_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql driver is deprecated. + +| +| AUTH_BASIC_OWNCLOUDSQL_DB_NAME +| Name of the owncloud database. +| 9.0.0 +| AUTH_BASIC_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql driver is deprecated. + +| +| AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD +| Password for the database user. +| 9.0.0 +| AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql driver is deprecated. + +| +| AUTH_BASIC_OWNCLOUDSQL_DB_PORT +| Network port to use for the database connection. +| 9.0.0 +| AUTH_BASIC_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql driver is deprecated. + +| +| AUTH_BASIC_OWNCLOUDSQL_DB_USERNAME +| Database user to use for authenticating with the owncloud database. +| 9.0.0 +| AUTH_BASIC_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql driver is deprecated. + +| +| AUTH_BASIC_OWNCLOUDSQL_IDP +| The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. +| 9.0.0 +| AUTH_BASIC_OWNCLOUDSQL_IDP is deprecated because the owncloudsql driver is deprecated. + +| +| AUTH_BASIC_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID +| Join the user properties table to read user ID's. +| 9.0.0 +| AUTH_BASIC_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID is deprecated because the owncloudsql driver is deprecated. + +| +| AUTH_BASIC_OWNCLOUDSQL_JOIN_USERNAME +| Join the user properties table to read usernames +| 9.0.0 +| AUTH_BASIC_OWNCLOUDSQL_JOIN_USERNAME is deprecated because the owncloudsql driver is deprecated. + +| +| AUTH_BASIC_OWNCLOUDSQL_NOBODY +| Fallback number if no numeric UID and GID properties are provided. +| 9.0.0 +| AUTH_BASIC_OWNCLOUDSQL_NOBODY is deprecated because the owncloudsql driver is deprecated. + +| xref:{s-path}/groups.adoc[Groups] +| GROUPS_OWNCLOUDSQL_DB_HOST +| Hostname of the database server. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql driver is deprecated. + +| +| GROUPS_OWNCLOUDSQL_DB_NAME +| Name of the owncloud database. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql driver is deprecated. + +| +| GROUPS_OWNCLOUDSQL_DB_PASSWORD +| Password for the database user. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql driver is deprecated. + +| +| GROUPS_OWNCLOUDSQL_DB_PORT +| Network port to use for the database connection. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql driver is deprecated. + +| +| GROUPS_OWNCLOUDSQL_DB_USERNAME +| Database user to use for authenticating with the owncloud database. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql driver is deprecated. + +| +| GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH +| Allow 'medial search' when searching for users instead of just doing a prefix search. This allows finding 'Alice' when searching for 'lic'. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH is deprecated because the owncloudsql driver is deprecated. + +| +| GROUPS_OWNCLOUDSQL_IDP +| The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_IDP is deprecated because the owncloudsql driver is deprecated. + +| +| GROUPS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID +| Join the user properties table to read user IDs. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID is deprecated because the owncloudsql driver is deprecated. + +| +| GROUPS_OWNCLOUDSQL_JOIN_USERNAME +| Join the user properties table to read usernames. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_JOIN_USERNAME is deprecated because the owncloudsql driver is deprecated. + +| +| GROUPS_OWNCLOUDSQL_NOBODY +| Fallback number if no numeric UID and GID properties are provided. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_NOBODY is deprecated because the owncloudsql driver is deprecated. + +| xref:{s-path}/sharing.adoc[Sharing] +| SHARING_USER_OWNCLOUDSQL_DB_HOST +| Hostname or IP of the database server. +| 9.0.0 +| SHARING_USER_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql driver is deprecated. + +| +| SHARING_USER_OWNCLOUDSQL_DB_NAME +| Name of the database to be used. +| 9.0.0 +| SHARING_USER_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql driver is deprecated. + +| +| SHARING_USER_OWNCLOUDSQL_DB_PASSWORD +| Password for the database. +| 9.0.0 +| SHARING_USER_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql driver is deprecated. + +| +| SHARING_USER_OWNCLOUDSQL_DB_PORT +| Port that the database server is listening on. +| 9.0.0 +| SHARING_USER_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql driver is deprecated. + +| +| SHARING_USER_OWNCLOUDSQL_DB_USERNAME +| Username for the database. +| 9.0.0 +| SHARING_USER_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql driver is deprecated. + +| +| SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID +| Mount ID of the ownCloudSQL users storage for mapping ownCloud 10 shares. +| 9.0.0 +| SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID is deprecated because the owncloudsql driver is deprecated. + +| xref:{s-path}/storage-users.adoc[Storage-Users] +| STORAGE_USERS_OWNCLOUDSQL_DATADIR +| The directory where the filesystem storage will store SQL migration data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/owncloud. +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_DATADIR is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_OWNCLOUDSQL_DB_HOST +| Hostname or IP of the database server. +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_OWNCLOUDSQL_DB_NAME +| Name of the database to be used. +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD +| Password for the database. +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_OWNCLOUDSQL_DB_PORT +| Port that the database server is listening on. +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME +| Username for the database. +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_OWNCLOUDSQL_LAYOUT +| Path layout to use to navigate into a users folder in an owncloud data directory +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_LAYOUT is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER +| Name of the folder jailing all shares. +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR +| The directory where the filesystem will store uploads temporarily. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/uploadinfo. +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT +| Endpoint of the users provider. +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_POSIX_GENERAL_SPACE_PATH_TEMPLATE +| Template string to construct the paths of the projects space roots. +| 9.0.0 +| STORAGE_USERS_POSIX_GENERAL_SPACE_PATH_TEMPLATE is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. + +| +| STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT +| Endpoint of the permissions service. The endpoints can differ for 'ocis', 'posix' and 's3ng'. +| 9.0.0 +| STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. + +| +| STORAGE_USERS_POSIX_PERSONAL_SPACE_PATH_TEMPLATE +| Template string to construct the paths of the personal space roots. +| 9.0.0 +| STORAGE_USERS_POSIX_PERSONAL_SPACE_PATH_TEMPLATE is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. + +| +| STORAGE_USERS_POSIX_ROOT +| The directory where the filesystem storage will store its data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/users. +| 9.0.0 +| STORAGE_USERS_POSIX_ROOT is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. + +| +| STORAGE_USERS_POSIX_SCAN_DEBOUNCE_DELAY +| The time in milliseconds to wait before scanning the filesystem for changes after a change has been detected. +| 9.0.0 +| STORAGE_USERS_POSIX_SCAN_DEBOUNCE_DELAY is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. + +| +| STORAGE_USERS_POSIX_USE_SPACE_GROUPS +| Use space groups to manage permissions on spaces. +| 9.0.0 +| STORAGE_USERS_POSIX_USE_SPACE_GROUPS is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. + +| +| STORAGE_USERS_POSIX_WATCH_FOLDER_KAFKA_BROKERS +| Comma-separated list of kafka brokers to read the watchfolder events from. +| 9.0.0 +| STORAGE_USERS_POSIX_WATCH_FOLDER_KAFKA_BROKERS is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. + +| +| STORAGE_USERS_POSIX_WATCH_PATH +| Path to the watch directory/file. Only applies to the 'gpfsfileauditlogging' and 'inotifywait' watcher, in which case it is the path of the file audit log file/base directory to watch. +| 9.0.0 +| STORAGE_USERS_POSIX_WATCH_PATH is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. + +| +| STORAGE_USERS_POSIX_WATCH_TYPE +| Type of the watcher to use for getting notified about changes to the filesystem. Currently available options are 'inotifywait' (default), 'gpfswatchfolder' and 'gpfsfileauditlogging'. +| 9.0.0 +| STORAGE_USERS_POSIX_WATCH_TYPE is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. + +| xref:{s-path}/users.adoc[Users] +| USERS_OWNCLOUDSQL_DB_HOST +| Hostname of the database server. +| 9.0.0 +| USERS_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql driver is deprecated. + +| +| USERS_OWNCLOUDSQL_DB_NAME +| Name of the owncloud database. +| 9.0.0 +| USERS_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql driver is deprecated. + +| +| USERS_OWNCLOUDSQL_DB_PASSWORD +| Password for the database user. +| 9.0.0 +| USERS_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql driver is deprecated. + +| +| USERS_OWNCLOUDSQL_DB_PORT +| Network port to use for the database connection. +| 9.0.0 +| USERS_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql driver is deprecated. + +| +| USERS_OWNCLOUDSQL_DB_USERNAME +| Database user to use for authenticating with the owncloud database. +| 9.0.0 +| USERS_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql driver is deprecated. + +| +| USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH +| Allow 'medial search' when searching for users instead of just doing a prefix search. This allows finding 'Alice' when searching for 'lic'. +| 9.0.0 +| USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH is deprecated because the owncloudsql driver is deprecated. + +| +| USERS_OWNCLOUDSQL_IDP +| The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. +| 9.0.0 +| USERS_OWNCLOUDSQL_IDP is deprecated because the owncloudsql driver is deprecated. + +| +| USERS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID +| Join the user properties table to read user IDs. +| 9.0.0 +| USERS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID is deprecated because the owncloudsql driver is deprecated. + +| +| USERS_OWNCLOUDSQL_JOIN_USERNAME +| Join the user properties table to read usernames +| 9.0.0 +| USERS_OWNCLOUDSQL_JOIN_USERNAME is deprecated because the owncloudsql driver is deprecated. + +| +| USERS_OWNCLOUDSQL_NOBODY +| Fallback number if no numeric UID and GID properties are provided. +| 9.0.0 +| USERS_OWNCLOUDSQL_NOBODY is deprecated because the owncloudsql driver is deprecated. + |=== diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/env_var_deltas/8.1.0-8.2.0-removed.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/env_var_deltas/8.1.0-8.2.0-removed.adoc index 79a6d809..0beddb41 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/env_var_deltas/8.1.0-8.2.0-removed.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/env_var_deltas/8.1.0-8.2.0-removed.adoc @@ -1,18 +1,13 @@ // # Removed Variables between oCIS 8.1.0 and oCIS 8.2.0 // commenting the headline to make it better includable -// table created per 2026.09.10 +// table created per 2026.11.04 // the table should be recreated/updated on source () changes [width="100%",cols="~,~,~,~",options="header"] |=== | Service | Variable | Description | Default -| xref:deployment/services/env-vars-special-scope.adoc[Special Scope Envvars] -| OCIS_LDAP_INSTANCE_MAPPER_CACHE_TTL -| Max TTL in seconds for the LDAP instance mapper cache. Requires OCIS_MULTI_INSTANCE_ENABLED. -| 60000000000 - | xref:{s-path}/graph.adoc[Graph] | GRAPH_MAX_IMAGE_FILE_SIZE | The maximum file size of an image which can be set as a space image. Must be less than or equal to 'THUMBNAILS_MAX_INPUT_IMAGE_FILE_SIZE' of the thumbnails service, otherwise images between the two values are accepted but cannot be rendered. Usable common abbreviations: [KB, KiB, MB, MiB, GB, GiB, TB, TiB, PB, PiB, EB, EiB], example: 2GB. Set to 0 to not limit the file size. diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/extended/extended_configvars.adoc b/content/ocis/8.2/modules/admin/examples/ocis_helpers/extended/extended_configvars.adoc index d2ba41a1..9ca1e229 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/extended/extended_configvars.adoc +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/extended/extended_configvars.adoc @@ -13,13 +13,22 @@ -a| `GRPC_MAX_CONNECTION_AGE` + +// manually added: GRPC PR #13020 (8.2.1 backport); re-verify on next ocis_helper run +a| `GRPC_CLIENT_KEEPALIVE_TIME` + a| [subs=-attributes] ++Duration ++ a| [subs=-attributes] -++9223372036854775807 ++ +++0s ++ a| [subs=-attributes] -++Timeout for GRPC connections. After timeout, a new connection will be established automatically. The default value is in ns and is about 2.5 mio h. ++ +++How long a grpc client connection with an ongoing request may stay silent before the server is pinged to check whether it is still answering. Set a duration like '20s' to enable detection of unresponsive peers. Leaving it unset, or at '0', sends no pings at all, which is grpc's own default. Values below '10s' are raised to '10s' by grpc. Make sure to include the unit suffix, a bare number is not a valid duration. ++ + +a| `GRPC_CLIENT_KEEPALIVE_TIMEOUT` + +a| [subs=-attributes] +++Duration ++ +a| [subs=-attributes] +++0s ++ +a| [subs=-attributes] +++How long a grpc client waits for the answer to a keepalive ping before it considers the connection dead and fails all requests on it. Defaults to '10s'. Has no effect unless GRPC_CLIENT_KEEPALIVE_TIME is set. See GRPC_CLIENT_KEEPALIVE_TIME. ++ a| `MICRO_LOG_LEVEL` + a| [subs=-attributes] diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/activitylog-config-example.yaml b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/activitylog-config-example.yaml index f698a699..c6640994 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/activitylog-config-example.yaml +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/activitylog-config-example.yaml @@ -38,6 +38,7 @@ store: tls_root_ca_certificate: "" reva_gateway: com.owncloud.api.gateway grpc_client_tls: null +grpc_client_options: null http: addr: 127.0.0.1:9195 root: / diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/auth-app-config-example.yaml b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/auth-app-config-example.yaml index 4b0112cb..52491360 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/auth-app-config-example.yaml +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/auth-app-config-example.yaml @@ -44,6 +44,7 @@ http: cert: "" key: "" grpc_client_tls: null +grpc_client_options: null token_manager: jwt_secret: "" reva: diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/eventhistory-config-example.yaml b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/eventhistory-config-example.yaml index 199e1c8c..861d75ee 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/eventhistory-config-example.yaml +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/eventhistory-config-example.yaml @@ -20,6 +20,7 @@ grpc: addr: 127.0.0.1:9274 tls: null grpc_client_tls: null +grpc_client_options: null events: endpoint: 127.0.0.1:9233 cluster: ocis-cluster diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/frontend-config-example.yaml b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/frontend-config-example.yaml index b0579ed1..3a68cf8b 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/frontend-config-example.yaml +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/frontend-config-example.yaml @@ -112,6 +112,9 @@ ocs: stat_cache_disable_persistence: false stat_cache_auth_username: "" stat_cache_auth_password: "" + stat_cache_enable_tls: false + stat_cache_tls_insecure: false + stat_cache_tls_root_ca_certificate: "" enable_denials: false list_ocm_shares: true include_ocm_sharees: false @@ -138,6 +141,7 @@ events: username: "" password: "" grpc_client_tls: null +grpc_client_options: null auto_accept_shares: true service_account: service_account_id: "" diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/graph-config-example.yaml b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/graph-config-example.yaml index eab5b5f6..21e3f5f2 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/graph-config-example.yaml +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/graph-config-example.yaml @@ -55,6 +55,7 @@ http: - X-Requested-With - X-Request-Id - Purge + - X-Purge - Restore allow_credentials: true api: @@ -71,6 +72,7 @@ reva: token_manager: jwt_secret: "" grpc_client_tls: null +grpc_client_options: null application: id: "" displayname: ownCloud Infinite Scale @@ -83,7 +85,7 @@ spaces: groups_cache_ttl: 60000000000 storage_users_address: com.owncloud.api.storage-users storage_users_vault_address: com.owncloud.api.storage-users-vault - default_language: "" + default_language: en translation_path: "" identity: backend: ldap @@ -149,6 +151,7 @@ identity: instance_mapper_id_attribute: "" cross_instance_reference_template: "" instance_url_template: "" + instance_mapper_cache_ttl: 60000000000 include_ocm_sharees: false events: endpoint: 127.0.0.1:9233 diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/notifications-config-example.yaml b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/notifications-config-example.yaml index bde53370..93b33d6a 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/notifications-config-example.yaml +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/notifications-config-example.yaml @@ -37,12 +37,16 @@ notifications: password: "" email_template_path: "" translation_path: "" - default_language: "" + default_language: en reva_gateway: com.owncloud.api.gateway grpc_client_tls: null grpc_client_tls: mode: "" cacert: "" +grpc_client_options: + grpc_max_received_message_size: 0 + grpc_client_keepalive_time: 0s + grpc_client_keepalive_timeout: 0s service_account: service_account_id: "" service_account_secret: "" diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/ocdav-config-example.yaml b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/ocdav-config-example.yaml index 350371e8..6b9557ee 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/ocdav-config-example.yaml +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/ocdav-config-example.yaml @@ -79,3 +79,4 @@ insecure: false gateway_request_timeout: 84300 machine_auth_api_key: "" allow_propfind_depth_infinity: false +disable_propfind_public_link_resolution: false diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/ocs-config-example.yaml b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/ocs-config-example.yaml index aa209a3e..c2ce995b 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/ocs-config-example.yaml +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/ocs-config-example.yaml @@ -43,6 +43,7 @@ http: cert: "" key: "" grpc_client_tls: null +grpc_client_options: null signing_keys: store: nats-js-kv addresses: diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/policies-config-example.yaml b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/policies-config-example.yaml index fd61d5b5..25e9335f 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/policies-config-example.yaml +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/policies-config-example.yaml @@ -18,6 +18,7 @@ events: username: "" password: "" grpc_client_tls: null +grpc_client_options: null log: level: "" pretty: false diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/proxy-config-example.yaml b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/proxy-config-example.yaml index 1dbb1786..981b9ea5 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/proxy-config-example.yaml +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/proxy-config-example.yaml @@ -29,6 +29,7 @@ reva: mode: "" cacert: "" grpc_client_tls: null +grpc_client_options: null role_quotas: {} policies: - name: ocis diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/search-config-example.yaml b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/search-config-example.yaml index 168ec569..82d2ef48 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/search-config-example.yaml +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/search-config-example.yaml @@ -27,6 +27,7 @@ reva: mode: "" cacert: "" grpc_client_tls: null +grpc_client_options: null events: endpoint: 127.0.0.1:9233 cluster: ocis-cluster diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/settings-config-example.yaml b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/settings-config-example.yaml index f07f95b8..f5214f8e 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/settings-config-example.yaml +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/settings-config-example.yaml @@ -45,6 +45,7 @@ grpc: addr: 127.0.0.1:9191 tls: null grpc_client_tls: null +grpc_client_options: null metadata_config: gateway_addr: com.owncloud.api.storage-system storage_addr: com.owncloud.api.storage-system @@ -72,5 +73,5 @@ token_manager: set_default_assignments: false service_account_ids: - service-user-id -default_language: "" +default_language: en translation_path: "" diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/sharing-config-example.yaml b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/sharing-config-example.yaml index 994a4d15..f539c3d0 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/sharing-config-example.yaml +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/sharing-config-example.yaml @@ -76,6 +76,7 @@ public_sharing_drivers: public_sharing_writeableshare_must_have_password: false public_sharing_share_must_have_password: true enable_expired_shares_cleanup: true +janitor_run_interval: 3600 enable_user_sharing: true enable_public_sharing: true password_policy: diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/thumbnails-config-example.yaml b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/thumbnails-config-example.yaml index ae925ccf..1d49c897 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/thumbnails-config-example.yaml +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/thumbnails-config-example.yaml @@ -47,6 +47,7 @@ http: - Cache-Control allow_credentials: true grpc_client_tls: null +grpc_client_options: null thumbnail: resolutions: - 16x16 diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/userlog-config-example.yaml b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/userlog-config-example.yaml index 321823c6..da7e628d 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/userlog-config-example.yaml +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/userlog-config-example.yaml @@ -38,11 +38,12 @@ http: cert: "" key: "" grpc_client_tls: null +grpc_client_options: null token_manager: jwt_secret: "" reva_gateway: com.owncloud.api.gateway translation_path: "" -default_language: "" +default_language: en events: endpoint: 127.0.0.1:9233 cluster: ocis-cluster diff --git a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/webdav-config-example.yaml b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/webdav-config-example.yaml index b9cbb788..a01268e3 100644 --- a/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/webdav-config-example.yaml +++ b/content/ocis/8.2/modules/admin/examples/ocis_helpers/yaml/webdav-config-example.yaml @@ -17,6 +17,7 @@ debug: pprof: false zpages: false grpc_client_tls: null +grpc_client_options: null http: addr: 127.0.0.1:9115 root: / diff --git a/content/ocis/8.2/modules/admin/pages/deployment/gdpr/gdpr.adoc b/content/ocis/8.2/modules/admin/pages/deployment/gdpr/gdpr.adoc index 997ee384..9bb3ccc9 100644 --- a/content/ocis/8.2/modules/admin/pages/deployment/gdpr/gdpr.adoc +++ b/content/ocis/8.2/modules/admin/pages/deployment/gdpr/gdpr.adoc @@ -7,6 +7,10 @@ {description} When using Keycloak, some environment variables must be configured to gather user-relevant data stored in Keycloak, completing the report. +== Limits + +To stop things being misused, the number of GDPR report requests that can be made in one minute by each user is limited to five. + == Configuration If Keycloak is used for authentication, GDPR regulations require to add all personal identifiable information that Keycloak has about the user to the personal data export. To configure these settings, see the xref:{s-path}/graph.adoc#keycloak-configuration-for-the-personal-data-export[Keycloak Configuration for the Personal Data Export] for more details. Beside that, no additional configuration is necessary as everything works out of the box. diff --git a/content/ocis/8.2/modules/admin/pages/deployment/general/general-info.adoc b/content/ocis/8.2/modules/admin/pages/deployment/general/general-info.adoc index bf5e8461..260b7c25 100644 --- a/content/ocis/8.2/modules/admin/pages/deployment/general/general-info.adoc +++ b/content/ocis/8.2/modules/admin/pages/deployment/general/general-info.adoc @@ -673,6 +673,8 @@ The volume names needed to reset the password are: * `ocis_wopi_ocis-config`. -- +NOTE: In addition to the admin and regular users, the passwords of internal service accounts (`libregraph`, `idp`, `reva`) can also be reset from the command line. See the xref:{s-path}/idm.adoc#internal-service-accounts[Internal Service Accounts] section in the IDM service documentation for details. + === Demo Users and Groups ==== Create Demo Users and Groups diff --git a/content/ocis/8.2/modules/admin/pages/deployment/services/s-list/idm.adoc b/content/ocis/8.2/modules/admin/pages/deployment/services/s-list/idm.adoc index f83b9770..d9a545ba 100644 --- a/content/ocis/8.2/modules/admin/pages/deployment/services/s-list/idm.adoc +++ b/content/ocis/8.2/modules/admin/pages/deployment/services/s-list/idm.adoc @@ -89,6 +89,98 @@ LDAPTLS_REQCERT=never \ Extract the `idm_password` password to enter from the `ocis.yaml` config file which is located in the Infinite Scale xref:deployment/general/general-info.adoc#configuration-directory[configuration directory]. +== Resetting Lost Passwords + +The `resetpassword` sub-command resets the password of any account stored in the built-in IDM, whether that is the administrator, a regular user, or one of the internal service accounts. + +[source,plaintext] +---- +NAME: + ocis idm resetpassword - Reset user password + +USAGE: + ocis idm resetpassword [command options] + +CATEGORY: + password reset + +OPTIONS: + --user-name value, -u value User name (default: "admin") + --user-type value Type of user account: 'user' (ou=users) or 'service' (ou=sysusers) (default: "user") + --help, -h show help +---- + +[NOTE] +==== +As this command accesses the IDM database directly, Infinite Scale must *not* be running and no other process may be accessing the database when you issue it. +==== + +=== Administrator Account + +If the password of the built-in `admin` account is ever lost, run the command without any options — it defaults to the `admin` account: + +[source,bash] +---- +ocis idm resetpassword +---- + +The command prompts for the new password twice and updates the account on confirmation. + +=== Any Other User Account + +To reset the password of any other regular user stored in the built-in IDM, provide the account name with the `--user-name` option: + +[source,bash] +---- +ocis idm resetpassword --user-name +---- + +The command prompts for the new password twice and updates the account on confirmation. + +=== Internal Service Accounts + +As described in xref:#default-and-demo-users[Default and Demo Users], IDM maintains three internal service accounts that Infinite Scale services use to access the built-in directory: `libregraph`, `idp`, and `reva`. Normally their passwords are set during initialization and never need to change. Use this procedure only if the passwords have gone out of sync between the IDM database and the Infinite Scale configuration, for example after a manual database restore. + +[cols="1,2,3",options="header"] +|=== +| Account +| Used by +| Environment Variables to Update + +| `libregraph` +| Graph service — manages users and groups in the directory; has write access +| `GRAPH_LDAP_BIND_PASSWORD`, + +`IDM_SVC_PASSWORD` + +| `idp` +| IDP service — looks up users during login +| `IDP_LDAP_BIND_PASSWORD`, + +`IDM_IDPSVC_PASSWORD` + +| `reva` +| Auth-Basic, Users, and Groups services — read access to the directory +| `AUTH_BASIC_LDAP_BIND_PASSWORD`, `USERS_LDAP_BIND_PASSWORD`, `GROUPS_LDAP_BIND_PASSWORD`, `IDM_REVASVC_PASSWORD` +|=== + +IMPORTANT: `OCIS_LDAP_BIND_PASSWORD` is a single shared variable that sets the password for all three accounts at once. If you use it instead of the per-service variables, updating it and restarting Infinite Scale is sufficient. + +Run the command with `--user-type service` and the account name: + +[source,bash] +---- +ocis idm resetpassword --user-type service --user-name +---- + +Replace `` with one of: `libregraph`, `idp`, or `reva`. The command prompts for the new password twice. After confirmation it performs two additional steps automatically: + +* It rewrites the affected password entries in `ocis.yaml` (if that file is present in the configuration directory). +* It prints the names of all environment variables that must also be updated wherever they are configured — in environment files, container secrets, Kubernetes secrets, or any other external configuration store. + +[IMPORTANT] +==== +After changing a service account password, Infinite Scale must be restarted so all affected services pick up the new credentials. +==== + == Configuration include::partial$deployment/services/env-and-yaml.adoc[tag=envvars-yaml] diff --git a/content/ocis/8.2/modules/admin/pages/deployment/services/s-list/search.adoc b/content/ocis/8.2/modules/admin/pages/deployment/services/s-list/search.adoc index ff21bd35..8aa74153 100644 --- a/content/ocis/8.2/modules/admin/pages/deployment/services/s-list/search.adoc +++ b/content/ocis/8.2/modules/admin/pages/deployment/services/s-list/search.adoc @@ -189,7 +189,18 @@ ocis search index --space $SPACE_ID || --all-spaces * IDs but not names are necessary as parameter. ** See the xref:maintenance/space-ids/space-ids.adoc[Listing Space IDs] for how to retrieve a space ID. -* The arguments `-space` and `--all-spaces` are mutual exclusive , but one must be provided. +* The arguments `--space` and `--all-spaces` are mutually exclusive, but one must be provided. + +==== Compact the Search Index + +The search performance can degrade over time after bulk reindexing operations that create many small index segments. Use this command to compact the search index by merging Bleve segments without reindexing the content. + +[source,bash] +---- +ocis search optimize +---- + +NOTE: Although this command accesses the search index directly and does not block search queries, it is still recommended that it is issued during a maintenance window. == Notes diff --git a/content/ocis/8.2/modules/admin/pages/deployment/services/s-list/storage-users.adoc b/content/ocis/8.2/modules/admin/pages/deployment/services/s-list/storage-users.adoc index e54ecf6b..3d83942a 100644 --- a/content/ocis/8.2/modules/admin/pages/deployment/services/s-list/storage-users.adoc +++ b/content/ocis/8.2/modules/admin/pages/deployment/services/s-list/storage-users.adoc @@ -40,6 +40,38 @@ To authenticate CLI commands use: The `storage-users` CLI tool uses the default address to establish the connection to the xref:{s-path}/gateway.adoc[gateway] service. If the connection fails, check your custom `gateway` service `GATEWAY_GRPC_ADDR` configuration and set the same address in `storage-users` `OCIS_GATEWAY_GRPC_ADDR` or `STORAGE_USERS_GATEWAY_GRPC_ADDR`. +=== Command Set Overview + +The following commands are available in the `ocis storage-users` command set: + +[source,bash] +---- +ocis storage-users -h +NAME: + ocis storage-users - storage-users service commands + +USAGE: + ocis storage-users [command options] + +CATEGORY: + services + +COMMANDS: + uploads manage unfinished uploads + trash-bin manage trash-bin's + spaces manage spaces + blobstore manage the blobstore + help, h Shows a list of commands or help for one command + info: + health check health status + version print the version of this binary and the running service instances + server: + server start the storage-users service without runtime (unsupervised mode) + +OPTIONS: + --help, -h show help +---- + === Manage Unfinished or Stale Uploads When using Infinite Scale as user storage, a directory named `storage/users/uploads` can be found in the Infinite Scale data folder. This is an intermediate directory based on {tus-url}[TUS] which is an open protocol for resumable uploads. Each upload consists of a _blob_ and a _blob.info_ file. Note that the term _blob_ is just a placeholder. @@ -327,6 +359,44 @@ ocis storage-users trash-bin restore [command options] ['spaceID' required] ['it ---- -- +=== Verify and Inspect the Configured Blobstore + +Verify and inspect the configured blobstore without requiring direct access to the underlying storage system. + +==== Command Details + +The following command can verify and inspect the configured blobstore. + +.Usage: + +[source,bash] +---- +ocis storage-users blobstore -h +NAME: + ocis storage-users blobstore - manage the blobstore + +USAGE: + ocis storage-users blobstore [command options] + +COMMANDS: + check check blobstore connectivity via an upload/download/delete round-trip + get get a blob from the blobstore by ID + help, h Shows a list of commands or help for one command + +OPTIONS: + --help, -h show help +---- + +.Notes: + +* `blobstore check` + +Performs a full upload/download/delete round-trip using a random payload. The payload size is configurable via `--blob-size` and accepts human-readable values such as `64`, `1KB` or `4MiB` (default: 64 bytes). + +* `blobstore get` + +Downloads a specific blob by its ID to verify it is readable. The blob can be identified either with `--blob-id` and `--space-id`, or by passing the raw blob path from a log line directly via `--path`. Both the s3ng key format (`/`) and the ocis filesystem path format (`…/spaces//blobs/`) are accepted. When using the s3ng driver without a known blob size, an automatic retry with the actual size is performed on a size mismatch. + +As both commands read the existing service configuration, they always target the same blobstore as the running service. Only the `ocis` and `s3ng` storage drivers are supported. + == Resource Optimisation See the xref:deployment/storage/general-considerations.adoc#resource-optimisation[General Storage Considerations and Settings] documentation for details about configuring the `STORAGE_USERS_OCIS_MAX_CONCURRENCY` environment variable. diff --git a/content/ocis/8.2/modules/admin/pages/maintenance/commands/changed-cli.adoc b/content/ocis/8.2/modules/admin/pages/maintenance/commands/changed-cli.adoc index 65df72af..1385cd91 100644 --- a/content/ocis/8.2/modules/admin/pages/maintenance/commands/changed-cli.adoc +++ b/content/ocis/8.2/modules/admin/pages/maintenance/commands/changed-cli.adoc @@ -15,3 +15,12 @@ See the link for a detailed description of the respective CLI command if availab * xref:maintenance/commands/commands.adoc#clean-corrupt-public-shares[Clean Corrupt Public Shares] + This CLI command has been added to detect and remove corrupt public share entries. + +* xref:maintenance/commands/commands.adoc#compact-the-search-index[Compact the Search Index] + +This CLI command has been added to compact the search index. + +* xref:maintenance/commands/commands.adoc#reset-password-for-idm-users[Reset Password for IDM Users] + +This CLI command has been updated with new options. + +* xref:maintenance/commands/commands.adoc#verify-and-inspect-a-configured-blobstore[Verify and Inspect a Configured Blobstore] + +This CLI command has been added to Inspect and Verify a configured Blobstore (S3). diff --git a/content/ocis/8.2/modules/admin/pages/maintenance/commands/commands.adoc b/content/ocis/8.2/modules/admin/pages/maintenance/commands/commands.adoc index e12c6a0b..d61bdc32 100644 --- a/content/ocis/8.2/modules/admin/pages/maintenance/commands/commands.adoc +++ b/content/ocis/8.2/modules/admin/pages/maintenance/commands/commands.adoc @@ -84,6 +84,10 @@ Detect and, if desired, delete storage grants that have no corresponding share-m When a shared space or directory got deleted, use the following xref:maintenance/commands/cleanup-orphaned-shares.adoc[CLI command] to cleanup those share orphans. This can't be done automatically at the moment. +=== Compact the Search Index + +The search performance can degrade over time after bulk reindexing operations that create many small index segments. Use the following xref:{s-path}/search.adoc#compact-the-search-index[CLI command] to compact the search index for improved search performance. + === Inspect and Manipulate Node Metadata Infinite Scale provides a xref:maintenance/commands/node-metadata.adoc[CLI command] with which you can inspect and manipulate node metadata. @@ -118,7 +122,6 @@ WARNING: Use this command with absolute care. It is not intended to play around If post-processing fails in one step due to an unforeseen error, current uploads will not be retried automatically. A system administrator can instead run a xref:{s-path}/postprocessing.adoc#cli-commands[CLI Command] to retry the failed upload. - === Roll Back / Roll Forward Decomposedfs Migrations A xref:maintenance/commands/rolling-back-and-forward.adoc[CLI command] is provided to roll back or roll forward a decomposedfs migration. @@ -129,6 +132,6 @@ WARNING: Use this command with absolute care. It is not intended to play around This command is about sending emails based on events stored in a named group bucket. See the xref:{s-path}/notifications.adoc#sending-grouped-emails[Sending Grouped Emails] section in the _notification_ service for details. -=== Verify and Inspect a Blobstore +=== Verify and Inspect a Configured Blobstore -This command has been added to verify and inspect the configured Blobstore without requiring direct access to the underlying storage system. Use the following xref:maintenance/commands/verify-and-inspect-blobstore.adoc[CLI command] for this task. +This command has been added to verify and inspect the configured blobstore without requiring direct access to the underlying storage system. Use the following xref:{s-path}/storage-users.adoc#verify-and-inspect-the-configured-blobstore[CLI command] for this task. diff --git a/content/ocis/8.2/modules/admin/pages/maintenance/commands/verify-and-inspect-blobstore.adoc b/content/ocis/8.2/modules/admin/pages/maintenance/commands/verify-and-inspect-blobstore.adoc deleted file mode 100644 index fae3f3c0..00000000 --- a/content/ocis/8.2/modules/admin/pages/maintenance/commands/verify-and-inspect-blobstore.adoc +++ /dev/null @@ -1,40 +0,0 @@ -= Verify and Inspect a Blobstore -:toc: right - -Verify and inspect the configured Blobstore without requiring direct access to the underlying storage system. - -include::partial$/maintenance/ocis-storage-users-cli.adoc[] - -== Command Details - -The following command can verify and inspect the configured Blobstore. - -.Usage: - -[source,bash] ----- -ocis storage-users blobstore -h -NAME: - ocis storage-users blobstore - manage the blobstore - -USAGE: - ocis storage-users blobstore [command options] - -COMMANDS: - check check blobstore connectivity via an upload/download/delete round-trip - get get a blob from the blobstore by ID - help, h Shows a list of commands or help for one command - -OPTIONS: - --help, -h show help ----- - -.Notes: - -* `blobstore check` + -Performs a full upload/download/delete round-trip using a random payload. The payload size is configurable via `--blob-size` and accepts human-readable values such as `64`, `1KB` or `4MiB` (default: 64 bytes). - -* `blobstore get` + -Downloads a specific blob by its ID to verify it is readable. The blob can be identified either with `--blob-id` and `--space-id`, or by passing the raw blob path from a log line directly via `--path`. Both the s3ng key format (`/`) and the ocis filesystem path format (`…/spaces//blobs/`) are accepted. When using the s3ng driver without a known blob size, an automatic retry with the actual size is performed on a size mismatch. - -As both commands read the existing service configuration, they always target the same blobstore as the running service. Only the `ocis` and `s3ng` storage drivers are supported. diff --git a/content/ocis/8.2/modules/admin/pages/migration/upgrading-ocis.adoc b/content/ocis/8.2/modules/admin/pages/migration/upgrading-ocis.adoc index cac5ab9e..2e5fd22d 100644 --- a/content/ocis/8.2/modules/admin/pages/migration/upgrading-ocis.adoc +++ b/content/ocis/8.2/modules/admin/pages/migration/upgrading-ocis.adoc @@ -20,6 +20,20 @@ IMPORTANT: When upgrading from an older release to the desired one, *ALL* upgrad IMPORTANT: When upgrading from an older release to the desired one, mandatory configuration settings may have been added or removed. To see the changes required, you can run `ocis init --diff` after upgrading but before finally starting. For more details, see the xref:deployment/general/ocis-init.adoc[ocis init command] description. +== Version 8.1.0 to 8.2.0 + +=== Notable Changes Requiring Manual Intervention + +There are no changes in Infinite Scale 8.2 that require manual intervention, but other notable changes have been implemented. + +=== Breaking Changes Requiring Manual Intervention + +There are no breaking changes in Infinite Scale 8.1. + +=== Upgrade Steps + +For a detailed description of the steps to upgrade, see the xref:migration/upgrading_8.1.0_8.2.0.adoc[Upgrading from 8.1.0 to 8.2.0] documentation. Note that this document also contains references to added/changed/removed CLI commands and environment variables. + == Version 8.0.0 to 8.1.0 === Notable Changes Requiring Manual Intervention diff --git a/content/ocis/8.2/modules/admin/pages/migration/upgrading_8.1.0_8.2.0.adoc b/content/ocis/8.2/modules/admin/pages/migration/upgrading_8.1.0_8.2.0.adoc new file mode 100644 index 00000000..776d516f --- /dev/null +++ b/content/ocis/8.2/modules/admin/pages/migration/upgrading_8.1.0_8.2.0.adoc @@ -0,0 +1,123 @@ += Upgrading from 8.1.0 to 8.2.0 +:toc: right +:description: This document describes the necessary steps when upgrading Infinite Scale from release 8.1.0 to 8.2.0. + +// define the actual version of this release. it may contain a patch version that needs to be updated accordingly +:actual_ocis_version: '8.2.2' + +include::partial$multi-location/compose-version.adoc[] + +== Introduction + +{description} + +IMPORTANT: Read the important notes in the xref:migration/upgrading-ocis.adoc#introduction[Upgrading Infinite Scale] documentation before you start. + +IMPORTANT: Check below, if you are affected by breaking changes and prepare all steps mentioned before you start the upgrade. + +== Upgrade Steps + +. Download and install Infinite Scale + +*Do not start it after downloading the image*! +. Shut down the Infinite Scale instance +. We strongly recommend doing a backup +. Reconfigure the deployment +. Manage Breaking Changes +. Notabale Changes +. Manage Added/Removed/Deprecated environment variables +. Start Infinite Scale + +:sectnums: + +== Download and Install Infinite Scale + +Download and install Infinite Scale: + +* Issue the following command to download the new image: ++ +[source,bash,subs="attributes+"] +---- +docker pull owncloud/ocis:{actual_ocis_version} +---- + +== Shut Down the Infinite Scale Instance + +Depending how you deployed Infinite Scale, you need to shut it down differently. + +* *docker compose* + +For deployments using `docker compose` do a graceful shutdown as described in xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc#stop-the-deployment[Stop the Deployment]. + +* *Any other image based deployment* + +For any other image based deployment, shut down Infinite Scale according the vendors deployment description. + +== Backup of Infinite Scale + +See the xref:maintenance/b-r/backup_considerations.adoc[Backup Considerations] and the xref:maintenance/b-r/backup.adoc[Backup] documentation for more details. + +== Reconfigure the Deployment + +Reconfigure the deployment to use the new image: + +* For `docker compose` +** Update _every_ compose file where the `ocis image` is referenced accordingly. +** If you have used the deployment examples either for xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc[Local Production Setup] or xref:depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc[Deployment on Hetzner], read the *Updating and Upgrading* section of those pages carefully. + +== Manage Breaking Changes + +There are no breaking changes in Infinite Scale 8.2 + +== Notabale Changes + +* The deployment examples now include KeyCloak as an option. + +* The OIDC group synchronization is now opt-in. + +*Upgrade note.* +** Deployments that set `PROXY_AUTOPROVISION_CLAIM_GROUPS` explicitly will not be affected. +** Deployments that relied on the previous 'groups' default setting will stop synchronising group memberships after upgrading. Set `PROXY_AUTOPROVISION_CLAIM_GROUPS=groups` to restore the previous behaviour. + +* The `ocis_full` and `ocis_ocm` deployment examples now ship a hardened Collabora configuration. +** Collabora is restricted to the hosts it needs, runs on its own internal network that only the proxy and the collaboration service share, and the admin console requires explicitly configured credentials (`COLLABORA_ADMIN_USER` and `COLLABORA_ADMIN_PASSWORD`). If you copy these examples, make sure to set the credentials in your `.env` file. +** Note for operators: when updating the COLLABORA_DOCKER_TAG, diff the image's stock `/etc/coolwsd/coolwsd.xml` against the compose file `config/coolwsd/coolwsd.xml` and merge changes manually. + +* The `keycloak.yml` in the deployment examples have changed — operator action may be required: +** The PostgreSQL volume path has been corrected corrected: + +`/var/lib/postgresql/data` → `/var/lib/postgresql` + +For upgrades, this is a *breakingchange*: + +If the existing volume was created with the old path, data may appear missing after the change. Volume migration or recreation may be needed before upgrading. + +== Reconfigure Deployment Examples + +The following steps are based on the xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc[Local Production Setup] deployment example. The steps are identical for the xref:depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc[Deployment on Hetzner]. + +* Stop the deployment example + +* Backup the the base folder containing the existing deployment example by renaming it. + +You will need your configuration details with the new example. + +* Follow the xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc#download-and-transfer-the-example[Download and Transfer Example] link to get the new deployment and extract it as described in the following section of the guide. + +* Reconfigure the new `.env` file based on settings made in the `.env` file of the backup. +** Note that defined image versions have changed for: + +`Traefik`, `Collabora` and `OnlyOffice`. + +The provided versions have been tested. Update at your own risk. Note that this applies in particular when using `latest`. The image versions are subject to change if a new deployment example is provided. + +** The version of other images using the `latest` tag may also have changed. +** Pull the new image versions with `docker compose pull`. + +* Start the deployment example. + +== Start Infinite Scale + +When you have finished upgrading, you now can start Infinite Scale as usual. + +For any deployment used, you now can delete/remove old binaries or images/containers. + +:sectnums!: + +== Changed or Added CLI Commands + +See the xref:maintenance/commands/changed-cli.adoc[Changed or Added CLI Commands] document for details. + +== Changed Environment Variables + +See the xref:deployment/services/env-var-changes.adoc[Changed Environment Variables in Versions] document for details. diff --git a/content/ocis/8.2/modules/admin/partials/maintenance/ocis-storage-users-cli.adoc b/content/ocis/8.2/modules/admin/partials/maintenance/ocis-storage-users-cli.adoc deleted file mode 100644 index 04b4f65d..00000000 --- a/content/ocis/8.2/modules/admin/partials/maintenance/ocis-storage-users-cli.adoc +++ /dev/null @@ -1,31 +0,0 @@ -== Command Set Overview - -The described command is part of the `ocis storage-users` command set: - -[source,bash] ----- -ocis storage-users -h -NAME: - ocis storage-users - storage-users service commands - -USAGE: - ocis storage-users [command options] - -CATEGORY: - services - -COMMANDS: - uploads manage unfinished uploads - trash-bin manage trash-bins - spaces manage spaces - blobstore manage the blobstore - help, h Shows a list of commands or help for one command - info: - health check health status - version print the version of this binary and the running service instances - server: - server start the storage-users service without runtime (unsupervised mode) - -OPTIONS: - --help, -h show help ----- diff --git a/content/ocis/8.2/services/persistent_files/delta_config.yaml b/content/ocis/8.2/services/persistent_files/delta_config.yaml index 7dbfcd77..eb79b05a 100644 --- a/content/ocis/8.2/services/persistent_files/delta_config.yaml +++ b/content/ocis/8.2/services/persistent_files/delta_config.yaml @@ -11,7 +11,7 @@ versionNew: "8.2" # CHANGE according your needs (for printing, toVersion also to identify all other findings that should be excluded) fromVersion: "8.1.0" -toVersion: "8.2.0" +toVersion: "8.2.3" # CHANGE according your needs (for file names to be created) # this will create files such as 8.0.0-8.1.0-added, 8.0.0-8.1.0-removed etc. @@ -43,4 +43,8 @@ defaultExcludePattern: # it is therefore highly recommended to use the dryrun flag first. extraExcludePattern: # - "" - - "8.3.0" + - "9.0.0" + # 8.2.0 env vars (introduced in the base 8.2.0 release, not in a patch) are out of scope + # for the added table when toVersion is set to a 8.2.x patch. Exclude them here so the + # added table does not report them as out-of-scope if regenerated in the future. + - "8.2.0" diff --git a/content/ocis/8.2/services/persistent_files/env_vars.yaml b/content/ocis/8.2/services/persistent_files/env_vars.yaml index ce472b44..2e182bea 100644 --- a/content/ocis/8.2/services/persistent_files/env_vars.yaml +++ b/content/ocis/8.2/services/persistent_files/env_vars.yaml @@ -208,7 +208,7 @@ ACTIVITYLOG_STORE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -239,7 +239,7 @@ ACTIVITYLOG_STORE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -249,7 +249,7 @@ ACTIVITYLOG_STORE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1930,45 +1930,50 @@ AUTH_BASIC_OWNCLOUDSQL_DB_HOST: type: string description: Hostname of the database server. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: AUTH_BASIC_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql + driver is deprecated. AUTH_BASIC_OWNCLOUDSQL_DB_NAME: name: AUTH_BASIC_OWNCLOUDSQL_DB_NAME defaultValue: owncloud type: string description: Name of the owncloud database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: AUTH_BASIC_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql + driver is deprecated. AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD: name: AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD defaultValue: "" type: string description: Password for the database user. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql + driver is deprecated. AUTH_BASIC_OWNCLOUDSQL_DB_PORT: name: AUTH_BASIC_OWNCLOUDSQL_DB_PORT defaultValue: "3306" type: int description: Network port to use for the database connection. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: AUTH_BASIC_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql + driver is deprecated. AUTH_BASIC_OWNCLOUDSQL_DB_USERNAME: name: AUTH_BASIC_OWNCLOUDSQL_DB_USERNAME defaultValue: owncloud type: string description: Database user to use for authenticating with the owncloud database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: AUTH_BASIC_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql + driver is deprecated. AUTH_BASIC_OWNCLOUDSQL_IDP: name: AUTH_BASIC_OWNCLOUDSQL_IDP defaultValue: https://localhost:9200 @@ -1976,36 +1981,40 @@ AUTH_BASIC_OWNCLOUDSQL_IDP: description: The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: AUTH_BASIC_OWNCLOUDSQL_IDP is deprecated because the owncloudsql + driver is deprecated. AUTH_BASIC_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID: name: AUTH_BASIC_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID defaultValue: "false" type: bool description: Join the user properties table to read user ID's. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: AUTH_BASIC_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID is deprecated because + the owncloudsql driver is deprecated. AUTH_BASIC_OWNCLOUDSQL_JOIN_USERNAME: name: AUTH_BASIC_OWNCLOUDSQL_JOIN_USERNAME defaultValue: "false" type: bool description: Join the user properties table to read usernames introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: AUTH_BASIC_OWNCLOUDSQL_JOIN_USERNAME is deprecated because the + owncloudsql driver is deprecated. AUTH_BASIC_OWNCLOUDSQL_NOBODY: name: AUTH_BASIC_OWNCLOUDSQL_NOBODY defaultValue: "90" type: int64 description: Fallback number if no numeric UID and GID properties are provided. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: AUTH_BASIC_OWNCLOUDSQL_NOBODY is deprecated because the owncloudsql + driver is deprecated. AUTH_BASIC_SKIP_USER_GROUPS_IN_TOKEN: name: AUTH_BASIC_SKIP_USER_GROUPS_IN_TOKEN defaultValue: "false" @@ -3045,7 +3054,7 @@ COLLABORATION_STORE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3076,7 +3085,7 @@ COLLABORATION_STORE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3086,7 +3095,7 @@ COLLABORATION_STORE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3423,7 +3432,7 @@ EVENTHISTORY_STORE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3454,7 +3463,7 @@ EVENTHISTORY_STORE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3464,7 +3473,7 @@ EVENTHISTORY_STORE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4433,7 +4442,7 @@ GATEWAY_PROVIDER_CACHE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4465,7 +4474,7 @@ GATEWAY_PROVIDER_CACHE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4475,7 +4484,7 @@ GATEWAY_PROVIDER_CACHE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4734,7 +4743,7 @@ GRAPH_CACHE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4784,7 +4793,7 @@ GRAPH_CACHE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4794,7 +4803,7 @@ GRAPH_CACHE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4821,7 +4830,7 @@ GRAPH_CORS_ALLOW_CREDENTIALS: GRAPH_CORS_ALLOW_HEADERS: name: OCIS_CORS_ALLOW_HEADERS;GRAPH_CORS_ALLOW_HEADERS defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id - Purge Restore]' + Purge X-Purge Restore]' type: '[]string' description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. @@ -6249,45 +6258,50 @@ GROUPS_OWNCLOUDSQL_DB_HOST: type: string description: Hostname of the database server. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql + driver is deprecated. GROUPS_OWNCLOUDSQL_DB_NAME: name: GROUPS_OWNCLOUDSQL_DB_NAME defaultValue: owncloud type: string description: Name of the owncloud database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql + driver is deprecated. GROUPS_OWNCLOUDSQL_DB_PASSWORD: name: GROUPS_OWNCLOUDSQL_DB_PASSWORD defaultValue: "" type: string description: Password for the database user. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql + driver is deprecated. GROUPS_OWNCLOUDSQL_DB_PORT: name: GROUPS_OWNCLOUDSQL_DB_PORT defaultValue: "3306" type: int description: Network port to use for the database connection. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql + driver is deprecated. GROUPS_OWNCLOUDSQL_DB_USERNAME: name: GROUPS_OWNCLOUDSQL_DB_USERNAME defaultValue: owncloud type: string description: Database user to use for authenticating with the owncloud database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql + driver is deprecated. GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH: name: GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH defaultValue: "false" @@ -6295,9 +6309,10 @@ GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH: description: Allow 'medial search' when searching for users instead of just doing a prefix search. This allows finding 'Alice' when searching for 'lic'. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH is deprecated because the + owncloudsql driver is deprecated. GROUPS_OWNCLOUDSQL_IDP: name: GROUPS_OWNCLOUDSQL_IDP defaultValue: https://localhost:9200 @@ -6305,36 +6320,40 @@ GROUPS_OWNCLOUDSQL_IDP: description: The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_IDP is deprecated because the owncloudsql driver + is deprecated. GROUPS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID: name: GROUPS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID defaultValue: "false" type: bool description: Join the user properties table to read user IDs. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID is deprecated because the + owncloudsql driver is deprecated. GROUPS_OWNCLOUDSQL_JOIN_USERNAME: name: GROUPS_OWNCLOUDSQL_JOIN_USERNAME defaultValue: "false" type: bool description: Join the user properties table to read usernames. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_JOIN_USERNAME is deprecated because the owncloudsql + driver is deprecated. GROUPS_OWNCLOUDSQL_NOBODY: name: GROUPS_OWNCLOUDSQL_NOBODY defaultValue: "90" type: int64 description: Fallback number if no numeric UID and GID properties are provided. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_NOBODY is deprecated because the owncloudsql + driver is deprecated. GROUPS_SKIP_USER_GROUPS_IN_TOKEN: name: GROUPS_SKIP_USER_GROUPS_IN_TOKEN defaultValue: "false" @@ -6383,6 +6402,31 @@ GROUPS_TRACING_TYPE: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +GRPC_CLIENT_KEEPALIVE_TIME: + name: GRPC_CLIENT_KEEPALIVE_TIME + defaultValue: 0s + type: Duration + description: How long a grpc client connection with an ongoing request may stay + silent before the server is pinged to check whether it is still answering. Set + a duration like '20s' to enable detection of unresponsive peers. Leaving it unset, + or at '0', sends no pings at all, which is grpc's own default. Values below '10s' + are raised to '10s' by grpc. Make sure to include the unit suffix, a bare number + is not a valid duration. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRPC_CLIENT_KEEPALIVE_TIMEOUT: + name: GRPC_CLIENT_KEEPALIVE_TIMEOUT + defaultValue: 0s + type: Duration + description: How long a grpc client waits for the answer to a keepalive ping before + it considers the connection dead and fails all requests on it. Defaults to '10s'. + Has no effect unless GRPC_CLIENT_KEEPALIVE_TIME is set. See GRPC_CLIENT_KEEPALIVE_TIME. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" IDM_ADMIN_PASSWORD: name: IDM_ADMIN_PASSWORD defaultValue: "" @@ -7852,7 +7896,7 @@ NOTIFICATIONS_STORE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7883,7 +7927,7 @@ NOTIFICATIONS_STORE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7893,7 +7937,7 @@ NOTIFICATIONS_STORE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8062,6 +8106,17 @@ OCDAV_DEBUG_ZPAGES: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +OCDAV_DISABLE_PROPFIND_PUBLIC_LINK_RESOLUTION: + name: OCDAV_DISABLE_PROPFIND_PUBLIC_LINK_RESOLUTION + defaultValue: "false" + type: bool + description: Disable the resolution of public link shares when answering PROPFIND + requests. When disabled, the oc:share-type property will not be populated with + public link share information, which can reduce load on services for large collections. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" OCDAV_EDITION: name: OCIS_EDITION;OCDAV_EDITION defaultValue: Community @@ -8365,7 +8420,9 @@ OCIS_CACHE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the signing key store. Only applies when store type 'nats-js-kv' is configured. | Activate TLS for the connection - to the cache store. Only applies when store type 'nats-js-kv' is configured. + to the cache store. Only applies when store type 'nats-js-kv' is configured. | + Activate TLS for the connection to the stat cache store. Only applies when using + the 'nats-js-kv' store type. introductionVersion: 8.3.0 deprecationVersion: "" removalVersion: "" @@ -8407,7 +8464,8 @@ OCIS_CACHE_TLS_INSECURE: description: Disable TLS certificate verification for the signing key store connection. Only applies when store type 'nats-js-kv' is configured. | Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' - is configured. + is configured. | Disable TLS certificate verification for the stat cache store + connection. Only applies when using the 'nats-js-kv' store type. introductionVersion: 8.3.0 deprecationVersion: "" removalVersion: "" @@ -8419,7 +8477,9 @@ OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE: description: Path to the PEM-encoded root CA certificate for the signing key store TLS connection. Only applies when store type 'nats-js-kv' is configured. | Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only - applies when store type 'nats-js-kv' is configured. + applies when store type 'nats-js-kv' is configured. | Path to the PEM-encoded + root CA certificate for the stat cache store TLS connection. Only applies when + using the 'nats-js-kv' store type. introductionVersion: 8.3.0 deprecationVersion: "" removalVersion: "" @@ -8509,7 +8569,9 @@ OCIS_CORS_ALLOW_HEADERS: Content-Type Accept X-Requested-With X-Request-Id] | [Authorization Origin Content-Type Accept X-Requested-With X-Request-Id Purge Restore] | [Authorization Origin X-Requested-With X-Request-Id X-HTTP-Method-Override Content-Type Upload-Length Upload-Offset Tus-Resumable - Upload-Metadata Upload-Defer-Length Upload-Concat Upload-Incomplete Upload-Draft-Interop-Version]' + Upload-Metadata Upload-Defer-Length Upload-Concat Upload-Incomplete Upload-Draft-Interop-Version] + | [Authorization Origin Content-Type Accept X-Requested-With X-Request-Id Purge + X-Purge Restore]' type: '[]string' description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. @@ -8828,6 +8890,18 @@ OCIS_GRPC_CLIENT_TLS_MODE: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +OCIS_GRPC_MAX_RECEIVED_MESSAGE_SIZE: + name: OCIS_GRPC_MAX_RECEIVED_MESSAGE_SIZE + defaultValue: "0" + type: int + description: The maximum body size for grpc requests. Defaults to '10240000' bytes + (10MB). Note that large values can potentially hide errors but may lead to network + timeouts. Should only be changed temporarily to regain access for large folders + with 25.000+ files to copy out data. + introductionVersion: pre5.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" OCIS_GRPC_PROTOCOL: name: OCIS_GRPC_PROTOCOL;APP_PROVIDER_GRPC_PROTOCOL;APP_REGISTRY_GRPC_PROTOCOL;AUTH_APP_GRPC_PROTOCOL;AUTH_BASIC_GRPC_PROTOCOL;AUTH_BEARER_GRPC_PROTOCOL;AUTH_MACHINE_GRPC_PROTOCOL;AUTH_SERVICE_GRPC_PROTOCOL;COLLABORATION_GRPC_PROTOCOL;GATEWAY_GRPC_PROTOCOL;GROUPS_GRPC_PROTOCOL;OCM_GRPC_PROTOCOL;SHARING_GRPC_PROTOCOL;STORAGE_PUBLICLINK_GRPC_PROTOCOL;STORAGE_SHARES_GRPC_PROTOCOL;STORAGE_SYSTEM_GRPC_PROTOCOL;STORAGE_USERS_GRPC_PROTOCOL;USERS_GRPC_PROTOCOL defaultValue: tcp @@ -9169,6 +9243,15 @@ OCIS_LDAP_INSTANCE_MAPPER_BASE_DN: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +OCIS_LDAP_INSTANCE_MAPPER_CACHE_TTL: + name: OCIS_LDAP_INSTANCE_MAPPER_CACHE_TTL + defaultValue: "60000000000" + type: int + description: Max TTL in seconds for the LDAP instance mapper cache. Requires OCIS_MULTI_INSTANCE_ENABLED. + introductionVersion: 8.2.1 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" OCIS_LDAP_INSTANCE_MAPPER_ENABLED: name: OCIS_LDAP_INSTANCE_MAPPER_ENABLED defaultValue: "false" @@ -9621,7 +9704,18 @@ OCIS_MULTI_INSTANCE_MASTER_ID: description: The master instance ID for multi-instance setups. When set, LDAP user filters are enhanced to also match users belonging to the master instance. | The master ID that grants access to all instances. Users with this ID in their memberOf - or guestOf claims can access any instance. Leave empty to disable. + or guestOf claims can access any instance. Leave empty to disable. | The master + instance ID for multi-instance setups. When set, LDAP user filters are enhanced + to also match users belonging to the master instance. Also set 'user_filter'. + Without an explicit 'user_filter', this instance resolves every user in the shared + LDAP directory. | The master instance ID for multi-instance setups. When set, + LDAP user filters are enhanced to also match users belonging to the master instance. + Also set 'user_filter'. Without an explicit 'user_filter', this instance allows + login for every user in the shared LDAP directory. | The master ID that grants + access to all instances. Users with this ID in their memberOf or guestOf claims + can access any instance. Leave empty to disable. Also set 'OCIS_LDAP_USER_FILTER'. + Without an explicit user filter, this instance resolves every user in the shared + LDAP directory. introductionVersion: "7.0" deprecationVersion: "" removalVersion: "" @@ -9900,6 +9994,27 @@ OCIS_SERVICE_ACCOUNT_SECRET: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +OCIS_SHARING_ENABLE_EXPIRED_SHARES_CLEANUP: + name: OCIS_SHARING_ENABLE_EXPIRED_SHARES_CLEANUP;SHARING_ENABLE_EXPIRED_SHARES_CLEANUP + defaultValue: "true" + type: bool + description: Enable the periodic removal of expired public shares. When disabled, + expired shares are still hidden from listings but never actually deleted. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_SHARING_JANITOR_RUN_INTERVAL: + name: OCIS_SHARING_JANITOR_RUN_INTERVAL;SHARING_JANITOR_RUN_INTERVAL + defaultValue: "3600" + type: int + description: Interval in seconds between two runs of the janitor that permanently + deletes expired public shares. Defaults to '3600' (1 hour). Only relevant when + OCIS_SHARING_ENABLE_EXPIRED_SHARES_CLEANUP is enabled. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD: name: OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD;SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD defaultValue: "true" @@ -10748,7 +10863,7 @@ OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the signing key store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10769,7 +10884,7 @@ OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the signing key store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10779,7 +10894,7 @@ OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the signing key store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11291,7 +11406,7 @@ POSTPROCESSING_STORE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11322,7 +11437,7 @@ POSTPROCESSING_STORE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11332,7 +11447,7 @@ POSTPROCESSING_STORE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11847,7 +11962,7 @@ PROXY_OIDC_USERINFO_CACHE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11888,7 +12003,7 @@ PROXY_OIDC_USERINFO_CACHE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11898,7 +12013,7 @@ PROXY_OIDC_USERINFO_CACHE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11970,7 +12085,7 @@ PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the signing key store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11991,7 +12106,7 @@ PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the signing key store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12001,7 +12116,7 @@ PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the signing key store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12537,7 +12652,7 @@ SETTINGS_CACHE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12569,7 +12684,7 @@ SETTINGS_CACHE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12579,7 +12694,7 @@ SETTINGS_CACHE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12913,6 +13028,16 @@ SHARING_DEBUG_ZPAGES: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +SHARING_ENABLE_EXPIRED_SHARES_CLEANUP: + name: OCIS_SHARING_ENABLE_EXPIRED_SHARES_CLEANUP;SHARING_ENABLE_EXPIRED_SHARES_CLEANUP + defaultValue: "true" + type: bool + description: Enable the periodic removal of expired public shares. When disabled, + expired shares are still hidden from listings but never actually deleted. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" SHARING_EVENTS_AUTH_PASSWORD: name: OCIS_EVENTS_AUTH_PASSWORD;SHARING_EVENTS_AUTH_PASSWORD defaultValue: "" @@ -12999,6 +13124,17 @@ SHARING_GRPC_PROTOCOL: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +SHARING_JANITOR_RUN_INTERVAL: + name: OCIS_SHARING_JANITOR_RUN_INTERVAL;SHARING_JANITOR_RUN_INTERVAL + defaultValue: "3600" + type: int + description: Interval in seconds between two runs of the janitor that permanently + deletes expired public shares. Defaults to '3600' (1 hour). Only relevant when + OCIS_SHARING_ENABLE_EXPIRED_SHARES_CLEANUP is enabled. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" SHARING_JWT_SECRET: name: OCIS_JWT_SECRET;SHARING_JWT_SECRET defaultValue: "" @@ -13411,54 +13547,60 @@ SHARING_USER_OWNCLOUDSQL_DB_HOST: type: string description: Hostname or IP of the database server. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: SHARING_USER_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql + driver is deprecated. SHARING_USER_OWNCLOUDSQL_DB_NAME: name: SHARING_USER_OWNCLOUDSQL_DB_NAME defaultValue: owncloud type: string description: Name of the database to be used. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: SHARING_USER_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql + driver is deprecated. SHARING_USER_OWNCLOUDSQL_DB_PASSWORD: name: SHARING_USER_OWNCLOUDSQL_DB_PASSWORD defaultValue: "" type: string description: Password for the database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: SHARING_USER_OWNCLOUDSQL_DB_PASSWORD is deprecated because the + owncloudsql driver is deprecated. SHARING_USER_OWNCLOUDSQL_DB_PORT: name: SHARING_USER_OWNCLOUDSQL_DB_PORT defaultValue: "3306" type: int description: Port that the database server is listening on. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: SHARING_USER_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql + driver is deprecated. SHARING_USER_OWNCLOUDSQL_DB_USERNAME: name: SHARING_USER_OWNCLOUDSQL_DB_USERNAME defaultValue: owncloud type: string description: Username for the database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: SHARING_USER_OWNCLOUDSQL_DB_USERNAME is deprecated because the + owncloudsql driver is deprecated. SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID: name: SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID defaultValue: "" type: string description: Mount ID of the ownCloudSQL users storage for mapping ownCloud 10 shares. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID is deprecated because + the owncloudsql driver is deprecated. SSE_CORS_ALLOW_CREDENTIALS: name: OCIS_CORS_ALLOW_CREDENTIALS;SSE_CORS_ALLOW_CREDENTIALS defaultValue: "true" @@ -13918,7 +14060,7 @@ STORAGE_PUBLICLINK_STORE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13959,7 +14101,7 @@ STORAGE_PUBLICLINK_STORE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13969,7 +14111,7 @@ STORAGE_PUBLICLINK_STORE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14226,7 +14368,7 @@ STORAGE_SYSTEM_CACHE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14258,7 +14400,7 @@ STORAGE_SYSTEM_CACHE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14268,7 +14410,7 @@ STORAGE_SYSTEM_CACHE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14813,7 +14955,7 @@ STORAGE_USERS_FILEMETADATA_CACHE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14845,7 +14987,7 @@ STORAGE_USERS_FILEMETADATA_CACHE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14855,7 +14997,7 @@ STORAGE_USERS_FILEMETADATA_CACHE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14963,7 +15105,7 @@ STORAGE_USERS_ID_CACHE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14995,7 +15137,7 @@ STORAGE_USERS_ID_CACHE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15005,7 +15147,7 @@ STORAGE_USERS_ID_CACHE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15222,54 +15364,60 @@ STORAGE_USERS_OWNCLOUDSQL_DATADIR: description: The directory where the filesystem storage will store SQL migration data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/owncloud. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_DATADIR is deprecated because the owncloudsql + driver is deprecated. STORAGE_USERS_OWNCLOUDSQL_DB_HOST: name: STORAGE_USERS_OWNCLOUDSQL_DB_HOST defaultValue: "" type: string description: Hostname or IP of the database server. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql + driver is deprecated. STORAGE_USERS_OWNCLOUDSQL_DB_NAME: name: STORAGE_USERS_OWNCLOUDSQL_DB_NAME defaultValue: owncloud type: string description: Name of the database to be used. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql + driver is deprecated. STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD: name: STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD defaultValue: owncloud type: string description: Password for the database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD is deprecated because the + owncloudsql driver is deprecated. STORAGE_USERS_OWNCLOUDSQL_DB_PORT: name: STORAGE_USERS_OWNCLOUDSQL_DB_PORT defaultValue: "3306" type: int description: Port that the database server is listening on. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql + driver is deprecated. STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME: name: STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME defaultValue: owncloud type: string description: Username for the database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME is deprecated because the + owncloudsql driver is deprecated. STORAGE_USERS_OWNCLOUDSQL_LAYOUT: name: STORAGE_USERS_OWNCLOUDSQL_LAYOUT defaultValue: '{{.Username}}' @@ -15277,18 +15425,20 @@ STORAGE_USERS_OWNCLOUDSQL_LAYOUT: description: Path layout to use to navigate into a users folder in an owncloud data directory introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_LAYOUT is deprecated because the owncloudsql + driver is deprecated. STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER: name: STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER defaultValue: /Shares type: string description: Name of the folder jailing all shares. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER is deprecated because the + owncloudsql driver is deprecated. STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR: name: STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR defaultValue: /var/lib/ocis/storage/uploadinfo @@ -15296,18 +15446,20 @@ STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR: description: The directory where the filesystem will store uploads temporarily. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/uploadinfo. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR is deprecated because + the owncloudsql driver is deprecated. STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT: name: STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT defaultValue: com.owncloud.api.users type: string description: Endpoint of the users provider. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT is deprecated + because the owncloudsql driver is deprecated. STORAGE_USERS_PERMISSION_ENDPOINT: name: STORAGE_USERS_PERMISSION_ENDPOINT;STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT defaultValue: com.owncloud.api.settings @@ -15324,9 +15476,10 @@ STORAGE_USERS_POSIX_GENERAL_SPACE_PATH_TEMPLATE: type: string description: Template string to construct the paths of the projects space roots. introductionVersion: 6.0.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_POSIX_GENERAL_SPACE_PATH_TEMPLATE is deprecated because + the posixfs storage driver is deprecated and will be removed in 9.0.0. STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT: name: STORAGE_USERS_PERMISSION_ENDPOINT;STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT defaultValue: com.owncloud.api.settings @@ -15334,18 +15487,20 @@ STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT: description: Endpoint of the permissions service. The endpoints can differ for 'ocis', 'posix' and 's3ng'. introductionVersion: 6.0.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT is deprecated because + the posixfs storage driver is deprecated and will be removed in 9.0.0. STORAGE_USERS_POSIX_PERSONAL_SPACE_PATH_TEMPLATE: name: STORAGE_USERS_POSIX_PERSONAL_SPACE_PATH_TEMPLATE defaultValue: users/{{.User.Username}} type: string description: Template string to construct the paths of the personal space roots. introductionVersion: 6.0.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_POSIX_PERSONAL_SPACE_PATH_TEMPLATE is deprecated + because the posixfs storage driver is deprecated and will be removed in 9.0.0. STORAGE_USERS_POSIX_ROOT: name: STORAGE_USERS_POSIX_ROOT defaultValue: /var/lib/ocis/storage/users @@ -15353,9 +15508,10 @@ STORAGE_USERS_POSIX_ROOT: description: The directory where the filesystem storage will store its data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/users. introductionVersion: 6.0.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_POSIX_ROOT is deprecated because the posixfs storage + driver is deprecated and will be removed in 9.0.0. STORAGE_USERS_POSIX_SCAN_DEBOUNCE_DELAY: name: STORAGE_USERS_POSIX_SCAN_DEBOUNCE_DELAY defaultValue: 1s @@ -15363,18 +15519,20 @@ STORAGE_USERS_POSIX_SCAN_DEBOUNCE_DELAY: description: The time in milliseconds to wait before scanning the filesystem for changes after a change has been detected. introductionVersion: 6.0.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_POSIX_SCAN_DEBOUNCE_DELAY is deprecated because the + posixfs storage driver is deprecated and will be removed in 9.0.0. STORAGE_USERS_POSIX_USE_SPACE_GROUPS: name: STORAGE_USERS_POSIX_USE_SPACE_GROUPS defaultValue: "false" type: bool description: Use space groups to manage permissions on spaces. introductionVersion: 6.0.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_POSIX_USE_SPACE_GROUPS is deprecated because the + posixfs storage driver is deprecated and will be removed in 9.0.0. STORAGE_USERS_POSIX_WATCH_FOLDER_KAFKA_BROKERS: name: STORAGE_USERS_POSIX_WATCH_FOLDER_KAFKA_BROKERS defaultValue: "" @@ -15382,9 +15540,10 @@ STORAGE_USERS_POSIX_WATCH_FOLDER_KAFKA_BROKERS: description: Comma-separated list of kafka brokers to read the watchfolder events from. introductionVersion: 6.0.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_POSIX_WATCH_FOLDER_KAFKA_BROKERS is deprecated because + the posixfs storage driver is deprecated and will be removed in 9.0.0. STORAGE_USERS_POSIX_WATCH_PATH: name: STORAGE_USERS_POSIX_WATCH_PATH defaultValue: "" @@ -15393,9 +15552,10 @@ STORAGE_USERS_POSIX_WATCH_PATH: and 'inotifywait' watcher, in which case it is the path of the file audit log file/base directory to watch. introductionVersion: 6.0.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_POSIX_WATCH_PATH is deprecated because the posixfs + storage driver is deprecated and will be removed in 9.0.0. STORAGE_USERS_POSIX_WATCH_TYPE: name: STORAGE_USERS_POSIX_WATCH_TYPE defaultValue: "" @@ -15404,9 +15564,10 @@ STORAGE_USERS_POSIX_WATCH_TYPE: filesystem. Currently available options are 'inotifywait' (default), 'gpfswatchfolder' and 'gpfsfileauditlogging'. introductionVersion: 6.0.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_POSIX_WATCH_TYPE is deprecated because the posixfs + storage driver is deprecated and will be removed in 9.0.0. STORAGE_USERS_PURGE_TRASH_BIN_PERSONAL_DELETE_BEFORE: name: STORAGE_USERS_PURGE_TRASH_BIN_PERSONAL_DELETE_BEFORE defaultValue: 720h0m0s @@ -16358,7 +16519,7 @@ USERLOG_STORE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -16389,7 +16550,7 @@ USERLOG_STORE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -16399,7 +16560,7 @@ USERLOG_STORE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -16937,45 +17098,50 @@ USERS_OWNCLOUDSQL_DB_HOST: type: string description: Hostname of the database server. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql + driver is deprecated. USERS_OWNCLOUDSQL_DB_NAME: name: USERS_OWNCLOUDSQL_DB_NAME defaultValue: owncloud type: string description: Name of the owncloud database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql + driver is deprecated. USERS_OWNCLOUDSQL_DB_PASSWORD: name: USERS_OWNCLOUDSQL_DB_PASSWORD defaultValue: secret type: string description: Password for the database user. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql + driver is deprecated. USERS_OWNCLOUDSQL_DB_PORT: name: USERS_OWNCLOUDSQL_DB_PORT defaultValue: "3306" type: int description: Network port to use for the database connection. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql + driver is deprecated. USERS_OWNCLOUDSQL_DB_USERNAME: name: USERS_OWNCLOUDSQL_DB_USERNAME defaultValue: owncloud type: string description: Database user to use for authenticating with the owncloud database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql + driver is deprecated. USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH: name: USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH defaultValue: "false" @@ -16983,9 +17149,10 @@ USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH: description: Allow 'medial search' when searching for users instead of just doing a prefix search. This allows finding 'Alice' when searching for 'lic'. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH is deprecated because the + owncloudsql driver is deprecated. USERS_OWNCLOUDSQL_IDP: name: USERS_OWNCLOUDSQL_IDP defaultValue: https://localhost:9200 @@ -16993,36 +17160,40 @@ USERS_OWNCLOUDSQL_IDP: description: The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_IDP is deprecated because the owncloudsql driver + is deprecated. USERS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID: name: USERS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID defaultValue: "false" type: bool description: Join the user properties table to read user IDs. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID is deprecated because the + owncloudsql driver is deprecated. USERS_OWNCLOUDSQL_JOIN_USERNAME: name: USERS_OWNCLOUDSQL_JOIN_USERNAME defaultValue: "false" type: bool description: Join the user properties table to read usernames introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_JOIN_USERNAME is deprecated because the owncloudsql + driver is deprecated. USERS_OWNCLOUDSQL_NOBODY: name: USERS_OWNCLOUDSQL_NOBODY defaultValue: "90" type: int64 description: Fallback number if no numeric UID and GID properties are provided. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_NOBODY is deprecated because the owncloudsql + driver is deprecated. USERS_SKIP_USER_GROUPS_IN_TOKEN: name: USERS_SKIP_USER_GROUPS_IN_TOKEN defaultValue: "false" diff --git a/content/ocis/8.2/services/persistent_files/extended_vars.yaml b/content/ocis/8.2/services/persistent_files/extended_vars.yaml index 283fba0a..fc0842d3 100644 --- a/content/ocis/8.2/services/persistent_files/extended_vars.yaml +++ b/content/ocis/8.2/services/persistent_files/extended_vars.yaml @@ -31,16 +31,6 @@ variables: default_value: "" description: ignored intentionally do_ignore: true -- rawname: _serverMaxConnectionAgeEnv - path: ../../ocis/ocis-pkg/service/grpc/keepalive.go:19 - foundincode: true - name: GRPC_MAX_CONNECTION_AGE - type: Duration - default_value: "9223372036854775807" - description: Timeout for GRPC connections. After timeout, a new connection will - be established automatically. The default value is in ns and is about 2.5 mio - h. - do_ignore: false - rawname: MICRO_LOG_LEVEL path: ../../ocis/ocis-pkg/log/log.go:34 foundincode: true @@ -154,7 +144,7 @@ variables: section in the documentation for more details on defaults. do_ignore: false - rawname: OCIS_INSECURE - path: ../../ocis/ocis-pkg/service/grpc/client.go:79 + path: ../../ocis/ocis-pkg/service/grpc/client.go:101 foundincode: true name: OCIS_INSECURE type: bool diff --git a/content/ocis/9.0/modules/ROOT/pages/index.adoc b/content/ocis/9.0/modules/ROOT/pages/index.adoc index 39c4bf5c..27323c90 100644 --- a/content/ocis/9.0/modules/ROOT/pages/index.adoc +++ b/content/ocis/9.0/modules/ROOT/pages/index.adoc @@ -27,10 +27,6 @@ You can find more details on changes made in each release published in the https IMPORTANT: Rolling releases are published in a cycle of 3 weeks. Due to this relative short cycle, you will find the actual development and the current published rolling release documentation *not* separated. They are both part of the `next` segment in the URL. Compared to production releases where the respective release number is used, the actual rolling release number published can be found e.g. in each service description in section "Environment Variables". -== End-User License Agreement (EULA) - -ownCloud provides an EULA to clarify, among various topics, who can use this software and which conditions apply to the groups of users defined. See the actual {compose_raw_url}{compose_version}/assets/End-User-License-Agreement-for-ownCloud-Infinite-Scale.pdf[EULA] for details. - == FAQ === What Is the Difference Between the Admin and Developer Documentation? diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/activitylog_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/activitylog_configvars.adoc index bf167db6..b766887d 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/activitylog_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/activitylog_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the activitylog service [width="100%",cols="~,~,~,~",options="header"] @@ -248,6 +248,28 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. +a|`OCIS_NATS_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. The service reads the file again on each reconnect. + +a|`OCIS_NATS_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. + a|`OCIS_PERSISTENT_STORE` + `ACTIVITYLOG_STORE` + @@ -330,11 +352,35 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. +a|`OCIS_NATS_CREDS_FILE` + +`ACTIVITYLOG_STORE_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. + +a|`OCIS_NATS_CREDS` + +`ACTIVITYLOG_STORE_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. + a|`OCIS_PERSISTENT_STORE_ENABLE_TLS` + `ACTIVITYLOG_STORE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -346,7 +392,7 @@ a|`OCIS_PERSISTENT_STORE_TLS_INSECURE` + `ACTIVITYLOG_STORE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -358,7 +404,7 @@ a|`OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE` + `ACTIVITYLOG_STORE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/antivirus_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/antivirus_configvars.adoc index bff4ea35..10b120a6 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/antivirus_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/antivirus_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the antivirus service [width="100%",cols="~,~,~,~",options="header"] @@ -266,6 +266,30 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. +a|`OCIS_NATS_CREDS_FILE` + +`ANTIVIRUS_EVENTS_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. + +a|`OCIS_NATS_CREDS` + +`ANTIVIRUS_EVENTS_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. + a|`ANTIVIRUS_WORKERS` + a| [subs=-attributes] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/app-provider_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/app-provider_configvars.adoc index be590bcf..8c313d8c 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/app-provider_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/app-provider_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the app-provider service [width="100%",cols="~,~,~,~",options="header"] @@ -391,7 +391,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++https://localhost:9200/ ++ +++https://localhost:9200 ++ a| [subs=-attributes] Base url to navigate back from the app to the containing folder in the file list. diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/app-registry_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/app-registry_configvars.adoc index a1fccbf0..36b73e99 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/app-registry_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/app-registry_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the app-registry service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/audit_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/audit_configvars.adoc index badf907a..8c9aa871 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/audit_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/audit_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the audit service [width="100%",cols="~,~,~,~",options="header"] @@ -255,6 +255,30 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. +a|`OCIS_NATS_CREDS_FILE` + +`AUDIT_EVENTS_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. + +a|`OCIS_NATS_CREDS` + +`AUDIT_EVENTS_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. + a|`AUDIT_LOG_TO_CONSOLE` + a| [subs=-attributes] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-app_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-app_configvars.adoc index 9491654a..5bbda78f 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-app_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-app_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the auth-app service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-basic_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-basic_configvars.adoc index 9fdc9c1e..1602d3ac 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-basic_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-basic_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the auth-basic service [width="100%",cols="~,~,~,~",options="header"] @@ -511,7 +511,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The master instance ID for multi-instance setups. When set, LDAP user filters are enhanced to also match users belonging to the master instance. +The master instance ID for multi-instance setups. When set, LDAP user filters are enhanced to also match users belonging to the master instance. Also set 'user_filter'. Without an explicit 'user_filter', this instance allows login for every user in the shared LDAP directory. a|`OCIS_LDAP_USER_MEMBER_ATTRIBUTE` + @@ -543,7 +543,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ownclouduuid ++ +++ownCloudUUID ++ a| [subs=-attributes] LDAP Attribute to use as the unique ID for users. This should be a stable globally unique ID like a UUID. @@ -579,7 +579,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++displayname ++ +++displayName ++ a| [subs=-attributes] LDAP Attribute to use for the displayname of users. @@ -615,7 +615,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ownclouduuid ++ +++ownCloudUUID ++ a| [subs=-attributes] LDAP Attribute to use as the unique id for groups. This should be a stable globally unique id (e.g. a UUID). @@ -714,104 +714,5 @@ a| [subs=-attributes] ++30s ++ a| [subs=-attributes] Maximum time to wait for a pooled LDAP connection to become available once the pool is exhausted. Defaults to 30s when unset or <= 0. See the Environment Variable Types description for more details. - -a|`AUTH_BASIC_OWNCLOUDSQL_DB_USERNAME` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++owncloud ++ -a| [subs=-attributes] -Database user to use for authenticating with the owncloud database. - -a|`AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++ ++ -a| [subs=-attributes] -Password for the database user. - -a|`AUTH_BASIC_OWNCLOUDSQL_DB_HOST` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++mysql ++ -a| [subs=-attributes] -Hostname of the database server. - -a|`AUTH_BASIC_OWNCLOUDSQL_DB_PORT` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++int ++ -a| [subs=-attributes] -++3306 ++ -a| [subs=-attributes] -Network port to use for the database connection. - -a|`AUTH_BASIC_OWNCLOUDSQL_DB_NAME` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++owncloud ++ -a| [subs=-attributes] -Name of the owncloud database. - -a|`AUTH_BASIC_OWNCLOUDSQL_IDP` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++https://localhost:9200 ++ -a| [subs=-attributes] -The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. - -a|`AUTH_BASIC_OWNCLOUDSQL_NOBODY` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++int64 ++ -a| [subs=-attributes] -++90 ++ -a| [subs=-attributes] -Fallback number if no numeric UID and GID properties are provided. - -a|`AUTH_BASIC_OWNCLOUDSQL_JOIN_USERNAME` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++bool ++ -a| [subs=-attributes] -++false ++ -a| [subs=-attributes] -Join the user properties table to read usernames - -a|`AUTH_BASIC_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++bool ++ -a| [subs=-attributes] -++false ++ -a| [subs=-attributes] -Join the user properties table to read user ID's. |=== diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-bearer_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-bearer_configvars.adoc index a4632b8c..63730091 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-bearer_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-bearer_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the auth-bearer service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-machine_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-machine_configvars.adoc index 8130d49b..dc6fb1d7 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-machine_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-machine_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the auth-machine service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-service_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-service_configvars.adoc index 20838e69..9b508bb5 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-service_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/auth-service_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the auth-service service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/clientlog_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/clientlog_configvars.adoc index 5fb8513f..6ef8592e 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/clientlog_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/clientlog_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the clientlog service [width="100%",cols="~,~,~,~",options="header"] @@ -278,6 +278,30 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. +a|`OCIS_NATS_CREDS_FILE` + +`CLIENTLOG_EVENTS_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. + +a|`OCIS_NATS_CREDS` + +`CLIENTLOG_EVENTS_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. + a|`OCIS_SERVICE_ACCOUNT_ID` + `CLIENTLOG_SERVICE_ACCOUNT_ID` + diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/collaboration_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/collaboration_configvars.adoc index a089a031..ce8d48c3 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/collaboration_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/collaboration_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the collaboration service [width="100%",cols="~,~,~,~",options="header"] @@ -223,11 +223,35 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. +a|`OCIS_NATS_CREDS_FILE` + +`COLLABORATION_STORE_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. + +a|`OCIS_NATS_CREDS` + +`COLLABORATION_STORE_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. + a|`OCIS_PERSISTENT_STORE_ENABLE_TLS` + `COLLABORATION_STORE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -239,7 +263,7 @@ a|`OCIS_PERSISTENT_STORE_TLS_INSECURE` + `COLLABORATION_STORE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -251,7 +275,7 @@ a|`OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE` + `COLLABORATION_STORE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/eventhistory_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/eventhistory_configvars.adoc index ec73da10..262cc786 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/eventhistory_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/eventhistory_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the eventhistory service [width="100%",cols="~,~,~,~",options="header"] @@ -266,6 +266,30 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. +a|`OCIS_NATS_CREDS_FILE` + +`EVENTHISTORY_EVENTS_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. + +a|`OCIS_NATS_CREDS` + +`EVENTHISTORY_EVENTS_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. + a|`OCIS_PERSISTENT_STORE` + `EVENTHISTORY_STORE` + @@ -348,11 +372,35 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. +a|`OCIS_NATS_CREDS_FILE` + +`EVENTHISTORY_STORE_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. + +a|`OCIS_NATS_CREDS` + +`EVENTHISTORY_STORE_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. + a|`OCIS_PERSISTENT_STORE_ENABLE_TLS` + `EVENTHISTORY_STORE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -364,19 +412,19 @@ a|`OCIS_PERSISTENT_STORE_TLS_INSECURE` + `EVENTHISTORY_STORE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. +Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. a|`OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE` + `EVENTHISTORY_STORE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/frontend_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/frontend_configvars.adoc index 239e2d52..c2d853f8 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/frontend_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/frontend_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the frontend service [width="100%",cols="~,~,~,~",options="header"] @@ -639,7 +639,7 @@ a| [subs=-attributes] Path prefix for the data gateway. a|`OCIS_CACHE_STORE` + -xref:deprecation-note-2026-09-09-11-27-22[Deprecation Note] +xref:deprecation-note-2026-11-13-11-05-23[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -650,7 +650,7 @@ a| [subs=-attributes] The type of the cache store. Supported values are: 'memory', 'redis-sentinel', 'nats-js-kv', 'noop'. See the text description for details. a|`OCIS_CACHE_STORE_NODES` + -xref:deprecation-note-2026-09-09-11-27-22[Deprecation Note] +xref:deprecation-note-2026-11-13-11-05-23[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -661,7 +661,7 @@ a| [subs=-attributes] 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. a|`OCIS_CACHE_DATABASE` + -xref:deprecation-note-2026-09-09-11-27-22[Deprecation Note] +xref:deprecation-note-2026-11-13-11-05-23[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -672,7 +672,7 @@ a| [subs=-attributes] The database name the configured store should use. a|`OCIS_CACHE_TTL` + -xref:deprecation-note-2026-09-09-11-27-22[Deprecation Note] +xref:deprecation-note-2026-11-13-11-05-23[Deprecation Note] a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] @@ -683,7 +683,7 @@ a| [subs=-attributes] 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. a|`OCIS_CACHE_DISABLE_PERSISTENCE` + -xref:deprecation-note-2026-09-09-11-27-22[Deprecation Note] +xref:deprecation-note-2026-11-13-11-05-23[Deprecation Note] a| [subs=-attributes] ++5.0 ++ a| [subs=-attributes] @@ -694,7 +694,7 @@ a| [subs=-attributes] Disable persistence of the cache. Only applies when using the 'nats-js-kv' store type. Defaults to false. a|`OCIS_CACHE_AUTH_USERNAME` + -xref:deprecation-note-2026-09-09-11-27-22[Deprecation Note] +xref:deprecation-note-2026-11-13-11-05-23[Deprecation Note] a| [subs=-attributes] ++5.0 ++ a| [subs=-attributes] @@ -705,7 +705,7 @@ a| [subs=-attributes] The username to use for authentication. Only applies when using the 'nats-js-kv' store type. a|`OCIS_CACHE_AUTH_PASSWORD` + -xref:deprecation-note-2026-09-09-11-27-22[Deprecation Note] +xref:deprecation-note-2026-11-13-11-05-23[Deprecation Note] a| [subs=-attributes] ++5.0 ++ a| [subs=-attributes] @@ -715,8 +715,63 @@ a| [subs=-attributes] a| [subs=-attributes] The password to use for authentication. Only applies when using the 'nats-js-kv' store type. +a|`OCIS_NATS_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. + +a|`OCIS_NATS_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Only applies when store type 'nats-js-kv' is configured. + +a|`OCIS_CACHE_ENABLE_TLS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++bool ++ +a| [subs=-attributes] +++false ++ +a| [subs=-attributes] +Activate TLS for the connection to the stat cache store. Only applies when using the 'nats-js-kv' store type. + +a|`OCIS_CACHE_TLS_INSECURE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++bool ++ +a| [subs=-attributes] +++false ++ +a| [subs=-attributes] +Disable TLS certificate verification for the stat cache store connection. Only applies when using the 'nats-js-kv' store type. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. + +a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to the PEM-encoded root CA certificate for the stat cache store TLS connection. Only applies when using the 'nats-js-kv' store type. + a|`OCIS_ENABLE_OCM` + -xref:deprecation-note-2026-09-09-11-27-22[Deprecation Note] +xref:deprecation-note-2026-11-13-11-05-23[Deprecation Note] a| [subs=-attributes] ++5.0 ++ a| [subs=-attributes] @@ -727,7 +782,7 @@ a| [subs=-attributes] Include OCM shares when listing shares. See the OCM service documentation for more details. a|`OCIS_ENABLE_OCM` + -xref:deprecation-note-2026-09-09-11-27-22[Deprecation Note] +xref:deprecation-note-2026-11-13-11-05-23[Deprecation Note] a| [subs=-attributes] ++5.0 ++ a| [subs=-attributes] @@ -738,7 +793,7 @@ a| [subs=-attributes] Include OCM sharees when listing sharees. a|`OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD` + -xref:deprecation-note-2026-09-09-11-27-22[Deprecation Note] +xref:deprecation-note-2026-11-13-11-05-23[Deprecation Note] a| [subs=-attributes] ++5.0 ++ a| [subs=-attributes] @@ -749,7 +804,7 @@ a| [subs=-attributes] Set this to true if you want to enforce passwords on all public shares. a|`OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD` + -xref:deprecation-note-2026-09-09-11-27-22[Deprecation Note] +xref:deprecation-note-2026-11-13-11-05-23[Deprecation Note] a| [subs=-attributes] ++5.0 ++ a| [subs=-attributes] @@ -899,6 +954,30 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. +a|`OCIS_NATS_CREDS_FILE` + +`FRONTEND_EVENTS_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. + +a|`OCIS_NATS_CREDS` + +`FRONTEND_EVENTS_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. + a|`FRONTEND_AUTO_ACCEPT_SHARES` + a| [subs=-attributes] @@ -1073,27 +1152,28 @@ a| [subs=-attributes] a| [subs=-attributes] This authentication level name indicates that multi-factor authentication was performed. The name must match the ACR claim in the access token received. Note: If multiple names are required, use a comma-separated list. The front-end service will use the first name in the list when requesting multi-factor authentication (MFA). -a|`OCIS_MFA_SESSION_DURATION` + +a|`OCIS_ENABLE_VAULT_MODE` + +`FRONTEND_ENABLE_VAULT_MODE` + a| [subs=-attributes] ++8.1.0 ++ a| [subs=-attributes] -++int ++ +++bool ++ a| [subs=-attributes] -++3600 ++ +++false ++ a| [subs=-attributes] -The duration in seconds that a multi-factor authentication session is valid. After this time the user will be prompted to re-authenticate. Defaults to 3600 (1 hour). +Enable vault mode. When enabled, the capabilities endpoint will report vault as enabled and the capabilities?vault=true endpoint will return capabilities with public sharing and federation disabled. -a|`OCIS_ENABLE_VAULT_MODE` + -`FRONTEND_ENABLE_VAULT_MODE` + +a|`OCIS_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS` + +`FRONTEND_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS` + a| [subs=-attributes] -++8.1.0 ++ +++9.0.0 ++ a| [subs=-attributes] -++bool ++ +++int ++ a| [subs=-attributes] -++false ++ +++30 ++ a| [subs=-attributes] -Enable vault mode. When enabled, the capabilities endpoint will report vault as enabled and the capabilities?vault=true endpoint will return capabilities with public sharing and federation disabled. +The default expiration, in days, applied to a vault user or group share created without an explicit expiration date. Reported via the vault capability so clients can reflect the admin-configured value. Must match the graph service's GRAPH_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS. |=== diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/gateway_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/gateway_configvars.adoc index 246c88d6..d41e205d 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/gateway_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/gateway_configvars.adoc @@ -2,11 +2,11 @@ // if the generated adoc file is used outside tabs, it renders correctly depending on the attribute set. // if inside, you need to also use the xxx_deprecation.adoc file. attributes can't be defined inside tabs. -:show-deprecation: false +:show-deprecation: true ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the gateway service [width="100%",cols="~,~,~,~",options="header"] @@ -15,6 +15,11 @@ ifeval::[{show-deprecation} == true] | Deprecation Version | Removal Version | Deprecation Replacement + +| The global variable OCIS_CACHE_DATABASE is deprecated and will be removed in a future release. Please use local variable GATEWAY_PROVIDER_CACHE_DATABASE instead. +| +| +| |=== {empty} + @@ -331,9 +336,10 @@ a| [subs=-attributes] 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. a|`OCIS_CACHE_DATABASE` + - +`GATEWAY_PROVIDER_CACHE_DATABASE` + +xref:deprecation-note-2026-11-13-11-05-23[Deprecation Note] a| [subs=-attributes] -++pre5.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] @@ -389,11 +395,35 @@ a| [subs=-attributes] a| [subs=-attributes] The password to use for authentication. Only applies when store type 'nats-js-kv' is configured. +a|`OCIS_NATS_CREDS_FILE` + +`GATEWAY_PROVIDER_CACHE_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. + +a|`OCIS_NATS_CREDS` + +`GATEWAY_PROVIDER_CACHE_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. + a|`OCIS_CACHE_ENABLE_TLS` + `GATEWAY_PROVIDER_CACHE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -405,19 +435,19 @@ a|`OCIS_CACHE_TLS_INSECURE` + `GATEWAY_PROVIDER_CACHE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. +Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + `GATEWAY_PROVIDER_CACHE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/gateway_deprecation.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/gateway_deprecation.adoc index 4b3cef68..e452d9c3 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/gateway_deprecation.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/gateway_deprecation.adoc @@ -1,2 +1,2 @@ -:show-deprecation: false +:show-deprecation: true diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/global_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/global_configvars.adoc index 38534e8f..37a8d9d5 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/global_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/global_configvars.adoc @@ -28,7 +28,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -The default role assignments the demo users should be setup. +Flag to enable or disable the creation of the demo users. a| `OCIS_ADMIN_USER_ID` a| [subs=-attributes] @@ -55,7 +55,6 @@ a| [subs=-attributes] a| [subs=attributes+] * xref:{s-path}/search.adoc[search] + * xref:{s-path}/storage-users.adoc[storage-users] + -* xref:{s-path}/storage-users.adoc[storage-users] + a| [subs=-attributes] ++bool ++ @@ -89,7 +88,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. +The password to use for authentication. Only applies when using the 'nats-js-kv' store type. a| `OCIS_CACHE_AUTH_USERNAME` a| [subs=-attributes] @@ -114,7 +113,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The username to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. +The username to use for authentication. Only applies when using the 'nats-js-kv' store type. a| `OCIS_CACHE_DATABASE` a| [subs=-attributes] @@ -133,14 +132,14 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++settings-cache ++ +++cache-stat ++ a| [subs=-attributes] The database name the configured store should use. a| `OCIS_CACHE_DISABLE_PERSISTENCE` a| [subs=-attributes] -++5.0 ++ +++pre5.0 ++ a| [subs=attributes+] * xref:{s-path}/frontend.adoc[frontend] + @@ -160,13 +159,14 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Disables persistence of the cache. Only applies when store type 'nats-js-kv' is configured. Defaults to false. +Disable persistence of the cache. Only applies when using the 'nats-js-kv' store type. Defaults to false. a| `OCIS_CACHE_ENABLE_TLS` a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=attributes+] +* xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/gateway.adoc[gateway] + * xref:{s-path}/graph.adoc[graph] + * xref:{s-path}/ocs.adoc[ocs] + @@ -184,11 +184,11 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Activate TLS for the connection to the signing key store. Only applies when store type 'nats-js-kv' is configured. +Activate TLS for the connection to the stat cache store. Only applies when using the 'nats-js-kv' store type. a| `OCIS_CACHE_STORE` a| [subs=-attributes] -++5.0 ++ +++pre5.0 ++ a| [subs=attributes+] * xref:{s-path}/frontend.adoc[frontend] + @@ -206,14 +206,14 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++nats-js-kv ++ +++memory ++ a| [subs=-attributes] -The type of the signing key store. Supported values are: 'redis-sentinel' and 'nats-js-kv'. See the text description for details. +The type of the cache store. Supported values are: 'memory', 'redis-sentinel', 'nats-js-kv', 'noop'. See the text description for details. a| `OCIS_CACHE_STORE_NODES` a| [subs=-attributes] -++5.0 ++ +++pre5.0 ++ a| [subs=attributes+] * xref:{s-path}/frontend.adoc[frontend] + @@ -234,13 +234,14 @@ a| [subs=-attributes] ++[127.0.0.1:9233] ++ a| [subs=-attributes] -A list of nodes to access the configured store. 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. +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. a| `OCIS_CACHE_TLS_INSECURE` a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=attributes+] +* xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/gateway.adoc[gateway] + * xref:{s-path}/graph.adoc[graph] + * xref:{s-path}/ocs.adoc[ocs] + @@ -258,13 +259,14 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Disable TLS certificate verification for the signing key store connection. Only applies when store type 'nats-js-kv' is configured. +Disable TLS certificate verification for the stat cache store connection. Only applies when using the 'nats-js-kv' store type. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. a| `OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=attributes+] +* xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/gateway.adoc[gateway] + * xref:{s-path}/graph.adoc[graph] + * xref:{s-path}/ocs.adoc[ocs] + @@ -282,11 +284,11 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -Path to the PEM-encoded root CA certificate for the signing key store TLS connection. Only applies when store type 'nats-js-kv' is configured. +Path to the PEM-encoded root CA certificate for the stat cache store TLS connection. Only applies when using the 'nats-js-kv' store type. a| `OCIS_CACHE_TTL` a| [subs=-attributes] -++5.0 ++ +++pre5.0 ++ a| [subs=attributes+] * xref:{s-path}/frontend.adoc[frontend] + @@ -304,10 +306,10 @@ a| [subs=-attributes] ++Duration ++ a| [subs=-attributes] -++12h0m0s ++ +++5m0s ++ a| [subs=-attributes] -Default time to live for signing keys. See the Environment Variable Types description for more details. +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. a| `OCIS_CLAIM_MANAGED_SPACES_ENABLED` a| [subs=-attributes] @@ -352,7 +354,7 @@ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] -++true ++ +++false ++ a| [subs=-attributes] Allow credentials for CORS.See following chapter for more details: *Access-Control-Allow-Credentials* at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials. @@ -383,7 +385,7 @@ a| [subs=-attributes] ++[]string ++ a| [subs=-attributes] -++[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id Cache-Control] ++ +++[] ++ a| [subs=-attributes] A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details. @@ -414,7 +416,7 @@ a| [subs=-attributes] ++[]string ++ a| [subs=-attributes] -++[GET POST PUT PATCH DELETE OPTIONS] ++ +++[] ++ a| [subs=-attributes] A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. See the Environment Variable Types description for more details. @@ -445,7 +447,7 @@ a| [subs=-attributes] ++[]string ++ a| [subs=-attributes] -++[*] ++ +++[https://localhost:9200] ++ a| [subs=-attributes] 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. @@ -482,10 +484,27 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ ++ +++en ++ a| [subs=-attributes] The default language used by services and the WebUI. If not defined, English will be used as default. See the documentation for more details. +a| `OCIS_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS` + +a| [subs=-attributes] +++9.0.0 ++ + +a| [subs=attributes+] +* xref:{s-path}/frontend.adoc[frontend] + +* xref:{s-path}/graph.adoc[graph] + + +a| [subs=-attributes] +++int ++ + +a| [subs=-attributes] +++30 ++ + +a| [subs=-attributes] +The default expiration, in days, applied to a vault user or group share created without an explicit expiration date. Reported via the vault capability so clients can reflect the admin-configured value. Must match the graph service's GRAPH_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS. a| `OCIS_DISABLE_VERSIONING` a| [subs=-attributes] @@ -523,7 +542,7 @@ Edition of oCIS. Used for branding purposes. a| `OCIS_ENABLE_OCM` a| [subs=-attributes] -++5.0 ++ +++pre5.0 ++ a| [subs=attributes+] * xref:{s-path}/frontend.adoc[frontend] + @@ -539,7 +558,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Include OCM sharees when listing users. +Changing this value is NOT supported. Enables support for incoming federated sharing for clients. The backend behaviour is not changed. a| `OCIS_ENABLE_PUBLIC_SHARING` a| [subs=-attributes] @@ -594,7 +613,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Set this to true to enable the default rule for vault storage provider configuration. Only applicable if the storage-users-vault service, a specially configured storage-users service, is configured. +Enable vault mode. When enabled, the capabilities endpoint will report vault as enabled and the capabilities?vault=true endpoint will return capabilities with public sharing and federation disabled. a| `OCIS_EVENTS_AUTH_PASSWORD` a| [subs=-attributes] @@ -786,7 +805,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The root CA certificate used to validate the server's TLS certificate. If provided POSTPROCESSING_EVENTS_TLS_INSECURE will be seen as false. +The root CA certificate used to validate the server's TLS certificate. Will be seen as empty if NOTIFICATIONS_EVENTS_TLS_INSECURE is provided. a| `OCIS_GATEWAY_GRPC_ADDR` a| [subs=-attributes] @@ -911,7 +930,7 @@ a| [subs=-attributes] ++tcp ++ a| [subs=-attributes] -The transport protocol of the GPRC service. +The transport protocol of the GRPC service. a| `OCIS_HTTP_TLS_CERTIFICATE` a| [subs=-attributes] @@ -1037,7 +1056,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Whether the ocis server should skip the client certificate verification during the TLS handshake. +Whether to verify the server TLS certificates. a| `OCIS_JWT_SECRET` a| [subs=-attributes] @@ -1115,7 +1134,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The client id to authenticate with keycloak. +The client ID to authenticate with keycloak. a| `OCIS_KEYCLOAK_CLIENT_REALM` a| [subs=-attributes] @@ -1389,7 +1408,7 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ownclouduuid ++ +++ownCloudUUID ++ a| [subs=-attributes] LDAP Attribute to use as the unique id for groups. This should be a stable globally unique ID like a UUID. @@ -1771,7 +1790,7 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++displayname ++ +++displayName ++ a| [subs=-attributes] LDAP Attribute to use for the displayname of users. @@ -1791,7 +1810,7 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ownclouduuid ++ +++ownCloudUUID ++ a| [subs=-attributes] LDAP Attribute to use as the unique id for users. This should be a stable globally unique id like a UUID. @@ -2122,7 +2141,7 @@ Activates pretty log output. a| `OCIS_MACHINE_AUTH_API_KEY` a| [subs=-attributes] -++7.0.0 ++ +++pre5.0 ++ a| [subs=attributes+] * xref:{s-path}/auth-app.adoc[auth-app] + @@ -2140,11 +2159,11 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The machine auth API key used to validate internal requests necessary to access resources from other services. +Machine auth API key used to validate internal requests necessary for the access to resources from other services. a| `OCIS_MAX_CONCURRENCY` a| [subs=-attributes] -++7.0.0 ++ +++pre5.0 ++ a| [subs=attributes+] * xref:{s-path}/frontend.adoc[frontend] + @@ -2212,41 +2231,41 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Enable MFA enforcement. If enabled users need to complete MFA before they can access specific paths -a| `OCIS_MFA_SESSION_DURATION` +Set to true to enable multi factor authentication. See the documentation for more details. +a| `OCIS_MULTI_INSTANCE_ENABLED` a| [subs=-attributes] -++7.3.0 ++ +++8.0.0 ++ a| [subs=attributes+] -* xref:{s-path}/frontend.adoc[frontend] + +* xref:{s-path}/graph.adoc[graph] + * xref:{s-path}/proxy.adoc[proxy] + a| [subs=-attributes] -++int ++ +++bool ++ a| [subs=-attributes] -++3600 ++ +++false ++ a| [subs=-attributes] -The duration in seconds that a multi-factor authentication session is valid for non-OIDC requests. Defaults to 3600 (1 hour). -a| `OCIS_MULTI_INSTANCE_ENABLED` +Enable multiple instances of Infinite Scale. +a| `OCIS_MULTI_INSTANCE_GUEST_ROLE_MAPPING` a| [subs=-attributes] -++8.0.0 ++ +++9.0.0 ++ a| [subs=attributes+] * xref:{s-path}/graph.adoc[graph] + * xref:{s-path}/proxy.adoc[proxy] + a| [subs=-attributes] -++bool ++ +++[]string ++ a| [subs=-attributes] -++false ++ +++[] ++ a| [subs=-attributes] -Enable multiple instances of Infinite Scale. +(Optional) Mapping of PROXY_ROLE_ASSIGNMENT_OIDC_CLAIM values to the role a guest gets instead of OCIS_MULTI_INSTANCE_GUEST_ROLE. Example: 'spaceadmin:user-light-vault'. A claim value is an exact string or a regular expression that must match the full claim value, the same as the claim_value of the role mapping. Escape regex metacharacters such as '.' in an exact string. The first match wins. Role names must not contain a colon. Only applies to the 'oidc' role assignment driver. a| `OCIS_MULTI_INSTANCE_INSTANCEID` a| [subs=-attributes] @@ -2263,7 +2282,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The unique ID of this instance. +The unique id of this instance a| `OCIS_MULTI_INSTANCE_MASTER_ID` a| [subs=-attributes] @@ -2283,7 +2302,105 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The master instance ID for multi-instance setups. When set, LDAP user filters are enhanced to also match users belonging to the master instance. +The master instance ID for multi-instance setups. When set, LDAP user filters are enhanced to also match users belonging to the master instance. Also set 'user_filter'. Without an explicit 'user_filter', this instance resolves every user in the shared LDAP directory. +a| `OCIS_NATS_CREDS` + +a| [subs=-attributes] +++9.0.0 ++ + +a| [subs=attributes+] +* xref:{s-path}/activitylog.adoc[activitylog] + +* xref:{s-path}/activitylog.adoc[activitylog] + +* xref:{s-path}/antivirus.adoc[antivirus] + +* xref:{s-path}/audit.adoc[audit] + +* xref:{s-path}/clientlog.adoc[clientlog] + +* xref:{s-path}/collaboration.adoc[collaboration] + +* xref:{s-path}/eventhistory.adoc[eventhistory] + +* xref:{s-path}/eventhistory.adoc[eventhistory] + +* xref:{s-path}/frontend.adoc[frontend] + +* xref:{s-path}/frontend.adoc[frontend] + +* xref:{s-path}/gateway.adoc[gateway] + +* xref:{s-path}/graph.adoc[graph] + +* xref:{s-path}/graph.adoc[graph] + +* xref:{s-path}/notifications.adoc[notifications] + +* xref:{s-path}/notifications.adoc[notifications] + +* xref:{s-path}/ocm.adoc[ocm] + +* xref:{s-path}/ocs.adoc[ocs] + +* xref:{s-path}/policies.adoc[policies] + +* xref:{s-path}/postprocessing.adoc[postprocessing] + +* xref:{s-path}/postprocessing.adoc[postprocessing] + +* xref:{s-path}/proxy.adoc[proxy] + +* xref:{s-path}/proxy.adoc[proxy] + +* xref:{s-path}/proxy.adoc[proxy] + +* xref:{s-path}/search.adoc[search] + +* xref:{s-path}/settings.adoc[settings] + +* xref:{s-path}/sharing.adoc[sharing] + +* xref:{s-path}/sse.adoc[sse] + +* xref:{s-path}/storage-publiclink.adoc[storage-publiclink] + +* xref:{s-path}/storage-system.adoc[storage-system] + +* xref:{s-path}/storage-users.adoc[storage-users] + +* xref:{s-path}/storage-users.adoc[storage-users] + +* xref:{s-path}/storage-users.adoc[storage-users] + +* xref:{s-path}/userlog.adoc[userlog] + +* xref:{s-path}/userlog.adoc[userlog] + + +a| [subs=-attributes] +++string ++ + +a| [subs=-attributes] +++ ++ + +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. +a| `OCIS_NATS_CREDS_FILE` + +a| [subs=-attributes] +++9.0.0 ++ + +a| [subs=attributes+] +* xref:{s-path}/activitylog.adoc[activitylog] + +* xref:{s-path}/activitylog.adoc[activitylog] + +* xref:{s-path}/antivirus.adoc[antivirus] + +* xref:{s-path}/audit.adoc[audit] + +* xref:{s-path}/clientlog.adoc[clientlog] + +* xref:{s-path}/collaboration.adoc[collaboration] + +* xref:{s-path}/eventhistory.adoc[eventhistory] + +* xref:{s-path}/eventhistory.adoc[eventhistory] + +* xref:{s-path}/frontend.adoc[frontend] + +* xref:{s-path}/frontend.adoc[frontend] + +* xref:{s-path}/gateway.adoc[gateway] + +* xref:{s-path}/graph.adoc[graph] + +* xref:{s-path}/graph.adoc[graph] + +* xref:{s-path}/notifications.adoc[notifications] + +* xref:{s-path}/notifications.adoc[notifications] + +* xref:{s-path}/ocm.adoc[ocm] + +* xref:{s-path}/ocs.adoc[ocs] + +* xref:{s-path}/policies.adoc[policies] + +* xref:{s-path}/postprocessing.adoc[postprocessing] + +* xref:{s-path}/postprocessing.adoc[postprocessing] + +* xref:{s-path}/proxy.adoc[proxy] + +* xref:{s-path}/proxy.adoc[proxy] + +* xref:{s-path}/proxy.adoc[proxy] + +* xref:{s-path}/search.adoc[search] + +* xref:{s-path}/settings.adoc[settings] + +* xref:{s-path}/sharing.adoc[sharing] + +* xref:{s-path}/sse.adoc[sse] + +* xref:{s-path}/storage-publiclink.adoc[storage-publiclink] + +* xref:{s-path}/storage-system.adoc[storage-system] + +* xref:{s-path}/storage-users.adoc[storage-users] + +* xref:{s-path}/storage-users.adoc[storage-users] + +* xref:{s-path}/storage-users.adoc[storage-users] + +* xref:{s-path}/userlog.adoc[userlog] + +* xref:{s-path}/userlog.adoc[userlog] + + +a| [subs=-attributes] +++string ++ + +a| [subs=-attributes] +++ ++ + +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. a| `OCIS_OIDC_ISSUER` a| [subs=-attributes] @@ -2307,7 +2424,7 @@ a| [subs=-attributes] ++https://localhost:9200 ++ a| [subs=-attributes] -The identity provider value to set in the group IDs of the CS3 group objects for groups returned by this group provider. +The OIDC issuer URL to assign to the demo users. a| `OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST` a| [subs=-attributes] @@ -2448,7 +2565,7 @@ a| [subs=-attributes] ++nats-js-kv ++ a| [subs=-attributes] -The type of the store. Supported values are: 'memory', 'redis-sentinel', 'nats-js-kv', 'noop'. See the text description for details. +The type of the store. Supported values are: 'memory', 'nats-js-kv', 'redis-sentinel', 'noop'. See the text description for details. a| `OCIS_PERSISTENT_STORE_AUTH_PASSWORD` a| [subs=-attributes] @@ -2496,7 +2613,7 @@ The username to authenticate with the store. Only applies when store type 'nats- a| `OCIS_PERSISTENT_STORE_ENABLE_TLS` a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=attributes+] * xref:{s-path}/activitylog.adoc[activitylog] + @@ -2540,7 +2657,7 @@ A list of nodes to access the configured store. This has no effect when 'memory' a| `OCIS_PERSISTENT_STORE_TLS_INSECURE` a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=attributes+] * xref:{s-path}/activitylog.adoc[activitylog] + @@ -2558,11 +2675,11 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. +Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. a| `OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE` a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=attributes+] * xref:{s-path}/activitylog.adoc[activitylog] + @@ -2598,10 +2715,10 @@ a| [subs=-attributes] ++Duration ++ a| [subs=-attributes] -++0s ++ +++336h0m0s ++ a| [subs=-attributes] -Time to live for events in the store. See the Environment Variable Types description for more details. +Time to live for events in the store. Defaults to '336h' (2 weeks). See the Environment Variable Types description for more details. a| `OCIS_REVA_GATEWAY` a| [subs=-attributes] @@ -2749,7 +2866,7 @@ a| [subs=-attributes] ++0 ++ a| [subs=-attributes] -Set a global max quota for spaces in bytes. A value of 0 equals unlimited. If not using the global OCIS_SPACES_MAX_QUOTA, you must define the FRONTEND_MAX_QUOTA in the frontend service. +Set the global max quota value in bytes. A value of 0 equals unlimited. The value is provided via capabilities. a| `OCIS_SYSTEM_USER_API_KEY` a| [subs=-attributes] @@ -3056,7 +3173,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The storage transfer secret. +Transfer secret for signing file up- and download requests. a| `OCIS_TRANSLATION_PATH` a| [subs=-attributes] @@ -3107,10 +3224,10 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++https://localhost:9200/ ++ +++https://localhost:9200 ++ a| [subs=-attributes] -Base url to navigate back from the app to the containing folder in the file list. +The OIDC issuer URL to assign to the demo users. a| `OCIS_USER_SEARCH_DISPLAYED_ATTRIBUTES` a| [subs=-attributes] @@ -3127,7 +3244,7 @@ a| [subs=-attributes] ++[] ++ a| [subs=-attributes] -The attributes to display in the user search results. +A list of user attributes to display in the user search results. a| `OCIS_WOPI_DISABLE_CHAT` a| [subs=-attributes] @@ -3144,7 +3261,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Disable the chat functionality of the office app. +Disable chat in the office web frontend. This feature applies to OnlyOffice and Microsoft. a| `STORAGE_USERS_ASYNC_PROPAGATOR_PROPAGATION_DELAY` a| [subs=-attributes] @@ -3170,7 +3287,6 @@ a| [subs=-attributes] a| [subs=attributes+] * xref:{s-path}/storage-users.adoc[storage-users] + * xref:{s-path}/storage-users.adoc[storage-users] + -* xref:{s-path}/storage-users.adoc[storage-users] + a| [subs=-attributes] ++string ++ diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/graph_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/graph_configvars.adoc index 867d0110..dc31d321 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/graph_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/graph_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the graph service [width="100%",cols="~,~,~,~",options="header"] @@ -221,11 +221,35 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the cache. Only applies when store type 'nats-js-kv' is configured. +a|`OCIS_NATS_CREDS_FILE` + +`GRAPH_CACHE_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. + +a|`OCIS_NATS_CREDS` + +`GRAPH_CACHE_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. + a|`OCIS_CACHE_ENABLE_TLS` + `GRAPH_CACHE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -237,7 +261,7 @@ a|`OCIS_CACHE_TLS_INSECURE` + `GRAPH_CACHE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -249,7 +273,7 @@ a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + `GRAPH_CACHE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] @@ -633,7 +657,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ ++ +++en ++ a| [subs=-attributes] The default language used by services and the WebUI. If not defined, English will be used as default. See the documentation for more details. @@ -897,6 +921,18 @@ a| [subs=-attributes] a| [subs=-attributes] The object class to use for users in the default user search filter ('inetOrgPerson'). +a|`OCIS_LDAP_USER_ADDITIONAL_OBJECTCLASSES` + +`GRAPH_LDAP_USER_ADDITIONAL_OBJECTCLASSES` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++[]string ++ +a| [subs=-attributes] +++[] ++ +a| [subs=-attributes] +Additional object classes to set when creating new users (e.g. to allow a custom surname attribute). The default classes 'inetOrgPerson', 'organizationalPerson', 'person', 'top' and 'ownCloudUser' are always included. + a|`OCIS_LDAP_USER_SCHEMA_MAIL` + `GRAPH_LDAP_USER_EMAIL_ATTRIBUTE` + @@ -933,6 +969,29 @@ a| [subs=-attributes] a| [subs=-attributes] LDAP Attribute to use for username of users. +a|`OCIS_LDAP_USER_SCHEMA_SURNAME` + +`GRAPH_LDAP_USER_SURNAME_ATTRIBUTE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++sn ++ +a| [subs=-attributes] +LDAP Attribute to use for the surname of users. + +a|`GRAPH_LDAP_USER_SEARCH_ATTRIBUTES` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++[]string ++ +a| [subs=-attributes] +++[onPremisesSamAccountName displayName mail] ++ +a| [subs=-attributes] +The user attributes to match against when searching for users via the Graph API. Does not affect the legacy OCS sharees search, which always matches on username, display name, and mail. Accepts the logical names 'onPremisesSamAccountName', 'displayName', 'surname', 'mail' (case-insensitive), or any other LDAP attribute name directly. + a|`OCIS_LDAP_USER_SCHEMA_ID` + `GRAPH_LDAP_USER_UID_ATTRIBUTE` + @@ -941,7 +1000,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++owncloudUUID ++ +++ownCloudUUID ++ a| [subs=-attributes] LDAP Attribute to use as the unique ID for users. This should be a stable globally unique ID like a UUID. @@ -1120,7 +1179,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++owncloudUUID ++ +++ownCloudUUID ++ a| [subs=-attributes] LDAP Attribute to use as the unique id for groups. This should be a stable globally unique ID like a UUID. @@ -1359,7 +1418,7 @@ Template for the instance URL. Requires OCIS_MULTI_INSTANCE_ENABLED. a|`OCIS_LDAP_INSTANCE_MAPPER_CACHE_TTL` + a| [subs=-attributes] -++8.0.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++int ++ a| [subs=-attributes] @@ -1463,6 +1522,30 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. +a|`OCIS_NATS_CREDS_FILE` + +`GRAPH_EVENTS_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. + +a|`OCIS_NATS_CREDS` + +`GRAPH_EVENTS_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. + a|`GRAPH_AVAILABLE_ROLES` + a| [subs=-attributes] @@ -1624,7 +1707,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The master ID that grants access to all instances. Users with this ID in their memberOf or guestOf claims can access any instance. Leave empty to disable. +The master ID that grants access to all instances. Users with this ID in their memberOf or guestOf claims can access any instance. Leave empty to disable. Also set 'OCIS_LDAP_USER_FILTER'. Without an explicit user filter, this instance resolves every user in the shared LDAP directory. a|`OCIS_MULTI_INSTANCE_QUERY_TEMPLATE` + @@ -1637,6 +1720,17 @@ a| [subs=-attributes] a| [subs=-attributes] The regular expression extracting username and instancename from a user provided search. +a|`OCIS_MULTI_INSTANCE_GUEST_ROLE_MAPPING` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++[]string ++ +a| [subs=-attributes] +++[] ++ +a| [subs=-attributes] +(Optional) The guest role mapping of the proxy service. The graph service matches it against the LDAP attribute 'userClass' of guests without a role on this instance, so they can receive vault shares before their first login here. 'userClass' must hold the same values as the PROXY_ROLE_ASSIGNMENT_OIDC_CLAIM claim. + a|`OCIS_MAX_TAG_LENGTH` + a| [subs=-attributes] @@ -1651,7 +1745,7 @@ Define the maximum tag length. Defaults to 100 if not set. Set to 0 to not limit a|`GRAPH_MAX_IMAGE_FILE_SIZE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] @@ -1671,6 +1765,18 @@ a| [subs=-attributes] a| [subs=-attributes] Enable vault mode in addition to the regular graph service. This only applies when the additional storage-users-vault service is running, which is a special configured storage-users service. +a|`OCIS_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS` + +`GRAPH_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++int ++ +a| [subs=-attributes] +++30 ++ +a| [subs=-attributes] +The default expiration, in days, applied to a vault user or group share created without an explicit expiration date. Space memberships are exempt. + a|`OCIS_ENABLE_USER_SHARING` + a| [subs=-attributes] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/groups_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/groups_configvars.adoc index f432186b..6b875f18 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/groups_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/groups_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the groups service [width="100%",cols="~,~,~,~",options="header"] @@ -259,7 +259,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++ldap ++ a| [subs=-attributes] -The driver which should be used by the groups service. Supported values are 'ldap' and 'owncloudsql'. +The driver which should be used by the groups service. Supported value is 'ldap'. a|`OCIS_LDAP_URI` + `GROUPS_LDAP_URI` + @@ -487,7 +487,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The master instance ID for multi-instance setups. When set, LDAP user filters are enhanced to also match users belonging to the master instance. +The master instance ID for multi-instance setups. When set, LDAP user filters are enhanced to also match users belonging to the master instance. Also set 'user_filter'. Without an explicit 'user_filter', this instance resolves every user in the shared LDAP directory. a|`OCIS_LDAP_USER_MEMBER_ATTRIBUTE` + @@ -519,7 +519,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ownclouduuid ++ +++ownCloudUUID ++ a| [subs=-attributes] LDAP Attribute to use as the unique id for users. This should be a stable globally unique id like a UUID. @@ -555,7 +555,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++displayname ++ +++displayName ++ a| [subs=-attributes] LDAP Attribute to use for the displayname of users. @@ -579,7 +579,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ownclouduuid ++ +++ownCloudUUID ++ a| [subs=-attributes] LDAP Attribute to use as the unique id for groups. This should be a stable globally unique ID like a UUID. @@ -678,115 +678,5 @@ a| [subs=-attributes] ++30s ++ a| [subs=-attributes] Maximum time to wait for a pooled LDAP connection to become available once the pool is exhausted. Defaults to 30s when unset or <= 0. See the Environment Variable Types description for more details. - -a|`GROUPS_OWNCLOUDSQL_DB_USERNAME` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++owncloud ++ -a| [subs=-attributes] -Database user to use for authenticating with the owncloud database. - -a|`GROUPS_OWNCLOUDSQL_DB_PASSWORD` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++ ++ -a| [subs=-attributes] -Password for the database user. - -a|`GROUPS_OWNCLOUDSQL_DB_HOST` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++mysql ++ -a| [subs=-attributes] -Hostname of the database server. - -a|`GROUPS_OWNCLOUDSQL_DB_PORT` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++int ++ -a| [subs=-attributes] -++3306 ++ -a| [subs=-attributes] -Network port to use for the database connection. - -a|`GROUPS_OWNCLOUDSQL_DB_NAME` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++owncloud ++ -a| [subs=-attributes] -Name of the owncloud database. - -a|`GROUPS_OWNCLOUDSQL_IDP` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++https://localhost:9200 ++ -a| [subs=-attributes] -The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. - -a|`GROUPS_OWNCLOUDSQL_NOBODY` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++int64 ++ -a| [subs=-attributes] -++90 ++ -a| [subs=-attributes] -Fallback number if no numeric UID and GID properties are provided. - -a|`GROUPS_OWNCLOUDSQL_JOIN_USERNAME` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++bool ++ -a| [subs=-attributes] -++false ++ -a| [subs=-attributes] -Join the user properties table to read usernames. - -a|`GROUPS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++bool ++ -a| [subs=-attributes] -++false ++ -a| [subs=-attributes] -Join the user properties table to read user IDs. - -a|`GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++bool ++ -a| [subs=-attributes] -++false ++ -a| [subs=-attributes] -Allow 'medial search' when searching for users instead of just doing a prefix search. This allows finding 'Alice' when searching for 'lic'. |=== diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/idm_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/idm_configvars.adoc index 55d26143..54fde702 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/idm_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/idm_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the idm service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/idp_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/idp_configvars.adoc index 6ce25dba..9980a13c 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/idp_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/idp_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the idp service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/invitations_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/invitations_configvars.adoc index b9bd7802..ae9b0ba3 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/invitations_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/invitations_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the invitations service [width="100%",cols="~,~,~,~",options="header"] @@ -349,7 +349,7 @@ Disable TLS certificate validation for Keycloak connections. Do not set this in a|`INVITATIONS_KEYCLOAK_EXECUTE_ACTIONS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++[]string ++ a| [subs=-attributes] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/nats_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/nats_configvars.adoc index 7abc7de0..9f6ea8da 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/nats_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/nats_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the nats service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/notifications_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/notifications_configvars.adoc index 84656420..0f269675 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/notifications_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/notifications_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the notifications service [width="100%",cols="~,~,~,~",options="header"] @@ -355,6 +355,30 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. +a|`OCIS_NATS_CREDS_FILE` + +`NOTIFICATIONS_EVENTS_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. + +a|`OCIS_NATS_CREDS` + +`NOTIFICATIONS_EVENTS_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. + a|`OCIS_EMAIL_TEMPLATE_PATH` + `NOTIFICATIONS_EMAIL_TEMPLATE_PATH` + @@ -386,7 +410,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ ++ +++en ++ a| [subs=-attributes] The default language used by services and the WebUI. If not defined, English will be used as default. See the documentation for more details. @@ -423,6 +447,39 @@ a| [subs=-attributes] a| [subs=-attributes] Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the go-micro based grpc services. +a|`OCIS_GRPC_MAX_RECEIVED_MESSAGE_SIZE` + + +a| [subs=-attributes] +++pre5.0 ++ +a| [subs=-attributes] +++int ++ +a| [subs=-attributes] +++0 ++ +a| [subs=-attributes] +The maximum body size for grpc requests. Defaults to '10240000' bytes (10MB). Note that large values can potentially hide errors but may lead to network timeouts. Should only be changed temporarily to regain access for large folders with 25.000+ files to copy out data. + +a|`GRPC_CLIENT_KEEPALIVE_TIME` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++Duration ++ +a| [subs=-attributes] +++0s ++ +a| [subs=-attributes] +How long a grpc client connection with an ongoing request may stay silent before the server is pinged to check whether it is still answering. Set a duration like '20s' to enable detection of unresponsive peers. Leaving it unset, or at '0', sends no pings at all, which is grpc's own default. Values below '10s' are raised to '10s' by grpc. Make sure to include the unit suffix, a bare number is not a valid duration. + +a|`GRPC_CLIENT_KEEPALIVE_TIMEOUT` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++Duration ++ +a| [subs=-attributes] +++0s ++ +a| [subs=-attributes] +How long a grpc client waits for the answer to a keepalive ping before it considers the connection dead and fails all requests on it. Defaults to '10s'. Has no effect unless GRPC_CLIENT_KEEPALIVE_TIME is set. See GRPC_CLIENT_KEEPALIVE_TIME. + a|`OCIS_SERVICE_ACCOUNT_ID` + `NOTIFICATIONS_SERVICE_ACCOUNT_ID` + @@ -529,11 +586,35 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. +a|`OCIS_NATS_CREDS_FILE` + +`NOTIFICATIONS_STORE_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. + +a|`OCIS_NATS_CREDS` + +`NOTIFICATIONS_STORE_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. + a|`OCIS_PERSISTENT_STORE_ENABLE_TLS` + `NOTIFICATIONS_STORE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -545,19 +626,19 @@ a|`OCIS_PERSISTENT_STORE_TLS_INSECURE` + `NOTIFICATIONS_STORE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. +Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. a|`OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE` + `NOTIFICATIONS_STORE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/ocdav_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/ocdav_configvars.adoc index 63bce53b..0b64adec 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/ocdav_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/ocdav_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the ocdav service [width="100%",cols="~,~,~,~",options="header"] @@ -421,5 +421,16 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] Allow the use of depth infinity in PROPFINDS. When enabled, a propfind will traverse through all subfolders. If many subfolders are expected, depth infinity can cause heavy server load and/or delayed response times. + +a|`OCDAV_DISABLE_PROPFIND_PUBLIC_LINK_RESOLUTION` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++bool ++ +a| [subs=-attributes] +++false ++ +a| [subs=-attributes] +Disable the resolution of public link shares when answering PROPFIND requests. When disabled, the oc:share-type property will not be populated with public link share information, which can reduce load on services for large collections. |=== diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/ocm_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/ocm_configvars.adoc index 14d70ae2..dea4bf89 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/ocm_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/ocm_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the ocm service [width="100%",cols="~,~,~,~",options="header"] @@ -383,6 +383,30 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. +a|`OCIS_NATS_CREDS_FILE` + +`OCM_EVENTS_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. + +a|`OCIS_NATS_CREDS` + +`OCM_EVENTS_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. + a|`OCIS_JWT_SECRET` + `OCM_JWT_SECRET` + diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/ocs_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/ocs_configvars.adoc index 729ad8f0..928fe84b 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/ocs_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/ocs_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the ocs service [width="100%",cols="~,~,~,~",options="header"] @@ -334,11 +334,35 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. +a|`OCIS_NATS_CREDS_FILE` + +`OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. + +a|`OCIS_NATS_CREDS` + +`OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. + a|`OCIS_CACHE_ENABLE_TLS` + `OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -350,19 +374,19 @@ a|`OCIS_CACHE_TLS_INSECURE` + `OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Disable TLS certificate verification for the signing key store connection. Only applies when store type 'nats-js-kv' is configured. +Disable TLS certificate verification for the signing key store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + `OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/policies_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/policies_configvars.adoc index ff5c12f4..5a4bed4d 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/policies_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/policies_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the policies service [width="100%",cols="~,~,~,~",options="header"] @@ -170,6 +170,30 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. +a|`OCIS_NATS_CREDS_FILE` + +`POLICIES_EVENTS_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. + +a|`OCIS_NATS_CREDS` + +`POLICIES_EVENTS_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. + a|`OCIS_LOG_LEVEL` + `POLICIES_LOG_LEVEL` + diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/postprocessing_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/postprocessing_configvars.adoc index 16edf1f5..8fe548b2 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/postprocessing_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/postprocessing_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the postprocessing service [width="100%",cols="~,~,~,~",options="header"] @@ -253,11 +253,35 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. +a|`OCIS_NATS_CREDS_FILE` + +`POSTPROCESSING_STORE_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. + +a|`OCIS_NATS_CREDS` + +`POSTPROCESSING_STORE_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. + a|`OCIS_PERSISTENT_STORE_ENABLE_TLS` + `POSTPROCESSING_STORE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -269,19 +293,19 @@ a|`OCIS_PERSISTENT_STORE_TLS_INSECURE` + `POSTPROCESSING_STORE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. +Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. a|`OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE` + `POSTPROCESSING_STORE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] @@ -373,6 +397,30 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. +a|`OCIS_NATS_CREDS_FILE` + +`POSTPROCESSING_EVENTS_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. + +a|`OCIS_NATS_CREDS` + +`POSTPROCESSING_EVENTS_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. + a|`POSTPROCESSING_WORKERS` + a| [subs=-attributes] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/proxy_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/proxy_configvars.adoc index f760c3df..c5c6fae7 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/proxy_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/proxy_configvars.adoc @@ -2,11 +2,11 @@ // if the generated adoc file is used outside tabs, it renders correctly depending on the attribute set. // if inside, you need to also use the xxx_deprecation.adoc file. attributes can't be defined inside tabs. -:show-deprecation: false +:show-deprecation: true ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the proxy service [width="100%",cols="~,~,~,~",options="header"] @@ -15,6 +15,11 @@ ifeval::[{show-deprecation} == true] | Deprecation Version | Removal Version | Deprecation Replacement + +| The global variable OCIS_CACHE_DATABASE is deprecated and will be removed in a future release. Please use local variable PROXY_OIDC_USERINFO_CACHE_DATABASE instead. +| +| +| |=== {empty} + @@ -306,17 +311,6 @@ a| [subs=-attributes] a| [subs=-attributes] Sets how OIDC access tokens should be verified. Possible values are 'none' and 'jwt'. When using 'none', no special validation apart from using it for accessing the IDP's userinfo endpoint will be done. When using 'jwt', it tries to parse the access token as a jwt token and verifies the signature using the keys published on the IDP's 'jwks_uri'. -a|`PROXY_OIDC_ACCESS_TOKEN_VERIFY_AUD` + - -a| [subs=-attributes] -++8.2.0 ++ -a| [subs=-attributes] -++[]string ++ -a| [subs=-attributes] -++[] ++ -a| [subs=-attributes] -A list of accepted audiences for OIDC access tokens, usually the OIDC client IDs used to access ownCloud (for example the web and desktop client IDs). When set, a JWT access token is only accepted if one of these values is present in its 'aud' claim or matches its 'azp' claim. This prevents tokens issued for other applications of a shared IDP from being accepted. When set via the environment variable, use a comma-separated list. Has no effect when 'PROXY_OIDC_ACCESS_TOKEN_VERIFY_METHOD' is set to 'none'. Leave empty to disable the check (default). - a|`PROXY_OIDC_SKIP_USER_INFO` + a| [subs=-attributes] @@ -353,9 +347,10 @@ a| [subs=-attributes] 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. a|`OCIS_CACHE_DATABASE` + - +`PROXY_OIDC_USERINFO_CACHE_DATABASE` + +xref:deprecation-note-2026-11-13-11-05-23[Deprecation Note] a| [subs=-attributes] -++pre5.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] @@ -422,11 +417,35 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the cache. Only applies when store type 'nats-js-kv' is configured. +a|`OCIS_NATS_CREDS_FILE` + +`PROXY_OIDC_USERINFO_CACHE_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. + +a|`OCIS_NATS_CREDS` + +`PROXY_OIDC_USERINFO_CACHE_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. + a|`OCIS_CACHE_ENABLE_TLS` + `PROXY_OIDC_USERINFO_CACHE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -438,7 +457,7 @@ a|`OCIS_CACHE_TLS_INSECURE` + `PROXY_OIDC_USERINFO_CACHE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -450,7 +469,7 @@ a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + `PROXY_OIDC_USERINFO_CACHE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] @@ -513,6 +532,17 @@ a| [subs=-attributes] a| [subs=-attributes] Enables rewriting the /.well-known/openid-configuration to the configured OIDC issuer. Needed by the Desktop Client, Android Client and iOS Client to discover the OIDC provider. +a|`PROXY_OIDC_ACCESS_TOKEN_VERIFY_AUD` + + +a| [subs=-attributes] +++8.2.0 ++ +a| [subs=-attributes] +++[]string ++ +a| [subs=-attributes] +++[] ++ +a| [subs=-attributes] +A list of accepted audiences for OIDC access tokens, usually the OIDC client IDs used to access ownCloud (for example the web and desktop client IDs). When set, a JWT access token is only accepted if one of these values is present in its 'aud' claim or matches its 'azp' claim. This prevents tokens issued for other applications of a shared IDP from being accepted. When set via the environment variable, use a comma-separated list. Has no effect when 'PROXY_OIDC_ACCESS_TOKEN_VERIFY_METHOD' is set to 'none'. Leave empty to disable the check (default). + a|`OCIS_SERVICE_ACCOUNT_ID` + `PROXY_SERVICE_ACCOUNT_ID` + @@ -642,11 +672,35 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. +a|`OCIS_NATS_CREDS_FILE` + +`PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. + +a|`OCIS_NATS_CREDS` + +`PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. + a|`OCIS_CACHE_ENABLE_TLS` + `PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -658,7 +712,7 @@ a|`OCIS_CACHE_TLS_INSECURE` + `PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -670,7 +724,7 @@ a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + `PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] @@ -928,6 +982,30 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. +a|`OCIS_NATS_CREDS_FILE` + +`PROXY_EVENTS_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. + +a|`OCIS_NATS_CREDS` + +`PROXY_EVENTS_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. + a|`OCIS_CLAIM_MANAGED_SPACES_ENABLED` + a| [subs=-attributes] @@ -1071,6 +1149,17 @@ a| [subs=-attributes] a| [subs=-attributes] The role that should be assigned to a guest user +a|`OCIS_MULTI_INSTANCE_GUEST_ROLE_MAPPING` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++[]string ++ +a| [subs=-attributes] +++[] ++ +a| [subs=-attributes] +(Optional) Mapping of PROXY_ROLE_ASSIGNMENT_OIDC_CLAIM values to the role a guest gets instead of OCIS_MULTI_INSTANCE_GUEST_ROLE. Example: 'spaceadmin:user-light-vault'. A claim value is an exact string or a regular expression that must match the full claim value, the same as the claim_value of the role mapping. Escape regex metacharacters such as '.' in an exact string. The first match wins. Role names must not contain a colon. Only applies to the 'oidc' role assignment driver. + a|`OCIS_ENABLE_VAULT_MODE` + `PROXY_ENABLE_VAULT_MODE` + diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/proxy_deprecation.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/proxy_deprecation.adoc index 4b3cef68..e452d9c3 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/proxy_deprecation.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/proxy_deprecation.adoc @@ -1,2 +1,2 @@ -:show-deprecation: false +:show-deprecation: true diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/search_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/search_configvars.adoc index 22890c4e..07f1f66f 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/search_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/search_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the search service [width="100%",cols="~,~,~,~",options="header"] @@ -345,6 +345,30 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. +a|`OCIS_NATS_CREDS_FILE` + +`SEARCH_EVENTS_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. + +a|`OCIS_NATS_CREDS` + +`SEARCH_EVENTS_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. + a|`SEARCH_ENGINE_TYPE` + a| [subs=-attributes] @@ -423,6 +447,17 @@ a| [subs=-attributes] a| [subs=-attributes] Defines if stop words should be cleaned or not. See the documentation for more details. +a|`SEARCH_EXTRACTOR_MAX_CONSECUTIVE_FAILURES` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++int ++ +a| [subs=-attributes] +++5 ++ +a| [subs=-attributes] +Abort a space (re)index walk after this many files in a row fail content extraction, which usually means the extraction service is down. Files that cannot be resolved at all are logged and skipped without counting towards this limit. Set to 0 to never abort. + a|`SEARCH_CONTENT_EXTRACTION_SIZE_LIMIT` + a| [subs=-attributes] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/settings_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/settings_configvars.adoc index b0e7eaf5..3d52b6d2 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/settings_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/settings_configvars.adoc @@ -2,11 +2,11 @@ // if the generated adoc file is used outside tabs, it renders correctly depending on the attribute set. // if inside, you need to also use the xxx_deprecation.adoc file. attributes can't be defined inside tabs. -:show-deprecation: false +:show-deprecation: true ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the settings service [width="100%",cols="~,~,~,~",options="header"] @@ -15,6 +15,11 @@ ifeval::[{show-deprecation} == true] | Deprecation Version | Removal Version | Deprecation Replacement + +| The global variable OCIS_CACHE_DATABASE is deprecated and will be removed in a future release. Please use local variable SETTINGS_CACHE_DATABASE instead. +| +| +| |=== {empty} + @@ -369,9 +374,10 @@ a| [subs=-attributes] 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. a|`OCIS_CACHE_DATABASE` + - +`SETTINGS_CACHE_DATABASE` + +xref:deprecation-note-2026-11-13-11-05-23[Deprecation Note] a| [subs=-attributes] -++pre5.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] @@ -449,11 +455,35 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the cache. Only applies when store type 'nats-js-kv' is configured. +a|`OCIS_NATS_CREDS_FILE` + +`SETTINGS_CACHE_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. + +a|`OCIS_NATS_CREDS` + +`SETTINGS_CACHE_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. + a|`OCIS_CACHE_ENABLE_TLS` + `SETTINGS_CACHE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -465,7 +495,7 @@ a|`OCIS_CACHE_TLS_INSECURE` + `SETTINGS_CACHE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -477,7 +507,7 @@ a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + `SETTINGS_CACHE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] @@ -551,7 +581,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ ++ +++en ++ a| [subs=-attributes] The default language used by services and the WebUI. If not defined, English will be used as default. See the documentation for more details. diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/settings_deprecation.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/settings_deprecation.adoc index 4b3cef68..e452d9c3 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/settings_deprecation.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/settings_deprecation.adoc @@ -1,2 +1,2 @@ -:show-deprecation: false +:show-deprecation: true diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/sharing_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/sharing_configvars.adoc index ddf03b94..c1d65ac4 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/sharing_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/sharing_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the sharing service [width="100%",cols="~,~,~,~",options="header"] @@ -323,6 +323,30 @@ a| [subs=-attributes] a| [subs=-attributes] Password for the events broker. +a|`OCIS_NATS_CREDS_FILE` + +`SHARING_EVENTS_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. + +a|`OCIS_NATS_CREDS` + +`SHARING_EVENTS_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. + a|`SHARING_SKIP_USER_GROUPS_IN_TOKEN` + a| [subs=-attributes] @@ -343,7 +367,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++jsoncs3 ++ a| [subs=-attributes] -Driver to be used to persist shares. Supported values are 'jsoncs3', 'json', 'cs3' (deprecated) and 'owncloudsql'. +Driver to be used to persist shares. Supported values are 'jsoncs3', 'json' and 'cs3' (deprecated). a|`SHARING_USER_JSONCS3_PROVIDER_ADDR` + @@ -473,72 +497,6 @@ a| [subs=-attributes] a| [subs=-attributes] API key for the STORAGE-SYSTEM system user. -a|`SHARING_USER_OWNCLOUDSQL_DB_USERNAME` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++owncloud ++ -a| [subs=-attributes] -Username for the database. - -a|`SHARING_USER_OWNCLOUDSQL_DB_PASSWORD` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++ ++ -a| [subs=-attributes] -Password for the database. - -a|`SHARING_USER_OWNCLOUDSQL_DB_HOST` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++mysql ++ -a| [subs=-attributes] -Hostname or IP of the database server. - -a|`SHARING_USER_OWNCLOUDSQL_DB_PORT` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++int ++ -a| [subs=-attributes] -++3306 ++ -a| [subs=-attributes] -Port that the database server is listening on. - -a|`SHARING_USER_OWNCLOUDSQL_DB_NAME` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++owncloud ++ -a| [subs=-attributes] -Name of the database to be used. - -a|`SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++ ++ -a| [subs=-attributes] -Mount ID of the ownCloudSQL users storage for mapping ownCloud 10 shares. - a|`SHARING_PUBLIC_DRIVER` + a| [subs=-attributes] @@ -679,6 +637,30 @@ a| [subs=-attributes] a| [subs=-attributes] Set this to true if you want to enforce passwords on all public shares. +a|`OCIS_SHARING_ENABLE_EXPIRED_SHARES_CLEANUP` + +`SHARING_ENABLE_EXPIRED_SHARES_CLEANUP` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++bool ++ +a| [subs=-attributes] +++true ++ +a| [subs=-attributes] +Enable the periodic removal of expired public shares. When disabled, expired shares are still hidden from listings but never actually deleted. + +a|`OCIS_SHARING_JANITOR_RUN_INTERVAL` + +`SHARING_JANITOR_RUN_INTERVAL` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++int ++ +a| [subs=-attributes] +++3600 ++ +a| [subs=-attributes] +Interval in seconds between two runs of the janitor that permanently deletes expired public shares. Defaults to '3600' (1 hour). Only relevant when OCIS_SHARING_ENABLE_EXPIRED_SHARES_CLEANUP is enabled. + a|`OCIS_ENABLE_USER_SHARING` + a| [subs=-attributes] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/sse_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/sse_configvars.adoc index 89cbae0f..5801b7ef 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/sse_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/sse_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the sse service [width="100%",cols="~,~,~,~",options="header"] @@ -266,6 +266,30 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. +a|`OCIS_NATS_CREDS_FILE` + +`SSE_EVENTS_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. + +a|`OCIS_NATS_CREDS` + +`SSE_EVENTS_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. + a|`SSE_HTTP_ADDR` + a| [subs=-attributes] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-publiclink_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-publiclink_configvars.adoc index dd693f72..ff39ac02 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-publiclink_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-publiclink_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the storage-publiclink service [width="100%",cols="~,~,~,~",options="header"] @@ -331,11 +331,35 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. +a|`OCIS_NATS_CREDS_FILE` + +`STORAGE_PUBLICLINK_STORE_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. + +a|`OCIS_NATS_CREDS` + +`STORAGE_PUBLICLINK_STORE_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. + a|`OCIS_PERSISTENT_STORE_ENABLE_TLS` + `STORAGE_PUBLICLINK_STORE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -347,19 +371,19 @@ a|`OCIS_PERSISTENT_STORE_TLS_INSECURE` + `STORAGE_PUBLICLINK_STORE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. +Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. a|`OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE` + `STORAGE_PUBLICLINK_STORE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-shares_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-shares_configvars.adoc index 562ce485..2387edad 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-shares_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-shares_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the storage-shares service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-system_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-system_configvars.adoc index bcd7d60e..05a20d59 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-system_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-system_configvars.adoc @@ -2,11 +2,11 @@ // if the generated adoc file is used outside tabs, it renders correctly depending on the attribute set. // if inside, you need to also use the xxx_deprecation.adoc file. attributes can't be defined inside tabs. -:show-deprecation: false +:show-deprecation: true ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the storage-system service [width="100%",cols="~,~,~,~",options="header"] @@ -15,6 +15,11 @@ ifeval::[{show-deprecation} == true] | Deprecation Version | Removal Version | Deprecation Replacement + +| The global variable OCIS_CACHE_DATABASE is deprecated and will be removed in a future release. Please use local variable STORAGE_SYSTEM_CACHE_DATABASE instead. +| +| +| |=== {empty} + @@ -319,9 +324,10 @@ a| [subs=-attributes] 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. a|`OCIS_CACHE_DATABASE` + - +`STORAGE_SYSTEM_CACHE_DATABASE` + +xref:deprecation-note-2026-11-13-11-05-23[Deprecation Note] a| [subs=-attributes] -++pre5.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] @@ -377,11 +383,35 @@ a| [subs=-attributes] a| [subs=-attributes] Password for the configured store. Only applies when store type 'nats-js-kv' is configured. +a|`OCIS_NATS_CREDS_FILE` + +`STORAGE_SYSTEM_CACHE_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. + +a|`OCIS_NATS_CREDS` + +`STORAGE_SYSTEM_CACHE_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. + a|`OCIS_CACHE_ENABLE_TLS` + `STORAGE_SYSTEM_CACHE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -393,19 +423,19 @@ a|`OCIS_CACHE_TLS_INSECURE` + `STORAGE_SYSTEM_CACHE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. +Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + `STORAGE_SYSTEM_CACHE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-system_deprecation.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-system_deprecation.adoc index 4b3cef68..e452d9c3 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-system_deprecation.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-system_deprecation.adoc @@ -1,2 +1,2 @@ -:show-deprecation: false +:show-deprecation: true diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-users_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-users_configvars.adoc index b9d34983..78a15911 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-users_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-users_configvars.adoc @@ -2,11 +2,11 @@ // if the generated adoc file is used outside tabs, it renders correctly depending on the attribute set. // if inside, you need to also use the xxx_deprecation.adoc file. attributes can't be defined inside tabs. -:show-deprecation: false +:show-deprecation: true ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the storage-users service [width="100%",cols="~,~,~,~",options="header"] @@ -15,6 +15,16 @@ ifeval::[{show-deprecation} == true] | Deprecation Version | Removal Version | Deprecation Replacement + +| The global variable OCIS_CACHE_DATABASE is deprecated and will be removed in a future release. Please use local variable STORAGE_USERS_FILEMETADATA_CACHE_DATABASE instead. +| +| +| + +| The global variable OCIS_CACHE_DATABASE is deprecated and will be removed in a future release. Please use local variable STORAGE_USERS_ID_CACHE_DATABASE instead. +| +| +| |=== {empty} + @@ -375,7 +385,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++ocis ++ a| [subs=-attributes] -The storage driver which should be used by the service. Defaults to 'ocis', Supported values are: 'ocis', 's3ng' and 'owncloudsql' (deprecated). The 'ocis' driver stores all data (blob and meta data) in an POSIX compliant volume. The 's3ng' driver stores metadata in a POSIX compliant volume and uploads blobs to the s3 bucket. +The storage driver which should be used by the service. Defaults to 'ocis', Supported values are: 'ocis' and 's3ng'. The 'ocis' driver stores all data (blob and meta data) in an POSIX compliant volume. The 's3ng' driver stores metadata in a POSIX compliant volume and uploads blobs to the s3 bucket. a|`OCIS_DECOMPOSEDFS_PROPAGATOR` + `STORAGE_USERS_OCIS_PROPAGATOR` + @@ -835,259 +845,121 @@ a| [subs=-attributes] a| [subs=-attributes] Disables versioning of files. When set to true, new uploads with the same filename will overwrite existing files instead of creating a new version. -a|`STORAGE_USERS_OWNCLOUDSQL_DATADIR` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++/var/lib/ocis/storage/owncloud ++ -a| [subs=-attributes] -The directory where the filesystem storage will store SQL migration data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/owncloud. - -a|`STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++/Shares ++ -a| [subs=-attributes] -Name of the folder jailing all shares. - -a|`STORAGE_USERS_OWNCLOUDSQL_LAYOUT` + +a|`STORAGE_USERS_DATA_SERVER_URL` + a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++{{.Username}} ++ +++http://localhost:9158/data ++ a| [subs=-attributes] -Path layout to use to navigate into a users folder in an owncloud data directory +URL of the data server, needs to be reachable by the data gateway provided by the frontend service or the user if directly exposed. -a|`STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR` + +a|`STORAGE_USERS_DATA_GATEWAY_URL` + a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++/var/lib/ocis/storage/uploadinfo ++ +++https://localhost:9200/data ++ a| [subs=-attributes] -The directory where the filesystem will store uploads temporarily. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/uploadinfo. +URL of the data gateway server -a|`STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME` + +a|`STORAGE_USERS_TRANSFER_EXPIRES` + a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] -++string ++ +++int64 ++ a| [subs=-attributes] -++owncloud ++ +++86400 ++ a| [subs=-attributes] -Username for the database. +The time after which the token for upload postprocessing expires -a|`STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD` + +a|`OCIS_INSECURE` + +`STORAGE_USERS_EVENTS_TLS_INSECURE` + a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] -++string ++ +++bool ++ a| [subs=-attributes] -++owncloud ++ +++false ++ a| [subs=-attributes] -Password for the database. +Whether to verify the server TLS certificates. -a|`STORAGE_USERS_OWNCLOUDSQL_DB_HOST` + +a|`OCIS_EVENTS_ENABLE_TLS` + +`STORAGE_USERS_EVENTS_ENABLE_TLS` + a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] -++string ++ +++bool ++ a| [subs=-attributes] -++ ++ +++false ++ a| [subs=-attributes] -Hostname or IP of the database server. +Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. -a|`STORAGE_USERS_OWNCLOUDSQL_DB_PORT` + +a|`STORAGE_USERS_EVENTS_NUM_CONSUMERS` + a| [subs=-attributes] ++pre5.0 ++ a| [subs=-attributes] ++int ++ a| [subs=-attributes] -++3306 ++ -a| [subs=-attributes] -Port that the database server is listening on. - -a|`STORAGE_USERS_OWNCLOUDSQL_DB_NAME` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++owncloud ++ -a| [subs=-attributes] -Name of the database to be used. - -a|`STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++com.owncloud.api.users ++ -a| [subs=-attributes] -Endpoint of the users provider. - -a|`STORAGE_USERS_POSIX_ROOT` + - -a| [subs=-attributes] -++6.0.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++/var/lib/ocis/storage/users ++ -a| [subs=-attributes] -The directory where the filesystem storage will store its data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/users. - -a|`STORAGE_USERS_POSIX_PERSONAL_SPACE_PATH_TEMPLATE` + - -a| [subs=-attributes] -++6.0.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++users/{{.User.Username}} ++ -a| [subs=-attributes] -Template string to construct the paths of the personal space roots. - -a|`STORAGE_USERS_POSIX_GENERAL_SPACE_PATH_TEMPLATE` + - -a| [subs=-attributes] -++6.0.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++projects/{{.SpaceId}} ++ -a| [subs=-attributes] -Template string to construct the paths of the projects space roots. - -a|`STORAGE_USERS_PERMISSION_ENDPOINT` + -`STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT` + - -a| [subs=-attributes] -++6.0.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++com.owncloud.api.settings ++ -a| [subs=-attributes] -Endpoint of the permissions service. The endpoints can differ for 'ocis', 'posix' and 's3ng'. - -a|`OCIS_ASYNC_UPLOADS` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++bool ++ -a| [subs=-attributes] -++true ++ -a| [subs=-attributes] -Enable asynchronous file uploads. - -a|`STORAGE_USERS_POSIX_SCAN_DEBOUNCE_DELAY` + - -a| [subs=-attributes] -++6.0.0 ++ -a| [subs=-attributes] -++Duration ++ -a| [subs=-attributes] -++1s ++ -a| [subs=-attributes] -The time in milliseconds to wait before scanning the filesystem for changes after a change has been detected. - -a|`STORAGE_USERS_POSIX_USE_SPACE_GROUPS` + - -a| [subs=-attributes] -++6.0.0 ++ -a| [subs=-attributes] -++bool ++ -a| [subs=-attributes] -++false ++ +++0 ++ a| [subs=-attributes] -Use space groups to manage permissions on spaces. +The amount of concurrent event consumers to start. Event consumers are used for post-processing files. Multiple consumers increase parallelisation, but will also increase CPU and memory demands. The setting has no effect when the OCIS_ASYNC_UPLOADS is set to false. The default and minimum value is 1. -a|`STORAGE_USERS_POSIX_WATCH_TYPE` + +a|`OCIS_EVENTS_AUTH_USERNAME` + +`STORAGE_USERS_EVENTS_AUTH_USERNAME` + a| [subs=-attributes] -++6.0.0 ++ +++5.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -Type of the watcher to use for getting notified about changes to the filesystem. Currently available options are 'inotifywait' (default), 'gpfswatchfolder' and 'gpfsfileauditlogging'. +The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. -a|`STORAGE_USERS_POSIX_WATCH_PATH` + +a|`OCIS_EVENTS_AUTH_PASSWORD` + +`STORAGE_USERS_EVENTS_AUTH_PASSWORD` + a| [subs=-attributes] -++6.0.0 ++ +++5.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -Path to the watch directory/file. Only applies to the 'gpfsfileauditlogging' and 'inotifywait' watcher, in which case it is the path of the file audit log file/base directory to watch. +The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. -a|`STORAGE_USERS_POSIX_WATCH_FOLDER_KAFKA_BROKERS` + +a|`OCIS_NATS_CREDS_FILE` + +`STORAGE_USERS_EVENTS_CREDS_FILE` + a| [subs=-attributes] -++6.0.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -Comma-separated list of kafka brokers to read the watchfolder events from. +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. -a|`STORAGE_USERS_DATA_SERVER_URL` + +a|`OCIS_NATS_CREDS` + +`STORAGE_USERS_EVENTS_CREDS` + a| [subs=-attributes] -++pre5.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++http://localhost:9158/data ++ -a| [subs=-attributes] -URL of the data server, needs to be reachable by the data gateway provided by the frontend service or the user if directly exposed. - -a|`STORAGE_USERS_DATA_GATEWAY_URL` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++https://localhost:9200/data ++ -a| [subs=-attributes] -URL of the data gateway server - -a|`STORAGE_USERS_TRANSFER_EXPIRES` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++int64 ++ -a| [subs=-attributes] -++86400 ++ +++ ++ a| [subs=-attributes] -The time after which the token for upload postprocessing expires +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. a|`OCIS_EVENTS_ENDPOINT` + `STORAGE_USERS_EVENTS_ENDPOINT` + @@ -1113,18 +985,6 @@ a| [subs=-attributes] a| [subs=-attributes] 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. -a|`OCIS_INSECURE` + -`STORAGE_USERS_EVENTS_TLS_INSECURE` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++bool ++ -a| [subs=-attributes] -++false ++ -a| [subs=-attributes] -Whether to verify the server TLS certificates. - a|`OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE` + `STORAGE_USERS_EVENTS_TLS_ROOT_CA_CERTIFICATE` + @@ -1137,29 +997,6 @@ a| [subs=-attributes] a| [subs=-attributes] The root CA certificate used to validate the server's TLS certificate. If provided STORAGE_USERS_EVENTS_TLS_INSECURE will be seen as false. -a|`OCIS_EVENTS_ENABLE_TLS` + -`STORAGE_USERS_EVENTS_ENABLE_TLS` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++bool ++ -a| [subs=-attributes] -++false ++ -a| [subs=-attributes] -Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. - -a|`STORAGE_USERS_EVENTS_NUM_CONSUMERS` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++int ++ -a| [subs=-attributes] -++0 ++ -a| [subs=-attributes] -The amount of concurrent event consumers to start. Event consumers are used for post-processing files. Multiple consumers increase parallelisation, but will also increase CPU and memory demands. The setting has no effect when the OCIS_ASYNC_UPLOADS is set to false. The default and minimum value is 1. - a|`STORAGE_USERS_EVENTS_CONSUMER_GROUP` + a| [subs=-attributes] @@ -1171,30 +1008,6 @@ a| [subs=-attributes] a| [subs=-attributes] The name of the consumer group to be used at the event to help consumers identify the unique group. -a|`OCIS_EVENTS_AUTH_USERNAME` + -`STORAGE_USERS_EVENTS_AUTH_USERNAME` + - -a| [subs=-attributes] -++5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++ ++ -a| [subs=-attributes] -The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - -a|`OCIS_EVENTS_AUTH_PASSWORD` + -`STORAGE_USERS_EVENTS_AUTH_PASSWORD` + - -a| [subs=-attributes] -++5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++ ++ -a| [subs=-attributes] -The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - a|`OCIS_CACHE_STORE` + `STORAGE_USERS_FILEMETADATA_CACHE_STORE` + @@ -1220,9 +1033,10 @@ a| [subs=-attributes] 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. a|`OCIS_CACHE_DATABASE` + - +`STORAGE_USERS_FILEMETADATA_CACHE_DATABASE` + +xref:deprecation-note-2026-11-13-11-05-23[Deprecation Note] a| [subs=-attributes] -++pre5.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] @@ -1278,11 +1092,35 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the cache store. Only applies when store type 'nats-js-kv' is configured. +a|`OCIS_NATS_CREDS_FILE` + +`STORAGE_USERS_FILEMETADATA_CACHE_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. + +a|`OCIS_NATS_CREDS` + +`STORAGE_USERS_FILEMETADATA_CACHE_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. + a|`OCIS_CACHE_ENABLE_TLS` + `STORAGE_USERS_FILEMETADATA_CACHE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -1294,19 +1132,19 @@ a|`OCIS_CACHE_TLS_INSECURE` + `STORAGE_USERS_FILEMETADATA_CACHE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. +Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + `STORAGE_USERS_FILEMETADATA_CACHE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] @@ -1339,9 +1177,10 @@ a| [subs=-attributes] 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. a|`OCIS_CACHE_DATABASE` + - +`STORAGE_USERS_ID_CACHE_DATABASE` + +xref:deprecation-note-2026-11-13-11-05-23[Deprecation Note] a| [subs=-attributes] -++pre5.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] @@ -1397,11 +1236,35 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the cache store. Only applies when store type 'nats-js-kv' is configured. +a|`OCIS_NATS_CREDS_FILE` + +`STORAGE_USERS_ID_CACHE_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. + +a|`OCIS_NATS_CREDS` + +`STORAGE_USERS_ID_CACHE_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. + a|`OCIS_CACHE_ENABLE_TLS` + `STORAGE_USERS_ID_CACHE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -1413,19 +1276,19 @@ a|`OCIS_CACHE_TLS_INSECURE` + `STORAGE_USERS_ID_CACHE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. +Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. a|`OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE` + `STORAGE_USERS_ID_CACHE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-users_deprecation.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-users_deprecation.adoc index 4b3cef68..e452d9c3 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-users_deprecation.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/storage-users_deprecation.adoc @@ -1,2 +1,2 @@ -:show-deprecation: false +:show-deprecation: true diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/thumbnails_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/thumbnails_configvars.adoc index a48139b3..f48ab9bd 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/thumbnails_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/thumbnails_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the thumbnails service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/userlog_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/userlog_configvars.adoc index af8ef6c7..41c6efaf 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/userlog_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/userlog_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the userlog service [width="100%",cols="~,~,~,~",options="header"] @@ -316,7 +316,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ ++ +++en ++ a| [subs=-attributes] The default language used by services and the WebUI. If not defined, English will be used as default. See the documentation for more details. @@ -404,6 +404,30 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. +a|`OCIS_NATS_CREDS_FILE` + +`USERLOG_EVENTS_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. + +a|`OCIS_NATS_CREDS` + +`USERLOG_EVENTS_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. + a|`OCIS_MAX_CONCURRENCY` + `USERLOG_MAX_CONCURRENCY` + @@ -436,7 +460,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++[]string ++ a| [subs=-attributes] -++[] ++ +++[127.0.0.1:9233] ++ a| [subs=-attributes] 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. @@ -498,11 +522,35 @@ a| [subs=-attributes] a| [subs=-attributes] The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. +a|`OCIS_NATS_CREDS_FILE` + +`USERLOG_STORE_CREDS_FILE` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. + +a|`OCIS_NATS_CREDS` + +`USERLOG_STORE_CREDS` + + +a| [subs=-attributes] +++9.0.0 ++ +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. + a|`OCIS_PERSISTENT_STORE_ENABLE_TLS` + `USERLOG_STORE_ENABLE_TLS` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] @@ -514,19 +562,19 @@ a|`OCIS_PERSISTENT_STORE_TLS_INSECURE` + `USERLOG_STORE_TLS_INSECURE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++bool ++ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. +Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. a|`OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE` + `USERLOG_STORE_TLS_ROOT_CA_CERTIFICATE` + a| [subs=-attributes] -++8.3.0 ++ +++9.0.0 ++ a| [subs=-attributes] ++string ++ a| [subs=-attributes] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/users_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/users_configvars.adoc index 1e1b28e5..04ff0d70 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/users_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/users_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the users service [width="100%",cols="~,~,~,~",options="header"] @@ -259,7 +259,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++ldap ++ a| [subs=-attributes] -The driver which should be used by the users service. Supported values are 'ldap' and 'owncloudsql'. +The driver which should be used by the users service. Supported value is 'ldap'. a|`OCIS_LDAP_URI` + `USERS_LDAP_URI` + @@ -523,7 +523,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The master instance ID for multi-instance setups. When set, LDAP user filters are enhanced to also match users belonging to the master instance. +The master instance ID for multi-instance setups. When set, LDAP user filters are enhanced to also match users belonging to the master instance. Also set 'user_filter'. Without an explicit 'user_filter', this instance resolves every user in the shared LDAP directory. a|`OCIS_LDAP_USER_MEMBER_ATTRIBUTE` + @@ -555,7 +555,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ownclouduuid ++ +++ownCloudUUID ++ a| [subs=-attributes] LDAP Attribute to use as the unique ID for users. This should be a stable globally unique ID like a UUID. @@ -591,7 +591,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++displayname ++ +++displayName ++ a| [subs=-attributes] LDAP Attribute to use for the displayname of users. @@ -627,7 +627,7 @@ a| [subs=-attributes] a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ownclouduuid ++ +++ownCloudUUID ++ a| [subs=-attributes] LDAP Attribute to use as the unique ID for groups. This should be a stable globally unique ID like a UUID. @@ -726,115 +726,5 @@ a| [subs=-attributes] ++30s ++ a| [subs=-attributes] Maximum time to wait for a pooled LDAP connection to become available once the pool is exhausted. Defaults to 30s when unset or <= 0. See the Environment Variable Types description for more details. - -a|`USERS_OWNCLOUDSQL_DB_USERNAME` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++owncloud ++ -a| [subs=-attributes] -Database user to use for authenticating with the owncloud database. - -a|`USERS_OWNCLOUDSQL_DB_PASSWORD` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++secret ++ -a| [subs=-attributes] -Password for the database user. - -a|`USERS_OWNCLOUDSQL_DB_HOST` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++mysql ++ -a| [subs=-attributes] -Hostname of the database server. - -a|`USERS_OWNCLOUDSQL_DB_PORT` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++int ++ -a| [subs=-attributes] -++3306 ++ -a| [subs=-attributes] -Network port to use for the database connection. - -a|`USERS_OWNCLOUDSQL_DB_NAME` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++owncloud ++ -a| [subs=-attributes] -Name of the owncloud database. - -a|`USERS_OWNCLOUDSQL_IDP` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++https://localhost:9200 ++ -a| [subs=-attributes] -The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. - -a|`USERS_OWNCLOUDSQL_NOBODY` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++int64 ++ -a| [subs=-attributes] -++90 ++ -a| [subs=-attributes] -Fallback number if no numeric UID and GID properties are provided. - -a|`USERS_OWNCLOUDSQL_JOIN_USERNAME` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++bool ++ -a| [subs=-attributes] -++false ++ -a| [subs=-attributes] -Join the user properties table to read usernames - -a|`USERS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++bool ++ -a| [subs=-attributes] -++false ++ -a| [subs=-attributes] -Join the user properties table to read user IDs. - -a|`USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH` + - -a| [subs=-attributes] -++pre5.0 ++ -a| [subs=-attributes] -++bool ++ -a| [subs=-attributes] -++false ++ -a| [subs=-attributes] -Allow 'medial search' when searching for users instead of just doing a prefix search. This allows finding 'Alice' when searching for 'lic'. |=== diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/web_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/web_configvars.adoc index c6f3a654..217f2f3c 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/web_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/web_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the web service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/webdav_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/webdav_configvars.adoc index 94d62e73..60e3f911 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/webdav_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/webdav_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the webdav service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/webfinger_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/webfinger_configvars.adoc index 62fdb1fa..e9385a37 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/webfinger_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/adoc/webfinger_configvars.adoc @@ -6,7 +6,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2026-09-09-11-27-22] +[#deprecation-note-2026-11-13-11-05-23] [caption=] .Deprecation notes for the webfinger service [width="100%",cols="~,~,~,~",options="header"] diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/env_var_deltas/8.2.0-9.0.0-added.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/env_var_deltas/8.2.0-9.0.0-added.adoc index 9e0addfe..b1976546 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/env_var_deltas/8.2.0-9.0.0-added.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/env_var_deltas/8.2.0-9.0.0-added.adoc @@ -1,14 +1,54 @@ -// # Added Variables between oCIS 8.2.0 and oCIS 8.3.0 +// # Added Variables between oCIS 8.2.0 and oCIS 9.0.0 // commenting the headline to make it better includable -// table created per 2026.09.10 +// table created per 2026.11.13 // the table should be recreated/updated on source () changes [width="100%",cols="~,~,~,~",options="header"] |=== | Service | Variable | Description | Default +| xref:deployment/services/env-vars-special-scope.adoc[Special Scope Envvars] +| OCIS_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS +| The default expiration, in days, applied to a vault user or group share created without an explicit expiration date. Space memberships are exempt. +| 30 + +| +| OCIS_LDAP_USER_ADDITIONAL_OBJECTCLASSES +| Additional object classes to set when creating new users (e.g. to allow a custom surname attribute). The default classes 'inetOrgPerson', 'organizationalPerson', 'person', 'top' and 'ownCloudUser' are always included. +| [] + +| +| OCIS_LDAP_USER_SCHEMA_SURNAME +| LDAP Attribute to use for the surname of users. +| sn + +| +| OCIS_MULTI_INSTANCE_GUEST_ROLE_MAPPING +| (Optional) The guest role mapping of the proxy service. The graph service matches it against the LDAP attribute 'userClass' of guests without a role on this instance, so they can receive vault shares before their first login here. 'userClass' must hold the same values as the PROXY_ROLE_ASSIGNMENT_OIDC_CLAIM claim. +| [] + +| +| OCIS_NATS_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. +| + +| +| OCIS_NATS_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. +| + | xref:{s-path}/activitylog.adoc[Activitylog] +| ACTIVITYLOG_STORE_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. +| + +| +| ACTIVITYLOG_STORE_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. +| + +| | ACTIVITYLOG_STORE_ENABLE_TLS | Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. | false @@ -23,7 +63,47 @@ | Path to the PEM-encoded root CA certificate for the store TLS connection. Only applies when store type 'nats-js-kv' is configured. | +| xref:{s-path}/antivirus.adoc[Antivirus] +| ANTIVIRUS_EVENTS_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. +| + +| +| ANTIVIRUS_EVENTS_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. +| + +| xref:{s-path}/audit.adoc[Audit] +| AUDIT_EVENTS_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. +| + +| +| AUDIT_EVENTS_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. +| + +| xref:{s-path}/clientlog.adoc[Clientlog] +| CLIENTLOG_EVENTS_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. +| + +| +| CLIENTLOG_EVENTS_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. +| + | xref:{s-path}/collaboration.adoc[Collaboration] +| COLLABORATION_STORE_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. +| + +| +| COLLABORATION_STORE_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. +| + +| | COLLABORATION_STORE_ENABLE_TLS | Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. | false @@ -39,13 +119,33 @@ | | xref:{s-path}/eventhistory.adoc[Eventhistory] +| EVENTHISTORY_EVENTS_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. +| + +| +| EVENTHISTORY_EVENTS_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. +| + +| +| EVENTHISTORY_STORE_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. +| + +| +| EVENTHISTORY_STORE_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. +| + +| | EVENTHISTORY_STORE_ENABLE_TLS | Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. | false | | EVENTHISTORY_STORE_TLS_INSECURE -| Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. +| Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. | false | @@ -53,14 +153,44 @@ | Path to the PEM-encoded root CA certificate for the store TLS connection. Only applies when store type 'nats-js-kv' is configured. | +| xref:{s-path}/frontend.adoc[Frontend] +| FRONTEND_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS +| The default expiration, in days, applied to a vault user or group share created without an explicit expiration date. Reported via the vault capability so clients can reflect the admin-configured value. Must match the graph service's GRAPH_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS. +| 30 + +| +| FRONTEND_EVENTS_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. +| + +| +| FRONTEND_EVENTS_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. +| + | xref:{s-path}/gateway.adoc[Gateway] +| GATEWAY_PROVIDER_CACHE_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. +| + +| +| GATEWAY_PROVIDER_CACHE_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. +| + +| +| GATEWAY_PROVIDER_CACHE_DATABASE +| The database name the configured store should use. +| cache-providers + +| | GATEWAY_PROVIDER_CACHE_ENABLE_TLS | Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. | false | | GATEWAY_PROVIDER_CACHE_TLS_INSECURE -| Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. +| Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. | false | @@ -69,6 +199,16 @@ | | xref:{s-path}/graph.adoc[Graph] +| GRAPH_CACHE_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. +| + +| +| GRAPH_CACHE_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. +| + +| | GRAPH_CACHE_ENABLE_TLS | Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. | false @@ -83,24 +223,84 @@ | Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. | +| +| GRAPH_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS +| The default expiration, in days, applied to a vault user or group share created without an explicit expiration date. Space memberships are exempt. +| 30 + +| +| GRAPH_EVENTS_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. +| + +| +| GRAPH_EVENTS_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. +| + +| +| GRAPH_LDAP_USER_ADDITIONAL_OBJECTCLASSES +| Additional object classes to set when creating new users (e.g. to allow a custom surname attribute). The default classes 'inetOrgPerson', 'organizationalPerson', 'person', 'top' and 'ownCloudUser' are always included. +| [] + +| +| GRAPH_LDAP_USER_SEARCH_ATTRIBUTES +| The user attributes to match against when searching for users via the Graph API. Does not affect the legacy OCS sharees search, which always matches on username, display name, and mail. Accepts the logical names 'onPremisesSamAccountName', 'displayName', 'surname', 'mail' (case-insensitive), or any other LDAP attribute name directly. +| [onPremisesSamAccountName displayName mail] + +| +| GRAPH_LDAP_USER_SURNAME_ATTRIBUTE +| LDAP Attribute to use for the surname of users. +| sn + | | GRAPH_MAX_IMAGE_FILE_SIZE | The maximum file size of an image which can be set as a space image. Must be less than or equal to 'THUMBNAILS_MAX_INPUT_IMAGE_FILE_SIZE' of the thumbnails service, otherwise images between the two values are accepted but cannot be rendered. Usable common abbreviations: [KB, KiB, MB, MiB, GB, GiB, TB, TiB, PB, PiB, EB, EiB], example: 2GB. Set to 0 to not limit the file size. | 50MB +| xref:deployment/services/env-vars-special-scope.adoc#extended-environment-variables[Extended Environment Variables] +| GRPC_CLIENT_KEEPALIVE_TIME +| How long a grpc client connection with an ongoing request may stay silent before the server is pinged to check whether it is still answering. Set a duration like '20s' to enable detection of unresponsive peers. Leaving it unset, or at '0', sends no pings at all, which is grpc's own default. Values below '10s' are raised to '10s' by grpc. Make sure to include the unit suffix, a bare number is not a valid duration. +| 0s + +| +| GRPC_CLIENT_KEEPALIVE_TIMEOUT +| How long a grpc client waits for the answer to a keepalive ping before it considers the connection dead and fails all requests on it. Defaults to '10s'. Has no effect unless GRPC_CLIENT_KEEPALIVE_TIME is set. See GRPC_CLIENT_KEEPALIVE_TIME. +| 0s + | xref:{s-path}/invitations.adoc[Invitations] | INVITATIONS_KEYCLOAK_EXECUTE_ACTIONS | A comma-separated list of Keycloak required actions sent to invited guests via the execute-actions email. Values are passed to Keycloak as-is. Defaults to 'UPDATE_PASSWORD,VERIFY_EMAIL'. See the Environment Variable Types description for more details. | [UPDATE_PASSWORD VERIFY_EMAIL] | xref:{s-path}/notifications.adoc[Notifications] +| NOTIFICATIONS_EVENTS_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. +| + +| +| NOTIFICATIONS_EVENTS_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. +| + +| +| NOTIFICATIONS_STORE_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. +| + +| +| NOTIFICATIONS_STORE_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. +| + +| | NOTIFICATIONS_STORE_ENABLE_TLS | Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. | false | | NOTIFICATIONS_STORE_TLS_INSECURE -| Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. +| Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. | false | @@ -108,14 +308,39 @@ | Path to the PEM-encoded root CA certificate for the store TLS connection. Only applies when store type 'nats-js-kv' is configured. | +| xref:{s-path}/ocdav.adoc[OCDAV] +| OCDAV_DISABLE_PROPFIND_PUBLIC_LINK_RESOLUTION +| Disable the resolution of public link shares when answering PROPFIND requests. When disabled, the oc:share-type property will not be populated with public link share information, which can reduce load on services for large collections. +| false + +| xref:{s-path}/ocm.adoc[OCM] +| OCM_EVENTS_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. +| + +| +| OCM_EVENTS_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. +| + | xref:{s-path}/ocs.adoc[OCS] +| OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. +| + +| +| OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. +| + +| | OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_ENABLE_TLS | Activate TLS for the connection to the signing key store. Only applies when store type 'nats-js-kv' is configured. | false | | OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_TLS_INSECURE -| Disable TLS certificate verification for the signing key store connection. Only applies when store type 'nats-js-kv' is configured. +| Disable TLS certificate verification for the signing key store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. | false | @@ -123,14 +348,44 @@ | Path to the PEM-encoded root CA certificate for the signing key store TLS connection. Only applies when store type 'nats-js-kv' is configured. | +| xref:{s-path}/policies.adoc[Policies] +| POLICIES_EVENTS_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. +| + +| +| POLICIES_EVENTS_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. +| + | xref:{s-path}/postprocessing.adoc[Postprocessing] +| POSTPROCESSING_EVENTS_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. +| + +| +| POSTPROCESSING_EVENTS_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. +| + +| +| POSTPROCESSING_STORE_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. +| + +| +| POSTPROCESSING_STORE_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. +| + +| | POSTPROCESSING_STORE_ENABLE_TLS | Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. | false | | POSTPROCESSING_STORE_TLS_INSECURE -| Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. +| Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. | false | @@ -139,6 +394,31 @@ | | xref:{s-path}/proxy.adoc[Proxy] +| PROXY_EVENTS_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. +| + +| +| PROXY_EVENTS_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. +| + +| +| PROXY_OIDC_USERINFO_CACHE_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. +| + +| +| PROXY_OIDC_USERINFO_CACHE_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. +| + +| +| PROXY_OIDC_USERINFO_CACHE_DATABASE +| The database name the configured store should use. +| cache-userinfo + +| | PROXY_OIDC_USERINFO_CACHE_ENABLE_TLS | Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. | false @@ -153,6 +433,16 @@ | Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. | +| +| PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. +| + +| +| PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. +| + | | PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_ENABLE_TLS | Activate TLS for the connection to the signing key store. Only applies when store type 'nats-js-kv' is configured. @@ -168,7 +458,37 @@ | Path to the PEM-encoded root CA certificate for the signing key store TLS connection. Only applies when store type 'nats-js-kv' is configured. | +| xref:{s-path}/search.adoc[Search] +| SEARCH_EVENTS_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. +| + +| +| SEARCH_EVENTS_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. +| + +| +| SEARCH_EXTRACTOR_MAX_CONSECUTIVE_FAILURES +| Abort a space (re)index walk after this many files in a row fail content extraction, which usually means the extraction service is down. Files that cannot be resolved at all are logged and skipped without counting towards this limit. Set to 0 to never abort. +| 5 + | xref:{s-path}/settings.adoc[Settings] +| SETTINGS_CACHE_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. +| + +| +| SETTINGS_CACHE_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. +| + +| +| SETTINGS_CACHE_DATABASE +| The database name the configured store should use. +| settings-cache + +| | SETTINGS_CACHE_ENABLE_TLS | Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. | false @@ -183,14 +503,54 @@ | Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. | +| xref:{s-path}/sharing.adoc[Sharing] +| SHARING_ENABLE_EXPIRED_SHARES_CLEANUP +| Enable the periodic removal of expired public shares. When disabled, expired shares are still hidden from listings but never actually deleted. +| true + +| +| SHARING_EVENTS_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. +| + +| +| SHARING_EVENTS_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. +| + +| +| SHARING_JANITOR_RUN_INTERVAL +| Interval in seconds between two runs of the janitor that permanently deletes expired public shares. Defaults to '3600' (1 hour). Only relevant when OCIS_SHARING_ENABLE_EXPIRED_SHARES_CLEANUP is enabled. +| 3600 + +| xref:{s-path}/sse.adoc[SSE] +| SSE_EVENTS_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. +| + +| +| SSE_EVENTS_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. +| + | xref:{s-path}/storage-publiclink.adoc[Storage-Publiclink] +| STORAGE_PUBLICLINK_STORE_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. +| + +| +| STORAGE_PUBLICLINK_STORE_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. +| + +| | STORAGE_PUBLICLINK_STORE_ENABLE_TLS | Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. | false | | STORAGE_PUBLICLINK_STORE_TLS_INSECURE -| Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. +| Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. | false | @@ -199,13 +559,28 @@ | | xref:{s-path}/storage-system.adoc[Storage-System] +| STORAGE_SYSTEM_CACHE_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. +| + +| +| STORAGE_SYSTEM_CACHE_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. +| + +| +| STORAGE_SYSTEM_CACHE_DATABASE +| The database name the configured store should use. +| storage-system + +| | STORAGE_SYSTEM_CACHE_ENABLE_TLS | Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. | false | | STORAGE_SYSTEM_CACHE_TLS_INSECURE -| Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. +| Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. | false | @@ -214,13 +589,38 @@ | | xref:{s-path}/storage-users.adoc[Storage-Users] +| STORAGE_USERS_EVENTS_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. +| + +| +| STORAGE_USERS_EVENTS_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. +| + +| +| STORAGE_USERS_FILEMETADATA_CACHE_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. +| + +| +| STORAGE_USERS_FILEMETADATA_CACHE_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. +| + +| +| STORAGE_USERS_FILEMETADATA_CACHE_DATABASE +| The database name the configured store should use. +| storage-users + +| | STORAGE_USERS_FILEMETADATA_CACHE_ENABLE_TLS | Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. | false | | STORAGE_USERS_FILEMETADATA_CACHE_TLS_INSECURE -| Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. +| Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. | false | @@ -228,6 +628,21 @@ | Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. | +| +| STORAGE_USERS_ID_CACHE_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. +| + +| +| STORAGE_USERS_ID_CACHE_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. +| + +| +| STORAGE_USERS_ID_CACHE_DATABASE +| The database name the configured store should use. +| ids-storage-users + | | STORAGE_USERS_ID_CACHE_ENABLE_TLS | Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. @@ -235,7 +650,7 @@ | | STORAGE_USERS_ID_CACHE_TLS_INSECURE -| Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. +| Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. | false | @@ -244,13 +659,33 @@ | | xref:{s-path}/userlog.adoc[Userlog] +| USERLOG_EVENTS_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. +| + +| +| USERLOG_EVENTS_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the events broker when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. +| + +| +| USERLOG_STORE_CREDS +| Content of a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific variable takes precedence over a global variable. In the same scope, the content takes precedence over the path of a .creds file. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store type 'nats-js-kv' is configured. +| + +| +| USERLOG_STORE_CREDS_FILE +| Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate with the store when NATS runs in JWT (operator) mode. When set, the service does not use the username and the password. Exception: a service-specific username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the file again on each reconnect. Only applies when store type 'nats-js-kv' is configured. +| + +| | USERLOG_STORE_ENABLE_TLS | Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. | false | | USERLOG_STORE_TLS_INSECURE -| Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. +| Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. Do not enable this in production because it disables authentication of the NATS server. Use it only for testing with self-signed certificates. | false | diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/env_var_deltas/8.2.0-9.0.0-deprecated.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/env_var_deltas/8.2.0-9.0.0-deprecated.adoc index bbbe4210..b1fa2e09 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/env_var_deltas/8.2.0-9.0.0-deprecated.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/env_var_deltas/8.2.0-9.0.0-deprecated.adoc @@ -1,7 +1,7 @@ -// # Deprecated Variables between oCIS 8.2.0 and oCIS 8.3.0 +// # Deprecated Variables between oCIS 8.2.0 and oCIS 9.0.0 // commenting the headline to make it better includable -// table created per 2026.09.10 +// table created per 2026.11.13 // the table should be recreated/updated on source () changes [width="100%",cols="~,~,~,~,~",options="header"] @@ -62,5 +62,329 @@ | %%NEXT_PRODUCTION_VERSION%% | The OCS API is deprecated +| xref:{s-path}/auth-basic.adoc[Auth-Basic] +| AUTH_BASIC_OWNCLOUDSQL_DB_HOST +| Hostname of the database server. +| 9.0.0 +| AUTH_BASIC_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql driver is deprecated. + +| +| AUTH_BASIC_OWNCLOUDSQL_DB_NAME +| Name of the owncloud database. +| 9.0.0 +| AUTH_BASIC_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql driver is deprecated. + +| +| AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD +| Password for the database user. +| 9.0.0 +| AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql driver is deprecated. + +| +| AUTH_BASIC_OWNCLOUDSQL_DB_PORT +| Network port to use for the database connection. +| 9.0.0 +| AUTH_BASIC_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql driver is deprecated. + +| +| AUTH_BASIC_OWNCLOUDSQL_DB_USERNAME +| Database user to use for authenticating with the owncloud database. +| 9.0.0 +| AUTH_BASIC_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql driver is deprecated. + +| +| AUTH_BASIC_OWNCLOUDSQL_IDP +| The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. +| 9.0.0 +| AUTH_BASIC_OWNCLOUDSQL_IDP is deprecated because the owncloudsql driver is deprecated. + +| +| AUTH_BASIC_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID +| Join the user properties table to read user ID's. +| 9.0.0 +| AUTH_BASIC_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID is deprecated because the owncloudsql driver is deprecated. + +| +| AUTH_BASIC_OWNCLOUDSQL_JOIN_USERNAME +| Join the user properties table to read usernames +| 9.0.0 +| AUTH_BASIC_OWNCLOUDSQL_JOIN_USERNAME is deprecated because the owncloudsql driver is deprecated. + +| +| AUTH_BASIC_OWNCLOUDSQL_NOBODY +| Fallback number if no numeric UID and GID properties are provided. +| 9.0.0 +| AUTH_BASIC_OWNCLOUDSQL_NOBODY is deprecated because the owncloudsql driver is deprecated. + +| xref:{s-path}/groups.adoc[Groups] +| GROUPS_OWNCLOUDSQL_DB_HOST +| Hostname of the database server. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql driver is deprecated. + +| +| GROUPS_OWNCLOUDSQL_DB_NAME +| Name of the owncloud database. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql driver is deprecated. + +| +| GROUPS_OWNCLOUDSQL_DB_PASSWORD +| Password for the database user. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql driver is deprecated. + +| +| GROUPS_OWNCLOUDSQL_DB_PORT +| Network port to use for the database connection. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql driver is deprecated. + +| +| GROUPS_OWNCLOUDSQL_DB_USERNAME +| Database user to use for authenticating with the owncloud database. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql driver is deprecated. + +| +| GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH +| Allow 'medial search' when searching for users instead of just doing a prefix search. This allows finding 'Alice' when searching for 'lic'. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH is deprecated because the owncloudsql driver is deprecated. + +| +| GROUPS_OWNCLOUDSQL_IDP +| The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_IDP is deprecated because the owncloudsql driver is deprecated. + +| +| GROUPS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID +| Join the user properties table to read user IDs. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID is deprecated because the owncloudsql driver is deprecated. + +| +| GROUPS_OWNCLOUDSQL_JOIN_USERNAME +| Join the user properties table to read usernames. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_JOIN_USERNAME is deprecated because the owncloudsql driver is deprecated. + +| +| GROUPS_OWNCLOUDSQL_NOBODY +| Fallback number if no numeric UID and GID properties are provided. +| 9.0.0 +| GROUPS_OWNCLOUDSQL_NOBODY is deprecated because the owncloudsql driver is deprecated. + +| xref:{s-path}/sharing.adoc[Sharing] +| SHARING_USER_OWNCLOUDSQL_DB_HOST +| Hostname or IP of the database server. +| 9.0.0 +| SHARING_USER_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql driver is deprecated. + +| +| SHARING_USER_OWNCLOUDSQL_DB_NAME +| Name of the database to be used. +| 9.0.0 +| SHARING_USER_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql driver is deprecated. + +| +| SHARING_USER_OWNCLOUDSQL_DB_PASSWORD +| Password for the database. +| 9.0.0 +| SHARING_USER_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql driver is deprecated. + +| +| SHARING_USER_OWNCLOUDSQL_DB_PORT +| Port that the database server is listening on. +| 9.0.0 +| SHARING_USER_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql driver is deprecated. + +| +| SHARING_USER_OWNCLOUDSQL_DB_USERNAME +| Username for the database. +| 9.0.0 +| SHARING_USER_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql driver is deprecated. + +| +| SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID +| Mount ID of the ownCloudSQL users storage for mapping ownCloud 10 shares. +| 9.0.0 +| SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID is deprecated because the owncloudsql driver is deprecated. + +| xref:{s-path}/storage-users.adoc[Storage-Users] +| STORAGE_USERS_OWNCLOUDSQL_DATADIR +| The directory where the filesystem storage will store SQL migration data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/owncloud. +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_DATADIR is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_OWNCLOUDSQL_DB_HOST +| Hostname or IP of the database server. +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_OWNCLOUDSQL_DB_NAME +| Name of the database to be used. +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD +| Password for the database. +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_OWNCLOUDSQL_DB_PORT +| Port that the database server is listening on. +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME +| Username for the database. +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_OWNCLOUDSQL_LAYOUT +| Path layout to use to navigate into a users folder in an owncloud data directory +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_LAYOUT is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER +| Name of the folder jailing all shares. +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR +| The directory where the filesystem will store uploads temporarily. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/uploadinfo. +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT +| Endpoint of the users provider. +| 9.0.0 +| STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT is deprecated because the owncloudsql driver is deprecated. + +| +| STORAGE_USERS_POSIX_GENERAL_SPACE_PATH_TEMPLATE +| Template string to construct the paths of the projects space roots. +| 9.0.0 +| STORAGE_USERS_POSIX_GENERAL_SPACE_PATH_TEMPLATE is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. + +| +| STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT +| Endpoint of the permissions service. The endpoints can differ for 'ocis', 'posix' and 's3ng'. +| 9.0.0 +| STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. + +| +| STORAGE_USERS_POSIX_PERSONAL_SPACE_PATH_TEMPLATE +| Template string to construct the paths of the personal space roots. +| 9.0.0 +| STORAGE_USERS_POSIX_PERSONAL_SPACE_PATH_TEMPLATE is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. + +| +| STORAGE_USERS_POSIX_ROOT +| The directory where the filesystem storage will store its data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/users. +| 9.0.0 +| STORAGE_USERS_POSIX_ROOT is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. + +| +| STORAGE_USERS_POSIX_SCAN_DEBOUNCE_DELAY +| The time in milliseconds to wait before scanning the filesystem for changes after a change has been detected. +| 9.0.0 +| STORAGE_USERS_POSIX_SCAN_DEBOUNCE_DELAY is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. + +| +| STORAGE_USERS_POSIX_USE_SPACE_GROUPS +| Use space groups to manage permissions on spaces. +| 9.0.0 +| STORAGE_USERS_POSIX_USE_SPACE_GROUPS is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. + +| +| STORAGE_USERS_POSIX_WATCH_FOLDER_KAFKA_BROKERS +| Comma-separated list of kafka brokers to read the watchfolder events from. +| 9.0.0 +| STORAGE_USERS_POSIX_WATCH_FOLDER_KAFKA_BROKERS is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. + +| +| STORAGE_USERS_POSIX_WATCH_PATH +| Path to the watch directory/file. Only applies to the 'gpfsfileauditlogging' and 'inotifywait' watcher, in which case it is the path of the file audit log file/base directory to watch. +| 9.0.0 +| STORAGE_USERS_POSIX_WATCH_PATH is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. + +| +| STORAGE_USERS_POSIX_WATCH_TYPE +| Type of the watcher to use for getting notified about changes to the filesystem. Currently available options are 'inotifywait' (default), 'gpfswatchfolder' and 'gpfsfileauditlogging'. +| 9.0.0 +| STORAGE_USERS_POSIX_WATCH_TYPE is deprecated because the posixfs storage driver is deprecated and will be removed in 9.0.0. + +| xref:{s-path}/users.adoc[Users] +| USERS_OWNCLOUDSQL_DB_HOST +| Hostname of the database server. +| 9.0.0 +| USERS_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql driver is deprecated. + +| +| USERS_OWNCLOUDSQL_DB_NAME +| Name of the owncloud database. +| 9.0.0 +| USERS_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql driver is deprecated. + +| +| USERS_OWNCLOUDSQL_DB_PASSWORD +| Password for the database user. +| 9.0.0 +| USERS_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql driver is deprecated. + +| +| USERS_OWNCLOUDSQL_DB_PORT +| Network port to use for the database connection. +| 9.0.0 +| USERS_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql driver is deprecated. + +| +| USERS_OWNCLOUDSQL_DB_USERNAME +| Database user to use for authenticating with the owncloud database. +| 9.0.0 +| USERS_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql driver is deprecated. + +| +| USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH +| Allow 'medial search' when searching for users instead of just doing a prefix search. This allows finding 'Alice' when searching for 'lic'. +| 9.0.0 +| USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH is deprecated because the owncloudsql driver is deprecated. + +| +| USERS_OWNCLOUDSQL_IDP +| The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. +| 9.0.0 +| USERS_OWNCLOUDSQL_IDP is deprecated because the owncloudsql driver is deprecated. + +| +| USERS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID +| Join the user properties table to read user IDs. +| 9.0.0 +| USERS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID is deprecated because the owncloudsql driver is deprecated. + +| +| USERS_OWNCLOUDSQL_JOIN_USERNAME +| Join the user properties table to read usernames +| 9.0.0 +| USERS_OWNCLOUDSQL_JOIN_USERNAME is deprecated because the owncloudsql driver is deprecated. + +| +| USERS_OWNCLOUDSQL_NOBODY +| Fallback number if no numeric UID and GID properties are provided. +| 9.0.0 +| USERS_OWNCLOUDSQL_NOBODY is deprecated because the owncloudsql driver is deprecated. + |=== diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/env_var_deltas/8.2.0-9.0.0-removed.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/env_var_deltas/8.2.0-9.0.0-removed.adoc index c5f1a6a0..9b54cded 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/env_var_deltas/8.2.0-9.0.0-removed.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/env_var_deltas/8.2.0-9.0.0-removed.adoc @@ -1,12 +1,17 @@ -// # Removed Variables between oCIS 8.2.0 and oCIS 8.3.0 +// # Removed Variables between oCIS 8.2.0 and oCIS 9.0.0 // commenting the headline to make it better includable -// table created per 2026.09.10 +// table created per 2026.11.13 // the table should be recreated/updated on source () changes [width="100%",cols="~,~,~,~",options="header"] |=== | Service | Variable | Description | Default +| xref:deployment/services/env-vars-special-scope.adoc#extended-environment-variables[Extended Environment Variables] +| GRPC_MAX_CONNECTION_AGE +| Timeout for GRPC connections. After timeout, a new connection will be established automatically. The default value is in ns and is about 2.5 mio h. +| 9223372036854775807 + |=== diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/extended/extended_configvars.adoc b/content/ocis/9.0/modules/admin/examples/ocis_helpers/extended/extended_configvars.adoc index 601091e7..49d32486 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/extended/extended_configvars.adoc +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/extended/extended_configvars.adoc @@ -13,13 +13,22 @@ -a| `GRPC_MAX_CONNECTION_AGE` + +// manually added: GRPC PR #13020 (8.2.1 backport); re-verify on next ocis_helper run +a| `GRPC_CLIENT_KEEPALIVE_TIME` + a| [subs=-attributes] ++Duration ++ a| [subs=-attributes] -++9223372036854775807 ++ +++0s ++ a| [subs=-attributes] -++Timeout for GRPC connections. After timeout, a new connection will be established automatically. The default value is in ns and is about 2.5 mio h. ++ +++How long a grpc client connection with an ongoing request may stay silent before the server is pinged to check whether it is still answering. Set a duration like '20s' to enable detection of unresponsive peers. Leaving it unset, or at '0', sends no pings at all, which is grpc's own default. Values below '10s' are raised to '10s' by grpc. Make sure to include the unit suffix, a bare number is not a valid duration. ++ + +a| `GRPC_CLIENT_KEEPALIVE_TIMEOUT` + +a| [subs=-attributes] +++Duration ++ +a| [subs=-attributes] +++0s ++ +a| [subs=-attributes] +++How long a grpc client waits for the answer to a keepalive ping before it considers the connection dead and fails all requests on it. Defaults to '10s'. Has no effect unless GRPC_CLIENT_KEEPALIVE_TIME is set. See GRPC_CLIENT_KEEPALIVE_TIME. ++ a| `MICRO_LOG_LEVEL` + a| [subs=-attributes] @@ -114,5 +123,4 @@ a| [subs=-attributes] - |=== diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/activitylog-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/activitylog-config-example.yaml index f698a699..a6a3b562 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/activitylog-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/activitylog-config-example.yaml @@ -24,6 +24,8 @@ events: enable_tls: false username: "" password: "" + creds_file: "" + creds: "" store: store: nats-js-kv nodes: @@ -33,11 +35,14 @@ store: ttl: 0s username: "" password: "" + creds_file: "" + creds: "" enable_tls: false tls_insecure: false tls_root_ca_certificate: "" reva_gateway: com.owncloud.api.gateway grpc_client_tls: null +grpc_client_options: null http: addr: 127.0.0.1:9195 root: / diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/antivirus-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/antivirus-config-example.yaml index dd128610..49acc735 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/antivirus-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/antivirus-config-example.yaml @@ -26,6 +26,8 @@ events: enable_tls: false username: "" password: "" + creds_file: "" + creds: "" workers: 10 scanner: type: clamav diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/app-provider-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/app-provider-config-example.yaml index bb57e9c4..9780031a 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/app-provider-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/app-provider-config-example.yaml @@ -41,5 +41,5 @@ drivers: insecure: false wopi_server_iop_secret: "" wopi_server_external_url: "" - wopi_folder_url_base_url: https://localhost:9200/ + wopi_folder_url_base_url: https://localhost:9200 wopi_folder_url_path_template: /f/{{.ResourceID}} diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/audit-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/audit-config-example.yaml index 9bcce9f9..b1028dbe 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/audit-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/audit-config-example.yaml @@ -24,6 +24,8 @@ events: enable_tls: false username: "" password: "" + creds_file: "" + creds: "" auditlog: log_to_console: true log_to_file: false diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/auth-app-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/auth-app-config-example.yaml index 4b0112cb..52491360 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/auth-app-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/auth-app-config-example.yaml @@ -44,6 +44,7 @@ http: cert: "" key: "" grpc_client_tls: null +grpc_client_options: null token_manager: jwt_secret: "" reva: diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/auth-basic-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/auth-basic-config-example.yaml index 7e7dc5bb..ebef5a58 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/auth-basic-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/auth-basic-config-example.yaml @@ -56,14 +56,14 @@ auth_providers: user_member_attribute: "" user_guest_attribute: "" user_schema: - id: ownclouduuid + id: ownCloudUUID id_is_octet_string: false mail: mail - display_name: displayname + display_name: displayName user_name: uid user_enabled: ownCloudUserEnabled group_schema: - id: ownclouduuid + id: ownCloudUUID id_is_octet_string: false mail: mail display_name: cn @@ -72,13 +72,3 @@ auth_providers: pool_enabled: false pool_size: 5 pool_checkout_timeout: 30s - owncloudsql: - db_username: owncloud - db_password: "" - db_host: mysql - db_port: 3306 - db_name: owncloud - idp: https://localhost:9200 - nobody: 90 - join_username: false - join_owncloud_uuid: false diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/clientlog-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/clientlog-config-example.yaml index 98dc5041..90ec58dc 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/clientlog-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/clientlog-config-example.yaml @@ -28,6 +28,8 @@ events: enable_tls: false username: "" password: "" + creds_file: "" + creds: "" service_account: service_account_id: "" service_account_secret: "" diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/collaboration-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/collaboration-config-example.yaml index 2444ba10..d8b455ee 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/collaboration-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/collaboration-config-example.yaml @@ -22,6 +22,8 @@ store: ttl: 30m0s username: "" password: "" + creds_file: "" + creds: "" enable_tls: false tls_insecure: false tls_root_ca_certificate: "" diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/eventhistory-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/eventhistory-config-example.yaml index 199e1c8c..45ca775c 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/eventhistory-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/eventhistory-config-example.yaml @@ -20,6 +20,7 @@ grpc: addr: 127.0.0.1:9274 tls: null grpc_client_tls: null +grpc_client_options: null events: endpoint: 127.0.0.1:9233 cluster: ocis-cluster @@ -28,6 +29,8 @@ events: enable_tls: false username: "" password: "" + creds_file: "" + creds: "" store: store: nats-js-kv nodes: @@ -37,6 +40,8 @@ store: ttl: 336h0m0s username: "" password: "" + creds_file: "" + creds: "" enable_tls: false tls_insecure: false tls_root_ca_certificate: "" diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/frontend-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/frontend-config-example.yaml index b0579ed1..e4d45ceb 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/frontend-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/frontend-config-example.yaml @@ -112,6 +112,11 @@ ocs: stat_cache_disable_persistence: false stat_cache_auth_username: "" stat_cache_auth_password: "" + stat_cache_creds_file: "" + stat_cache_creds: "" + stat_cache_enable_tls: false + stat_cache_tls_insecure: false + stat_cache_tls_root_ca_certificate: "" enable_denials: false list_ocm_shares: true include_ocm_sharees: false @@ -137,7 +142,10 @@ events: enable_tls: false username: "" password: "" + creds_file: "" + creds: "" grpc_client_tls: null +grpc_client_options: null auto_accept_shares: true service_account: service_account_id: "" @@ -157,5 +165,5 @@ mfa: enabled: false auth_level_names: - advanced - session_duration: 3600 enable_vault_mode: false +default_vault_share_expiration_days: 30 diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/gateway-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/gateway-config-example.yaml index 6c9faedd..f515d252 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/gateway-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/gateway-config-example.yaml @@ -42,6 +42,8 @@ cache: provider_cache_disable_persistence: false provider_cache_auth_username: "" provider_cache_auth_password: "" + provider_cache_creds_file: "" + provider_cache_creds: "" provider_cache_enable_tls: false provider_cache_tls_insecure: false provider_cache_tls_root_ca_certificate: "" diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/graph-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/graph-config-example.yaml index 7eb9235c..5521621e 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/graph-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/graph-config-example.yaml @@ -21,6 +21,8 @@ cache: disable_persistence: false username: "" password: "" + creds_file: "" + creds: "" enable_tls: false tls_insecure: false tls_root_ca_certificate: "" @@ -71,6 +73,7 @@ reva: token_manager: jwt_secret: "" grpc_client_tls: null +grpc_client_options: null application: id: "" displayname: ownCloud Infinite Scale @@ -83,7 +86,7 @@ spaces: groups_cache_ttl: 60000000000 storage_users_address: com.owncloud.api.storage-users storage_users_vault_address: com.owncloud.api.storage-users-vault - default_language: "" + default_language: en translation_path: "" identity: backend: ldap @@ -108,10 +111,16 @@ identity: user_search_scope: sub user_filter: "" user_objectclass: inetOrgPerson + user_additional_objectclasses: [] user_mail_attribute: mail user_displayname_attribute: displayName user_name_attribute: uid - user_id_attribute: owncloudUUID + user_surname_attribute: sn + user_search_attributes: + - onPremisesSamAccountName + - displayName + - mail + user_id_attribute: ownCloudUUID user_id_is_octet_string: false user_type_attribute: ownCloudUserType user_enabled_attribute: ownCloudUserEnabled @@ -126,7 +135,7 @@ identity: group_additional_objectclasses: [] group_name_attribute: cn group_member_attribute: member - group_id_attribute: owncloudUUID + group_id_attribute: ownCloudUUID group_id_is_octet_string: false education_resources_enabled: false educationconfig: @@ -159,6 +168,8 @@ events: enable_tls: false username: "" password: "" + creds_file: "" + creds: "" unified_roles: available_roles: - b1e2218d-eef8-4d4c-b82d-0f1a1b48f3b5 @@ -185,8 +196,10 @@ multi_instance: instanceid: "" master_id: "" query_regexp: "" + guest_role_mapping: [] validation: max_tag_length: 100 max_image_file_size: 50MB enable_vault_mode: false +default_vault_share_expiration_days: 30 enable_user_sharing: true diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/groups-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/groups-config-example.yaml index 82efcd9d..bcd67f67 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/groups-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/groups-config-example.yaml @@ -53,13 +53,13 @@ drivers: user_member_attribute: "" user_guest_attribute: "" user_schema: - id: ownclouduuid + id: ownCloudUUID id_is_octet_string: false mail: mail - display_name: displayname + display_name: displayName user_name: uid group_schema: - id: ownclouduuid + id: ownCloudUUID id_is_octet_string: false mail: mail display_name: cn @@ -68,14 +68,3 @@ drivers: pool_enabled: false pool_size: 5 pool_checkout_timeout: 30s - owncloudsql: - db_username: owncloud - db_password: "" - db_host: mysql - db_port: 3306 - db_name: owncloud - idp: https://localhost:9200 - nobody: 90 - join_username: false - join_owncloud_uuid: false - enable_medial_search: false diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/notifications-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/notifications-config-example.yaml index bde53370..f6287bd2 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/notifications-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/notifications-config-example.yaml @@ -35,14 +35,20 @@ notifications: enable_tls: false username: "" password: "" + creds_file: "" + creds: "" email_template_path: "" translation_path: "" - default_language: "" + default_language: en reva_gateway: com.owncloud.api.gateway grpc_client_tls: null grpc_client_tls: mode: "" cacert: "" +grpc_client_options: + grpc_max_received_message_size: 0 + grpc_client_keepalive_time: 0s + grpc_client_keepalive_timeout: 0s service_account: service_account_id: "" service_account_secret: "" @@ -55,6 +61,8 @@ store: ttl: 336h0m0s username: "" password: "" + creds_file: "" + creds: "" enable_tls: false tls_insecure: false tls_root_ca_certificate: "" diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/ocdav-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/ocdav-config-example.yaml index 350371e8..6b9557ee 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/ocdav-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/ocdav-config-example.yaml @@ -79,3 +79,4 @@ insecure: false gateway_request_timeout: 84300 machine_auth_api_key: "" allow_propfind_depth_infinity: false +disable_propfind_public_link_resolution: false diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/ocs-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/ocs-config-example.yaml index aa209a3e..d4143015 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/ocs-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/ocs-config-example.yaml @@ -43,6 +43,7 @@ http: cert: "" key: "" grpc_client_tls: null +grpc_client_options: null signing_keys: store: nats-js-kv addresses: @@ -50,6 +51,8 @@ signing_keys: ttl: 12h0m0s username: "" password: "" + creds_file: "" + creds: "" enable_tls: false tls_insecure: false tls_root_ca_certificate: "" diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/policies-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/policies-config-example.yaml index fd61d5b5..ca0c8f93 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/policies-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/policies-config-example.yaml @@ -17,7 +17,10 @@ events: enable_tls: false username: "" password: "" + creds_file: "" + creds: "" grpc_client_tls: null +grpc_client_options: null log: level: "" pretty: false diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/postprocessing-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/postprocessing-config-example.yaml index 436f68bb..d71e56e1 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/postprocessing-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/postprocessing-config-example.yaml @@ -25,6 +25,8 @@ store: ttl: 0s username: "" password: "" + creds_file: "" + creds: "" enable_tls: false tls_insecure: false tls_root_ca_certificate: "" @@ -37,6 +39,8 @@ postprocessing: enable_tls: false username: "" password: "" + creds_file: "" + creds: "" workers: 3 steps: [] delayprocessing: 0s diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/proxy-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/proxy-config-example.yaml index 1dbb1786..f930a3f3 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/proxy-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/proxy-config-example.yaml @@ -29,6 +29,7 @@ reva: mode: "" cacert: "" grpc_client_tls: null +grpc_client_options: null role_quotas: {} policies: - name: ocis @@ -120,6 +121,10 @@ policies: service: com.owncloud.web.invitations - endpoint: /graph/ service: com.owncloud.web.graph + - endpoint: /vault/graph/v1beta1/extensions/org.libregraph/activities + service: com.owncloud.web.activitylog + - endpoint: /vault/graph/v1.0/invitations + service: com.owncloud.web.invitations - endpoint: /vault/graph/ service: com.owncloud.web.graph - endpoint: /api/v0/settings @@ -131,7 +136,6 @@ oidc: issuer: https://localhost:9200 insecure: false access_token_verify_method: jwt - access_token_verify_aud: [] skip_user_info: false user_info_cache: store: memory @@ -143,6 +147,8 @@ oidc: disable_persistence: false username: "" password: "" + creds_file: "" + creds: "" enable_tls: false tls_insecure: false tls_root_ca_certificate: "" @@ -152,6 +158,7 @@ oidc: refresh_limit: 60 refresh_unknown_kid: true rewrite_well_known: false + access_token_verify_aud: [] service_account: service_account_id: "" service_account_secret: "" @@ -185,6 +192,8 @@ pre_signed_url: disable_persistence: true username: "" password: "" + creds_file: "" + creds: "" enable_tls: false tls_insecure: false tls_root_ca_certificate: "" @@ -215,6 +224,8 @@ events: enable_tls: false username: "" password: "" + creds_file: "" + creds: "" claim_space_management: enabled: false claim: "" @@ -232,4 +243,5 @@ multi_instance: member_claim: "" guest_claim: "" guest_role: "" + guest_role_mapping: [] enable_vault_mode: false diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/search-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/search-config-example.yaml index 168ec569..1b41a910 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/search-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/search-config-example.yaml @@ -27,6 +27,7 @@ reva: mode: "" cacert: "" grpc_client_tls: null +grpc_client_options: null events: endpoint: 127.0.0.1:9233 cluster: ocis-cluster @@ -38,6 +39,8 @@ events: enable_tls: false username: "" password: "" + creds_file: "" + creds: "" engine: type: bleve bleve: @@ -49,6 +52,7 @@ extractor: tika: tika_url: http://127.0.0.1:9998 clean_stop_words: true + max_consecutive_failures: 5 content_extraction_size_limit: 20971520 service_account: service_account_id: "" diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/settings-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/settings-config-example.yaml index f07f95b8..9daff748 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/settings-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/settings-config-example.yaml @@ -45,6 +45,7 @@ grpc: addr: 127.0.0.1:9191 tls: null grpc_client_tls: null +grpc_client_options: null metadata_config: gateway_addr: com.owncloud.api.storage-system storage_addr: com.owncloud.api.storage-system @@ -62,6 +63,8 @@ metadata_config: disable_persistence: false username: "" password: "" + creds_file: "" + creds: "" enable_tls: false tls_insecure: false tls_root_ca_certificate: "" @@ -72,5 +75,5 @@ token_manager: set_default_assignments: false service_account_ids: - service-user-id -default_language: "" +default_language: en translation_path: "" diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/sharing-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/sharing-config-example.yaml index 994a4d15..5be611ca 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/sharing-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/sharing-config-example.yaml @@ -35,6 +35,8 @@ events: enable_tls: false auth_username: "" auth_password: "" + creds_file: "" + creds: "" skip_user_groups_in_token: false user_sharing_driver: jsoncs3 user_sharing_drivers: @@ -52,13 +54,6 @@ user_sharing_drivers: system_user_id: "" system_user_idp: internal system_user_api_key: "" - owncloudsql: - db_username: owncloud - db_password: "" - db_host: mysql - db_port: 3306 - db_name: owncloud - user_storage_mount_id: "" public_sharing_driver: jsoncs3 public_sharing_drivers: json: @@ -76,6 +71,7 @@ public_sharing_drivers: public_sharing_writeableshare_must_have_password: false public_sharing_share_must_have_password: true enable_expired_shares_cleanup: true +janitor_run_interval: 3600 enable_user_sharing: true enable_public_sharing: true password_policy: diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/sse-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/sse-config-example.yaml index 4e835c94..4318fd38 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/sse-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/sse-config-example.yaml @@ -25,6 +25,8 @@ events: enable_tls: false username: "" password: "" + creds_file: "" + creds: "" http: addr: 127.0.0.1:9135 root: / diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/storage-publiclink-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/storage-publiclink-config-example.yaml index fee71791..f2e4732c 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/storage-publiclink-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/storage-publiclink-config-example.yaml @@ -38,6 +38,8 @@ store: table: brute-force-protection username: "" password: "" + creds_file: "" + creds: "" enable_tls: false tls_insecure: false tls_root_ca_certificate: "" diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/storage-system-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/storage-system-config-example.yaml index 59b1bd49..0d6d3a53 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/storage-system-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/storage-system-config-example.yaml @@ -42,6 +42,8 @@ cache: disable_persistence: false auth_username: "" auth_password: "" + creds_file: "" + creds: "" enable_tls: false tls_insecure: false tls_root_ca_certificate: "" diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/storage-users-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/storage-users-config-example.yaml index a3ec5559..d59dd2b6 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/storage-users-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/storage-users-config-example.yaml @@ -120,41 +120,21 @@ drivers: lock_cycle_duration_factor: 30 max_concurrency: 5 disable_versioning: false - owncloudsql: - root: /var/lib/ocis/storage/owncloud - share_folder: /Shares - user_layout: '{{.Username}}' - upload_info_dir: /var/lib/ocis/storage/uploadinfo - db_username: owncloud - db_password: owncloud - db_host: "" - db_port: 3306 - db_name: owncloud - users_provider_endpoint: com.owncloud.api.users - posix: - root: /var/lib/ocis/storage/users - personalspacepath_template: users/{{.User.Username}} - generalspacepath_template: projects/{{.SpaceId}} - permissions_endpoint: com.owncloud.api.settings - async_uploads: true - scan_debounce_delay: 1s - use_space_groups: false - watch_type: "" - watch_path: "" - watch_folder_kafka_hosts: "" data_server_url: http://localhost:9158/data data_gateway_url: https://localhost:9200/data transfer_expires: 86400 events: - endpoint: 127.0.0.1:9233 - cluster: ocis-cluster tls_insecure: false - tls_root_ca_cert_path: "" enable_tls: false num_consumers: 0 - consumer_group: "" username: "" password: "" + creds_file: "" + creds: "" + endpoint: 127.0.0.1:9233 + cluster: ocis-cluster + tls_root_ca_cert_path: "" + consumer_group: "" filemetadata_cache: store: memory nodes: @@ -164,6 +144,8 @@ filemetadata_cache: disable_persistence: false username: "" password: "" + creds_file: "" + creds: "" enable_tls: false tls_insecure: false tls_root_ca_certificate: "" @@ -176,6 +158,8 @@ id_cache: disable_persistence: false username: "" password: "" + creds_file: "" + creds: "" enable_tls: false tls_insecure: false tls_root_ca_certificate: "" diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/thumbnails-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/thumbnails-config-example.yaml index ae925ccf..1d49c897 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/thumbnails-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/thumbnails-config-example.yaml @@ -47,6 +47,7 @@ http: - Cache-Control allow_credentials: true grpc_client_tls: null +grpc_client_options: null thumbnail: resolutions: - 16x16 diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/userlog-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/userlog-config-example.yaml index 321823c6..8117c64c 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/userlog-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/userlog-config-example.yaml @@ -38,11 +38,12 @@ http: cert: "" key: "" grpc_client_tls: null +grpc_client_options: null token_manager: jwt_secret: "" reva_gateway: com.owncloud.api.gateway translation_path: "" -default_language: "" +default_language: en events: endpoint: 127.0.0.1:9233 cluster: ocis-cluster @@ -51,15 +52,20 @@ events: enable_tls: false username: "" password: "" + creds_file: "" + creds: "" max_concurrency: 1 persistence: store: memory - nodes: [] + nodes: + - 127.0.0.1:9233 database: userlog table: events ttl: 336h0m0s username: "" password: "" + creds_file: "" + creds: "" enable_tls: false tls_insecure: false tls_root_ca_certificate: "" diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/users-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/users-config-example.yaml index 1379904e..73df959f 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/users-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/users-config-example.yaml @@ -56,14 +56,14 @@ drivers: user_member_attribute: "" user_guest_attribute: "" user_schema: - id: ownclouduuid + id: ownCloudUUID id_is_octet_string: false mail: mail - display_name: displayname + display_name: displayName user_name: uid user_enabled: ownCloudUserEnabled group_schema: - id: ownclouduuid + id: ownCloudUUID id_is_octet_string: false mail: mail display_name: cn @@ -72,14 +72,3 @@ drivers: pool_enabled: false pool_size: 5 pool_checkout_timeout: 30s - owncloudsql: - db_username: owncloud - db_password: secret - db_host: mysql - db_port: 3306 - db_name: owncloud - idp: https://localhost:9200 - nobody: 90 - join_username: false - join_owncloud_uuid: false - enable_medial_search: false diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/web-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/web-config-example.yaml index 2ce645bc..5f57a229 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/web-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/web-config-example.yaml @@ -87,6 +87,7 @@ web: - files - search - text-editor + - mermaid-editor - pdf-viewer - external - admin-settings diff --git a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/webdav-config-example.yaml b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/webdav-config-example.yaml index b9cbb788..a01268e3 100644 --- a/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/webdav-config-example.yaml +++ b/content/ocis/9.0/modules/admin/examples/ocis_helpers/yaml/webdav-config-example.yaml @@ -17,6 +17,7 @@ debug: pprof: false zpages: false grpc_client_tls: null +grpc_client_options: null http: addr: 127.0.0.1:9115 root: / diff --git a/content/ocis/9.0/modules/admin/pages/architecture/architecture.adoc b/content/ocis/9.0/modules/admin/pages/architecture/architecture.adoc index b42825ed..aa2c478f 100644 --- a/content/ocis/9.0/modules/admin/pages/architecture/architecture.adoc +++ b/content/ocis/9.0/modules/admin/pages/architecture/architecture.adoc @@ -107,6 +107,7 @@ Spaces are a logical concept. They organize a set of resources in a hierarchical * A storage spaces registry then allows listing the capabilities of storage spaces, e.g. free space, quota, managers, syncable, root {etag-url}[ETag] etc. * Spaces may serve different purposes like every user’s personal storage space, project, group or school class storage spaces including shares and reshares. * A space makes it much easier to separate data that can be shared and data that should not be shared. As an example, although you can share content in your personal space, it is much more secure to have a dedicated space for sharing and keep your personal space for your eyes only. +* *Personal spaces* are owned by a single user. Only that user and users with the administrator role can be assigned as managers of a personal space. Regular users cannot promote others to the manager role in someone else’s personal space. * Spaces have a small memory footprint and are therefore very effective. For details see the xref:prerequisites/prerequisites.adoc#ram-considerations[RAM Considerations]. For detailed information on the implementation of spaces, check out the https://owncloud.dev/ocis/storage/spaces/[Developer Guide]. diff --git a/content/ocis/9.0/modules/admin/pages/conf-examples/search/configure-search.adoc b/content/ocis/9.0/modules/admin/pages/conf-examples/search/configure-search.adoc index 975cb83c..ae11bec7 100644 --- a/content/ocis/9.0/modules/admin/pages/conf-examples/search/configure-search.adoc +++ b/content/ocis/9.0/modules/admin/pages/conf-examples/search/configure-search.adoc @@ -11,7 +11,7 @@ {description} Using search is a good way to find documents based on various criteria. The search service will return results for documents the searcher is eligible to access. Read the description of the xref:{s-path}/search.adoc[search service] for more details. -You can use basic search functionality without any configuration as it is preconfigured when using the default container deployment. +You can use basic search functionality without any configuration as it is preconfigured when using the default container deployment. For the full query syntax available to users, see xref:conf-examples/search/kql-search-syntax.adoc[KQL Search Syntax]. == Index Data diff --git a/content/ocis/9.0/modules/admin/pages/conf-examples/search/kql-search-syntax.adoc b/content/ocis/9.0/modules/admin/pages/conf-examples/search/kql-search-syntax.adoc new file mode 100644 index 00000000..a31f8aba --- /dev/null +++ b/content/ocis/9.0/modules/admin/pages/conf-examples/search/kql-search-syntax.adoc @@ -0,0 +1,296 @@ += KQL Search Syntax +:toc: right +:toclevels: 3 +:description: Infinite Scale search uses a subset of the Keyword Query Language (KQL). This page documents every field, operator, and date shortcut that the search service understands. + +{description} + +The search box in the web interface and clients accepts plain text as well as structured queries using the syntax described below. All queries are case-insensitive. + +== Fields + +If no field is specified, the query matches against the file or folder name. + +[cols="1,1,2,2",options="header"] +|=== +| Field +| Type +| Description +| Example + +| `name` +| text +| File or folder name. Default when no field is given. Supports wildcards. +| `name:report` or just `report` + +| `content` +| text +| Full-text content. Requires a content extraction engine (Tika). See xref:conf-examples/search/configure-search.adoc[Configuring Search]. +| `content:budget` + +| `tag` / `tags` +| text +| Tags assigned to the file. +| `tag:project` + +| `mediatype` / `type` +| keyword +| MIME type or a type shortcut (see <>). +| `mediatype:pdf` or `type:image` + +| `size` +| numeric +| File size in bytes. Only comparison operators are supported — equality is not. +| `size:>1048576` + +| `mtime` +| date +| Last-modified time. Accepts ISO dates, times, or natural-language ranges (see <>). +| `mtime:>2025-01-01` + +| `hidden` +| boolean +| Whether the item is hidden. +| `hidden:true` + +| `photo.cameraMake` +| text +| Camera manufacturer embedded in photo metadata. +| `photo.cameraMake:Canon` + +| `photo.cameraModel` +| text +| Camera model embedded in photo metadata. +| `photo.cameraModel:"EOS R5"` + +| `photo.takenDateTime` +| date +| Date and time the photo was taken (EXIF). +| `photo.takenDateTime:>=2024-01-01` + +| `photo.iso` +| text +| ISO speed value embedded in photo metadata. +| `photo.iso:3200` + +| `photo.fNumber` +| text +| Aperture f-number embedded in photo metadata. +| `photo.fNumber:2.8` + +| `photo.focalLength` +| text +| Focal length embedded in photo metadata. +| `photo.focalLength:50` + +| `photo.orientation` +| text +| Orientation flag embedded in photo metadata. +| `photo.orientation:1` + +|=== + +NOTE: `photo.*` fields are populated only when a content extraction engine (Tika) is configured and the file has been indexed. + +== Operators + +=== Boolean Operators + +[cols="1,2,3",options="header"] +|=== +| Operator +| Shorthand +| Description + +| `AND` +| `+` +| Both conditions must match (default when no operator is written between terms). + +| `OR` +| +| Either condition may match. + +| `NOT` +| `-` +| The following term must not match. + +|=== + +Examples: + +[source] +---- +report AND budget +report OR budget +report NOT draft ++report +budget +-draft report +---- + +=== Comparison Operators + +Used with `size:` and `mtime:` (and `photo.takenDateTime:`): + +[cols="1,3",options="header"] +|=== +| Operator +| Meaning + +| `>` +| Greater than + +| `>=` +| Greater than or equal + +| `<` +| Less than + +| `\<=` +| Less than or equal + +|=== + +=== Grouping + +Use parentheses to group sub-expressions. Optionally prefix a group with a field name to apply the field to all terms inside: + +[source] +---- +(report OR budget) AND mtime:>2025-01-01 +name:(report budget) +---- + +== Wildcards + +[cols="1,3",options="header"] +|=== +| Wildcard +| Meaning + +| `*` +| Zero or more characters + +| `?` +| Exactly one character + +|=== + +Examples: + +[source] +---- +report* +rep?rt +name:*.pdf +---- + +NOTE: Wildcards apply to `name:` and free-text queries. They are not applied to `content:`, numeric, or date fields. + +[[type-shortcuts]] +== Type Shortcuts + +The `mediatype:` (or `type:`) field accepts the following convenience shortcuts in addition to raw MIME types: + +[cols="1,3",options="header"] +|=== +| Shortcut +| Matches + +| `file` +| Any file (excludes folders) + +| `folder` +| Folders only + +| `document` +| Word-processor formats: `.docx`, `.odt`, `.doc`, `.txt`, `.md`, `.rtf`, Pages + +| `spreadsheet` +| Spreadsheet formats: `.xlsx`, `.ods`, `.xls`, `.csv`, Numbers + +| `presentation` +| Presentation formats: `.pptx`, `.odp`, `.ppt`, Keynote + +| `pdf` +| PDF files + +| `image` +| All image MIME types (`image/*`) + +| `video` +| All video MIME types (`video/*`) + +| `audio` +| All audio MIME types (`audio/*`) + +| `archive` +| Archive formats: `.zip`, `.gz`, `.7z`, `.rar`, `.tar`, `.bz2` + +|=== + +[[natural-language-dates]] +== Natural-Language Dates + +The `mtime:` and `photo.takenDateTime:` fields accept the following natural-language values in place of an ISO date. The week starts on Monday. + +[cols="1,3",options="header"] +|=== +| Value +| Range + +| `today` +| From the beginning to the end of today + +| `yesterday` +| From the beginning to the end of yesterday + +| `this week` +| From Monday to Sunday of the current week + +| `last week` +| From Monday to Sunday of the previous week + +| `last 7 days` +| The last 7 days including today + +| `this month` +| From the first to the last day of the current month + +| `last month` +| From the first to the last day of the previous month + +| `last 30 days` +| The last 30 days including today + +| `this year` +| From 1 January to 31 December of the current year + +| `last year` +| From 1 January to 31 December of the previous year + +|=== + +Example: + +[source] +---- +mtime:"last 7 days" +mtime:"this month" AND type:document +---- + +NOTE: Natural-language date values that contain a space must be enclosed in double quotes. + +== Examples + +[source] +---- +report +"quarterly report" +name:report* +content:budget AND mtime:>2025-01-01 +type:document AND mtime:"last 30 days" +size:>=10485760 AND type:video +tag:invoice NOT tag:draft +(type:image OR type:video) AND mtime:"this year" +photo.cameraMake:Canon AND photo.takenDateTime:>=2024-01-01 +---- diff --git a/content/ocis/9.0/modules/admin/pages/deployment/gdpr/gdpr.adoc b/content/ocis/9.0/modules/admin/pages/deployment/gdpr/gdpr.adoc index 997ee384..9bb3ccc9 100644 --- a/content/ocis/9.0/modules/admin/pages/deployment/gdpr/gdpr.adoc +++ b/content/ocis/9.0/modules/admin/pages/deployment/gdpr/gdpr.adoc @@ -7,6 +7,10 @@ {description} When using Keycloak, some environment variables must be configured to gather user-relevant data stored in Keycloak, completing the report. +== Limits + +To stop things being misused, the number of GDPR report requests that can be made in one minute by each user is limited to five. + == Configuration If Keycloak is used for authentication, GDPR regulations require to add all personal identifiable information that Keycloak has about the user to the personal data export. To configure these settings, see the xref:{s-path}/graph.adoc#keycloak-configuration-for-the-personal-data-export[Keycloak Configuration for the Personal Data Export] for more details. Beside that, no additional configuration is necessary as everything works out of the box. diff --git a/content/ocis/9.0/modules/admin/pages/deployment/general/general-info.adoc b/content/ocis/9.0/modules/admin/pages/deployment/general/general-info.adoc index 31848c96..3bba5794 100644 --- a/content/ocis/9.0/modules/admin/pages/deployment/general/general-info.adoc +++ b/content/ocis/9.0/modules/admin/pages/deployment/general/general-info.adoc @@ -681,6 +681,8 @@ The volume names needed to reset the password are: * `ocis_wopi_ocis-config`. -- +NOTE: In addition to the admin and regular users, the passwords of internal service accounts (`libregraph`, `idp`, `reva`) can also be reset from the command line. See the xref:{s-path}/idm.adoc#internal-service-accounts[Internal Service Accounts] section in the IDM service documentation for details. + === Demo Users and Groups ==== Create Demo Users and Groups diff --git a/content/ocis/9.0/modules/admin/pages/deployment/identity-management/external-iam.adoc b/content/ocis/9.0/modules/admin/pages/deployment/identity-management/external-iam.adoc new file mode 100644 index 00000000..eae7e562 --- /dev/null +++ b/content/ocis/9.0/modules/admin/pages/deployment/identity-management/external-iam.adoc @@ -0,0 +1,272 @@ += External Identity and Authentication +:toc: right +:toclevels: 3 +:description: Requirements and configuration guidance for replacing the built-in IDM and IDP services with an external LDAP directory and an external OpenID Connect provider. + +include::partial$multi-location/compose-version.adoc[] + +== Introduction + +{description} + +The two services can be replaced independently. A common approach is: + +. Replace *IDP* with an external OIDC provider first (e.g. Keycloak) while keeping the built-in IDM. +. Replace *IDM* with an external LDAP directory once the organization's directory requirements are clear. + +Both replacements can also be done simultaneously. + +== Replacing IDM with an External LDAP Directory + +=== When to Replace + +Replace the built-in IDM when you need: + +* An existing corporate directory (Active Directory, OpenLDAP) as the user source. +* User management through external tooling rather than the Infinite Scale Web UI. +* High-availability or replication for the directory. +* Features the built-in IDM does not support: schema validation, referrals, 2FA. + +=== LDAP Schema Requirements + +Infinite Scale requires the following from any external LDAP directory: + +* The `inetOrgPerson` object class for user entries. +* The `groupOfNames` object class for group entries. +* Several additional attributes that are not part of the standard LDAP schema (e.g. `owncloudUUID`). A ready-to-use OpenLDAP schema file (ldif) is available in the deployment example: {compose_url}{compose_version}{compose_final_path}/ocis_ldap/config/ldap/schemas/[LDAP schemas,window=_blank]. + +NOTE: Microsoft Active Directory uses `group` instead of `groupOfNames`. The Graph service can be configured to work with AD via `OCIS_LDAP_GROUP_OBJECTCLASS=group`. See the developer documentation at https://owncloud.dev/ocis/identity-provider/ldap-active-directory/[LDAP Active Directory,window=_blank] for a full example. + +=== User ID Attribute + +Infinite Scale uses a stable, unique attribute to identify users internally. The attribute is configured via `OCIS_LDAP_USER_SCHEMA_ID`. The value must: + +* Be unique across all users. +* Never change for the lifetime of a user — a change causes the user to lose access to their files and shares. + +The `owncloudUUID` attribute from the schema file above is the recommended choice. For Active Directory, `objectGUID` is a suitable alternative. + +=== Write Access for Web UI User Management + +If you want administrators to be able to create, update and delete users and groups through the Infinite Scale Web UI or the LibreGraph API, the LDAP directory must grant write access to the bind user configured in `OCIS_LDAP_BIND_DN`. Set `OCIS_LDAP_SERVER_WRITE_ENABLED=true` (the default) and ensure the bind user has the necessary write permissions in the directory. + +If you are connecting to a *read-only* directory and do not need Web UI user management, set `OCIS_LDAP_SERVER_WRITE_ENABLED=false`. + +=== Key Environment Variables + +The following variables configure the LDAP connection. All services that connect to the directory (IDP, Graph, Users, Groups) share the `OCIS_LDAP_*` prefix; service-specific overrides use `GRAPH_LDAP_*`, `IDP_LDAP_*`, etc. + +[cols="2,3",options="header"] +|=== +| Variable +| Purpose + +| `OCIS_LDAP_URI` +| LDAP server address (e.g. `ldaps://ldap.example.com:636`) + +| `OCIS_LDAP_BIND_DN` +| DN of the service account used to connect + +| `OCIS_LDAP_BIND_PASSWORD` +| Password for the service account + +| `OCIS_LDAP_USER_BASE_DN` +| Base DN for user searches + +| `OCIS_LDAP_GROUP_BASE_DN` +| Base DN for group searches + +| `OCIS_LDAP_USER_SCHEMA_ID` +| LDAP attribute used as the stable internal user ID + +| `OCIS_LDAP_SERVER_WRITE_ENABLED` +| `true` to allow user/group creation via the Web UI + +| `OCIS_LDAP_GROUP_OBJECTCLASS` +| Object class for groups (default: `groupOfNames`; use `group` for AD) +|=== + +For the full list of LDAP configuration options see the xref:{s-path}/graph.adoc#ldap-configuration[Graph service LDAP configuration]. + +== Replacing IDP with an External OIDC Provider + +=== When to Replace + +Replace the built-in IDP when you need: + +* SSO across multiple applications. +* Federation with external identity providers (SAML, social login). +* 2FA / MFA. +* Backchannel logout so Infinite Scale invalidates sessions immediately when a user logs out elsewhere. +* Branding of the login screen. + +=== Requirements for the External OIDC Provider + +The external OIDC provider must: + +* Expose a standards-compliant OIDC discovery endpoint (`/.well-known/openid-configuration`). +* Issue tokens that include a *stable, unique* claim for each user. The `sub` claim is the safest choice; `email` or `preferred_username` can be used only if they never change. +* Include `email`, `profile`, and `groups` scopes (or equivalent custom scopes) in tokens, so Infinite Scale can read display names, email addresses, and group memberships. + +For backchannel logout support (strongly recommended for production), the provider must implement the https://openid.net/specs/openid-connect-backchannel-1_0.html[OIDC Back-Channel Logout specification]. Configure the backchannel logout URL in the provider to point at the Proxy service. + +=== User Lookup: Connecting OIDC Identity to the LDAP Directory + +When a user authenticates via the external OIDC provider, the Proxy service must map the OIDC identity to a user record in the directory. Two environment variables control this mapping: + +* `PROXY_USER_OIDC_CLAIM` — the OIDC claim whose value is used to look up the user (default: `preferred_username`). +* `PROXY_USER_CS3_CLAIM` — the user attribute in Infinite Scale that must match the claim value above (default: `username`). + +For a stable mapping that survives username or email changes, set both to use the `sub` claim and the `userid` attribute: + +[source,bash] +---- +PROXY_USER_OIDC_CLAIM=sub +PROXY_USER_CS3_CLAIM=userid +---- + +=== Automatic User Provisioning + +When the directory is managed externally (e.g. Active Directory) and you use an external OIDC provider, users can be provisioned into Infinite Scale automatically on first login without any manual import step. + +The Proxy service handles provisioning when `PROXY_AUTOPROVISION_ACCOUNTS=true` is set. On the user's first login it creates a user record in the directory using claims from the OIDC token. On subsequent logins it synchronises changed display names, email addresses, and group memberships. + +For full configuration details and caveats (claim immutability, group sync latency) see xref:{s-path}/proxy.adoc#automatic-user-and-group-provisioning[Automatic User and Group Provisioning] in the Proxy service documentation. + +== Combining an External LDAP Directory with an External OIDC Provider + +When both IDM and IDP are replaced: + +. Configure the external LDAP directory as described above. +. Configure the external OIDC provider as described above. +. Ensure the OIDC provider uses the same directory as its user store, so that the user identity from the token and the user record in LDAP refer to the same account. +. Set `PROXY_USER_OIDC_CLAIM` and `PROXY_USER_CS3_CLAIM` to match the stable identifier used in both systems (typically the LDAP `owncloudUUID` or AD `objectGUID` exposed as a custom OIDC claim). + +NOTE: Automatic user provisioning (`PROXY_AUTOPROVISION_ACCOUNTS`) is not needed when both systems share the same user store — users already exist in LDAP before they log in for the first time. + +== Using AD FS as the External OIDC Provider + +=== AD vs. AD FS + +*Active Directory (AD)* is an LDAP-based identity and access management (IAM) directory — it stores user and group records. *Active Directory Federation Services (AD FS)* is a Security Token Service (STS) that sits in front of AD and issues OIDC (and SAML) tokens. When this page refers to replacing the built-in IDP with AD FS, it means using AD FS as the OIDC provider while AD itself continues to serve as the LDAP directory. + +=== CORS Requirement + +The Proxy service calls the AD FS userinfo endpoint from the browser during the OIDC flow. AD FS does not send CORS headers by default, which causes browsers to block the response. To enable CORS on AD FS, the AD FS farm behavior level must first be raised to the 2019 level, then CORS can be configured. + +Run the following commands on the AD FS server (PowerShell, elevated): + +[source,powershell] +---- +# Raise the farm behavior level to ADFS 2019 (required for CORS support) +Invoke-AdfsFarmBehaviorLevelRaise + +# Enable CORS and allow requests from the Infinite Scale origin +Set-AdfsResponseHeader -EnableCORS $true +Set-AdfsResponseHeader -CORSTrustedOrigins "https://your-ocis-domain.example.com" +---- + +Replace `\https://your-ocis-domain.example.com` with the actual public URL of your Infinite Scale instance. + +For the full list of AD FS HTTP security header options see the https://learn.microsoft.com/en-us/windows-server/identity/ad-fs/operations/customize-http-security-headers-ad-fs#cors-customization[Microsoft AD FS CORS customization documentation,window=_blank]. + +=== Skipping the Userinfo Endpoint + +If raising the farm behavior level is not possible, or as an alternative to CORS configuration, Infinite Scale can be told to skip the userinfo endpoint entirely and read all user claims directly from the JWT access token: + +[source,bash] +---- +PROXY_OIDC_SKIP_USER_INFO=true +PROXY_OIDC_ACCESS_TOKEN_VERIFY_METHOD=jwt +---- + +[IMPORTANT] +==== +`PROXY_OIDC_SKIP_USER_INFO=true` requires `PROXY_OIDC_ACCESS_TOKEN_VERIFY_METHOD=jwt`. The two settings are mutually exclusive with the value `none` — setting `PROXY_OIDC_ACCESS_TOKEN_VERIFY_METHOD=none` while also setting `PROXY_OIDC_SKIP_USER_INFO=true` is an invalid combination and Infinite Scale will refuse to start. + +When skipping the userinfo endpoint, all required claims (`sub`, `email`, `preferred_username`, group memberships) must be present in the access token itself. Ensure the AD FS relying party trust is configured to include these claims in the issued access tokens. +==== + +== Access Token Verification + +The Proxy service verifies every OIDC access token it receives. The verification method and the behaviour when an unknown signing key is encountered are configurable. + +=== Verification Methods + +`PROXY_OIDC_ACCESS_TOKEN_VERIFY_METHOD` controls how the Proxy verifies access tokens. The default is `jwt`. + +`jwt`:: +The access token is parsed as a JSON Web Token (JWT) and its signature is verified against the public keys published at the IDP's `jwks_uri` endpoint. This is the recommended and most secure method and requires the IDP to issue proper JWT access tokens containing a `kid` (Key ID) header. + +`none`:: +No JWT signature verification is performed. The token is forwarded as-is to the IDP's userinfo endpoint, and the response is used to identify the user. Use this when the IDP issues opaque (non-JWT) access tokens, or JWT tokens that do not include a `kid` header. + +[IMPORTANT] +==== +`PROXY_OIDC_ACCESS_TOKEN_VERIFY_METHOD=none` is incompatible with `PROXY_OIDC_SKIP_USER_INFO=true`. Setting both causes Infinite Scale to refuse to start because there is no JWT to read claims from and no userinfo endpoint to fall back to. +==== + +=== The `kid` Header and When Verification Fails + +A JWT access token contains a header, a payload, and a signature. The header may carry a `kid` (Key ID) claim — a hint that tells the Proxy which key in the IDP's JSON Web Key Set (JWKS) to use when verifying the token's signature. When the Proxy encounters a token with a `kid` it does not recognise, it fetches the JWKS again to look for the new key. + +When the `kid` is missing from the token or cannot be matched to any key in the JWKS, the Proxy logs: + +[source] +---- +failed to verify access token: the JWT has an invalid kid: could not find kid in JWT header +---- + +There are two ways to resolve this: + +. *Fix the IDP configuration* (preferred). Configure the IDP to include a `kid` header in its issued access tokens and to publish the corresponding key in its JWKS. This is the correct long-term solution. + +. *Disable JWT verification* (workaround). If the IDP cannot be changed — for example in home-network setups using a provider that omits the `kid` — set: ++ +[source,bash] +---- +PROXY_OIDC_ACCESS_TOKEN_VERIFY_METHOD=none +---- ++ +With this setting the Proxy no longer validates the token's signature; it simply presents the token to the userinfo endpoint. Authentication still works but the cryptographic integrity check is skipped. + +=== JWKS Refresh Tuning + +When `PROXY_OIDC_ACCESS_TOKEN_VERIFY_METHOD=jwt` is active, the Proxy maintains an in-memory copy of the IDP's JSON Web Key Set (JWKS) and refreshes it periodically. The following variables control that behaviour: + +[cols="~,~,^~",options="header"] +|=== +| Variable +| Description +| Default + +| `PROXY_OIDC_JWKS_REFRESH_INTERVAL` +| Interval in minutes at which the JWKS is refreshed in the background. +| `60` + +| `PROXY_OIDC_JWKS_REFRESH_TIMEOUT` +| Timeout in seconds for an outgoing JWKS HTTP request. +| `10` + +| `PROXY_OIDC_JWKS_REFRESH_RATE_LIMIT` +| Minimum number of seconds that must pass between refresh requests triggered by an unknown `kid`. Prevents a flood of JWKS requests when a malicious client sends tokens with fabricated key IDs. +| `60` + +| `PROXY_OIDC_JWKS_REFRESH_UNKNOWN_KID` +| When `true`, an immediate background JWKS refresh is triggered every time a token arrives with an unknown `kid`. Useful when the IDP rotates keys frequently. Always keep `PROXY_OIDC_JWKS_REFRESH_RATE_LIMIT` set to a sensible value when this is enabled. +| `true` + +|=== + +=== Restricting Accepted Audiences + +By default the Proxy accepts any valid JWT access token issued by the configured OIDC issuer, regardless of which application it was issued for. In a shared IDP environment — where the same IDP serves multiple applications — a token issued for a different application could technically be presented to Infinite Scale. + +`PROXY_OIDC_ACCESS_TOKEN_VERIFY_AUD` restricts which tokens are accepted by requiring the token's `aud` (audience) or `azp` (authorised party) claim to match one of the configured values. Set it to the OIDC client IDs used to access Infinite Scale (for example the web and desktop client IDs): + +[source,bash] +---- +PROXY_OIDC_ACCESS_TOKEN_VERIFY_AUD=web,xdXOt13JKxym1B1QcEncf2XDkLAexMBFwiT9j6EkMg +---- + +Leave the variable unset to disable the audience check (the default). The setting has no effect when `PROXY_OIDC_ACCESS_TOKEN_VERIFY_METHOD=none`. diff --git a/content/ocis/9.0/modules/admin/pages/deployment/identity-management/index.adoc b/content/ocis/9.0/modules/admin/pages/deployment/identity-management/index.adoc new file mode 100644 index 00000000..0b18a584 --- /dev/null +++ b/content/ocis/9.0/modules/admin/pages/deployment/identity-management/index.adoc @@ -0,0 +1,108 @@ += Identity Management Overview +:toc: right +:toclevels: 3 +:description: Infinite Scale uses two built-in services to handle identity: IDM stores users and groups, and IDP authenticates them. Both can be replaced with external systems for larger or production deployments. + +== Introduction + +{description} Understanding which service does what — and when to replace the built-in components — is the foundation for any Infinite Scale deployment. + +Infinite Scale separates two concerns: + +* *Directory* — where user and group records are stored and managed. The xref:{s-path}/idm.adoc[IDM service] provides a minimal built-in LDAP server. +* *Authentication* — how users prove their identity. The xref:{s-path}/idp.adoc[IDP service] provides a minimal built-in OpenID Connect provider. + +== Service Interaction + +The diagram below shows how the core identity services interact at login and during a typical API request. + +[mermaid, width=700] +----- +flowchart LR + client([Client / Browser]) + proxy[Proxy] + idp["IDP
OpenID Connect"] + idm[("IDM
LDAP Directory")] + users["Users service
CS3 API"] + groups["Groups service
CS3 API"] + graphsvc["Graph service
LibreGraph API"] + + client -->|"① HTTP request"| proxy + proxy -->|"② OIDC auth"| idp + idp -->|"③ LDAP lookup"| idm + proxy -->|"④ CS3 user lookup"| users + users -->|"⑤ LDAP read"| idm + proxy -->|"⑥ CS3 group lookup"| groups + groups -->|"⑦ LDAP read"| idm + client -->|"⑧ LibreGraph API"| graphsvc + graphsvc -->|"⑨ LDAP write"| idm +----- + +Steps ① through ⑦ happen on every authenticated request. Step ⑧–⑨ happen when users or groups are created, modified or deleted through the Web UI or the LibreGraph API. + +== Built-In Services + +=== IDM Limitations + +The built-in IDM is based on https://github.com/libregraph/idm[LibreGraph IDM] and is intentionally minimal: + +* Supports only `BIND`, `SEARCH`, `ADD`, `MODIFY`, and `DELETE` LDAP operations — no replication, no referrals, no LDAP schema validation. +* No support for 2FA or device management. +* Single-node only — cannot be clustered or replicated. +* Recommended only for *small installations* or *testing*. + +For larger or production deployments, replace IDM with a full LDAP server such as OpenLDAP or Microsoft Active Directory. + +=== IDP Limitations + +The built-in IDP is a minimal OpenID Connect provider: + +* No login screen branding or theming. +* No brute force protection — failed login attempts are not rate-limited or locked out. +* No backchannel logout — when a user logs out via an external application, Infinite Scale cannot be notified to invalidate its session cache. Access tokens remain valid until they expire. +* Recommended only for *small installations* or *testing*. + +For larger or production deployments, replace IDP with an external OpenID Connect provider such as Keycloak. + +== When to Use Built-In vs. External + +[cols="1,1,1",options="header"] +|=== +| Scenario +| IDM +| IDP + +| Development / testing +| Built-in ✓ +| Built-in ✓ + +| Small production (< ~100 users, single node) +| Built-in ✓ +| Built-in ✓ + +| Existing corporate LDAP / Active Directory +| External ✓ +| Built-in or external + +| Requires 2FA, SSO, or federation +| External ✓ +| External ✓ + +| Requires backchannel logout +| — +| External ✓ + +| Multi-node or high-availability +| External ✓ +| External ✓ +|=== + +NOTE: IDM and IDP can be replaced independently. A common intermediate step is to keep the built-in IDM while replacing the IDP with Keycloak. + +== Further Reading + +* xref:{s-path}/idm.adoc[IDM Service] — configuration, password reset, service accounts +* xref:{s-path}/idp.adoc[IDP Service] — configuration +* xref:deployment/identity-management/external-iam.adoc[External Identity and Authentication] — requirements for replacing IDM or IDP with external systems +* xref:{s-path}/graph.adoc[Graph Service] — LDAP backend configuration, user/group management +* xref:{s-path}/proxy.adoc[Proxy Service] — OIDC configuration, automatic user provisioning diff --git a/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/graph.adoc b/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/graph.adoc index 4e6ee906..fbd87005 100644 --- a/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/graph.adoc +++ b/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/graph.adoc @@ -17,6 +17,12 @@ include::partial$multi-location/compose-version.adoc[] * Graph listens on port 9120 by default. +== Space Image Size Limit + +The maximum file size of an image that can be set as a space image is controlled by `GRAPH_MAX_IMAGE_FILE_SIZE` (default: `50MB`). Set to `0` to disable the limit. + +IMPORTANT: `GRAPH_MAX_IMAGE_FILE_SIZE` must not exceed `THUMBNAILS_MAX_INPUT_IMAGE_FILE_SIZE` in the xref:{s-path}/thumbnails.adoc[Thumbnails] service. If `GRAPH_MAX_IMAGE_FILE_SIZE` is larger, the Graph service accepts the upload but the Thumbnails service refuses to render it, resulting in a broken space image. + == Restrict Username Patterns Usernames can be restricted to follow certain patterns. Such patterns can be neccessary when using the xref:{s-path}/idm.adoc[internal IDM,window=_blank] for example to align with local Unix username restrictions. Username restrictions can also be handled with an external IDM like Keycloak. The environment variable `GRAPH_USERNAME_MATCH` can be set to the following values to define where and how these restriction are handled: diff --git a/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/idm.adoc b/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/idm.adoc index 3b69efc9..e84a548d 100644 --- a/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/idm.adoc +++ b/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/idm.adoc @@ -97,6 +97,98 @@ LDAPTLS_REQCERT=never \ Extract the `idm_password` password to enter from the `ocis.yaml` config file which is located in the Infinite Scale xref:deployment/general/general-info.adoc#configuration-directory[configuration directory]. +== Resetting Lost Passwords + +The `resetpassword` sub-command resets the password of any account stored in the built-in IDM, whether that is the administrator, a regular user, or one of the internal service accounts. + +[source,plaintext] +---- +NAME: + ocis idm resetpassword - Reset user password + +USAGE: + ocis idm resetpassword [command options] + +CATEGORY: + password reset + +OPTIONS: + --user-name value, -u value User name (default: "admin") + --user-type value Type of user account: 'user' (ou=users) or 'service' (ou=sysusers) (default: "user") + --help, -h show help +---- + +[NOTE] +==== +As this command accesses the IDM database directly, Infinite Scale must *not* be running and no other process may be accessing the database when you issue it. +==== + +=== Administrator Account + +If the password of the built-in `admin` account is ever lost, run the command without any options — it defaults to the `admin` account: + +[source,bash] +---- +ocis idm resetpassword +---- + +The command prompts for the new password twice and updates the account on confirmation. + +=== Any Other User Account + +To reset the password of any other regular user stored in the built-in IDM, provide the account name with the `--user-name` option: + +[source,bash] +---- +ocis idm resetpassword --user-name +---- + +The command prompts for the new password twice and updates the account on confirmation. + +=== Internal Service Accounts + +As described in xref:#default-and-demo-users[Default and Demo Users], IDM maintains three internal service accounts that Infinite Scale services use to access the built-in directory: `libregraph`, `idp`, and `reva`. Normally their passwords are set during initialization and never need to change. Use this procedure only if the passwords have gone out of sync between the IDM database and the Infinite Scale configuration, for example after a manual database restore. + +[cols="1,2,3",options="header"] +|=== +| Account +| Used by +| Environment Variables to Update + +| `libregraph` +| Graph service — manages users and groups in the directory; has write access +| `GRAPH_LDAP_BIND_PASSWORD` + +`IDM_SVC_PASSWORD` + +| `idp` +| IDP service — looks up users during login +| `IDP_LDAP_BIND_PASSWORD` + +`IDM_IDPSVC_PASSWORD` + +| `reva` +| Auth-Basic, Users, and Groups services — read access to the directory +| `AUTH_BASIC_LDAP_BIND_PASSWORD`, `USERS_LDAP_BIND_PASSWORD`, `GROUPS_LDAP_BIND_PASSWORD`, `IDM_REVASVC_PASSWORD` +|=== + +NOTE: `OCIS_LDAP_BIND_PASSWORD` is a single shared variable that sets the password for all three accounts at once. If you use it instead of the per-service variables, updating it and restarting Infinite Scale is sufficient. + +Run the command with `--user-type service` and the account name: + +[source,bash] +---- +ocis idm resetpassword --user-type service --user-name +---- + +Replace `` with one of: `libregraph`, `idp`, or `reva`. The command prompts for the new password twice. After confirmation it performs two additional steps automatically: + +* It rewrites the affected password entries in `ocis.yaml` (if that file is present in the configuration directory). +* It prints the names of all environment variables that must also be updated wherever they are configured — in environment files, container secrets, Kubernetes secrets, or any other external configuration store. + +[IMPORTANT] +==== +After changing a service account password, Infinite Scale must be restarted so all affected services pick up the new credentials. +==== + == Configuration include::partial$deployment/services/env-and-yaml.adoc[tag=envvars-yaml] diff --git a/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/search.adoc b/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/search.adoc index ff21bd35..d9868cd8 100644 --- a/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/search.adoc +++ b/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/search.adoc @@ -104,7 +104,7 @@ Every time a resource changes its state, a corresponding event is triggered. Bas === Searching -A query via the {service_name} service will return results based on the index created. +A query via the {service_name} service will return results based on the index created. The search box accepts plain text as well as structured queries using the Keyword Query Language (KQL) subset implemented by Infinite Scale. For the full field reference, operators, and date shortcuts, see xref:conf-examples/search/kql-search-syntax.adoc[KQL Search Syntax]. === State Changes which Trigger Indexing @@ -184,12 +184,24 @@ The service includes a command-line interface to trigger re-indexing spaces: [source,bash] ---- -ocis search index --space $SPACE_ID || --all-spaces +ocis search index --space $SPACE_ID || --all-spaces [--timeout ] ---- * IDs but not names are necessary as parameter. ** See the xref:maintenance/space-ids/space-ids.adoc[Listing Space IDs] for how to retrieve a space ID. -* The arguments `-space` and `--all-spaces` are mutual exclusive , but one must be provided. +* The arguments `--space` and `--all-spaces` are mutually exclusive, but one must be provided. +* `--timeout` sets how long to wait for the indexing to complete before cancelling the walk. Accepts a Go duration string such as `30m`, `2h`. Defaults to `10m`. Set to `0` to wait indefinitely — useful for large spaces or when a slow content extractor (such as Tika) is in use. + +==== Compact the Search Index + +The search performance can degrade over time after bulk reindexing operations that create many small index segments. Use this command to compact the search index by merging Bleve segments without reindexing the content. + +[source,bash] +---- +ocis search optimize +---- + +NOTE: Although this command accesses the search index directly and does not block search queries, it is still recommended that it is issued during a maintenance window. == Notes diff --git a/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/storage-users.adoc b/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/storage-users.adoc index e54ecf6b..a2d9e425 100644 --- a/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/storage-users.adoc +++ b/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/storage-users.adoc @@ -40,6 +40,38 @@ To authenticate CLI commands use: The `storage-users` CLI tool uses the default address to establish the connection to the xref:{s-path}/gateway.adoc[gateway] service. If the connection fails, check your custom `gateway` service `GATEWAY_GRPC_ADDR` configuration and set the same address in `storage-users` `OCIS_GATEWAY_GRPC_ADDR` or `STORAGE_USERS_GATEWAY_GRPC_ADDR`. +=== Command Set Overview + +The following commands are available in the `ocis storage-users` command set: + +[source,bash] +---- +ocis storage-users -h +NAME: + ocis storage-users - storage-users service commands + +USAGE: + ocis storage-users [command options] + +CATEGORY: + services + +COMMANDS: + uploads manage unfinished uploads + trash-bin manage trash-bin's + spaces manage spaces + blobstore manage the blobstore + help, h Shows a list of commands or help for one command + info: + health check health status + version print the version of this binary and the running service instances + server: + server start the storage-users service without runtime (unsupervised mode) + +OPTIONS: + --help, -h show help +---- + === Manage Unfinished or Stale Uploads When using Infinite Scale as user storage, a directory named `storage/users/uploads` can be found in the Infinite Scale data folder. This is an intermediate directory based on {tus-url}[TUS] which is an open protocol for resumable uploads. Each upload consists of a _blob_ and a _blob.info_ file. Note that the term _blob_ is just a placeholder. @@ -118,6 +150,8 @@ OPTIONS: --processing filter sessions by processing status (default: unset) --expired filter sessions by expired status (default: unset) --has-virus filter sessions by virus scan result (default: unset) + --orphaned filter sessions by whether their node metadata is unreadable. + Such sessions can never finish processing and can be removed with --clean (default: unset) --json output as json (default: false) --restart send restart event for all listed sessions (default: false) --resume send resume event for all listed sessions (default: false) @@ -327,6 +361,44 @@ ocis storage-users trash-bin restore [command options] ['spaceID' required] ['it ---- -- +=== Verify and Inspect the Configured Blobstore + +Verify and inspect the configured blobstore without requiring direct access to the underlying storage system. + +==== Command Details + +The following command can verify and inspect the configured blobstore. + +.Usage: + +[source,bash] +---- +ocis storage-users blobstore -h +NAME: + ocis storage-users blobstore - manage the blobstore + +USAGE: + ocis storage-users blobstore [command options] + +COMMANDS: + check check blobstore connectivity via an upload/download/delete round-trip + get get a blob from the blobstore by ID + help, h Shows a list of commands or help for one command + +OPTIONS: + --help, -h show help +---- + +.Notes: + +* `blobstore check` + +Performs a full upload/download/delete round-trip using a random payload. The payload size is configurable via `--blob-size` and accepts human-readable values such as `64`, `1KB` or `4MiB` (default: 64 bytes). + +* `blobstore get` + +Downloads a specific blob by its ID to verify it is readable. The blob can be identified either with `--blob-id` and `--space-id`, or by passing the raw blob path from a log line directly via `--path`. Both the s3ng key format (`/`) and the ocis filesystem path format (`…/spaces//blobs/`) are accepted. When using the s3ng driver without a known blob size, an automatic retry with the actual size is performed on a size mismatch. + +As both commands read the existing service configuration, they always target the same blobstore as the running service. Only the `ocis` and `s3ng` storage drivers are supported. + == Resource Optimisation See the xref:deployment/storage/general-considerations.adoc#resource-optimisation[General Storage Considerations and Settings] documentation for details about configuring the `STORAGE_USERS_OCIS_MAX_CONCURRENCY` environment variable. diff --git a/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/thumbnails.adoc b/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/thumbnails.adoc index 264e7ed6..c38ff792 100644 --- a/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/thumbnails.adoc +++ b/content/ocis/9.0/modules/admin/pages/deployment/services/s-list/thumbnails.adoc @@ -102,6 +102,12 @@ that section is covered in the dev docs only, see the comment in the page intro. As of now, there is no automated thumbnail deletion. This is especially true when a source file gets deleted or moved. This situation will be solved at a later stage. For the time being, if you run short on physical thumbnails space, you have to manually delete the thumbnail store to free space. Thumbnails will then be recreated on request. +=== Input Image File Size Limit + +The maximum file size of an input image processed by the Thumbnails service is controlled by `THUMBNAILS_MAX_INPUT_IMAGE_FILE_SIZE` (default: `50MB`). Files larger than this value are rejected by the service. + +NOTE: `THUMBNAILS_MAX_INPUT_IMAGE_FILE_SIZE` should be greater than or equal to `GRAPH_MAX_IMAGE_FILE_SIZE` in the xref:{s-path}/graph.adoc[Graph] service. If the Graph service accepts a space image that the Thumbnails service refuses to render, the space image appears broken. + === Memory Considerations Since source files need to be loaded into memory when generating thumbnails, large source files could potentially crash this service if there is insufficient memory available. For bigger instances when using container orchestration deployment methods, this service can be dedicated to its own server(s) with more memory. diff --git a/content/ocis/9.0/modules/admin/pages/index.adoc b/content/ocis/9.0/modules/admin/pages/index.adoc index 3ef114e7..5bf5c63f 100644 --- a/content/ocis/9.0/modules/admin/pages/index.adoc +++ b/content/ocis/9.0/modules/admin/pages/index.adoc @@ -69,6 +69,3 @@ NOTE: We highly recommend reading the xref:admin:deployment/general/general-info Configuration of Infinite Scale might be quite different to what you are used to but it's very simple. It works with environment variables and optional configuration files for you to create depending on your specific needs. The settings in configuration files can always be overruled by setting the respective environment variables manually on the command line. -== End-User License Agreement (EULA) - -ownCloud provides an EULA to clarify, among various topics, who can use this software and which conditions apply to the groups of users defined. See the actual {compose_raw_url}{ocis_git_version}/assets/End-User-License-Agreement-for-ownCloud-Infinite-Scale.pdf[EULA] for details. diff --git a/content/ocis/9.0/modules/admin/pages/maintenance/commands/changed-cli.adoc b/content/ocis/9.0/modules/admin/pages/maintenance/commands/changed-cli.adoc index b3f1fed0..ba7c08d2 100644 --- a/content/ocis/9.0/modules/admin/pages/maintenance/commands/changed-cli.adoc +++ b/content/ocis/9.0/modules/admin/pages/maintenance/commands/changed-cli.adoc @@ -1,6 +1,6 @@ = Changed or Added CLI Commands :toc: right -:description: This page contains a list with added, changed or removed CLI commands between Infinite Scale version 8.2.0 and 8.3.0. +:description: This page contains a list with added, changed or removed CLI commands between Infinite Scale version 8.2.0 and 9.0.0. :page-aliases: ROOT:maintenance/b-r/changed-cli.adoc == Introduction @@ -9,10 +9,16 @@ == Affected CLI Commands -// None of the admin-related commands have changed. - See the link for a detailed description of the respective CLI command if available. -// the commented link is only as an easy to add template -// * xref:maintenance/commands/commands.adoc#verify-and-inspect-blobstore[Verify and Inspect a Blobstore] + -This CLI command has been added to verify and inspect the configured Blobstore without requiring direct access to the underlying storage system. +* xref:maintenance/commands/recalculate-treesize.adoc[Recalculate Space Treesize] + +This CLI command has been added to correct drifting quota usage by recalculating the treesize of every directory in a space from the actual sizes of its children. Infinite Scale must be shut down before running in write mode. + +* xref:maintenance/commands/commands.adoc#reset-password-for-idm-users[Reset Password for IDM Users] + +The `ocis idm resetpassword` command now also supports resetting service account passwords (`libregraph`, `idp`, `reva`) via `--user-type service`. After a service account password is changed, affected environment variables must be updated and Infinite Scale restarted. + +* xref:maintenance/commands/commands.adoc#reindex-spaces-for-search[Reindex Spaces for Search] + +The `ocis search index` command has been extended with a `--timeout` flag (default `10m`, `0` = no limit) to allow indexing of large spaces or spaces with slow content extractors that previously failed with a context-cancelled error. + +* xref:maintenance/commands/commands.adoc#manage-expired-or-stale-uploads[Manage Expired or Stale Uploads] + +The `ocis storage-users uploads sessions` command has been extended with an `--orphaned` flag to filter sessions whose node metadata is unreadable. Such sessions can never complete processing and can be cleaned up with `--clean`. diff --git a/content/ocis/9.0/modules/admin/pages/maintenance/commands/commands.adoc b/content/ocis/9.0/modules/admin/pages/maintenance/commands/commands.adoc index e12c6a0b..377c2121 100644 --- a/content/ocis/9.0/modules/admin/pages/maintenance/commands/commands.adoc +++ b/content/ocis/9.0/modules/admin/pages/maintenance/commands/commands.adoc @@ -50,7 +50,13 @@ WARNING: Use this command with absolute care. It is not intended to play around === Reset Password for IDM Users -If you need to reset the password for the admin or a user in the xref:{s-path}/idm.adoc[idm] service from the command line, follow the xref:deployment/general/general-info.adoc#password-reset-for-idm-users[Password Reset for IDM Users]. +If you need to reset the password for the admin, a service account or an ordinary user that is handled via the IDM service from the command line, see the xref:{s-path}/idm.adoc#resetting-lost-passwords[Resetting Lost Passwords] section in the IDM service for more details. + +=== Recalculate Space Treesize + +The reported quota of a space can drift from the data actually stored on disk. Infinite Scale provides a xref:maintenance/commands/recalculate-treesize.adoc[CLI command] to walk a space bottom-up and correct the stored treesize of every directory. + +NOTE: This command MUST only be issued when Infinite Scale is offline and no services are running. === Revisions Cleanup @@ -84,6 +90,10 @@ Detect and, if desired, delete storage grants that have no corresponding share-m When a shared space or directory got deleted, use the following xref:maintenance/commands/cleanup-orphaned-shares.adoc[CLI command] to cleanup those share orphans. This can't be done automatically at the moment. +=== Compact the Search Index + +The search performance can degrade over time after bulk reindexing operations that create many small index segments. Use the following xref:{s-path}/search.adoc#compact-the-search-index[CLI command] to compact the search index for improved search performance. + === Inspect and Manipulate Node Metadata Infinite Scale provides a xref:maintenance/commands/node-metadata.adoc[CLI command] with which you can inspect and manipulate node metadata. @@ -129,6 +139,6 @@ WARNING: Use this command with absolute care. It is not intended to play around This command is about sending emails based on events stored in a named group bucket. See the xref:{s-path}/notifications.adoc#sending-grouped-emails[Sending Grouped Emails] section in the _notification_ service for details. -=== Verify and Inspect a Blobstore +=== Verify and Inspect a Configured Blobstore -This command has been added to verify and inspect the configured Blobstore without requiring direct access to the underlying storage system. Use the following xref:maintenance/commands/verify-and-inspect-blobstore.adoc[CLI command] for this task. +This command has been added to verify and inspect the configured blobstore without requiring direct access to the underlying storage system. Use the following xref:{s-path}/storage-users.adoc#verify-and-inspect-the-configured-blobstore[CLI command] for this task. diff --git a/content/ocis/9.0/modules/admin/pages/maintenance/commands/recalculate-treesize.adoc b/content/ocis/9.0/modules/admin/pages/maintenance/commands/recalculate-treesize.adoc new file mode 100644 index 00000000..3f2f3a0d --- /dev/null +++ b/content/ocis/9.0/modules/admin/pages/maintenance/commands/recalculate-treesize.adoc @@ -0,0 +1,43 @@ += Recalculate Space Treesize +:description: The recalculate-treesize command corrects drifting quota usage by recalculating the treesize of every directory in a space from the actual sizes of its children. + +{description} + +The reported quota usage of a space is maintained as a running counter that is updated on every change. A failed or incomplete update leaves the counter wrong, causing the Web UI to display an incorrect space size or quota usage. This command walks a space bottom-up, recalculates the treesize of every directory from the actual sizes of its children, and corrects the stored values. + +NOTE: This command MUST only be issued when Infinite Scale is offline and no services are running. + +[source,bash] +---- +ocis storage-users spaces recalculate-treesize [command options] + +OPTIONS: + --space-id value, -s value Space ID to recalculate ($!, + $ or bare ; omit to process all spaces) + --dry-run Only show which treesizes would be corrected without writing them (default: true) + --verbose, -v Enable verbose logging (default: false) + --help, -h show help +---- + +Dry-run mode is the default. Run without `--dry-run=false` first to review which treesizes would be corrected: + +[source,bash] +---- +ocis storage-users spaces recalculate-treesize +---- + +After reviewing the output, shut down Infinite Scale and apply the corrections: + +[source,bash] +---- +ocis storage-users spaces recalculate-treesize --dry-run=false +---- + +To target a single space only, provide its ID: + +[source,bash] +---- +ocis storage-users spaces recalculate-treesize --dry-run=false --space-id +---- + +See the xref:maintenance/space-ids/space-ids.adoc[Listing Space IDs] documentation for how to retrieve a space ID. diff --git a/content/ocis/9.0/modules/admin/pages/maintenance/commands/verify-and-inspect-blobstore.adoc b/content/ocis/9.0/modules/admin/pages/maintenance/commands/verify-and-inspect-blobstore.adoc deleted file mode 100644 index 3741c695..00000000 --- a/content/ocis/9.0/modules/admin/pages/maintenance/commands/verify-and-inspect-blobstore.adoc +++ /dev/null @@ -1,41 +0,0 @@ -= Verify and Inspect a Blobstore -:toc: right -:description: Verify and inspect the configured Blobstore without requiring direct access to the underlying storage system. - -Verify and inspect the configured Blobstore without requiring direct access to the underlying storage system. - -include::partial$/maintenance/ocis-storage-users-cli.adoc[] - -== Command Details - -The following command can verify and inspect the configured Blobstore. - -.Usage: - -[source,bash] ----- -ocis storage-users blobstore -h -NAME: - ocis storage-users blobstore - manage the blobstore - -USAGE: - ocis storage-users blobstore [command options] - -COMMANDS: - check check blobstore connectivity via an upload/download/delete round-trip - get get a blob from the blobstore by ID - help, h Shows a list of commands or help for one command - -OPTIONS: - --help, -h show help ----- - -.Notes: - -* `blobstore check` + -Performs a full upload/download/delete round-trip using a random payload. The payload size is configurable via `--blob-size` and accepts human-readable values such as `64`, `1KB` or `4MiB` (default: 64 bytes). - -* `blobstore get` + -Downloads a specific blob by its ID to verify it is readable. The blob can be identified either with `--blob-id` and `--space-id`, or by passing the raw blob path from a log line directly via `--path`. Both the s3ng key format (`/`) and the ocis filesystem path format (`…/spaces//blobs/`) are accepted. When using the s3ng driver without a known blob size, an automatic retry with the actual size is performed on a size mismatch. - -As both commands read the existing service configuration, they always target the same blobstore as the running service. Only the `ocis` and `s3ng` storage drivers are supported. diff --git a/content/ocis/9.0/modules/admin/pages/migration/upgrading-ocis.adoc b/content/ocis/9.0/modules/admin/pages/migration/upgrading-ocis.adoc index cac5ab9e..cb0442f5 100644 --- a/content/ocis/9.0/modules/admin/pages/migration/upgrading-ocis.adoc +++ b/content/ocis/9.0/modules/admin/pages/migration/upgrading-ocis.adoc @@ -20,6 +20,35 @@ IMPORTANT: When upgrading from an older release to the desired one, *ALL* upgrad IMPORTANT: When upgrading from an older release to the desired one, mandatory configuration settings may have been added or removed. To see the changes required, you can run `ocis init --diff` after upgrading but before finally starting. For more details, see the xref:deployment/general/ocis-init.adoc[ocis init command] description. + +== Version 8.2.0 to 9.0.0 + +=== Notable Changes Requiring Manual Intervention + +There are no changes in Infinite Scale 8.2 that require manual intervention, but other notable changes have been implemented. + +=== Breaking Changes Requiring Manual Intervention + +There are breaking changes in Infinite Scale 9.0. + +=== Upgrade Steps + +For a detailed description of the steps to upgrade, see the xref:migration/upgrading_8.2.0_9.0.0.adoc[Upgrading from 8.2.0 to 9.0.0] documentation. Note that this document also contains references to added/changed/removed CLI commands and environment variables. + +== Version 8.1.0 to 8.2.0 + +=== Notable Changes Requiring Manual Intervention + +There are no changes in Infinite Scale 8.2 that require manual intervention, but other notable changes have been implemented. + +=== Breaking Changes Requiring Manual Intervention + +There are no breaking changes in Infinite Scale 8.1. + +=== Upgrade Steps + +For a detailed description of the steps to upgrade, see the xref:migration/upgrading_8.1.0_8.2.0.adoc[Upgrading from 8.1.0 to 8.2.0] documentation. Note that this document also contains references to added/changed/removed CLI commands and environment variables. + == Version 8.0.0 to 8.1.0 === Notable Changes Requiring Manual Intervention diff --git a/content/ocis/9.0/modules/admin/pages/migration/upgrading_8.1.0_8.2.0.adoc b/content/ocis/9.0/modules/admin/pages/migration/upgrading_8.1.0_8.2.0.adoc new file mode 100644 index 00000000..1ddc1289 --- /dev/null +++ b/content/ocis/9.0/modules/admin/pages/migration/upgrading_8.1.0_8.2.0.adoc @@ -0,0 +1,108 @@ += Upgrading from 8.1.0 to 8.2.0 +:toc: right +:description: This document describes the necessary steps when upgrading Infinite Scale from release 8.1.0 to 8.2.0. + +// define the actual version of this release. it may contain a patch version that needs to be updated accordingly +:actual_ocis_version: '8.2.2' + +include::partial$multi-location/compose-version.adoc[] + +== Introduction + +{description} + +IMPORTANT: Read the important notes in the xref:migration/upgrading-ocis.adoc#introduction[Upgrading Infinite Scale] documentation before you start. + +IMPORTANT: Check below, if you are affected by breaking changes and prepare all steps mentioned before you start the upgrade. + +== Upgrade Steps + +. Download and install Infinite Scale + +*Do not start it after downloading the image*! +. Shut down the Infinite Scale instance +. We strongly recommend doing a backup +. Reconfigure the deployment +. Manage Breaking Changes +. Notabale Changes +. Manage Added/Removed/Deprecated environment variables +. Start Infinite Scale + +:sectnums: + +== Download and Install Infinite Scale + +Download and install Infinite Scale: + +* Issue the following command to download the new image: ++ +[source,bash,subs="attributes+"] +---- +docker pull owncloud/ocis:{actual_ocis_version} +---- + +== Shut Down the Infinite Scale Instance + +Depending how you deployed Infinite Scale, you need to shut it down differently. + +* *docker compose* + +For deployments using `docker compose` do a graceful shutdown as described in xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc#stop-the-deployment[Stop the Deployment]. + +* *Any other image based deployment* + +For any other image based deployment, shut down Infinite Scale according the vendors deployment description. + +== Backup of Infinite Scale + +See the xref:maintenance/b-r/backup_considerations.adoc[Backup Considerations] and the xref:maintenance/b-r/backup.adoc[Backup] documentation for more details. + +== Reconfigure the Deployment + +Reconfigure the deployment to use the new image: + +* For `docker compose` +** Update _every_ compose file where the `ocis image` is referenced accordingly. +** If you have used the deployment examples either for xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc[Local Production Setup] or xref:depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc[Deployment on Hetzner], read the *Updating and Upgrading* section of those pages carefully. + +== Manage Breaking Changes + +There are no breaking changes in Infinite Scale 8.2 + +== Notabale Changes + +* The deployment examples now include KeyCloak as an option. + +== Reconfigure Deployment Examples + +The following steps are based on the xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc[Local Production Setup] deployment example. The steps are identical for the xref:depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc[Deployment on Hetzner]. + +* Stop the deployment example + +* Backup the the base folder containing the existing deployment example by renaming it. + +You will need your configuration details with the new example. + +* Follow the xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc#download-and-transfer-the-example[Download and Transfer Example] link to get the new deployment and extract it as described in the following section of the guide. + +* Reconfigure the new `.env` file based on settings made in the `.env` file of the backup. +** Note that defined image versions have changed for: + +`Traefik`, `Collabora` and `OnlyOffice`. + +The provided versions have been tested. Update at your own risk. Note that this applies in particular when using `latest`. The image versions are subject to change if a new deployment example is provided. + +** The version of other images using the `latest` tag may also have changed. +** Pull the new image versions with `docker compose pull`. + +* Start the deployment example. + +== Start Infinite Scale + +When you have finished upgrading, you now can start Infinite Scale as usual. + +For any deployment used, you now can delete/remove old binaries or images/containers. + +:sectnums!: + +== Changed or Added CLI Commands + +See the xref:maintenance/commands/changed-cli.adoc[Changed or Added CLI Commands] document for details. + +== Changed Environment Variables + +See the xref:deployment/services/env-var-changes.adoc[Changed Environment Variables in Versions] document for details. diff --git a/content/ocis/9.0/modules/admin/pages/migration/upgrading_8.2.0_9.0.0.adoc b/content/ocis/9.0/modules/admin/pages/migration/upgrading_8.2.0_9.0.0.adoc new file mode 100644 index 00000000..6195bdc1 --- /dev/null +++ b/content/ocis/9.0/modules/admin/pages/migration/upgrading_8.2.0_9.0.0.adoc @@ -0,0 +1,136 @@ += Upgrading from 8.2.0 to 9.0.0 +:toc: right +:description: This document describes the necessary steps when upgrading Infinite Scale from release 8.2.0 to 9.0.0. + +// define the actual version of this release. it may contain a patch version that needs to be updated accordingly +:actual_ocis_version: '9.0.0' + +include::partial$multi-location/compose-version.adoc[] + +== Introduction + +{description} + +IMPORTANT: Read the important notes in the xref:migration/upgrading-ocis.adoc#introduction[Upgrading Infinite Scale] documentation before you start. + +IMPORTANT: Check below, if you are affected by breaking changes and prepare all steps mentioned before you start the upgrade. + +== Upgrade Steps + +. Download and install Infinite Scale + +*Do not start it after downloading the image*! +. Shut down the Infinite Scale instance +. We strongly recommend doing a backup +. Reconfigure the deployment +. Manage Breaking Changes +. Notabale Changes +. Manage Added/Removed/Deprecated environment variables +. Start Infinite Scale + +:sectnums: + +== Download and Install Infinite Scale + +Download and install Infinite Scale: + +* Issue the following command to download the new image: ++ +[source,bash,subs="attributes+"] +---- +docker pull owncloud/ocis:{actual_ocis_version} +---- + +== Shut Down the Infinite Scale Instance + +Depending how you deployed Infinite Scale, you need to shut it down differently. + +* *docker compose* + +For deployments using `docker compose` do a graceful shutdown as described in xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc#stop-the-deployment[Stop the Deployment]. + +* *Any other image based deployment* + +For any other image based deployment, shut down Infinite Scale according the vendors deployment description. + +== Backup of Infinite Scale + +See the xref:maintenance/b-r/backup_considerations.adoc[Backup Considerations] and the xref:maintenance/b-r/backup.adoc[Backup] documentation for more details. + +== Reconfigure the Deployment + +Reconfigure the deployment to use the new image: + +* For `docker compose` +** Update _every_ compose file where the `ocis image` is referenced accordingly. +** If you have used the deployment examples either for xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc[Local Production Setup] or xref:depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc[Deployment on Hetzner], read the *Updating and Upgrading* section of those pages carefully. + +== Manage Breaking Changes + +There are breaking changes in Infinite Scale 9.0. + +=== Removal of the posixfs Storage Driver + +The `posix` storage driver has been completely removed in 9.0.0 without replacement. + +IMPORTANT: If you are currently using `STORAGE_USERS_DRIVER=posix`, you *must* migrate to the `decomposedfs` driver *before* upgrading to 9.0.0. Starting Infinite Scale 9.0.0 with posixfs-related environment variables set will result in an error. + +The following changes apply: + +* The `storage-users` service no longer accepts `posix` as a driver value. +* All `STORAGE_USERS_POSIX_*` environment variables have been removed and must be unset before upgrading. +* Remove any posixfs-related configuration from your deployment before starting the upgraded instance. + +=== Removal of the owncloudsql Storage Driver + +The `owncloudsql` storage driver has been completely removed in 9.0.0. + +IMPORTANT: If you are using the `owncloudsql` driver in any service, you *must* migrate away from it before upgrading to 9.0.0. + +The following services are affected: `auth-basic`, `users`, `groups`, `sharing`, and `storage-users`. All related environment variables have been removed and must be unset before upgrading. + +== Notabale Changes + +* The deployment examples now include KeyCloak as an option. + +* The Collabora Online image in the deployment examples has been updated from version 25.x to 26.x. Collabora 26.x ships without a shell and without the `coolconfig` helper used in earlier releases to generate the WOPI proof key on startup. The deployment example handles this automatically with a new one-shot `collabora-proof-key-init` container that generates and persists the key before Collabora starts. ++ +If you are using Collabora, review the following changes in the `.env` file when migrating from an 8.2 deployment: + +** `COLLABORA_ADMIN_USER` and `COLLABORA_ADMIN_PASSWORD` must now be set explicitly. The hardened Collabora configuration included in this release enforces credentials for the admin console; leaving these empty disables admin console access. + +** A new `COLLABORA_CONFIG_DIR` variable controls where the WOPI proof key is stored on the host. It defaults to `./config/collabora` relative to the compose project directory. Set a custom path if you want the key stored elsewhere, for example when using an external volume. + +== Reconfigure Deployment Examples + +The following steps are based on the xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc[Local Production Setup] deployment example. The steps are identical for the xref:depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc[Deployment on Hetzner]. + +* Stop the deployment example + +* Backup the the base folder containing the existing deployment example by renaming it. + +You will need your configuration details with the new example. + +* Follow the xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc#download-and-transfer-the-example[Download and Transfer Example] link to get the new deployment and extract it as described in the following section of the guide. + +* Reconfigure the new `.env` file based on settings made in the `.env` file of the backup. +** Note that defined image versions have changed for: + +`Traefik`, `Collabora` and `OnlyOffice`. + +The provided versions have been tested. Update at your own risk. Note that this applies in particular when using `latest`. The image versions are subject to change if a new deployment example is provided. + +** The version of other images using the `latest` tag may also have changed. +** Pull the new image versions with `docker compose pull`. + +* Start the deployment example. + +== Start Infinite Scale + +When you have finished upgrading, you now can start Infinite Scale as usual. + +For any deployment used, you now can delete/remove old binaries or images/containers. + +:sectnums!: + +== Changed or Added CLI Commands + +See the xref:maintenance/commands/changed-cli.adoc[Changed or Added CLI Commands] document for details. + +== Changed Environment Variables + +See the xref:deployment/services/env-var-changes.adoc[Changed Environment Variables in Versions] document for details. diff --git a/content/ocis/9.0/modules/admin/partials/depl-examples/ubuntu-compose/shared-setup.adoc b/content/ocis/9.0/modules/admin/partials/depl-examples/ubuntu-compose/shared-setup.adoc index 87c004bf..8858423c 100644 --- a/content/ocis/9.0/modules/admin/partials/depl-examples/ubuntu-compose/shared-setup.adoc +++ b/content/ocis/9.0/modules/admin/partials/depl-examples/ubuntu-compose/shared-setup.adoc @@ -104,6 +104,10 @@ The following (sub)domains are required as a minimum, an example is printed for * `ONLYOFFICE_DOMAIN` + `[.blue]#onlyoffice.yourdomain.com#` +.If Keycloak is configured via .env +* `KEYCLOAK_DOMAIN` + +`[.blue]#keycloak.yourdomain.com#` + Note that depending on your setup, more (sub)domains may be required. See the `.env` file for more details.. Note that any communication between ocis and any web office application is handled via the docker network and is not exposed to the outside. @@ -316,6 +320,7 @@ clamav.yml cloudimporter.yml collabora.yml [.aqua]#config# +keycloak.yml ... ---- -- @@ -347,6 +352,24 @@ If you expect a higher amount of data in the instance, consider using own paths * `SMTP_xxx` + Define these settings according to your email configuration. If the settings are defined, Infinite Scale will be able to send notifications to users. If the settings are not defined, Infinite Scale will start but won't be able to send notifications. +* `COLLABORA_ADMIN_USER` and `COLLABORA_ADMIN_PASSWORD` + +If Collabora Online is enabled, set these to credentials of your choice. The hardened Collabora configuration enforces explicit credentials for the admin console; leaving them empty disables admin console access. + +* `COLLABORA_CONFIG_DIR` + +Optional. Path on the host where the Collabora WOPI proof key is persisted across container restarts. Defaults to `./config/collabora` relative to the compose project directory. The proof key is generated automatically on first start by a dedicated init container. + +* `KEYCLOAK` + +To enable Keycloak as an external Identity Provider, uncomment `#KEYCLOAK=:keycloak.yml` by removing the leading `#`. See xref:optional-keycloak-as-identity-provider[Optional: Keycloak as Identity Provider] before enabling this. + +* `KEYCLOAK_DOMAIN` + +If Keycloak is enabled, set the domain name for the Keycloak management and authentication frontend, as defined in xref:domain-names[Domain Names]. + +* `KEYCLOAK_REALM` + +The Keycloak realm to use with Infinite Scale. Defaults to `oCIS`. The realm is pre-configured and imported automatically on first start, including demo users. + +* `KEYCLOAK_ADMIN_USER` and `KEYCLOAK_ADMIN_PASSWORD` + +Keycloak administrator credentials for the Keycloak management UI. Change these from the default `admin/admin` before exposing the instance to the internet. + NOTE: If you do not define your own domain names, only domain names with self-signed certificates are automatically used for internal evaluation. NOTE: Additional options can be configured like web applications. These should be configured _after_ the deployment has successfully started without problems. This makes it easier to find any initial startup issues that need to be resolved first. @@ -458,9 +481,78 @@ docker compose down --remove-orphans For safety's sake, *do not* add the `-v` (volumes) flag to the command, as this will delete all volumes, including their data. If deleting volumes is necessary, selective deletion is the preferred method, see the above section for an example. See the `docker compose down` https://docs.docker.com/reference/cli/docker/compose/down/#options[options] for more details. == Change Settings - + To change settings via the `.env` file, the deployment _must be_ in the `down` state. See the section above for how to do this. +== Optional: Keycloak as Identity Provider + +By default, Infinite Scale uses its built-in Identity Provider (IDP). Keycloak can optionally be enabled instead. When enabled, Keycloak manages user authentication and the built-in IDP is automatically stopped. Keycloak adds two containers to the stack: Keycloak itself and a PostgreSQL database. The oCIS realm is pre-configured and imported into Keycloak automatically on first start, including the demo users. + +NOTE: This section covers enabling Keycloak on a fresh installation only. Migrating an existing installation from the built-in IDP to Keycloak is not covered here and requires separate planning — see xref:common-pitfalls[Common Pitfalls] for the risks involved. + +=== Enabling Keycloak + +Before enabling Keycloak, ensure a DNS entry and a valid TLS certificate are set up for `KEYCLOAK_DOMAIN` (see xref:domain-names[Domain Names]). + +To enable Keycloak, stop the deployment, then in the `.env` file: + +. Uncomment `KEYCLOAK=:keycloak.yml` by removing the leading `#`. +. Set `KEYCLOAK_DOMAIN` to the Keycloak domain. +. Set `KEYCLOAK_ADMIN_USER` and `KEYCLOAK_ADMIN_PASSWORD` to secure values. + +Restart the deployment. Keycloak and PostgreSQL need extra time to initialize on first start (1–2 minutes). Wait until the Keycloak container is healthy before attempting to log in. + +=== What Changes for the Administrator + +Enabling Keycloak shifts several responsibilities from Infinite Scale to Keycloak: + +* *User management moves to Keycloak.* + +Users can no longer be created or modified through the Infinite Scale administration panel. Manage users in the Keycloak management console at `https://`. + +* *Accounts are created automatically on first login.* + +When a user authenticates through Keycloak for the first time, an Infinite Scale account is provisioned automatically. + +* *Roles are assigned via Keycloak claims.* + +Default role assignment from Infinite Scale is disabled. Assign user roles in the Keycloak realm. + +* *Admin password management moves to Keycloak.* + +The `ocis idm resetpassword` command resets passwords in IDM, which is no longer used for authentication when Keycloak is active. Reset user passwords through the Keycloak management console instead. + +* *PostgreSQL data must be included in backups.* + +Keycloak stores its configuration and user data in `./data/keycloak-postgres`. This directory must be part of your regular backup routine. + +=== Common Pitfalls + +[IMPORTANT] +==== +*Enabling Keycloak on an existing installation without planning.* + +Users that exist only in IDM will not be able to log in until their accounts are recreated in Keycloak. Files and spaces they own will be inaccessible until the user accounts are linked with matching user IDs. Plan user migration before switching. +==== + +[IMPORTANT] +==== +*Switching back to the built-in IDP is not straightforward.* + +Once Keycloak has been enabled and users have authenticated through it, disabling Keycloak and reverting to the built-in IDP requires manually re-creating all users in IDM with matching user IDs. Treat enabling Keycloak as a one-way change unless you have a tested rollback plan. +==== + +[CAUTION] +==== +*Default Keycloak admin credentials.* + +`KEYCLOAK_ADMIN_USER` and `KEYCLOAK_ADMIN_PASSWORD` both default to `admin`. Always change these to strong, unique values before exposing the instance to the internet — the Keycloak management console is publicly reachable on `KEYCLOAK_DOMAIN`. +==== + +[CAUTION] +==== +*Keycloak takes longer to start than Infinite Scale.* + +Keycloak and PostgreSQL need 1–2 minutes to initialize on the first start and after every clean restart. Attempting to log in too early will result in authentication errors. The Keycloak container log shows `Keycloak 26.x.x on JVM ... started in` when it is ready. +==== + +[NOTE] +==== +*Tracing (`KEYCLOAK_TRACING`) requires the monitoring stack.* + +Setting `KEYCLOAK_TRACING=true` sends traces to `http://jaeger:4317`. This requires the optional monitoring stack (`MONITORING=:monitoring.yml`) to be enabled. Enabling tracing without monitoring will cause Keycloak startup errors. +==== + == First Time Login Now that the preparations are complete, you can access your instance *from any client*. To do this, open your browser and enter the instance URL as you defined it: diff --git a/content/ocis/9.0/modules/admin/partials/maintenance/ocis-storage-users-cli.adoc b/content/ocis/9.0/modules/admin/partials/maintenance/ocis-storage-users-cli.adoc deleted file mode 100644 index 04b4f65d..00000000 --- a/content/ocis/9.0/modules/admin/partials/maintenance/ocis-storage-users-cli.adoc +++ /dev/null @@ -1,31 +0,0 @@ -== Command Set Overview - -The described command is part of the `ocis storage-users` command set: - -[source,bash] ----- -ocis storage-users -h -NAME: - ocis storage-users - storage-users service commands - -USAGE: - ocis storage-users [command options] - -CATEGORY: - services - -COMMANDS: - uploads manage unfinished uploads - trash-bin manage trash-bins - spaces manage spaces - blobstore manage the blobstore - help, h Shows a list of commands or help for one command - info: - health check health status - version print the version of this binary and the running service instances - server: - server start the storage-users service without runtime (unsupervised mode) - -OPTIONS: - --help, -h show help ----- diff --git a/content/ocis/9.0/modules/admin/partials/nav.adoc b/content/ocis/9.0/modules/admin/partials/nav.adoc index 12438c53..85fe015a 100644 --- a/content/ocis/9.0/modules/admin/partials/nav.adoc +++ b/content/ocis/9.0/modules/admin/partials/nav.adoc @@ -17,6 +17,8 @@ **** xref:admin:deployment/storage/posixfs.adoc[PosixFS] *** xref:admin:deployment/general/general-info.adoc[General Information] *** xref:admin:deployment/general/ocis-init.adoc[The ocis init Command] +*** xref:admin:deployment/identity-management/index.adoc[Identity Management] +**** xref:admin:deployment/identity-management/external-iam.adoc[External Identity and Authentication] *** xref:admin:deployment/wopi/wopi.adoc[Office Applications using WOPI] *** xref:admin:deployment/security/security.adoc[Securing oCIS] *** xref:admin:deployment/gdpr/gdpr.adoc[User Triggered GDPR Report] @@ -98,6 +100,7 @@ ** Configuration Examples *** xref:admin:conf-examples/office/office-integration.adoc[Office Integration] *** xref:admin:conf-examples/search/configure-search.adoc[Search] +**** xref:admin:conf-examples/search/kql-search-syntax.adoc[KQL Search Syntax] ** Deployment Examples *** Ubuntu with Docker Compose diff --git a/content/ocis/9.0/modules/developer/pages/cli-commands/benchmark.adoc b/content/ocis/9.0/modules/developer/pages/cli-commands/benchmark.adoc new file mode 100644 index 00000000..a2fe7454 --- /dev/null +++ b/content/ocis/9.0/modules/developer/pages/cli-commands/benchmark.adoc @@ -0,0 +1,86 @@ += Benchmark CLI +:toc: right +:toclevels: 3 +:description: The ocis benchmark command provides two subcommands for measuring HTTP request throughput and low-level filesystem syscall performance. + +{description} + +[IMPORTANT] +==== +These commands are intended for internal performance testing and development use only. They are *not* suitable for production load testing or capacity planning. +==== + +== benchmark client + +Starts one or more parallel HTTP clients that continuously send requests to a running Infinite Scale instance and print aggregated statistics. The flags closely mimic `curl`. + +Infinite Scale must be running and reachable before using this command. + +[source,plaintext] +---- +NAME: + ocis benchmark client - Start a client that continuously makes web requests + and prints stats. The options mimic curl, but URL + must be at the end. + +USAGE: + ocis benchmark client [command options] + +OPTIONS: + --request value, -X value Specifies a custom request method (default: "PROPFIND") + --user value, -u value User name and password for server authentication + (default: "admin:admin") + --insecure, -k Skip TLS verification (default: false) + --data value, -d value Data to send in the request body + --header value, -H value Extra request header (repeatable) + --rate value Maximum request rate as "N/U" where U is s, m, h, or d + (default: unlimited) + --bearer-token-command value Command to run to obtain a bearer token, + e.g. 'oidc-token OCIS'. Disables basic auth when set. + --every value Print aggregated stats every N seconds (default: 0) + --jobs value, -j value Number of parallel clients (default: 1) + --help, -h show help +---- + +=== Example + +Send 4 parallel `PROPFIND` requests to a local instance and print stats every 10 seconds: + +[source,bash] +---- +ocis benchmark client \ + --jobs 4 \ + --every 10 \ + --user admin:admin \ + --insecure \ + https://localhost:9200/dav/files/admin +---- + +== benchmark syscalls + +Runs a series of low-level filesystem operations (xattr reads/writes, stat, mkdir, etc.) at a given path and reports timing statistics. No running Infinite Scale instance is required. + +[source,plaintext] +---- +NAME: + ocis benchmark syscalls - test the performance of syscalls + +USAGE: + ocis benchmark syscalls [command options] + +OPTIONS: + --path value Path to test + --iterations value Number of iterations to execute (default: "100") + --help, -h show help +---- + +=== Example + +Run 500 iterations against the Infinite Scale storage directory: + +[source,bash] +---- +ocis benchmark syscalls \ + --path /var/lib/ocis/storage/users \ + --iterations 500 +---- diff --git a/content/ocis/9.0/modules/developer/pages/license.adoc b/content/ocis/9.0/modules/developer/pages/license.adoc index 0648f5aa..a9e035c2 100644 --- a/content/ocis/9.0/modules/developer/pages/license.adoc +++ b/content/ocis/9.0/modules/developer/pages/license.adoc @@ -1,19 +1,8 @@ = License :toc: right :toclevels: 3 -:description: The source code of the project is licensed under the Apache 2.0 license. For the license of the used libraries you have to check the respective sources. +:description: Infinite Scale and its source code are licensed under the Apache 2.0 license. -// this generates a proper link to the actual version of the eula which can be ocis version dependent. -include::admin:partial$multi-location/compose-version.adoc[] +== License -== End-User License Agreement (EULA) - -The source code of the project is licensed under the link:https://github.com/owncloud/ocis/blob/master/LICENSE[Apache 2.0] license. For the license of the used libraries you have to check the respective sources. - -Stable, supported binary builds of ownCloud Infinite Scale that will be distributed by ownCloud GmbH are covered by a non OSS Freemium License link:https://owncloud.com/license-owncloud-infinite-scale/[EULA (web),window=_blank]. This protects additional efforts that ownCloud GmbH - Kiteworks Company is putting into these builds. - -Since the source code of Infinite Scale is available under free licenses, the free usage can, should and will not be limited in general. - -== Download the EULA as PDF - -The EULA is available for download as a PDF: link:{compose_raw_url}{compose_version}/assets/End-User-License-Agreement-for-ownCloud-Infinite-Scale.pdf[EULA (PDF),window=_blank] +Infinite Scale and its source code are licensed under the link:https://github.com/owncloud/ocis/blob/master/LICENSE[Apache 2.0] license. For the license of the used libraries, check the respective sources. diff --git a/content/ocis/9.0/modules/developer/pages/ocis/deployment/ocis_keycloak.adoc b/content/ocis/9.0/modules/developer/pages/ocis/deployment/ocis_keycloak.adoc index cd9baf1e..8d2bce78 100644 --- a/content/ocis/9.0/modules/developer/pages/ocis/deployment/ocis_keycloak.adoc +++ b/content/ocis/9.0/modules/developer/pages/ocis/deployment/ocis_keycloak.adoc @@ -3,6 +3,8 @@ :toclevels: 3 :description: Example docker-compose deployment of oCIS with Keycloak as identity provider behind Traefik. +NOTE: Since oCIS 8.1, Keycloak is also available as an optional service directly within the `ocis_full` deployment example, which is the basis of the production admin deployment guides. If you are setting up a production or home-server instance, see the xref:ocis:admin:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc#optional-keycloak-as-identity-provider[Optional: Keycloak as Identity Provider] section in the admin documentation instead. The standalone `ocis_keycloak` example documented here uses self-signed certificates and is intended for developer testing only. + == Overview * oCIS and Keycloak running behind Traefik as reverse proxy diff --git a/content/ocis/9.0/modules/developer/pages/services/s-list/gateway/gateway.adoc b/content/ocis/9.0/modules/developer/pages/services/s-list/gateway/gateway.adoc index 761c5649..c40f5421 100644 --- a/content/ocis/9.0/modules/developer/pages/services/s-list/gateway/gateway.adoc +++ b/content/ocis/9.0/modules/developer/pages/services/s-list/gateway/gateway.adoc @@ -16,6 +16,58 @@ include::partial$services/readme-link-text.adoc[] == Developer Topics +=== Configurable Service Endpoints + +The Gateway acts as a proxy for other CS3 services and resolves their addresses via the service registry on each request. Each downstream service endpoint can instead be configured with an explicit gRPC URI using the `dns://`, `kubernetes://`, or `unix:` scheme, bypassing registry lookups entirely. + +[IMPORTANT] +==== +This feature is experimental and intended for testing only. Services do not remove their socket files on shutdown; stale sockets must be cleaned up manually. +==== + +The configuration follows a triple of environment variables per service: + +[cols="2,2,3",options="header"] +|=== +| Variable +| Default +| Alternative example + +| `OCIS_GRPC_PROTOCOL` or + +`_GRPC_PROTOCOL` +| `tcp` +| `unix` + +| `_GRPC_ADDR` +| `127.0.0.1:` +| `/var/run/ocis/.sock` + +| `GATEWAY__ENDPOINT` +| `com.owncloud.api.` +| `unix:/var/run/ocis/.sock` +|=== + +Example for three services using unix sockets on a single-node deployment: + +[source,bash] +---- +USERS_GRPC_PROTOCOL=unix +USERS_GRPC_ADDR=/var/run/ocis/users.sock +GATEWAY_USERS_ENDPOINT=unix:/var/run/ocis/users.sock + +GROUPS_GRPC_PROTOCOL=unix +GROUPS_GRPC_ADDR=/var/run/ocis/groups.sock +GATEWAY_GROUPS_ENDPOINT=unix:/var/run/ocis/groups.sock + +STORAGE_USERS_GRPC_PROTOCOL=unix +STORAGE_USERS_GRPC_ADDR=/var/run/ocis/storage-users.sock +GATEWAY_STORAGE_USERS_ENDPOINT=unix:/var/run/ocis/storage-users.sock +---- + +NOTE: When configuring a unix socket for `storage-users`, also set `GRAPH_SPACES_STORAGE_USERS_ADDRESS=unix:/var/run/ocis/storage-users.sock`. The Graph service can bypass the Gateway for direct storage access and must be pointed at the socket independently. + +The full list of `GATEWAY_*_ENDPOINT` variables is available in the auto-generated environment variable reference of the xref:admin:{s-path}/gateway.adoc[Gateway admin documentation]. + === Storage Registry To add another storage provider, the CS3 storage registry that is running as part of the CS3 gateway must be made aware of it. Set `GATEWAY_STORAGE_REGISTRY_CONFIG_JSON=/path/to/storages.json` and list all storage providers in the JSON file. Replace `` with the mount UUID generated for the storage-users service; it can be found in the `config.yaml` created by `ocis init`. The last entry (`com.owncloud.api.storage-hello`) is an example for an additional storage provider running `hellofs`, a minimal example storage driver: diff --git a/content/ocis/9.0/modules/developer/pages/services/s-list/idm/admin_password_reset.adoc b/content/ocis/9.0/modules/developer/pages/services/s-list/idm/admin_password_reset.adoc index 3025c588..a8f70192 100644 --- a/content/ocis/9.0/modules/developer/pages/services/s-list/idm/admin_password_reset.adoc +++ b/content/ocis/9.0/modules/developer/pages/services/s-list/idm/admin_password_reset.adoc @@ -14,3 +14,5 @@ It will prompt for a new password and set the password of that user accordingly. ==== As this command accesses the IDM database directly, it will only work when ocis is *not* running and no other processes are accessing the database. ==== + +TIP: The `resetpassword` command supports additional options to reset passwords for regular users other than `admin` and for internal service accounts. See xref:admin:{s-path}/idm.adoc#resetting-lost-passwords[Resetting Lost Passwords] in the admin documentation. diff --git a/content/ocis/9.0/modules/developer/partials/nav.adoc b/content/ocis/9.0/modules/developer/partials/nav.adoc index d7961dc5..57b55bf0 100644 --- a/content/ocis/9.0/modules/developer/partials/nav.adoc +++ b/content/ocis/9.0/modules/developer/partials/nav.adoc @@ -141,6 +141,7 @@ *** xref:developer:cli-commands/create-new-cli-command.adoc[Create a New CLI Command] *** xref:developer:cli-commands/service_dependent_cli.adoc[Service-Dependent CLI] *** xref:developer:cli-commands/service_independent_cli.adoc[Service-Independent CLI] +*** xref:developer:cli-commands/benchmark.adoc[Benchmark] ** xref:developer:clients/index.adoc[Clients] *** xref:developer:clients/web/index.adoc[ownCloud Web] diff --git a/content/ocis/9.0/services/persistent_files/env_vars.yaml b/content/ocis/9.0/services/persistent_files/env_vars.yaml index 87b9b032..d7b588e6 100644 --- a/content/ocis/9.0/services/persistent_files/env_vars.yaml +++ b/content/ocis/9.0/services/persistent_files/env_vars.yaml @@ -193,6 +193,36 @@ ACTIVITYLOG_STORE_AUTH_USERNAME: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +ACTIVITYLOG_STORE_CREDS: + name: OCIS_NATS_CREDS;ACTIVITYLOG_STORE_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific + variable takes precedence over a global variable. In the same scope, the content + takes precedence over the path of a .creds file. When set, the service does not + use the username and the password. Exception: a service-specific username and + password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. Only applies when store type ''nats-js-kv'' + is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ACTIVITYLOG_STORE_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;ACTIVITYLOG_STORE_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the store when NATS runs in JWT (operator) mode. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. The service reads the file again on each reconnect. + Only applies when store type ''nats-js-kv'' is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" ACTIVITYLOG_STORE_DATABASE: name: ACTIVITYLOG_STORE_DATABASE defaultValue: activitylog @@ -208,7 +238,7 @@ ACTIVITYLOG_STORE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -239,7 +269,7 @@ ACTIVITYLOG_STORE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -249,7 +279,7 @@ ACTIVITYLOG_STORE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -401,6 +431,35 @@ ANTIVIRUS_EVENTS_CLUSTER: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +ANTIVIRUS_EVENTS_CREDS: + name: OCIS_NATS_CREDS;ANTIVIRUS_EVENTS_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the events broker when NATS runs in JWT (operator) mode. + A service-specific variable takes precedence over a global variable. In the same + scope, the content takes precedence over the path of a .creds file. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_EVENTS_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;ANTIVIRUS_EVENTS_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the events broker when NATS runs in JWT (operator) mode. + When set, the service does not use the username and the password. Exception: a + service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the + file again on each reconnect.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" ANTIVIRUS_EVENTS_ENABLE_TLS: name: OCIS_EVENTS_ENABLE_TLS;ANTIVIRUS_EVENTS_ENABLE_TLS defaultValue: "false" @@ -823,7 +882,7 @@ APP_PROVIDER_WOPI_DISABLE_CHAT: deprecationInfo: "" APP_PROVIDER_WOPI_FOLDER_URL_BASE_URL: name: OCIS_URL;APP_PROVIDER_WOPI_FOLDER_URL_BASE_URL - defaultValue: https://localhost:9200/ + defaultValue: https://localhost:9200 type: string description: Base url to navigate back from the app to the containing folder in the file list. @@ -1081,6 +1140,35 @@ AUDIT_EVENTS_CLUSTER: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +AUDIT_EVENTS_CREDS: + name: OCIS_NATS_CREDS;AUDIT_EVENTS_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the events broker when NATS runs in JWT (operator) mode. + A service-specific variable takes precedence over a global variable. In the same + scope, the content takes precedence over the path of a .creds file. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_EVENTS_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;AUDIT_EVENTS_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the events broker when NATS runs in JWT (operator) mode. + When set, the service does not use the username and the password. Exception: a + service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the + file again on each reconnect.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" AUDIT_EVENTS_ENABLE_TLS: name: OCIS_EVENTS_ENABLE_TLS;AUDIT_EVENTS_ENABLE_TLS defaultValue: "false" @@ -1653,7 +1741,7 @@ AUTH_BASIC_LDAP_GROUP_SCHEMA_GROUPNAME: deprecationInfo: "" AUTH_BASIC_LDAP_GROUP_SCHEMA_ID: name: OCIS_LDAP_GROUP_SCHEMA_ID;AUTH_BASIC_LDAP_GROUP_SCHEMA_ID - defaultValue: ownclouduuid + defaultValue: ownCloudUUID type: string description: LDAP Attribute to use as the unique id for groups. This should be a stable globally unique id (e.g. a UUID). @@ -1830,7 +1918,7 @@ AUTH_BASIC_LDAP_USER_OBJECTCLASS: deprecationInfo: "" AUTH_BASIC_LDAP_USER_SCHEMA_DISPLAYNAME: name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;AUTH_BASIC_LDAP_USER_SCHEMA_DISPLAYNAME - defaultValue: displayname + defaultValue: displayName type: string description: LDAP Attribute to use for the displayname of users. introductionVersion: pre5.0 @@ -1839,7 +1927,7 @@ AUTH_BASIC_LDAP_USER_SCHEMA_DISPLAYNAME: deprecationInfo: "" AUTH_BASIC_LDAP_USER_SCHEMA_ID: name: OCIS_LDAP_USER_SCHEMA_ID;AUTH_BASIC_LDAP_USER_SCHEMA_ID - defaultValue: ownclouduuid + defaultValue: ownCloudUUID type: string description: LDAP Attribute to use as the unique ID for users. This should be a stable globally unique ID like a UUID. @@ -1929,45 +2017,50 @@ AUTH_BASIC_OWNCLOUDSQL_DB_HOST: type: string description: Hostname of the database server. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: AUTH_BASIC_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql + driver is deprecated. AUTH_BASIC_OWNCLOUDSQL_DB_NAME: name: AUTH_BASIC_OWNCLOUDSQL_DB_NAME defaultValue: owncloud type: string description: Name of the owncloud database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: AUTH_BASIC_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql + driver is deprecated. AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD: name: AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD defaultValue: "" type: string description: Password for the database user. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql + driver is deprecated. AUTH_BASIC_OWNCLOUDSQL_DB_PORT: name: AUTH_BASIC_OWNCLOUDSQL_DB_PORT defaultValue: "3306" type: int description: Network port to use for the database connection. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: AUTH_BASIC_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql + driver is deprecated. AUTH_BASIC_OWNCLOUDSQL_DB_USERNAME: name: AUTH_BASIC_OWNCLOUDSQL_DB_USERNAME defaultValue: owncloud type: string description: Database user to use for authenticating with the owncloud database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: AUTH_BASIC_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql + driver is deprecated. AUTH_BASIC_OWNCLOUDSQL_IDP: name: AUTH_BASIC_OWNCLOUDSQL_IDP defaultValue: https://localhost:9200 @@ -1975,36 +2068,40 @@ AUTH_BASIC_OWNCLOUDSQL_IDP: description: The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: AUTH_BASIC_OWNCLOUDSQL_IDP is deprecated because the owncloudsql + driver is deprecated. AUTH_BASIC_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID: name: AUTH_BASIC_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID defaultValue: "false" type: bool description: Join the user properties table to read user ID's. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: AUTH_BASIC_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID is deprecated because + the owncloudsql driver is deprecated. AUTH_BASIC_OWNCLOUDSQL_JOIN_USERNAME: name: AUTH_BASIC_OWNCLOUDSQL_JOIN_USERNAME defaultValue: "false" type: bool description: Join the user properties table to read usernames introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: AUTH_BASIC_OWNCLOUDSQL_JOIN_USERNAME is deprecated because the + owncloudsql driver is deprecated. AUTH_BASIC_OWNCLOUDSQL_NOBODY: name: AUTH_BASIC_OWNCLOUDSQL_NOBODY defaultValue: "90" type: int64 description: Fallback number if no numeric UID and GID properties are provided. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: AUTH_BASIC_OWNCLOUDSQL_NOBODY is deprecated because the owncloudsql + driver is deprecated. AUTH_BASIC_SKIP_USER_GROUPS_IN_TOKEN: name: AUTH_BASIC_SKIP_USER_GROUPS_IN_TOKEN defaultValue: "false" @@ -2639,6 +2736,35 @@ CLIENTLOG_EVENTS_CLUSTER: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +CLIENTLOG_EVENTS_CREDS: + name: OCIS_NATS_CREDS;CLIENTLOG_EVENTS_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the events broker when NATS runs in JWT (operator) mode. + A service-specific variable takes precedence over a global variable. In the same + scope, the content takes precedence over the path of a .creds file. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_EVENTS_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;CLIENTLOG_EVENTS_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the events broker when NATS runs in JWT (operator) mode. + When set, the service does not use the username and the password. Exception: a + service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the + file again on each reconnect.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" CLIENTLOG_EVENTS_ENABLE_TLS: name: OCIS_EVENTS_ENABLE_TLS;CLIENTLOG_EVENTS_ENABLE_TLS defaultValue: "false" @@ -3029,6 +3155,36 @@ COLLABORATION_STORE_AUTH_USERNAME: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +COLLABORATION_STORE_CREDS: + name: OCIS_NATS_CREDS;COLLABORATION_STORE_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific + variable takes precedence over a global variable. In the same scope, the content + takes precedence over the path of a .creds file. When set, the service does not + use the username and the password. Exception: a service-specific username and + password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. Only applies when store type ''nats-js-kv'' + is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +COLLABORATION_STORE_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;COLLABORATION_STORE_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the store when NATS runs in JWT (operator) mode. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. The service reads the file again on each reconnect. + Only applies when store type ''nats-js-kv'' is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" COLLABORATION_STORE_DATABASE: name: COLLABORATION_STORE_DATABASE defaultValue: collaboration @@ -3044,7 +3200,7 @@ COLLABORATION_STORE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3075,7 +3231,7 @@ COLLABORATION_STORE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3085,7 +3241,7 @@ COLLABORATION_STORE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3292,6 +3448,35 @@ EVENTHISTORY_EVENTS_CLUSTER: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +EVENTHISTORY_EVENTS_CREDS: + name: OCIS_NATS_CREDS;EVENTHISTORY_EVENTS_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the events broker when NATS runs in JWT (operator) mode. + A service-specific variable takes precedence over a global variable. In the same + scope, the content takes precedence over the path of a .creds file. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_EVENTS_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;EVENTHISTORY_EVENTS_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the events broker when NATS runs in JWT (operator) mode. + When set, the service does not use the username and the password. Exception: a + service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the + file again on each reconnect.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" EVENTHISTORY_EVENTS_ENABLE_TLS: name: OCIS_EVENTS_ENABLE_TLS;EVENTHISTORY_EVENTS_ENABLE_TLS defaultValue: "false" @@ -3407,6 +3592,36 @@ EVENTHISTORY_STORE_AUTH_USERNAME: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +EVENTHISTORY_STORE_CREDS: + name: OCIS_NATS_CREDS;EVENTHISTORY_STORE_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific + variable takes precedence over a global variable. In the same scope, the content + takes precedence over the path of a .creds file. When set, the service does not + use the username and the password. Exception: a service-specific username and + password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. Only applies when store type ''nats-js-kv'' + is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_STORE_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;EVENTHISTORY_STORE_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the store when NATS runs in JWT (operator) mode. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. The service reads the file again on each reconnect. + Only applies when store type ''nats-js-kv'' is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" EVENTHISTORY_STORE_DATABASE: name: EVENTHISTORY_STORE_DATABASE defaultValue: eventhistory @@ -3422,7 +3637,7 @@ EVENTHISTORY_STORE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3452,8 +3667,10 @@ EVENTHISTORY_STORE_TLS_INSECURE: defaultValue: "false" type: bool description: Disable TLS certificate verification for the store connection. Only - applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + applies when store type 'nats-js-kv' is configured. Do not enable this in production + because it disables authentication of the NATS server. Use it only for testing + with self-signed certificates. + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3463,7 +3680,7 @@ EVENTHISTORY_STORE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3717,6 +3934,18 @@ FRONTEND_DEFAULT_UPLOAD_PROTOCOL: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +FRONTEND_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS: + name: OCIS_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS;FRONTEND_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS + defaultValue: "30" + type: int + description: The default expiration, in days, applied to a vault user or group share + created without an explicit expiration date. Reported via the vault capability + so clients can reflect the admin-configured value. Must match the graph service's + GRAPH_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" FRONTEND_DISABLE_SSE: name: OCIS_DISABLE_SSE;FRONTEND_DISABLE_SSE defaultValue: "false" @@ -3807,6 +4036,35 @@ FRONTEND_EVENTS_CLUSTER: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +FRONTEND_EVENTS_CREDS: + name: OCIS_NATS_CREDS;FRONTEND_EVENTS_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the events broker when NATS runs in JWT (operator) mode. + A service-specific variable takes precedence over a global variable. In the same + scope, the content takes precedence over the path of a .creds file. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_EVENTS_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;FRONTEND_EVENTS_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the events broker when NATS runs in JWT (operator) mode. + When set, the service does not use the username and the password. Exception: a + service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the + file again on each reconnect.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" FRONTEND_EVENTS_ENABLE_TLS: name: OCIS_EVENTS_ENABLE_TLS;FRONTEND_EVENTS_ENABLE_TLS defaultValue: "false" @@ -4416,6 +4674,47 @@ GATEWAY_PROVIDER_CACHE_AUTH_USERNAME: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +GATEWAY_PROVIDER_CACHE_CREDS: + name: OCIS_NATS_CREDS;GATEWAY_PROVIDER_CACHE_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific + variable takes precedence over a global variable. In the same scope, the content + takes precedence over the path of a .creds file. When set, the service does not + use the username and the password. Exception: a service-specific username and + password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. Only applies when store type ''nats-js-kv'' + is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_PROVIDER_CACHE_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;GATEWAY_PROVIDER_CACHE_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the cache when NATS runs in JWT (operator) mode. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. The service reads the file again on each reconnect. + Only applies when store type ''nats-js-kv'' is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_PROVIDER_CACHE_DATABASE: + name: OCIS_CACHE_DATABASE;GATEWAY_PROVIDER_CACHE_DATABASE + defaultValue: cache-providers + type: string + description: The database name the configured store should use. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: The global variable OCIS_CACHE_DATABASE is deprecated and will + be removed in a future release. Please use local variable GATEWAY_PROVIDER_CACHE_DATABASE + instead. GATEWAY_PROVIDER_CACHE_DISABLE_PERSISTENCE: name: OCIS_CACHE_DISABLE_PERSISTENCE;GATEWAY_PROVIDER_CACHE_DISABLE_PERSISTENCE defaultValue: "false" @@ -4432,7 +4731,7 @@ GATEWAY_PROVIDER_CACHE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4463,8 +4762,10 @@ GATEWAY_PROVIDER_CACHE_TLS_INSECURE: defaultValue: "false" type: bool description: Disable TLS certificate verification for the cache store connection. - Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + Only applies when store type 'nats-js-kv' is configured. Do not enable this in + production because it disables authentication of the NATS server. Use it only + for testing with self-signed certificates. + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4474,7 +4775,7 @@ GATEWAY_PROVIDER_CACHE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4717,6 +5018,36 @@ GRAPH_CACHE_AUTH_USERNAME: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +GRAPH_CACHE_CREDS: + name: OCIS_NATS_CREDS;GRAPH_CACHE_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific + variable takes precedence over a global variable. In the same scope, the content + takes precedence over the path of a .creds file. When set, the service does not + use the username and the password. Exception: a service-specific username and + password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. Only applies when store type ''nats-js-kv'' + is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_CACHE_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;GRAPH_CACHE_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the cache when NATS runs in JWT (operator) mode. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. The service reads the file again on each reconnect. + Only applies when store type ''nats-js-kv'' is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" GRAPH_CACHE_DISABLE_PERSISTENCE: name: OCIS_CACHE_DISABLE_PERSISTENCE;GRAPH_CACHE_DISABLE_PERSISTENCE defaultValue: "false" @@ -4733,7 +5064,7 @@ GRAPH_CACHE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4783,7 +5114,7 @@ GRAPH_CACHE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4793,7 +5124,7 @@ GRAPH_CACHE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4889,6 +5220,16 @@ GRAPH_DEBUG_ZPAGES: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +GRAPH_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS: + name: OCIS_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS;GRAPH_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS + defaultValue: "30" + type: int + description: The default expiration, in days, applied to a vault user or group share + created without an explicit expiration date. Space memberships are exempt. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" GRAPH_DISABLED_USERS_GROUP_DN: name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;GRAPH_DISABLED_USERS_GROUP_DN defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm @@ -4953,6 +5294,35 @@ GRAPH_EVENTS_CLUSTER: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +GRAPH_EVENTS_CREDS: + name: OCIS_NATS_CREDS;GRAPH_EVENTS_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the events broker when NATS runs in JWT (operator) mode. + A service-specific variable takes precedence over a global variable. In the same + scope, the content takes precedence over the path of a .creds file. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_EVENTS_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;GRAPH_EVENTS_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the events broker when NATS runs in JWT (operator) mode. + When set, the service does not use the username and the password. Exception: a + service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the + file again on each reconnect.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" GRAPH_EVENTS_ENABLE_TLS: name: OCIS_EVENTS_ENABLE_TLS;GRAPH_EVENTS_ENABLE_TLS defaultValue: "false" @@ -5215,7 +5585,7 @@ GRAPH_LDAP_GROUP_FILTER: deprecationInfo: "" GRAPH_LDAP_GROUP_ID_ATTRIBUTE: name: OCIS_LDAP_GROUP_SCHEMA_ID;GRAPH_LDAP_GROUP_ID_ATTRIBUTE - defaultValue: owncloudUUID + defaultValue: ownCloudUUID type: string description: LDAP Attribute to use as the unique id for groups. This should be a stable globally unique ID like a UUID. @@ -5494,6 +5864,17 @@ GRAPH_LDAP_URI: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +GRAPH_LDAP_USER_ADDITIONAL_OBJECTCLASSES: + name: OCIS_LDAP_USER_ADDITIONAL_OBJECTCLASSES;GRAPH_LDAP_USER_ADDITIONAL_OBJECTCLASSES + defaultValue: '[]' + type: '[]string' + description: Additional object classes to set when creating new users (e.g. to allow + a custom surname attribute). The default classes 'inetOrgPerson', 'organizationalPerson', + 'person', 'top' and 'ownCloudUser' are always included. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" GRAPH_LDAP_USER_BASE_DN: name: OCIS_LDAP_USER_BASE_DN;GRAPH_LDAP_USER_BASE_DN defaultValue: ou=users,o=libregraph-idm @@ -5570,6 +5951,28 @@ GRAPH_LDAP_USER_SCOPE: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +GRAPH_LDAP_USER_SEARCH_ATTRIBUTES: + name: GRAPH_LDAP_USER_SEARCH_ATTRIBUTES + defaultValue: '[onPremisesSamAccountName displayName mail]' + type: '[]string' + description: The user attributes to match against when searching for users via the + Graph API. Does not affect the legacy OCS sharees search, which always matches + on username, display name, and mail. Accepts the logical names 'onPremisesSamAccountName', + 'displayName', 'surname', 'mail' (case-insensitive), or any other LDAP attribute + name directly. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_USER_SURNAME_ATTRIBUTE: + name: OCIS_LDAP_USER_SCHEMA_SURNAME;GRAPH_LDAP_USER_SURNAME_ATTRIBUTE + defaultValue: sn + type: string + description: LDAP Attribute to use for the surname of users. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" GRAPH_LDAP_USER_TYPE_ATTRIBUTE: name: OCIS_LDAP_USER_SCHEMA_USER_TYPE;GRAPH_LDAP_USER_TYPE_ATTRIBUTE defaultValue: ownCloudUserType @@ -5582,7 +5985,7 @@ GRAPH_LDAP_USER_TYPE_ATTRIBUTE: deprecationInfo: "" GRAPH_LDAP_USER_UID_ATTRIBUTE: name: OCIS_LDAP_USER_SCHEMA_ID;GRAPH_LDAP_USER_UID_ATTRIBUTE - defaultValue: owncloudUUID + defaultValue: ownCloudUUID type: string description: LDAP Attribute to use as the unique ID for users. This should be a stable globally unique ID like a UUID. @@ -5645,7 +6048,7 @@ GRAPH_MAX_IMAGE_FILE_SIZE: thumbnails service, otherwise images between the two values are accepted but cannot be rendered. Usable common abbreviations: [KB, KiB, MB, MiB, GB, GiB, TB, TiB, PB, PiB, EB, EiB], example: 2GB. Set to 0 to not limit the file size.' - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5868,8 +6271,8 @@ GROUPS_DRIVER: name: GROUPS_DRIVER defaultValue: ldap type: string - description: The driver which should be used by the groups service. Supported values - are 'ldap' and 'owncloudsql'. + description: The driver which should be used by the groups service. Supported value + is 'ldap'. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -5990,7 +6393,7 @@ GROUPS_LDAP_GROUP_SCHEMA_GROUPNAME: deprecationInfo: "" GROUPS_LDAP_GROUP_SCHEMA_ID: name: OCIS_LDAP_GROUP_SCHEMA_ID;GROUPS_LDAP_GROUP_SCHEMA_ID - defaultValue: ownclouduuid + defaultValue: ownCloudUUID type: string description: LDAP Attribute to use as the unique id for groups. This should be a stable globally unique ID like a UUID. @@ -6160,7 +6563,7 @@ GROUPS_LDAP_USER_OBJECTCLASS: deprecationInfo: "" GROUPS_LDAP_USER_SCHEMA_DISPLAYNAME: name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;GROUPS_LDAP_USER_SCHEMA_DISPLAYNAME - defaultValue: displayname + defaultValue: displayName type: string description: LDAP Attribute to use for the displayname of users. introductionVersion: pre5.0 @@ -6169,7 +6572,7 @@ GROUPS_LDAP_USER_SCHEMA_DISPLAYNAME: deprecationInfo: "" GROUPS_LDAP_USER_SCHEMA_ID: name: OCIS_LDAP_USER_SCHEMA_ID;GROUPS_LDAP_USER_SCHEMA_ID - defaultValue: ownclouduuid + defaultValue: ownCloudUUID type: string description: LDAP Attribute to use as the unique id for users. This should be a stable globally unique id like a UUID. @@ -6259,45 +6662,50 @@ GROUPS_OWNCLOUDSQL_DB_HOST: type: string description: Hostname of the database server. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql + driver is deprecated. GROUPS_OWNCLOUDSQL_DB_NAME: name: GROUPS_OWNCLOUDSQL_DB_NAME defaultValue: owncloud type: string description: Name of the owncloud database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql + driver is deprecated. GROUPS_OWNCLOUDSQL_DB_PASSWORD: name: GROUPS_OWNCLOUDSQL_DB_PASSWORD defaultValue: "" type: string description: Password for the database user. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql + driver is deprecated. GROUPS_OWNCLOUDSQL_DB_PORT: name: GROUPS_OWNCLOUDSQL_DB_PORT defaultValue: "3306" type: int description: Network port to use for the database connection. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql + driver is deprecated. GROUPS_OWNCLOUDSQL_DB_USERNAME: name: GROUPS_OWNCLOUDSQL_DB_USERNAME defaultValue: owncloud type: string description: Database user to use for authenticating with the owncloud database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql + driver is deprecated. GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH: name: GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH defaultValue: "false" @@ -6305,9 +6713,10 @@ GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH: description: Allow 'medial search' when searching for users instead of just doing a prefix search. This allows finding 'Alice' when searching for 'lic'. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH is deprecated because the + owncloudsql driver is deprecated. GROUPS_OWNCLOUDSQL_IDP: name: GROUPS_OWNCLOUDSQL_IDP defaultValue: https://localhost:9200 @@ -6315,36 +6724,40 @@ GROUPS_OWNCLOUDSQL_IDP: description: The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_IDP is deprecated because the owncloudsql driver + is deprecated. GROUPS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID: name: GROUPS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID defaultValue: "false" type: bool description: Join the user properties table to read user IDs. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID is deprecated because the + owncloudsql driver is deprecated. GROUPS_OWNCLOUDSQL_JOIN_USERNAME: name: GROUPS_OWNCLOUDSQL_JOIN_USERNAME defaultValue: "false" type: bool description: Join the user properties table to read usernames. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_JOIN_USERNAME is deprecated because the owncloudsql + driver is deprecated. GROUPS_OWNCLOUDSQL_NOBODY: name: GROUPS_OWNCLOUDSQL_NOBODY defaultValue: "90" type: int64 description: Fallback number if no numeric UID and GID properties are provided. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: GROUPS_OWNCLOUDSQL_NOBODY is deprecated because the owncloudsql + driver is deprecated. GROUPS_SKIP_USER_GROUPS_IN_TOKEN: name: GROUPS_SKIP_USER_GROUPS_IN_TOKEN defaultValue: "false" @@ -6393,6 +6806,31 @@ GROUPS_TRACING_TYPE: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +GRPC_CLIENT_KEEPALIVE_TIME: + name: GRPC_CLIENT_KEEPALIVE_TIME + defaultValue: 0s + type: Duration + description: How long a grpc client connection with an ongoing request may stay + silent before the server is pinged to check whether it is still answering. Set + a duration like '20s' to enable detection of unresponsive peers. Leaving it unset, + or at '0', sends no pings at all, which is grpc's own default. Values below '10s' + are raised to '10s' by grpc. Make sure to include the unit suffix, a bare number + is not a valid duration. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRPC_CLIENT_KEEPALIVE_TIMEOUT: + name: GRPC_CLIENT_KEEPALIVE_TIMEOUT + defaultValue: 0s + type: Duration + description: How long a grpc client waits for the answer to a keepalive ping before + it considers the connection dead and fails all requests on it. Defaults to '10s'. + Has no effect unless GRPC_CLIENT_KEEPALIVE_TIME is set. See GRPC_CLIENT_KEEPALIVE_TIME. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" IDM_ADMIN_PASSWORD: name: IDM_ADMIN_PASSWORD defaultValue: "" @@ -6415,10 +6853,10 @@ IDM_ADMIN_USER_ID: removalVersion: "" deprecationInfo: "" IDM_CREATE_DEMO_USERS: - name: IDM_CREATE_DEMO_USERS + name: SETTINGS_SETUP_DEFAULT_ASSIGNMENTS;IDM_CREATE_DEMO_USERS defaultValue: "false" type: bool - description: Flag to enable or disable the creation of the demo users. + description: The default role assignments the demo users should be setup. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -7260,7 +7698,7 @@ INVITATIONS_KEYCLOAK_EXECUTE_ACTIONS: guests via the execute-actions email. Values are passed to Keycloak as-is. Defaults to 'UPDATE_PASSWORD,VERIFY_EMAIL'. See the Environment Variable Types description for more details. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7659,6 +8097,35 @@ NOTIFICATIONS_EVENTS_CLUSTER: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +NOTIFICATIONS_EVENTS_CREDS: + name: OCIS_NATS_CREDS;NOTIFICATIONS_EVENTS_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the events broker when NATS runs in JWT (operator) mode. + A service-specific variable takes precedence over a global variable. In the same + scope, the content takes precedence over the path of a .creds file. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_EVENTS_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;NOTIFICATIONS_EVENTS_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the events broker when NATS runs in JWT (operator) mode. + When set, the service does not use the username and the password. Exception: a + service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the + file again on each reconnect.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" NOTIFICATIONS_EVENTS_ENABLE_TLS: name: OCIS_EVENTS_ENABLE_TLS;NOTIFICATIONS_EVENTS_ENABLE_TLS defaultValue: "false" @@ -7859,6 +8326,36 @@ NOTIFICATIONS_STORE_AUTH_USERNAME: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +NOTIFICATIONS_STORE_CREDS: + name: OCIS_NATS_CREDS;NOTIFICATIONS_STORE_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific + variable takes precedence over a global variable. In the same scope, the content + takes precedence over the path of a .creds file. When set, the service does not + use the username and the password. Exception: a service-specific username and + password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. Only applies when store type ''nats-js-kv'' + is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_STORE_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;NOTIFICATIONS_STORE_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the store when NATS runs in JWT (operator) mode. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. The service reads the file again on each reconnect. + Only applies when store type ''nats-js-kv'' is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" NOTIFICATIONS_STORE_DATABASE: name: NOTIFICATIONS_STORE_DATABASE defaultValue: notifications @@ -7874,7 +8371,7 @@ NOTIFICATIONS_STORE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7904,8 +8401,10 @@ NOTIFICATIONS_STORE_TLS_INSECURE: defaultValue: "false" type: bool description: Disable TLS certificate verification for the store connection. Only - applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + applies when store type 'nats-js-kv' is configured. Do not enable this in production + because it disables authentication of the NATS server. Use it only for testing + with self-signed certificates. + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7915,7 +8414,7 @@ NOTIFICATIONS_STORE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8084,6 +8583,17 @@ OCDAV_DEBUG_ZPAGES: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +OCDAV_DISABLE_PROPFIND_PUBLIC_LINK_RESOLUTION: + name: OCDAV_DISABLE_PROPFIND_PUBLIC_LINK_RESOLUTION + defaultValue: "false" + type: bool + description: Disable the resolution of public link shares when answering PROPFIND + requests. When disabled, the oc:share-type property will not be populated with + public link share information, which can reduce load on services for large collections. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" OCDAV_EDITION: name: OCIS_EDITION;OCDAV_EDITION defaultValue: Community @@ -8358,7 +8868,7 @@ OCIS_CACHE_AUTH_USERNAME: deprecationInfo: The use of OCIS_CACHE_AUTH_USERNAME in the frontend service is deprecated because the OCS API is deprecated OCS API is deprecated OCIS_CACHE_DATABASE: - name: OCIS_CACHE_DATABASE + name: OCIS_CACHE_DATABASE;GATEWAY_PROVIDER_CACHE_DATABASE;PROXY_OIDC_USERINFO_CACHE_DATABASE;SETTINGS_CACHE_DATABASE;STORAGE_SYSTEM_CACHE_DATABASE;STORAGE_USERS_FILEMETADATA_CACHE_DATABASE;STORAGE_USERS_ID_CACHE_DATABASE defaultValue: cache-stat | cache-userinfo | storage-system | cache-providers | settings-cache | storage-users | ids-storage-users type: string @@ -8367,7 +8877,19 @@ OCIS_CACHE_DATABASE: deprecationVersion: 7.0.0 removalVersion: '%%NEXT_PRODUCTION_VERSION%%' deprecationInfo: The use of OCIS_CACHE_DATABASE in the frontend service is deprecated - because the OCS API is deprecated + because the OCS API is deprecated | The global variable OCIS_CACHE_DATABASE is + deprecated and will be removed in a future release. Please use local variable + SETTINGS_CACHE_DATABASE instead. | The global variable OCIS_CACHE_DATABASE is + deprecated and will be removed in a future release. Please use local variable + STORAGE_SYSTEM_CACHE_DATABASE instead. | The global variable OCIS_CACHE_DATABASE + is deprecated and will be removed in a future release. Please use local variable + STORAGE_USERS_FILEMETADATA_CACHE_DATABASE instead. | The global variable OCIS_CACHE_DATABASE + is deprecated and will be removed in a future release. Please use local variable + STORAGE_USERS_ID_CACHE_DATABASE instead. | The global variable OCIS_CACHE_DATABASE + is deprecated and will be removed in a future release. Please use local variable + GATEWAY_PROVIDER_CACHE_DATABASE instead. | The global variable OCIS_CACHE_DATABASE + is deprecated and will be removed in a future release. Please use local variable + PROXY_OIDC_USERINFO_CACHE_DATABASE instead. OCIS_CACHE_DISABLE_PERSISTENCE: name: OCIS_CACHE_DISABLE_PERSISTENCE;GATEWAY_PROVIDER_CACHE_DISABLE_PERSISTENCE;GRAPH_CACHE_DISABLE_PERSISTENCE;PROXY_OIDC_USERINFO_CACHE_DISABLE_PERSISTENCE;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_DISABLE_PERSISTENCE;SETTINGS_CACHE_DISABLE_PERSISTENCE;STORAGE_SYSTEM_CACHE_DISABLE_PERSISTENCE;STORAGE_USERS_FILEMETADATA_CACHE_DISABLE_PERSISTENCE;STORAGE_USERS_ID_CACHE_DISABLE_PERSISTENCE defaultValue: false | true @@ -8389,7 +8911,9 @@ OCIS_CACHE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. | Activate TLS for the connection to the - signing key store. Only applies when store type 'nats-js-kv' is configured. + signing key store. Only applies when store type 'nats-js-kv' is configured. | + Activate TLS for the connection to the stat cache store. Only applies when using + the 'nats-js-kv' store type. introductionVersion: 8.3.0 deprecationVersion: "" removalVersion: "" @@ -8433,7 +8957,17 @@ OCIS_CACHE_TLS_INSECURE: description: Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. | Disable TLS certificate verification for the signing key store connection. Only applies when store type - 'nats-js-kv' is configured. + 'nats-js-kv' is configured. | Disable TLS certificate verification for the cache + store connection. Only applies when store type 'nats-js-kv' is configured. Do + not enable this in production because it disables authentication of the NATS server. + Use it only for testing with self-signed certificates. | Disable TLS certificate + verification for the signing key store connection. Only applies when store type + 'nats-js-kv' is configured. Do not enable this in production because it disables + authentication of the NATS server. Use it only for testing with self-signed certificates. + | Disable TLS certificate verification for the stat cache store connection. Only + applies when using the 'nats-js-kv' store type. Do not enable this in production + because it disables authentication of the NATS server. Use it only for testing + with self-signed certificates. introductionVersion: 8.3.0 deprecationVersion: "" removalVersion: "" @@ -8445,7 +8979,9 @@ OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE: description: Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. | Path to the PEM-encoded root CA certificate for the signing key store TLS connection. - Only applies when store type 'nats-js-kv' is configured. + Only applies when store type 'nats-js-kv' is configured. | Path to the PEM-encoded + root CA certificate for the stat cache store TLS connection. Only applies when + using the 'nats-js-kv' store type. introductionVersion: 8.3.0 deprecationVersion: "" removalVersion: "" @@ -8616,6 +9152,19 @@ OCIS_DEFAULT_LANGUAGE: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +OCIS_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS: + name: OCIS_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS;FRONTEND_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS;GRAPH_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS + defaultValue: "30" + type: int + description: The default expiration, in days, applied to a vault user or group share + created without an explicit expiration date. Space memberships are exempt. | The + default expiration, in days, applied to a vault user or group share created without + an explicit expiration date. Reported via the vault capability so clients can + reflect the admin-configured value. Must match the graph service's GRAPH_DEFAULT_VAULT_SHARE_EXPIRATION_DAYS. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" OCIS_DISABLE_PREVIEWS: name: OCIS_DISABLE_PREVIEWS;WEBDAV_DISABLE_PREVIEWS defaultValue: "false" @@ -8856,6 +9405,18 @@ OCIS_GRPC_CLIENT_TLS_MODE: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +OCIS_GRPC_MAX_RECEIVED_MESSAGE_SIZE: + name: OCIS_GRPC_MAX_RECEIVED_MESSAGE_SIZE + defaultValue: "0" + type: int + description: The maximum body size for grpc requests. Defaults to '10240000' bytes + (10MB). Note that large values can potentially hide errors but may lead to network + timeouts. Should only be changed temporarily to regain access for large folders + with 25.000+ files to copy out data. + introductionVersion: pre5.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" OCIS_GRPC_PROTOCOL: name: OCIS_GRPC_PROTOCOL;APP_PROVIDER_GRPC_PROTOCOL;APP_REGISTRY_GRPC_PROTOCOL;AUTH_APP_GRPC_PROTOCOL;AUTH_BASIC_GRPC_PROTOCOL;AUTH_BEARER_GRPC_PROTOCOL;AUTH_MACHINE_GRPC_PROTOCOL;AUTH_SERVICE_GRPC_PROTOCOL;COLLABORATION_GRPC_PROTOCOL;GATEWAY_GRPC_PROTOCOL;GROUPS_GRPC_PROTOCOL;OCM_GRPC_PROTOCOL;SHARING_GRPC_PROTOCOL;STORAGE_PUBLICLINK_GRPC_PROTOCOL;STORAGE_SHARES_GRPC_PROTOCOL;STORAGE_SYSTEM_GRPC_PROTOCOL;STORAGE_USERS_GRPC_PROTOCOL;USERS_GRPC_PROTOCOL defaultValue: tcp @@ -9121,7 +9682,7 @@ OCIS_LDAP_GROUP_SCHEMA_GROUPNAME: deprecationInfo: "" OCIS_LDAP_GROUP_SCHEMA_ID: name: OCIS_LDAP_GROUP_SCHEMA_ID;AUTH_BASIC_LDAP_GROUP_SCHEMA_ID;GRAPH_LDAP_GROUP_ID_ATTRIBUTE;GROUPS_LDAP_GROUP_SCHEMA_ID;USERS_LDAP_GROUP_SCHEMA_ID - defaultValue: owncloudUUID | ownclouduuid + defaultValue: owncloudUUID | ownclouduuid | ownCloudUUID type: string description: LDAP Attribute to use as the unique id for groups. This should be a stable globally unique ID like a UUID. | LDAP Attribute to use as the unique ID @@ -9354,6 +9915,17 @@ OCIS_LDAP_URI: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +OCIS_LDAP_USER_ADDITIONAL_OBJECTCLASSES: + name: OCIS_LDAP_USER_ADDITIONAL_OBJECTCLASSES;GRAPH_LDAP_USER_ADDITIONAL_OBJECTCLASSES + defaultValue: '[]' + type: '[]string' + description: Additional object classes to set when creating new users (e.g. to allow + a custom surname attribute). The default classes 'inetOrgPerson', 'organizationalPerson', + 'person', 'top' and 'ownCloudUser' are always included. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" OCIS_LDAP_USER_BASE_DN: name: OCIS_LDAP_USER_BASE_DN;AUTH_BASIC_LDAP_USER_BASE_DN;GRAPH_LDAP_USER_BASE_DN;GROUPS_LDAP_USER_BASE_DN;IDP_LDAP_BASE_DN;USERS_LDAP_USER_BASE_DN defaultValue: ou=users,o=libregraph-idm @@ -9474,6 +10046,15 @@ OCIS_LDAP_USER_SCHEMA_MAIL: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +OCIS_LDAP_USER_SCHEMA_SURNAME: + name: OCIS_LDAP_USER_SCHEMA_SURNAME;GRAPH_LDAP_USER_SURNAME_ATTRIBUTE + defaultValue: sn + type: string + description: LDAP Attribute to use for the surname of users. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" OCIS_LDAP_USER_SCHEMA_USERNAME: name: OCIS_LDAP_USER_SCHEMA_USERNAME;AUTH_BASIC_LDAP_USER_SCHEMA_USERNAME;GRAPH_LDAP_USER_NAME_ATTRIBUTE;GROUPS_LDAP_USER_SCHEMA_USERNAME;IDP_LDAP_NAME_ATTRIBUTE;USERS_LDAP_USER_SCHEMA_USERNAME defaultValue: displayName | uid @@ -9643,6 +10224,24 @@ OCIS_MULTI_INSTANCE_GUEST_ROLE: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +OCIS_MULTI_INSTANCE_GUEST_ROLE_MAPPING: + name: OCIS_MULTI_INSTANCE_GUEST_ROLE_MAPPING + defaultValue: '[]' + type: '[]string' + description: '(Optional) The guest role mapping of the proxy service. The graph + service matches it against the LDAP attribute ''userClass'' of guests without + a role on this instance, so they can receive vault shares before their first login + here. ''userClass'' must hold the same values as the PROXY_ROLE_ASSIGNMENT_OIDC_CLAIM + claim. | (Optional) Mapping of PROXY_ROLE_ASSIGNMENT_OIDC_CLAIM values to the + role a guest gets instead of OCIS_MULTI_INSTANCE_GUEST_ROLE. Example: ''spaceadmin:user-light-vault''. + A claim value is an exact string or a regular expression that must match the full + claim value, the same as the claim_value of the role mapping. Escape regex metacharacters + such as ''.'' in an exact string. The first match wins. Role names must not contain + a colon. Only applies to the ''oidc'' role assignment driver.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" OCIS_MULTI_INSTANCE_INSTANCEID: name: OCIS_MULTI_INSTANCE_INSTANCEID defaultValue: "" @@ -9659,7 +10258,17 @@ OCIS_MULTI_INSTANCE_MASTER_ID: description: The master ID that grants access to all instances. Users with this ID in their memberOf or guestOf claims can access any instance. Leave empty to disable. | The master instance ID for multi-instance setups. When set, LDAP user - filters are enhanced to also match users belonging to the master instance. + filters are enhanced to also match users belonging to the master instance. | The + master ID that grants access to all instances. Users with this ID in their memberOf + or guestOf claims can access any instance. Leave empty to disable. Also set 'OCIS_LDAP_USER_FILTER'. + Without an explicit user filter, this instance resolves every user in the shared + LDAP directory. | The master instance ID for multi-instance setups. When set, + LDAP user filters are enhanced to also match users belonging to the master instance. + Also set 'user_filter'. Without an explicit 'user_filter', this instance resolves + every user in the shared LDAP directory. | The master instance ID for multi-instance + setups. When set, LDAP user filters are enhanced to also match users belonging + to the master instance. Also set 'user_filter'. Without an explicit 'user_filter', + this instance allows login for every user in the shared LDAP directory. introductionVersion: "7.0" deprecationVersion: "" removalVersion: "" @@ -9683,6 +10292,77 @@ OCIS_MULTI_INSTANCE_QUERY_TEMPLATE: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +OCIS_NATS_CREDS: + name: OCIS_NATS_CREDS;ACTIVITYLOG_STORE_CREDS;ANTIVIRUS_EVENTS_CREDS;AUDIT_EVENTS_CREDS;CLIENTLOG_EVENTS_CREDS;COLLABORATION_STORE_CREDS;EVENTHISTORY_EVENTS_CREDS;EVENTHISTORY_STORE_CREDS;FRONTEND_EVENTS_CREDS;GATEWAY_PROVIDER_CACHE_CREDS;GRAPH_CACHE_CREDS;GRAPH_EVENTS_CREDS;NOTIFICATIONS_EVENTS_CREDS;NOTIFICATIONS_STORE_CREDS;OCM_EVENTS_CREDS;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS;POLICIES_EVENTS_CREDS;POSTPROCESSING_EVENTS_CREDS;POSTPROCESSING_STORE_CREDS;PROXY_EVENTS_CREDS;PROXY_OIDC_USERINFO_CACHE_CREDS;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS;SEARCH_EVENTS_CREDS;SETTINGS_CACHE_CREDS;SHARING_EVENTS_CREDS;SSE_EVENTS_CREDS;STORAGE_PUBLICLINK_STORE_CREDS;STORAGE_SYSTEM_CACHE_CREDS;STORAGE_USERS_EVENTS_CREDS;STORAGE_USERS_FILEMETADATA_CACHE_CREDS;STORAGE_USERS_ID_CACHE_CREDS;USERLOG_EVENTS_CREDS;USERLOG_STORE_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the events broker when NATS runs in JWT (operator) mode. + A service-specific variable takes precedence over a global variable. In the same + scope, the content takes precedence over the path of a .creds file. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. | Content of a NATS .creds file with a user + JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in + JWT (operator) mode. A service-specific variable takes precedence over a global + variable. In the same scope, the content takes precedence over the path of a .creds + file. When set, the service does not use the username and the password. Exception: + a service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store + type ''nats-js-kv'' is configured. | Content of a NATS .creds file with a user + JWT and an NKey seed. Use it to authenticate with the store when NATS runs in + JWT (operator) mode. A service-specific variable takes precedence over a global + variable. In the same scope, the content takes precedence over the path of a .creds + file. When set, the service does not use the username and the password. Exception: + a service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. Only applies when store + type ''nats-js-kv'' is configured. | Content of a NATS .creds file with a user + JWT and an NKey seed. Use it to authenticate with the cache when NATS runs in + JWT (operator) mode. A service-specific variable takes precedence over a global + variable. In the same scope, the content takes precedence over the path of a .creds + file. When set, the service does not use the username and the password. Only applies + when store type ''nats-js-kv'' is configured. | Content of a NATS .creds file + with a user JWT and an NKey seed. Use it to authenticate with the events broker + when NATS runs in JWT (operator) mode. A service-specific variable takes precedence + over a global variable. In the same scope, the content takes precedence over the + path of a .creds file. When set, the service does not use the username and the + password.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_NATS_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;ACTIVITYLOG_STORE_CREDS_FILE;ANTIVIRUS_EVENTS_CREDS_FILE;AUDIT_EVENTS_CREDS_FILE;CLIENTLOG_EVENTS_CREDS_FILE;COLLABORATION_STORE_CREDS_FILE;EVENTHISTORY_EVENTS_CREDS_FILE;EVENTHISTORY_STORE_CREDS_FILE;FRONTEND_EVENTS_CREDS_FILE;GATEWAY_PROVIDER_CACHE_CREDS_FILE;GRAPH_CACHE_CREDS_FILE;GRAPH_EVENTS_CREDS_FILE;NOTIFICATIONS_EVENTS_CREDS_FILE;NOTIFICATIONS_STORE_CREDS_FILE;OCM_EVENTS_CREDS_FILE;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS_FILE;POLICIES_EVENTS_CREDS_FILE;POSTPROCESSING_EVENTS_CREDS_FILE;POSTPROCESSING_STORE_CREDS_FILE;PROXY_EVENTS_CREDS_FILE;PROXY_OIDC_USERINFO_CACHE_CREDS_FILE;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS_FILE;SEARCH_EVENTS_CREDS_FILE;SETTINGS_CACHE_CREDS_FILE;SHARING_EVENTS_CREDS_FILE;SSE_EVENTS_CREDS_FILE;STORAGE_PUBLICLINK_STORE_CREDS_FILE;STORAGE_SYSTEM_CACHE_CREDS_FILE;STORAGE_USERS_EVENTS_CREDS_FILE;STORAGE_USERS_FILEMETADATA_CACHE_CREDS_FILE;STORAGE_USERS_ID_CACHE_CREDS_FILE;USERLOG_EVENTS_CREDS_FILE;USERLOG_STORE_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the events broker when NATS runs in JWT (operator) mode. + When set, the service does not use the username and the password. Exception: a + service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the + file again on each reconnect. | Path to a NATS .creds file with a user JWT and + an NKey seed. Use it to authenticate with the cache when NATS runs in JWT (operator) + mode. When set, the service does not use the username and the password. Exception: + a service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the + file again on each reconnect. Only applies when store type ''nats-js-kv'' is configured. + | Path to a NATS .creds file with a user JWT and an NKey seed. Use it to authenticate + with the store when NATS runs in JWT (operator) mode. When set, the service does + not use the username and the password. Exception: a service-specific username + and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. The service reads the file again on each reconnect. + Only applies when store type ''nats-js-kv'' is configured. | Path to a NATS .creds + file with a user JWT and an NKey seed. Use it to authenticate with the cache when + NATS runs in JWT (operator) mode. When set, the service does not use the username + and the password. The service reads the file again on each reconnect. Only applies + when store type ''nats-js-kv'' is configured. | Path to a NATS .creds file with + a user JWT and an NKey seed. Use it to authenticate with the events broker when + NATS runs in JWT (operator) mode. When set, the service does not use the username + and the password. The service reads the file again on each reconnect.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" OCIS_OIDC_CLIENT_ID: name: OCIS_OIDC_CLIENT_ID;WEB_OIDC_CLIENT_ID defaultValue: web @@ -9834,7 +10514,10 @@ OCIS_PERSISTENT_STORE_TLS_INSECURE: defaultValue: "false" type: bool description: Disable TLS certificate verification for the store connection. Only - applies when store type 'nats-js-kv' is configured. + applies when store type 'nats-js-kv' is configured. | Disable TLS certificate + verification for the store connection. Only applies when store type 'nats-js-kv' + is configured. Do not enable this in production because it disables authentication + of the NATS server. Use it only for testing with self-signed certificates. introductionVersion: 8.3.0 deprecationVersion: "" removalVersion: "" @@ -9928,6 +10611,27 @@ OCIS_SERVICE_ACCOUNT_SECRET: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +OCIS_SHARING_ENABLE_EXPIRED_SHARES_CLEANUP: + name: OCIS_SHARING_ENABLE_EXPIRED_SHARES_CLEANUP;SHARING_ENABLE_EXPIRED_SHARES_CLEANUP + defaultValue: "true" + type: bool + description: Enable the periodic removal of expired public shares. When disabled, + expired shares are still hidden from listings but never actually deleted. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_SHARING_JANITOR_RUN_INTERVAL: + name: OCIS_SHARING_JANITOR_RUN_INTERVAL;SHARING_JANITOR_RUN_INTERVAL + defaultValue: "3600" + type: int + description: Interval in seconds between two runs of the janitor that permanently + deletes expired public shares. Defaults to '3600' (1 hour). Only relevant when + OCIS_SHARING_ENABLE_EXPIRED_SHARES_CLEANUP is enabled. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD: name: OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD;SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD defaultValue: "true" @@ -10213,6 +10917,35 @@ OCM_EVENTS_CLUSTER: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +OCM_EVENTS_CREDS: + name: OCIS_NATS_CREDS;OCM_EVENTS_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the events broker when NATS runs in JWT (operator) mode. + A service-specific variable takes precedence over a global variable. In the same + scope, the content takes precedence over the path of a .creds file. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_EVENTS_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;OCM_EVENTS_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the events broker when NATS runs in JWT (operator) mode. + When set, the service does not use the username and the password. Exception: a + service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the + file again on each reconnect.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" OCM_EVENTS_ENABLE_TLS: name: OCIS_EVENTS_ENABLE_TLS;OCM_EVENTS_ENABLE_TLS defaultValue: "false" @@ -10770,13 +11503,43 @@ OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_USERNAME: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS: + name: OCIS_NATS_CREDS;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific + variable takes precedence over a global variable. In the same scope, the content + takes precedence over the path of a .creds file. When set, the service does not + use the username and the password. Exception: a service-specific username and + password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. Only applies when store type ''nats-js-kv'' + is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the cache when NATS runs in JWT (operator) mode. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. The service reads the file again on each reconnect. + Only applies when store type ''nats-js-kv'' is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_ENABLE_TLS: name: OCIS_CACHE_ENABLE_TLS;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_ENABLE_TLS defaultValue: "false" type: bool description: Activate TLS for the connection to the signing key store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10796,8 +11559,10 @@ OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_TLS_INSECURE: defaultValue: "false" type: bool description: Disable TLS certificate verification for the signing key store connection. - Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + Only applies when store type 'nats-js-kv' is configured. Do not enable this in + production because it disables authentication of the NATS server. Use it only + for testing with self-signed certificates. + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10807,7 +11572,7 @@ OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the signing key store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10949,6 +11714,35 @@ POLICIES_EVENTS_CLUSTER: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +POLICIES_EVENTS_CREDS: + name: OCIS_NATS_CREDS;POLICIES_EVENTS_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the events broker when NATS runs in JWT (operator) mode. + A service-specific variable takes precedence over a global variable. In the same + scope, the content takes precedence over the path of a .creds file. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_EVENTS_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;POLICIES_EVENTS_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the events broker when NATS runs in JWT (operator) mode. + When set, the service does not use the username and the password. Exception: a + service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the + file again on each reconnect.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" POLICIES_EVENTS_ENABLE_TLS: name: OCIS_EVENTS_ENABLE_TLS;POLICIES_EVENTS_ENABLE_TLS defaultValue: "false" @@ -11166,6 +11960,35 @@ POSTPROCESSING_EVENTS_CLUSTER: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +POSTPROCESSING_EVENTS_CREDS: + name: OCIS_NATS_CREDS;POSTPROCESSING_EVENTS_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the events broker when NATS runs in JWT (operator) mode. + A service-specific variable takes precedence over a global variable. In the same + scope, the content takes precedence over the path of a .creds file. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_EVENTS_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;POSTPROCESSING_EVENTS_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the events broker when NATS runs in JWT (operator) mode. + When set, the service does not use the username and the password. Exception: a + service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the + file again on each reconnect.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" POSTPROCESSING_EVENTS_ENABLE_TLS: name: OCIS_EVENTS_ENABLE_TLS;POSTPROCESSING_EVENTS_ENABLE_TLS defaultValue: "false" @@ -11304,6 +12127,36 @@ POSTPROCESSING_STORE_AUTH_USERNAME: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +POSTPROCESSING_STORE_CREDS: + name: OCIS_NATS_CREDS;POSTPROCESSING_STORE_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific + variable takes precedence over a global variable. In the same scope, the content + takes precedence over the path of a .creds file. When set, the service does not + use the username and the password. Exception: a service-specific username and + password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. Only applies when store type ''nats-js-kv'' + is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_STORE_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;POSTPROCESSING_STORE_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the store when NATS runs in JWT (operator) mode. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. The service reads the file again on each reconnect. + Only applies when store type ''nats-js-kv'' is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" POSTPROCESSING_STORE_DATABASE: name: POSTPROCESSING_STORE_DATABASE defaultValue: postprocessing @@ -11319,7 +12172,7 @@ POSTPROCESSING_STORE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11349,8 +12202,10 @@ POSTPROCESSING_STORE_TLS_INSECURE: defaultValue: "false" type: bool description: Disable TLS certificate verification for the store connection. Only - applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + applies when store type 'nats-js-kv' is configured. Do not enable this in production + because it disables authentication of the NATS server. Use it only for testing + with self-signed certificates. + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11360,7 +12215,7 @@ POSTPROCESSING_STORE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11597,6 +12452,35 @@ PROXY_EVENTS_CLUSTER: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +PROXY_EVENTS_CREDS: + name: OCIS_NATS_CREDS;PROXY_EVENTS_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the events broker when NATS runs in JWT (operator) mode. + A service-specific variable takes precedence over a global variable. In the same + scope, the content takes precedence over the path of a .creds file. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_EVENTS_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;PROXY_EVENTS_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the events broker when NATS runs in JWT (operator) mode. + When set, the service does not use the username and the password. Exception: a + service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the + file again on each reconnect.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" PROXY_EVENTS_ENABLE_TLS: name: OCIS_EVENTS_ENABLE_TLS;PROXY_EVENTS_ENABLE_TLS defaultValue: "false" @@ -11859,6 +12743,47 @@ PROXY_OIDC_USERINFO_CACHE_AUTH_USERNAME: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +PROXY_OIDC_USERINFO_CACHE_CREDS: + name: OCIS_NATS_CREDS;PROXY_OIDC_USERINFO_CACHE_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific + variable takes precedence over a global variable. In the same scope, the content + takes precedence over the path of a .creds file. When set, the service does not + use the username and the password. Exception: a service-specific username and + password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. Only applies when store type ''nats-js-kv'' + is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_USERINFO_CACHE_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;PROXY_OIDC_USERINFO_CACHE_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the cache when NATS runs in JWT (operator) mode. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. The service reads the file again on each reconnect. + Only applies when store type ''nats-js-kv'' is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_USERINFO_CACHE_DATABASE: + name: OCIS_CACHE_DATABASE;PROXY_OIDC_USERINFO_CACHE_DATABASE + defaultValue: cache-userinfo + type: string + description: The database name the configured store should use. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: The global variable OCIS_CACHE_DATABASE is deprecated and will + be removed in a future release. Please use local variable PROXY_OIDC_USERINFO_CACHE_DATABASE + instead. PROXY_OIDC_USERINFO_CACHE_DISABLE_PERSISTENCE: name: OCIS_CACHE_DISABLE_PERSISTENCE;PROXY_OIDC_USERINFO_CACHE_DISABLE_PERSISTENCE defaultValue: "false" @@ -11875,7 +12800,7 @@ PROXY_OIDC_USERINFO_CACHE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11916,7 +12841,7 @@ PROXY_OIDC_USERINFO_CACHE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11926,7 +12851,7 @@ PROXY_OIDC_USERINFO_CACHE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11982,6 +12907,36 @@ PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_USERNAME: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS: + name: OCIS_NATS_CREDS;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific + variable takes precedence over a global variable. In the same scope, the content + takes precedence over the path of a .creds file. When set, the service does not + use the username and the password. Exception: a service-specific username and + password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. Only applies when store type ''nats-js-kv'' + is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the cache when NATS runs in JWT (operator) mode. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. The service reads the file again on each reconnect. + Only applies when store type ''nats-js-kv'' is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_DISABLE_PERSISTENCE: name: OCIS_CACHE_DISABLE_PERSISTENCE;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_DISABLE_PERSISTENCE defaultValue: "true" @@ -11998,7 +12953,7 @@ PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the signing key store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12019,7 +12974,7 @@ PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the signing key store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12029,7 +12984,7 @@ PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the signing key store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12298,6 +13253,35 @@ SEARCH_EVENTS_CLUSTER: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +SEARCH_EVENTS_CREDS: + name: OCIS_NATS_CREDS;SEARCH_EVENTS_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the events broker when NATS runs in JWT (operator) mode. + A service-specific variable takes precedence over a global variable. In the same + scope, the content takes precedence over the path of a .creds file. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_EVENTS_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;SEARCH_EVENTS_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the events broker when NATS runs in JWT (operator) mode. + When set, the service does not use the username and the password. Exception: a + service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the + file again on each reconnect.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" SEARCH_EVENTS_ENABLE_TLS: name: OCIS_EVENTS_ENABLE_TLS;SEARCH_EVENTS_ENABLE_TLS defaultValue: "false" @@ -12367,6 +13351,18 @@ SEARCH_EXTRACTOR_CS3SOURCE_INSECURE: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +SEARCH_EXTRACTOR_MAX_CONSECUTIVE_FAILURES: + name: SEARCH_EXTRACTOR_MAX_CONSECUTIVE_FAILURES + defaultValue: "5" + type: int + description: Abort a space (re)index walk after this many files in a row fail content + extraction, which usually means the extraction service is down. Files that cannot + be resolved at all are logged and skipped without counting towards this limit. + Set to 0 to never abort. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" SEARCH_EXTRACTOR_TIKA_CLEAN_STOP_WORDS: name: SEARCH_EXTRACTOR_TIKA_CLEAN_STOP_WORDS defaultValue: "true" @@ -12549,6 +13545,47 @@ SETTINGS_CACHE_AUTH_USERNAME: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +SETTINGS_CACHE_CREDS: + name: OCIS_NATS_CREDS;SETTINGS_CACHE_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific + variable takes precedence over a global variable. In the same scope, the content + takes precedence over the path of a .creds file. When set, the service does not + use the username and the password. Exception: a service-specific username and + password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. Only applies when store type ''nats-js-kv'' + is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_CACHE_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;SETTINGS_CACHE_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the cache when NATS runs in JWT (operator) mode. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. The service reads the file again on each reconnect. + Only applies when store type ''nats-js-kv'' is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_CACHE_DATABASE: + name: OCIS_CACHE_DATABASE;SETTINGS_CACHE_DATABASE + defaultValue: settings-cache + type: string + description: The database name the configured store should use. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: The global variable OCIS_CACHE_DATABASE is deprecated and will + be removed in a future release. Please use local variable SETTINGS_CACHE_DATABASE + instead. SETTINGS_CACHE_DISABLE_PERSISTENCE: name: OCIS_CACHE_DISABLE_PERSISTENCE;SETTINGS_CACHE_DISABLE_PERSISTENCE defaultValue: "false" @@ -12565,7 +13602,7 @@ SETTINGS_CACHE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12597,7 +13634,7 @@ SETTINGS_CACHE_TLS_INSECURE: type: bool description: Disable TLS certificate verification for the cache store connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12607,7 +13644,7 @@ SETTINGS_CACHE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12941,6 +13978,16 @@ SHARING_DEBUG_ZPAGES: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +SHARING_ENABLE_EXPIRED_SHARES_CLEANUP: + name: OCIS_SHARING_ENABLE_EXPIRED_SHARES_CLEANUP;SHARING_ENABLE_EXPIRED_SHARES_CLEANUP + defaultValue: "true" + type: bool + description: Enable the periodic removal of expired public shares. When disabled, + expired shares are still hidden from listings but never actually deleted. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" SHARING_EVENTS_AUTH_PASSWORD: name: OCIS_EVENTS_AUTH_PASSWORD;SHARING_EVENTS_AUTH_PASSWORD defaultValue: "" @@ -12970,6 +14017,35 @@ SHARING_EVENTS_CLUSTER: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +SHARING_EVENTS_CREDS: + name: OCIS_NATS_CREDS;SHARING_EVENTS_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the events broker when NATS runs in JWT (operator) mode. + A service-specific variable takes precedence over a global variable. In the same + scope, the content takes precedence over the path of a .creds file. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_EVENTS_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;SHARING_EVENTS_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the events broker when NATS runs in JWT (operator) mode. + When set, the service does not use the username and the password. Exception: a + service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the + file again on each reconnect.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" SHARING_EVENTS_ENABLE_TLS: name: OCIS_EVENTS_ENABLE_TLS;SHARING_EVENTS_ENABLE_TLS defaultValue: "false" @@ -13027,6 +14103,17 @@ SHARING_GRPC_PROTOCOL: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +SHARING_JANITOR_RUN_INTERVAL: + name: OCIS_SHARING_JANITOR_RUN_INTERVAL;SHARING_JANITOR_RUN_INTERVAL + defaultValue: "3600" + type: int + description: Interval in seconds between two runs of the janitor that permanently + deletes expired public shares. Defaults to '3600' (1 hour). Only relevant when + OCIS_SHARING_ENABLE_EXPIRED_SHARES_CLEANUP is enabled. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" SHARING_JWT_SECRET: name: OCIS_JWT_SECRET;SHARING_JWT_SECRET defaultValue: "" @@ -13359,7 +14446,7 @@ SHARING_USER_DRIVER: defaultValue: jsoncs3 type: string description: Driver to be used to persist shares. Supported values are 'jsoncs3', - 'json', 'cs3' (deprecated) and 'owncloudsql'. + 'json' and 'cs3' (deprecated). introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -13439,54 +14526,60 @@ SHARING_USER_OWNCLOUDSQL_DB_HOST: type: string description: Hostname or IP of the database server. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: SHARING_USER_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql + driver is deprecated. SHARING_USER_OWNCLOUDSQL_DB_NAME: name: SHARING_USER_OWNCLOUDSQL_DB_NAME defaultValue: owncloud type: string description: Name of the database to be used. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: SHARING_USER_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql + driver is deprecated. SHARING_USER_OWNCLOUDSQL_DB_PASSWORD: name: SHARING_USER_OWNCLOUDSQL_DB_PASSWORD defaultValue: "" type: string description: Password for the database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: SHARING_USER_OWNCLOUDSQL_DB_PASSWORD is deprecated because the + owncloudsql driver is deprecated. SHARING_USER_OWNCLOUDSQL_DB_PORT: name: SHARING_USER_OWNCLOUDSQL_DB_PORT defaultValue: "3306" type: int description: Port that the database server is listening on. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: SHARING_USER_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql + driver is deprecated. SHARING_USER_OWNCLOUDSQL_DB_USERNAME: name: SHARING_USER_OWNCLOUDSQL_DB_USERNAME defaultValue: owncloud type: string description: Username for the database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: SHARING_USER_OWNCLOUDSQL_DB_USERNAME is deprecated because the + owncloudsql driver is deprecated. SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID: name: SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID defaultValue: "" type: string description: Mount ID of the ownCloudSQL users storage for mapping ownCloud 10 shares. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID is deprecated because + the owncloudsql driver is deprecated. SSE_CORS_ALLOW_CREDENTIALS: name: OCIS_CORS_ALLOW_CREDENTIALS;SSE_CORS_ALLOW_CREDENTIALS defaultValue: "true" @@ -13600,6 +14693,35 @@ SSE_EVENTS_CLUSTER: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +SSE_EVENTS_CREDS: + name: OCIS_NATS_CREDS;SSE_EVENTS_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the events broker when NATS runs in JWT (operator) mode. + A service-specific variable takes precedence over a global variable. In the same + scope, the content takes precedence over the path of a .creds file. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_EVENTS_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;SSE_EVENTS_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the events broker when NATS runs in JWT (operator) mode. + When set, the service does not use the username and the password. Exception: a + service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the + file again on each reconnect.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" SSE_EVENTS_ENABLE_TLS: name: OCIS_EVENTS_ENABLE_TLS;SSE_EVENTS_ENABLE_TLS defaultValue: "false" @@ -13931,6 +15053,36 @@ STORAGE_PUBLICLINK_STORE_AUTH_USERNAME: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +STORAGE_PUBLICLINK_STORE_CREDS: + name: OCIS_NATS_CREDS;STORAGE_PUBLICLINK_STORE_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific + variable takes precedence over a global variable. In the same scope, the content + takes precedence over the path of a .creds file. When set, the service does not + use the username and the password. Exception: a service-specific username and + password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. Only applies when store type ''nats-js-kv'' + is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_PUBLICLINK_STORE_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;STORAGE_PUBLICLINK_STORE_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the store when NATS runs in JWT (operator) mode. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. The service reads the file again on each reconnect. + Only applies when store type ''nats-js-kv'' is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" STORAGE_PUBLICLINK_STORE_DATABASE: name: STORAGE_PUBLICLINK_STORE_DATABASE defaultValue: storage-publiclink @@ -13946,7 +15098,7 @@ STORAGE_PUBLICLINK_STORE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13986,8 +15138,10 @@ STORAGE_PUBLICLINK_STORE_TLS_INSECURE: defaultValue: "false" type: bool description: Disable TLS certificate verification for the store connection. Only - applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + applies when store type 'nats-js-kv' is configured. Do not enable this in production + because it disables authentication of the NATS server. Use it only for testing + with self-signed certificates. + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13997,7 +15151,7 @@ STORAGE_PUBLICLINK_STORE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14238,6 +15392,47 @@ STORAGE_SYSTEM_CACHE_AUTH_USERNAME: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +STORAGE_SYSTEM_CACHE_CREDS: + name: OCIS_NATS_CREDS;STORAGE_SYSTEM_CACHE_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific + variable takes precedence over a global variable. In the same scope, the content + takes precedence over the path of a .creds file. When set, the service does not + use the username and the password. Exception: a service-specific username and + password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. Only applies when store type ''nats-js-kv'' + is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_CACHE_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;STORAGE_SYSTEM_CACHE_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the cache when NATS runs in JWT (operator) mode. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. The service reads the file again on each reconnect. + Only applies when store type ''nats-js-kv'' is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_CACHE_DATABASE: + name: OCIS_CACHE_DATABASE;STORAGE_SYSTEM_CACHE_DATABASE + defaultValue: storage-system + type: string + description: The database name the configured store should use. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: The global variable OCIS_CACHE_DATABASE is deprecated and will + be removed in a future release. Please use local variable STORAGE_SYSTEM_CACHE_DATABASE + instead. STORAGE_SYSTEM_CACHE_DISABLE_PERSISTENCE: name: OCIS_CACHE_DISABLE_PERSISTENCE;STORAGE_SYSTEM_CACHE_DISABLE_PERSISTENCE defaultValue: "false" @@ -14254,7 +15449,7 @@ STORAGE_SYSTEM_CACHE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14285,8 +15480,10 @@ STORAGE_SYSTEM_CACHE_TLS_INSECURE: defaultValue: "false" type: bool description: Disable TLS certificate verification for the cache store connection. - Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + Only applies when store type 'nats-js-kv' is configured. Do not enable this in + production because it disables authentication of the NATS server. Use it only + for testing with self-signed certificates. + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14296,7 +15493,7 @@ STORAGE_SYSTEM_CACHE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14683,10 +15880,9 @@ STORAGE_USERS_DRIVER: defaultValue: ocis type: string description: 'The storage driver which should be used by the service. Defaults to - ''ocis'', Supported values are: ''ocis'', ''s3ng'' and ''owncloudsql'' (deprecated). - The ''ocis'' driver stores all data (blob and meta data) in an POSIX compliant - volume. The ''s3ng'' driver stores metadata in a POSIX compliant volume and uploads - blobs to the s3 bucket.' + ''ocis'', Supported values are: ''ocis'' and ''s3ng''. The ''ocis'' driver stores + all data (blob and meta data) in an POSIX compliant volume. The ''s3ng'' driver + stores metadata in a POSIX compliant volume and uploads blobs to the s3 bucket.' introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -14744,6 +15940,35 @@ STORAGE_USERS_EVENTS_CONSUMER_GROUP: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +STORAGE_USERS_EVENTS_CREDS: + name: OCIS_NATS_CREDS;STORAGE_USERS_EVENTS_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the events broker when NATS runs in JWT (operator) mode. + A service-specific variable takes precedence over a global variable. In the same + scope, the content takes precedence over the path of a .creds file. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_EVENTS_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;STORAGE_USERS_EVENTS_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the events broker when NATS runs in JWT (operator) mode. + When set, the service does not use the username and the password. Exception: a + service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the + file again on each reconnect.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" STORAGE_USERS_EVENTS_ENABLE_TLS: name: OCIS_EVENTS_ENABLE_TLS;STORAGE_USERS_EVENTS_ENABLE_TLS defaultValue: "false" @@ -14825,6 +16050,47 @@ STORAGE_USERS_FILEMETADATA_CACHE_AUTH_USERNAME: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +STORAGE_USERS_FILEMETADATA_CACHE_CREDS: + name: OCIS_NATS_CREDS;STORAGE_USERS_FILEMETADATA_CACHE_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific + variable takes precedence over a global variable. In the same scope, the content + takes precedence over the path of a .creds file. When set, the service does not + use the username and the password. Exception: a service-specific username and + password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. Only applies when store type ''nats-js-kv'' + is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_FILEMETADATA_CACHE_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;STORAGE_USERS_FILEMETADATA_CACHE_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the cache when NATS runs in JWT (operator) mode. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. The service reads the file again on each reconnect. + Only applies when store type ''nats-js-kv'' is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_FILEMETADATA_CACHE_DATABASE: + name: OCIS_CACHE_DATABASE;STORAGE_USERS_FILEMETADATA_CACHE_DATABASE + defaultValue: storage-users + type: string + description: The database name the configured store should use. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: The global variable OCIS_CACHE_DATABASE is deprecated and will + be removed in a future release. Please use local variable STORAGE_USERS_FILEMETADATA_CACHE_DATABASE + instead. STORAGE_USERS_FILEMETADATA_CACHE_DISABLE_PERSISTENCE: name: OCIS_CACHE_DISABLE_PERSISTENCE;STORAGE_USERS_FILEMETADATA_CACHE_DISABLE_PERSISTENCE defaultValue: "false" @@ -14841,7 +16107,7 @@ STORAGE_USERS_FILEMETADATA_CACHE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14872,8 +16138,10 @@ STORAGE_USERS_FILEMETADATA_CACHE_TLS_INSECURE: defaultValue: "false" type: bool description: Disable TLS certificate verification for the cache store connection. - Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + Only applies when store type 'nats-js-kv' is configured. Do not enable this in + production because it disables authentication of the NATS server. Use it only + for testing with self-signed certificates. + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14883,7 +16151,7 @@ STORAGE_USERS_FILEMETADATA_CACHE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14975,6 +16243,47 @@ STORAGE_USERS_ID_CACHE_AUTH_USERNAME: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +STORAGE_USERS_ID_CACHE_CREDS: + name: OCIS_NATS_CREDS;STORAGE_USERS_ID_CACHE_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the cache when NATS runs in JWT (operator) mode. A service-specific + variable takes precedence over a global variable. In the same scope, the content + takes precedence over the path of a .creds file. When set, the service does not + use the username and the password. Exception: a service-specific username and + password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. Only applies when store type ''nats-js-kv'' + is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_ID_CACHE_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;STORAGE_USERS_ID_CACHE_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the cache when NATS runs in JWT (operator) mode. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. The service reads the file again on each reconnect. + Only applies when store type ''nats-js-kv'' is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_ID_CACHE_DATABASE: + name: OCIS_CACHE_DATABASE;STORAGE_USERS_ID_CACHE_DATABASE + defaultValue: ids-storage-users + type: string + description: The database name the configured store should use. + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: The global variable OCIS_CACHE_DATABASE is deprecated and will + be removed in a future release. Please use local variable STORAGE_USERS_ID_CACHE_DATABASE + instead. STORAGE_USERS_ID_CACHE_DISABLE_PERSISTENCE: name: OCIS_CACHE_DISABLE_PERSISTENCE;STORAGE_USERS_ID_CACHE_DISABLE_PERSISTENCE defaultValue: "false" @@ -14991,7 +16300,7 @@ STORAGE_USERS_ID_CACHE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the cache store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15022,8 +16331,10 @@ STORAGE_USERS_ID_CACHE_TLS_INSECURE: defaultValue: "false" type: bool description: Disable TLS certificate verification for the cache store connection. - Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + Only applies when store type 'nats-js-kv' is configured. Do not enable this in + production because it disables authentication of the NATS server. Use it only + for testing with self-signed certificates. + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15033,7 +16344,7 @@ STORAGE_USERS_ID_CACHE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the cache store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15250,54 +16561,60 @@ STORAGE_USERS_OWNCLOUDSQL_DATADIR: description: The directory where the filesystem storage will store SQL migration data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/owncloud. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_DATADIR is deprecated because the owncloudsql + driver is deprecated. STORAGE_USERS_OWNCLOUDSQL_DB_HOST: name: STORAGE_USERS_OWNCLOUDSQL_DB_HOST defaultValue: "" type: string description: Hostname or IP of the database server. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql + driver is deprecated. STORAGE_USERS_OWNCLOUDSQL_DB_NAME: name: STORAGE_USERS_OWNCLOUDSQL_DB_NAME defaultValue: owncloud type: string description: Name of the database to be used. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql + driver is deprecated. STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD: name: STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD defaultValue: owncloud type: string description: Password for the database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD is deprecated because the + owncloudsql driver is deprecated. STORAGE_USERS_OWNCLOUDSQL_DB_PORT: name: STORAGE_USERS_OWNCLOUDSQL_DB_PORT defaultValue: "3306" type: int description: Port that the database server is listening on. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql + driver is deprecated. STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME: name: STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME defaultValue: owncloud type: string description: Username for the database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME is deprecated because the + owncloudsql driver is deprecated. STORAGE_USERS_OWNCLOUDSQL_LAYOUT: name: STORAGE_USERS_OWNCLOUDSQL_LAYOUT defaultValue: '{{.Username}}' @@ -15305,18 +16622,20 @@ STORAGE_USERS_OWNCLOUDSQL_LAYOUT: description: Path layout to use to navigate into a users folder in an owncloud data directory introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_LAYOUT is deprecated because the owncloudsql + driver is deprecated. STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER: name: STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER defaultValue: /Shares type: string description: Name of the folder jailing all shares. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER is deprecated because the + owncloudsql driver is deprecated. STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR: name: STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR defaultValue: /var/lib/ocis/storage/uploadinfo @@ -15324,25 +16643,27 @@ STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR: description: The directory where the filesystem will store uploads temporarily. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/uploadinfo. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR is deprecated because + the owncloudsql driver is deprecated. STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT: name: STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT defaultValue: com.owncloud.api.users type: string description: Endpoint of the users provider. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT is deprecated + because the owncloudsql driver is deprecated. STORAGE_USERS_PERMISSION_ENDPOINT: - name: STORAGE_USERS_PERMISSION_ENDPOINT;STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT + name: STORAGE_USERS_PERMISSION_ENDPOINT;STORAGE_USERS_S3NG_PERMISSIONS_ENDPOINT defaultValue: com.owncloud.api.settings type: string - description: Endpoint of the permissions service. The endpoints can differ for 'ocis', - 'posix' and 's3ng'. - introductionVersion: 6.0.0 + description: Endpoint of the permissions service. The endpoints can differ for 'ocis' + and 's3ng'. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15352,9 +16673,10 @@ STORAGE_USERS_POSIX_GENERAL_SPACE_PATH_TEMPLATE: type: string description: Template string to construct the paths of the projects space roots. introductionVersion: 6.0.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_POSIX_GENERAL_SPACE_PATH_TEMPLATE is deprecated because + the posixfs storage driver is deprecated and will be removed in 9.0.0. STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT: name: STORAGE_USERS_PERMISSION_ENDPOINT;STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT defaultValue: com.owncloud.api.settings @@ -15362,18 +16684,20 @@ STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT: description: Endpoint of the permissions service. The endpoints can differ for 'ocis', 'posix' and 's3ng'. introductionVersion: 6.0.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT is deprecated because + the posixfs storage driver is deprecated and will be removed in 9.0.0. STORAGE_USERS_POSIX_PERSONAL_SPACE_PATH_TEMPLATE: name: STORAGE_USERS_POSIX_PERSONAL_SPACE_PATH_TEMPLATE defaultValue: users/{{.User.Username}} type: string description: Template string to construct the paths of the personal space roots. introductionVersion: 6.0.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_POSIX_PERSONAL_SPACE_PATH_TEMPLATE is deprecated + because the posixfs storage driver is deprecated and will be removed in 9.0.0. STORAGE_USERS_POSIX_ROOT: name: STORAGE_USERS_POSIX_ROOT defaultValue: /var/lib/ocis/storage/users @@ -15381,9 +16705,10 @@ STORAGE_USERS_POSIX_ROOT: description: The directory where the filesystem storage will store its data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/storage/users. introductionVersion: 6.0.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_POSIX_ROOT is deprecated because the posixfs storage + driver is deprecated and will be removed in 9.0.0. STORAGE_USERS_POSIX_SCAN_DEBOUNCE_DELAY: name: STORAGE_USERS_POSIX_SCAN_DEBOUNCE_DELAY defaultValue: 1s @@ -15391,18 +16716,20 @@ STORAGE_USERS_POSIX_SCAN_DEBOUNCE_DELAY: description: The time in milliseconds to wait before scanning the filesystem for changes after a change has been detected. introductionVersion: 6.0.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_POSIX_SCAN_DEBOUNCE_DELAY is deprecated because the + posixfs storage driver is deprecated and will be removed in 9.0.0. STORAGE_USERS_POSIX_USE_SPACE_GROUPS: name: STORAGE_USERS_POSIX_USE_SPACE_GROUPS defaultValue: "false" type: bool description: Use space groups to manage permissions on spaces. introductionVersion: 6.0.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_POSIX_USE_SPACE_GROUPS is deprecated because the + posixfs storage driver is deprecated and will be removed in 9.0.0. STORAGE_USERS_POSIX_WATCH_FOLDER_KAFKA_BROKERS: name: STORAGE_USERS_POSIX_WATCH_FOLDER_KAFKA_BROKERS defaultValue: "" @@ -15410,9 +16737,10 @@ STORAGE_USERS_POSIX_WATCH_FOLDER_KAFKA_BROKERS: description: Comma-separated list of kafka brokers to read the watchfolder events from. introductionVersion: 6.0.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_POSIX_WATCH_FOLDER_KAFKA_BROKERS is deprecated because + the posixfs storage driver is deprecated and will be removed in 9.0.0. STORAGE_USERS_POSIX_WATCH_PATH: name: STORAGE_USERS_POSIX_WATCH_PATH defaultValue: "" @@ -15421,9 +16749,10 @@ STORAGE_USERS_POSIX_WATCH_PATH: and 'inotifywait' watcher, in which case it is the path of the file audit log file/base directory to watch. introductionVersion: 6.0.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_POSIX_WATCH_PATH is deprecated because the posixfs + storage driver is deprecated and will be removed in 9.0.0. STORAGE_USERS_POSIX_WATCH_TYPE: name: STORAGE_USERS_POSIX_WATCH_TYPE defaultValue: "" @@ -15432,9 +16761,10 @@ STORAGE_USERS_POSIX_WATCH_TYPE: filesystem. Currently available options are 'inotifywait' (default), 'gpfswatchfolder' and 'gpfsfileauditlogging'. introductionVersion: 6.0.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: STORAGE_USERS_POSIX_WATCH_TYPE is deprecated because the posixfs + storage driver is deprecated and will be removed in 9.0.0. STORAGE_USERS_PURGE_TRASH_BIN_PERSONAL_DELETE_BEFORE: name: STORAGE_USERS_PURGE_TRASH_BIN_PERSONAL_DELETE_BEFORE defaultValue: 720h0m0s @@ -16197,6 +17527,35 @@ USERLOG_EVENTS_CLUSTER: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +USERLOG_EVENTS_CREDS: + name: OCIS_NATS_CREDS;USERLOG_EVENTS_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the events broker when NATS runs in JWT (operator) mode. + A service-specific variable takes precedence over a global variable. In the same + scope, the content takes precedence over the path of a .creds file. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_EVENTS_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;USERLOG_EVENTS_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the events broker when NATS runs in JWT (operator) mode. + When set, the service does not use the username and the password. Exception: a + service-specific username and password take precedence over the global OCIS_NATS_CREDS + and OCIS_NATS_CREDS_FILE variables when both have a value. The service reads the + file again on each reconnect.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" USERLOG_EVENTS_ENABLE_TLS: name: OCIS_EVENTS_ENABLE_TLS;USERLOG_EVENTS_ENABLE_TLS defaultValue: "false" @@ -16371,6 +17730,36 @@ USERLOG_STORE_AUTH_USERNAME: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +USERLOG_STORE_CREDS: + name: OCIS_NATS_CREDS;USERLOG_STORE_CREDS + defaultValue: "" + type: string + description: 'Content of a NATS .creds file with a user JWT and an NKey seed. Use + it to authenticate with the store when NATS runs in JWT (operator) mode. A service-specific + variable takes precedence over a global variable. In the same scope, the content + takes precedence over the path of a .creds file. When set, the service does not + use the username and the password. Exception: a service-specific username and + password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. Only applies when store type ''nats-js-kv'' + is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_STORE_CREDS_FILE: + name: OCIS_NATS_CREDS_FILE;USERLOG_STORE_CREDS_FILE + defaultValue: "" + type: string + description: 'Path to a NATS .creds file with a user JWT and an NKey seed. Use it + to authenticate with the store when NATS runs in JWT (operator) mode. When set, + the service does not use the username and the password. Exception: a service-specific + username and password take precedence over the global OCIS_NATS_CREDS and OCIS_NATS_CREDS_FILE + variables when both have a value. The service reads the file again on each reconnect. + Only applies when store type ''nats-js-kv'' is configured.' + introductionVersion: 9.0.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" USERLOG_STORE_DATABASE: name: USERLOG_STORE_DATABASE defaultValue: userlog @@ -16386,13 +17775,13 @@ USERLOG_STORE_ENABLE_TLS: type: bool description: Activate TLS for the connection to the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERLOG_STORE_NODES: name: OCIS_PERSISTENT_STORE_NODES;USERLOG_STORE_NODES - defaultValue: '[]' + defaultValue: '[127.0.0.1:9233]' type: '[]string' description: 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 @@ -16416,8 +17805,10 @@ USERLOG_STORE_TLS_INSECURE: defaultValue: "false" type: bool description: Disable TLS certificate verification for the store connection. Only - applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + applies when store type 'nats-js-kv' is configured. Do not enable this in production + because it disables authentication of the NATS server. Use it only for testing + with self-signed certificates. + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -16427,7 +17818,7 @@ USERLOG_STORE_TLS_ROOT_CA_CERTIFICATE: type: string description: Path to the PEM-encoded root CA certificate for the store TLS connection. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.3.0 + introductionVersion: 9.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -16532,8 +17923,8 @@ USERS_DRIVER: name: USERS_DRIVER defaultValue: ldap type: string - description: The driver which should be used by the users service. Supported values - are 'ldap' and 'owncloudsql'. + description: The driver which should be used by the users service. Supported value + is 'ldap'. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -16677,7 +18068,7 @@ USERS_LDAP_GROUP_SCHEMA_GROUPNAME: deprecationInfo: "" USERS_LDAP_GROUP_SCHEMA_ID: name: OCIS_LDAP_GROUP_SCHEMA_ID;USERS_LDAP_GROUP_SCHEMA_ID - defaultValue: ownclouduuid + defaultValue: ownCloudUUID type: string description: LDAP Attribute to use as the unique ID for groups. This should be a stable globally unique ID like a UUID. @@ -16844,7 +18235,7 @@ USERS_LDAP_USER_OBJECTCLASS: deprecationInfo: "" USERS_LDAP_USER_SCHEMA_DISPLAYNAME: name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;USERS_LDAP_USER_SCHEMA_DISPLAYNAME - defaultValue: displayname + defaultValue: displayName type: string description: LDAP Attribute to use for the displayname of users. introductionVersion: pre5.0 @@ -16853,7 +18244,7 @@ USERS_LDAP_USER_SCHEMA_DISPLAYNAME: deprecationInfo: "" USERS_LDAP_USER_SCHEMA_ID: name: OCIS_LDAP_USER_SCHEMA_ID;USERS_LDAP_USER_SCHEMA_ID - defaultValue: ownclouduuid + defaultValue: ownCloudUUID type: string description: LDAP Attribute to use as the unique ID for users. This should be a stable globally unique ID like a UUID. @@ -16964,45 +18355,50 @@ USERS_OWNCLOUDSQL_DB_HOST: type: string description: Hostname of the database server. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_DB_HOST is deprecated because the owncloudsql + driver is deprecated. USERS_OWNCLOUDSQL_DB_NAME: name: USERS_OWNCLOUDSQL_DB_NAME defaultValue: owncloud type: string description: Name of the owncloud database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_DB_NAME is deprecated because the owncloudsql + driver is deprecated. USERS_OWNCLOUDSQL_DB_PASSWORD: name: USERS_OWNCLOUDSQL_DB_PASSWORD defaultValue: secret type: string description: Password for the database user. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_DB_PASSWORD is deprecated because the owncloudsql + driver is deprecated. USERS_OWNCLOUDSQL_DB_PORT: name: USERS_OWNCLOUDSQL_DB_PORT defaultValue: "3306" type: int description: Network port to use for the database connection. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_DB_PORT is deprecated because the owncloudsql + driver is deprecated. USERS_OWNCLOUDSQL_DB_USERNAME: name: USERS_OWNCLOUDSQL_DB_USERNAME defaultValue: owncloud type: string description: Database user to use for authenticating with the owncloud database. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_DB_USERNAME is deprecated because the owncloudsql + driver is deprecated. USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH: name: USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH defaultValue: "false" @@ -17010,9 +18406,10 @@ USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH: description: Allow 'medial search' when searching for users instead of just doing a prefix search. This allows finding 'Alice' when searching for 'lic'. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH is deprecated because the + owncloudsql driver is deprecated. USERS_OWNCLOUDSQL_IDP: name: USERS_OWNCLOUDSQL_IDP defaultValue: https://localhost:9200 @@ -17020,36 +18417,40 @@ USERS_OWNCLOUDSQL_IDP: description: The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_IDP is deprecated because the owncloudsql driver + is deprecated. USERS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID: name: USERS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID defaultValue: "false" type: bool description: Join the user properties table to read user IDs. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID is deprecated because the + owncloudsql driver is deprecated. USERS_OWNCLOUDSQL_JOIN_USERNAME: name: USERS_OWNCLOUDSQL_JOIN_USERNAME defaultValue: "false" type: bool description: Join the user properties table to read usernames introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_JOIN_USERNAME is deprecated because the owncloudsql + driver is deprecated. USERS_OWNCLOUDSQL_NOBODY: name: USERS_OWNCLOUDSQL_NOBODY defaultValue: "90" type: int64 description: Fallback number if no numeric UID and GID properties are provided. introductionVersion: pre5.0 - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + deprecationVersion: 8.2.0 + removalVersion: 9.0.0 + deprecationInfo: USERS_OWNCLOUDSQL_NOBODY is deprecated because the owncloudsql + driver is deprecated. USERS_SKIP_USER_GROUPS_IN_TOKEN: name: USERS_SKIP_USER_GROUPS_IN_TOKEN defaultValue: "false" diff --git a/content/ocis/9.0/services/persistent_files/extended_vars.yaml b/content/ocis/9.0/services/persistent_files/extended_vars.yaml index a4102a53..4af2ad18 100644 --- a/content/ocis/9.0/services/persistent_files/extended_vars.yaml +++ b/content/ocis/9.0/services/persistent_files/extended_vars.yaml @@ -31,16 +31,6 @@ variables: default_value: "" description: ignored intentionally do_ignore: true -- rawname: _serverMaxConnectionAgeEnv - path: ../../ocis/ocis-pkg/service/grpc/keepalive.go:19 - foundincode: true - name: GRPC_MAX_CONNECTION_AGE - type: Duration - default_value: "9223372036854775807" - description: Timeout for GRPC connections. After timeout, a new connection will - be established automatically. The default value is in ns and is about 2.5 mio - h. - do_ignore: false - rawname: MICRO_LOG_LEVEL path: ../../ocis/ocis-pkg/log/log.go:34 foundincode: true @@ -109,7 +99,7 @@ variables: description: '''true'' or ''false'', defaults to false' do_ignore: false - rawname: _registryTLSInsecureEnv - path: ../../ocis/ocis-pkg/natsjsregistry/registry.go:256 + path: ../../ocis/ocis-pkg/natsjsregistry/registry.go:258 foundincode: true name: MICRO_REGISTRY_TLS_INSECURE type: string @@ -119,7 +109,7 @@ variables: of the NATS server. Use it only for testing with self-signed certificates.' do_ignore: false - rawname: _registryTLSRootCAEnv - path: ../../ocis/ocis-pkg/natsjsregistry/registry.go:257 + path: ../../ocis/ocis-pkg/natsjsregistry/registry.go:259 foundincode: true name: MICRO_REGISTRY_TLS_ROOT_CA_CERTIFICATE type: string @@ -155,7 +145,7 @@ variables: section in the documentation for more details on defaults. do_ignore: false - rawname: OCIS_INSECURE - path: ../../ocis/ocis-pkg/service/grpc/client.go:79 + path: ../../ocis/ocis-pkg/service/grpc/client.go:101 foundincode: true name: OCIS_INSECURE type: bool @@ -163,14 +153,6 @@ variables: description: Insecure TLS mode is only allowed in development environments with OCIS_INSECURE=true do_ignore: false -- rawname: OCIS_INSECURE - path: ../../ocis/services/idp/pkg/service/v0/service.go:366 - foundincode: false - name: OCIS_INSECURE - type: "" - default_value: "" - description: OCIS_INSECURE - do_ignore: true - rawname: OCIS_INSECURE path: ../../ocis/services/idp/pkg/service/v0/service.go:367 foundincode: true @@ -180,7 +162,7 @@ variables: description: "" do_ignore: true - rawname: OCIS_LOG_LEVEL - path: ../../ocis/services/graph/pkg/identity/ldap_integration_test.go:132 + path: ../../ocis/services/graph/pkg/identity/ldap_integration_test.go:151 foundincode: true name: OCIS_LOG_LEVEL type: "" diff --git a/content/ocis/AGENTS.md b/content/ocis/AGENTS.md index 3d72e9f6..a6ca0f3c 100644 --- a/content/ocis/AGENTS.md +++ b/content/ocis/AGENTS.md @@ -2,6 +2,34 @@ Agent guidelines specific to the oCIS component (developer service pages, Collector and Swagger UI). Applies to every oCIS version directory. Loaded on demand; repo-wide rules live in the root `AGENTS.md`, content-authoring rules in `content/AGENTS.md`. +## Running a Throwaway oCIS Container for CLI Help + +When you need to inspect a CLI command's help output for a specific oCIS version, run it directly in a throwaway container — no init step or volume needed: + +```bash +docker run --rm owncloud/ocis: --help +``` + +Replace `` with the target release (e.g. `8.2.2`, `9.0.0`). Check available tags at https://hub.docker.com/r/owncloud/ocis/tags. + +Top-level commands are reached directly (`ocis backup`, `ocis init`, …). Service commands are nested under the service name: + +```bash +# Top-level command +docker run --rm owncloud/ocis:8.2.2 backup --help + +# Service sub-command +docker run --rm owncloud/ocis:8.2.2 idm resetpassword --help +``` + +To list all available top-level commands for a version: + +```bash +docker run --rm owncloud/ocis: --help +``` + +This is a read-only, ephemeral operation: the container starts, prints help, and exits without touching any data. No volume, no init, no port mapping required. + ## Audit-Tracking Page Attributes Pages that contain content requiring periodic review (Mermaid diagrams, architecture descriptions, configuration examples) carry two tracking attributes in their document header: @@ -54,6 +82,20 @@ Every ADR page under `pages/ocis/adr/` must have its `:description:` attribute s Exception: if a status note is needed (e.g. superseded), keep it after the number: `ADR 3 (superseded by ADR-0017): ...` +## ocis_helpers Go Dependencies + +`ocis_helpers/go.mod` and `go.sum` track the Go dependencies required to build the helper against a specific ocis branch. These files do **not** need to be updated proactively or checked manually — `ocis_helpers` enforces it at runtime: if the current `go.mod` does not match what the targeted ocis branch requires, Go prints `go: updates to go.mod needed; to update it` and exits. When that message appears, run: + +```bash +cd ocis_helpers +go mod tidy +go build +``` + +Then commit all three changed files — `go.mod`, `go.sum`, and the rebuilt `ocis_helpers` binary — together with the other work for that version. + +The `tools.go` file must remain present. It declares the intermediate-code imports that `go mod tidy` would otherwise drop, which would cause every task using the generated code to fail. + ## Developer Service Pages The oCIS developer module (`content/ocis//modules/developer/`) has a specific structure and content rule for service pages. diff --git a/ocis_helpers/README.md b/ocis_helpers/README.md index 19d498c5..146359f6 100644 --- a/ocis_helpers/README.md +++ b/ocis_helpers/README.md @@ -28,6 +28,10 @@ The subfolders in `services` (see [Folder Structure](#folder-structure)) are the * [For the Docs Prerelease Version](#for-the-docs-prerelease-version) * [For any Other Version](#for-any-other-version) * [Envvar Delta File Creation](#envvar-delta-file-creation) + * [Troubleshooting](#troubleshooting) + * [Out-of-Scope introductionVersion in the deltas Task](#out-of-scope-introductionversion-in-the-deltas-task) + * [Broken Table Row in the deprecated File](#broken-table-row-in-the-deprecated-file) + * [Regenerating a Single Delta File Without Overwriting the Others](#regenerating-a-single-delta-file-without-overwriting-the-others) * [Development](#development) ## Prerequisites @@ -239,7 +243,7 @@ If the `extended_vars.yaml` file has been corrupted or accidentally deleted, it ## Helper Usage * Please note that the `ocis_helper` directory is part of the repo and generally available for all ocis versions to be processed. -* **IMPORTANT**: The version **folders** that you are working on must be the same in both the documentation and the ocis repository. **DO NOT MIX VERSION BRANCHES**.\ +* **IMPORTANT**: The version **folders** that you are working on must be the same in both the documentation and the **branches** in the ocis repository. **DO NOT MIX VERSIONS**.\ Examples: ``` docs ocis @@ -250,7 +254,7 @@ Examples: 8.3 stable-8.2 WRONG ``` -**First switch to the relevant branches in both repos. The versions must match!** +**First switch to the relevant branch in the ocis repo and use the version as option in the `ocis_helpers` command. The versions must match!** As there may be changes to Go dependencies during development or between versions, updating the Go dependencies may be necessary. When running `ocis_helpers `, you will be notified by the following message: `go: updates to go.mod needed; to update it`. Run `go mod tidy` to update the dependencies for this version. These changes are tracked and must be committed and merged for that version. This is one of the reasons why versions must match. @@ -351,6 +355,61 @@ To create the `added, deprecated and removed` environment variables adoc files f **Note that on any consecutive script run, any manual changes made are overwritten. You need to re-apply them!** +## Troubleshooting + +### Out-of-Scope introductionVersion in the deltas Task + +**When:** The `deltas` task reports one or more environment variables as out-of-scope, for example: + +``` +This additional out-of-scope envvars have been found in 9.0.0. +They may require fixing in ocis or extra excluded here: + +GATEWAY_PROVIDER_CACHE_DATABASE 9.0 +``` + +**Why:** The `introductionVersion` stored in the `env_vars.yaml` file for the target version does not match the `toVersion` set in `delta_config.yaml`. A common cause is that the ocis source used an informal two-part version string (e.g. `9.0`) instead of the required three-part SemVer (e.g. `9.0.0`) at the time the `services` task was last run. + +**Fix:** + +1. Verify the correct `introductionVersion` for the affected envvar in the oCIS repo (search in `services/*/pkg/config/`). If the value is wrong (e.g. `9.0` instead of `9.0.0`), create a fix PR against the relevant ocis stable branch, merge it, and rebase your local ocis branch. Note that the same fix may need to be applied to other branches as well, such as `master`, to keep them consistent. + +2. With the corrected oCIS branch checked out locally, run `ocis_helpers services`. The `services` task will regenerate `env_vars.yaml` and report any `introductionVersion` changes it detects: + + ``` + The introductionVersion of the following envvars changed in .../env_vars.yaml: + + GATEWAY_PROVIDER_CACHE_DATABASE "9.0" -> "9.0.0" + + Update these introductionVersion changes in .../env_vars.yaml? [Y/n]: + ``` + + Confirm with `Y` (the default) to accept the updated values. + +3. Re-run `ocis_helpers deltas`. The corrected envvars now carry the expected `introductionVersion` and appear in the added table instead of being reported as out-of-scope. + +### Broken Table Row in the deprecated File + +**When:** A global envvar (starting with `OCIS_`) in the deprecated output file renders as a broken table row — one entry spills across multiple cells. + +**Why:** Global envvars can be deprecated by more than one service, each supplying its own `deprecationInfo` text. These texts are stored concatenated with ` | ` as a separator. An unescaped `|` inside a table cell is interpreted by AsciiDoc as a cell boundary, which shifts all following cells and breaks the row layout. + +**Fix:** This is handled automatically by the `deltas` task since the introduction of pipe-guarding on the `deprecationInfo` field. The cell is truncated at the first unescaped `|` and the affected envvar is printed as a warning on the console so the shortened text can be reviewed. If you see this in an existing generated file, simply re-run the `deltas` task (or just the `deprecated` sub-task — see below) to regenerate it with the corrected output. + +### Regenerating a Single Delta File Without Overwriting the Others + +The `deltas` task accepts an optional sub-task argument to regenerate only one of the three output files: + +```bash +./ocis_helpers deltas added +./ocis_helpers deltas removed +./ocis_helpers deltas deprecated +``` + +When a sub-task is given, only that file is written; the other two files on disk are left untouched. This is useful when you have already manually post-processed one or more of the files (grouping entries, fixing service name placeholders) and only need to fix a single file without losing your edits. + +Without a sub-task argument all three files are regenerated, which is the default behaviour. + ## Development When developing `ocis_helpers`, run `go build` to create a new executable file and merge it to this repo. diff --git a/ocis_helpers/changed_envvars.go b/ocis_helpers/changed_envvars.go index 8669c261..07a958cb 100644 --- a/ocis_helpers/changed_envvars.go +++ b/ocis_helpers/changed_envvars.go @@ -119,15 +119,15 @@ var descriptionCut = []string{} // RenderEnvVarDeltas creates the added, deprecated and removed envvar tables // isDryrun is provided by the flag defined in 'main.go' -func RenderEnvVarDeltas(isDryrun bool) { +func RenderEnvVarDeltas(isDryrun bool, subTask string) { ReadEnv() fmt.Printf(Green+"Generate the added, deprecated and removed envvar .adoc tables from the %s files\n\n"+Reset, yamlServiceSource) - doEnvVarDeltas(isDryrun) + doEnvVarDeltas(isDryrun, subTask) RemoveOutputDir() } -func doEnvVarDeltas(isDryrun bool) { +func doEnvVarDeltas(isDryrun bool, subTask string) { cfg := getDeltaConfig() @@ -193,7 +193,8 @@ func doEnvVarDeltas(isDryrun bool) { // so the source can be checked and the shortened text reviewed in the generated file if len(descriptionCut) > 0 { fmt.Printf(Yellow+"\nThe description of the following envvars contained an unescaped pipe, " + - "it has been cut before its first appearance:\n\n" + Reset) + "it has been cut before its first appearance — " + + "global envvars can have one description per service, joined by ' | '; only the first is kept here:\n\n" + Reset) for _, key := range descriptionCut { fmt.Printf("%s\n", key) @@ -206,10 +207,15 @@ func doEnvVarDeltas(isDryrun bool) { return } - // write the variables to a file - writeOutput(cfg, a, "added") - writeOutput(cfg, r, "removed") - writeOutput(cfg, d, "deprecated") + // write the requested table(s); when no sub-task is given all three are written + writeRequested := func(content string, name string) { + if subTask == "" || subTask == name { + writeOutput(cfg, content, name) + } + } + writeRequested(a, "added") + writeRequested(r, "removed") + writeRequested(d, "deprecated") // print that we succeeded fmt.Printf("\nSuccess, see files created in: %s\n", deltaWriteDir(cfg)) @@ -396,24 +402,27 @@ func deltaWriteDir(cfg DeltaConfig) string { } // loadEnvVars reads an 'env_vars.yaml' file and keeps the order of its keys. -// the file is parsed twice, once for the key order and once for the values func loadEnvVars(path string) (*EnvVarList, error) { yfile, err := os.ReadFile(path) if err != nil { return nil, err } + return parseEnvVars(yfile) +} + +// parseEnvVars parses raw YAML bytes into an EnvVarList, preserving key order. +// the bytes are parsed twice: once for key order (yaml.MapSlice) and once for typed values. +func parseEnvVars(data []byte) (*EnvVarList, error) { // yaml.MapSlice keeps the order of the keys as they appear in the file var ordered yaml.MapSlice - err = yaml.Unmarshal(yfile, &ordered) - if err != nil { + if err := yaml.Unmarshal(data, &ordered); err != nil { return nil, err } list := newEnvVarList(len(ordered)) - err = yaml.Unmarshal(yfile, &list.values) - if err != nil { + if err := yaml.Unmarshal(data, &list.values); err != nil { return nil, err } @@ -562,7 +571,10 @@ func createTable(typeText string, source *EnvVarList, fromVersion string, toVers } if isDeprecated { - b.WriteString(addAdocLine2(service, key, description, value.RemovalVersion, value.DeprecationInfo)) + // a pipe in deprecationInfo (from multiple services with different texts) would + // break the table just like it does in the description — guard it the same way + deprecationInfo := cutAtUnescapedPipe(key, value.DeprecationInfo) + b.WriteString(addAdocLine2(service, key, description, value.RemovalVersion, deprecationInfo)) } else { b.WriteString(addAdocLine1(service, key, description, value.DefaultValue)) } diff --git a/ocis_helpers/extended_vars.yaml.do_not_delete b/ocis_helpers/extended_vars.yaml.do_not_delete index f0a34c4a..4af2ad18 100644 --- a/ocis_helpers/extended_vars.yaml.do_not_delete +++ b/ocis_helpers/extended_vars.yaml.do_not_delete @@ -4,7 +4,7 @@ variables: foundincode: true name: CS3_GATEWAY type: "" - default_value: "ignored intentionally" + default_value: ignored intentionally description: "" do_ignore: true - rawname: CS3_MACHINE_AUTH_API_KEY @@ -13,7 +13,7 @@ variables: name: CS3_MACHINE_AUTH_API_KEY type: "" default_value: "" - description: "ignored intentionally" + description: ignored intentionally do_ignore: true - rawname: _registryRegisterIntervalEnv path: ../../ocis/ocis-pkg/registry/expiry.go:19 @@ -21,7 +21,7 @@ variables: name: EXPERIMENTAL_REGISTER_INTERVAL type: "" default_value: "" - description: "ignored intentionally" + description: ignored intentionally do_ignore: true - rawname: _registryRegisterTTLEnv path: ../../ocis/ocis-pkg/registry/expiry.go:28 @@ -29,18 +29,8 @@ variables: name: EXPERIMENTAL_REGISTER_TTL type: "" default_value: "" - description: "ignored intentionally" + description: ignored intentionally do_ignore: true -- rawname: _serverMaxConnectionAgeEnv - path: ../../ocis/ocis-pkg/service/grpc/keepalive.go:19 - foundincode: true - name: GRPC_MAX_CONNECTION_AGE - type: Duration - default_value: "9223372036854775807" - description: Timeout for GRPC connections. After timeout, a new connection will - be established automatically. The default value is in ns and is about 2.5 mio - h. - do_ignore: false - rawname: MICRO_LOG_LEVEL path: ../../ocis/ocis-pkg/log/log.go:34 foundincode: true @@ -109,7 +99,7 @@ variables: description: '''true'' or ''false'', defaults to false' do_ignore: false - rawname: _registryTLSInsecureEnv - path: ../../ocis/ocis-pkg/natsjsregistry/registry.go:256 + path: ../../ocis/ocis-pkg/natsjsregistry/registry.go:258 foundincode: true name: MICRO_REGISTRY_TLS_INSECURE type: string @@ -119,12 +109,12 @@ variables: of the NATS server. Use it only for testing with self-signed certificates.' do_ignore: false - rawname: _registryTLSRootCAEnv - path: ../../ocis/ocis-pkg/natsjsregistry/registry.go:257 + path: ../../ocis/ocis-pkg/natsjsregistry/registry.go:259 foundincode: true name: MICRO_REGISTRY_TLS_ROOT_CA_CERTIFICATE type: string default_value: "" - description: 'The Micro Registry TLS root CA certificate' + description: The Micro Registry TLS root CA certificate do_ignore: false - rawname: OCIS_BASE_DATA_PATH path: ../../ocis/ocis-pkg/config/defaults/paths.go:23 @@ -142,7 +132,7 @@ variables: foundincode: true name: OCIS_BASE_DATA_PATH type: "" - default_value: "dupe of OCIS_BASE_DATA_PATH" + default_value: dupe of OCIS_BASE_DATA_PATH description: "" do_ignore: true - rawname: OCIS_CONFIG_DIR @@ -155,7 +145,7 @@ variables: section in the documentation for more details on defaults. do_ignore: false - rawname: OCIS_INSECURE - path: ../../ocis/ocis-pkg/service/grpc/client.go:79 + path: ../../ocis/ocis-pkg/service/grpc/client.go:101 foundincode: true name: OCIS_INSECURE type: bool @@ -163,29 +153,21 @@ variables: description: Insecure TLS mode is only allowed in development environments with OCIS_INSECURE=true do_ignore: false -- rawname: OCIS_INSECURE - path: ../../ocis/services/idp/pkg/service/v0/service.go:366 - foundincode: false - name: OCIS_INSECURE - type: "" - default_value: "" - description: "OCIS_INSECURE" - do_ignore: true - rawname: OCIS_INSECURE path: ../../ocis/services/idp/pkg/service/v0/service.go:367 foundincode: true name: OCIS_INSECURE type: "" - default_value: "dupe of OCIS_INSECURE" + default_value: dupe of OCIS_INSECURE description: "" do_ignore: true - rawname: OCIS_LOG_LEVEL - path: ../../ocis/services/graph/pkg/identity/ldap_integration_test.go:132 + path: ../../ocis/services/graph/pkg/identity/ldap_integration_test.go:151 foundincode: true name: OCIS_LOG_LEVEL type: "" default_value: "" - description: "ignored intentionally" + description: ignored intentionally do_ignore: true - rawname: parts[0] path: ../../ocis/ocis-pkg/config/envdecode/envdecode.go:396 @@ -195,4 +177,3 @@ variables: default_value: "" description: false positive - code that extract envvars for config structs do_ignore: true - diff --git a/ocis_helpers/extractor_service_env.go b/ocis_helpers/extractor_service_env.go index 7eab2334..2b24e2f7 100644 --- a/ocis_helpers/extractor_service_env.go +++ b/ocis_helpers/extractor_service_env.go @@ -11,12 +11,23 @@ import ( "text/template" ) -// Render the envvars that origin in services +// Render the envvars that origin in services func RenderServices() { ReadEnv() fmt.Printf(Green + "Generate envvar .adoc tables and yaml examples from services and the %s file\n\n" + Reset, yamlServiceSource) + + // save the current env_vars.yaml before it gets overwritten so we can compare afterwards + envVarsFilePath := filepath.Join(Env.services_dir, persistent_files, yamlServiceSource) + oldContent, oldErr := os.ReadFile(envVarsFilePath) + doTemplates() + + // report any introductionVersion changes between the old and newly written file + if oldErr == nil { + reportIntroVersionChanges(envVarsFilePath, oldContent) + } + RemoveOutputDir() } @@ -115,3 +126,58 @@ func runIntermediateCode(intermediateCodePath string) { } fmt.Println(string(out)) } + +// reportIntroVersionChanges compares the introductionVersion of each envvar in the +// newly written env_vars.yaml against the content saved before the services run. +// If any values changed they are shown and the user is asked to keep or revert them. +func reportIntroVersionChanges(envVarsPath string, oldContent []byte) { + + oldList, err := parseEnvVars(oldContent) + if err != nil { + fmt.Printf(Yellow + "Could not parse previous env_vars.yaml for comparison: %v\n\n" + Reset, err) + return + } + newList, err := loadEnvVars(envVarsPath) + if err != nil { + fmt.Printf(Yellow + "Could not read new env_vars.yaml for comparison: %v\n\n" + Reset, err) + return + } + + type change struct { + key string + oldVer string + newVer string + } + var changes []change + for _, key := range newList.keys { + newVal := newList.values[key] + if oldVal, ok := oldList.values[key]; ok { + if oldVal.IntroductionVersion != newVal.IntroductionVersion { + changes = append(changes, change{key, oldVal.IntroductionVersion, newVal.IntroductionVersion}) + } + } + } + + if len(changes) == 0 { + return + } + + fmt.Printf(Yellow + "\nThe introductionVersion of the following envvars changed in %s:\n\n" + Reset, envVarsPath) + for _, c := range changes { + fmt.Printf(" %-60s %q -> %q\n", c.key, c.oldVer, c.newVer) + } + + fmt.Printf("\nUpdate these introductionVersion changes in %s? [Y/n]: ", envVarsPath) + var answer string + fmt.Scanln(&answer) + + if strings.ToLower(strings.TrimSpace(answer)) == "n" { + if err := os.WriteFile(envVarsPath, oldContent, Env.file_mode); err != nil { + fmt.Printf(Red + "Failed to revert %s: %v\n\n" + Reset, envVarsPath, err) + } else { + fmt.Printf(Green + "Reverted %s to its previous state.\n\n" + Reset, envVarsPath) + } + } else { + fmt.Printf(Green + "Updated the introductionVersion values in %s.\n\n" + Reset, envVarsPath) + } +} diff --git a/ocis_helpers/go.mod b/ocis_helpers/go.mod index 15eb5b93..38d07e20 100644 --- a/ocis_helpers/go.mod +++ b/ocis_helpers/go.mod @@ -2,26 +2,53 @@ module main/ocis_helpers // module github.com/owncloud/ocis/v2 -go 1.26.0 +go 1.26.10 replace github.com/owncloud/ocis/v2 => ../../ocis +replace github.com/studio-b12/gowebdav => github.com/kobergj/gowebdav v0.0.0-20251030165916-532350997dde + +replace github.com/egirna/icap-client => github.com/kobergj/icap-client v0.0.0-20250116172800-8eaa5022532b + +replace github.com/unrolled/secure => github.com/DeepDiver1975/secure v0.0.0-20240611112133-abc838fb797c + +replace github.com/go-micro/plugins/v4/store/nats-js-kv => github.com/kobergj/plugins/v4/store/nats-js-kv v0.0.0-20261030085317-811a2ded849b + +replace github.com/go-micro/plugins/v4/events/natsjs => github.com/kobergj/plugins/v4/events/natsjs v1.2.1-0.20261030085317-811a2ded849b + +replace go-micro.dev/v4 => github.com/kobergj/go-micro/v4 v4.0.0-20250610135441-d0b187215699 + require ( github.com/owncloud/ocis/v2 v2.0.1-0.20250122072425-665072d86d1a gopkg.in/yaml.v2 v2.4.0 ) require ( + dario.cat/mergo v1.0.2 // indirect github.com/Azure/go-ntlmssp v0.1.1 // indirect github.com/KimMachineGun/automemlimit v0.7.5 // indirect github.com/Masterminds/semver v1.5.0 // indirect github.com/MicahParks/keyfunc/v2 v2.1.0 // indirect + github.com/Microsoft/go-winio v0.6.2 // indirect + github.com/ProtonMail/go-crypto v1.1.6 // indirect github.com/ajg/form v1.5.1 // indirect + github.com/armon/go-radix v1.0.0 // indirect github.com/beorn7/perks v1.0.1 // indirect + github.com/bitly/go-simplejson v0.5.0 // indirect + github.com/bmizerany/assert v0.0.0-20160611221934-b7ed37b82869 // indirect + github.com/cenkalti/backoff v2.2.1+incompatible // indirect github.com/cenkalti/backoff/v5 v5.0.3 // indirect github.com/cespare/xxhash/v2 v2.3.0 // indirect - github.com/coreos/go-oidc/v3 v3.20.0 // indirect + github.com/cloudflare/circl v1.6.3 // indirect + github.com/coreos/go-oidc/v3 v3.21.0 // indirect + github.com/coreos/go-semver v0.3.1 // indirect + github.com/coreos/go-systemd/v22 v22.7.0 // indirect + github.com/cornelk/hashmap v1.0.8 // indirect + github.com/cpuguy83/go-md2man/v2 v2.0.7 // indirect github.com/cs3org/go-cs3apis v0.0.0-20241105092511-3ad35d174fc1 // indirect + github.com/cyphar/filepath-securejoin v0.6.1 // indirect + github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect + github.com/emirpasic/gods v1.18.1 // indirect github.com/evanphx/json-patch/v5 v5.5.0 // indirect github.com/fatih/color v1.19.0 // indirect github.com/felixge/httpsnoop v1.1.0 // indirect @@ -31,70 +58,101 @@ require ( github.com/go-chi/chi/v5 v5.4.0 // indirect github.com/go-chi/httprate v0.16.0 // indirect github.com/go-chi/render v1.0.3 // indirect + github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect + github.com/go-git/go-billy/v5 v5.9.0 // indirect + github.com/go-git/go-git/v5 v5.19.2 // indirect github.com/go-jose/go-jose/v4 v4.1.6 // indirect github.com/go-ldap/ldap/v3 v3.4.14 // indirect github.com/go-logr/logr v1.4.4 // indirect github.com/go-logr/stdr v1.2.2 // indirect + github.com/go-micro/plugins/v4/events/natsjs v1.2.2 // indirect github.com/go-micro/plugins/v4/logger/zerolog v1.2.0 // indirect + github.com/go-micro/plugins/v4/store/nats-js v1.2.1 // indirect + github.com/go-micro/plugins/v4/store/nats-js-kv v0.0.0-20240726082623-6831adfdcdc4 // indirect + github.com/go-micro/plugins/v4/store/redis v1.2.1 // indirect + github.com/go-redis/redis/v8 v8.11.5 // indirect github.com/gobwas/httphead v0.1.0 // indirect github.com/gobwas/pool v0.2.1 // indirect github.com/gobwas/ws v1.2.1 // indirect github.com/golang-jwt/jwt/v5 v5.3.1 // indirect + github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect github.com/golang/protobuf v1.5.4 // indirect github.com/google/uuid v1.6.0 // indirect github.com/gorilla/handlers v1.5.1 // indirect - github.com/grpc-ecosystem/grpc-gateway/v2 v2.30.0 // indirect + github.com/grpc-ecosystem/grpc-gateway/v2 v2.31.0 // indirect github.com/hashicorp/go-hclog v1.6.3 // indirect github.com/hashicorp/go-plugin v1.8.0 // indirect github.com/hashicorp/yamux v0.1.2 // indirect - github.com/klauspost/cpuid/v2 v2.3.0 // indirect + github.com/imdario/mergo v0.3.15 // indirect + github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect + github.com/kevinburke/ssh_config v1.2.0 // indirect + github.com/klauspost/compress v1.20.2 // indirect + github.com/klauspost/cpuid/v2 v2.4.0 // indirect github.com/leonelquinteros/gotext v1.7.2 // indirect - github.com/mattn/go-colorable v0.1.14 // indirect - github.com/mattn/go-isatty v0.0.21 // indirect + github.com/mattn/go-colorable v0.1.15 // indirect + github.com/mattn/go-isatty v0.0.22 // indirect github.com/miekg/dns v1.1.72 // indirect github.com/mileusna/useragent v1.3.5 // indirect github.com/mitchellh/mapstructure v1.5.0 // indirect github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect + github.com/nats-io/jwt/v2 v2.8.2 // indirect + github.com/nats-io/nats.go v1.54.0 // indirect + github.com/nats-io/nkeys v0.4.16 // indirect + github.com/nats-io/nuid v1.0.1 // indirect + github.com/nxadm/tail v1.4.8 // indirect github.com/oklog/run v1.2.0 // indirect github.com/owncloud/libre-graph-api-go v1.0.5-0.20260216101009-eeac018af245 // indirect - github.com/owncloud/reva/v2 v2.0.0-20260813121157-d386075a0421 // indirect + github.com/owncloud/reva/v2 v2.0.0-20261111080110-3e71db9f7bf2 // indirect github.com/oxtoacart/bpool v0.0.0-20190530202638-03653db5a59c // indirect github.com/patrickmn/go-cache v2.1.0+incompatible // indirect github.com/pbnjay/memory v0.0.0-20210728143218-7b4eea64cf58 // indirect + github.com/pjbgf/sha1cd v0.6.0 // indirect github.com/pkg/errors v0.9.1 // indirect github.com/prometheus/client_golang v1.24.1 // indirect - github.com/prometheus/client_model v0.6.2 // indirect + github.com/prometheus/client_model v0.6.3 // indirect github.com/prometheus/common v0.70.1 // indirect github.com/prometheus/procfs v0.21.1 // indirect github.com/rs/cors v1.11.1 // indirect github.com/rs/zerolog v1.35.1 // indirect + github.com/russross/blackfriday/v2 v2.1.0 // indirect github.com/sercand/kuberesolver/v5 v5.1.1 // indirect - github.com/sirupsen/logrus v1.10.0 // indirect - github.com/tus/tusd/v2 v2.10.0 // indirect + github.com/sergi/go-diff v1.4.0 // indirect + github.com/sirupsen/logrus v1.10.2 // indirect + github.com/skeema/knownhosts v1.3.1 // indirect + github.com/urfave/cli/v2 v2.27.7 // indirect + github.com/xanzy/ssh-agent v0.3.3 // indirect + github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 // indirect github.com/zeebo/xxh3 v1.1.0 // indirect go-micro.dev/v4 v4.11.0 // indirect + go.etcd.io/etcd/api/v3 v3.7.2 // indirect + go.etcd.io/etcd/client/pkg/v3 v3.7.2 // indirect + go.etcd.io/etcd/client/v3 v3.7.2 // indirect go.opentelemetry.io/auto/sdk v1.2.1 // indirect - go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.70.0 // indirect - go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.70.0 // indirect + go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.72.0 // indirect + go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.71.0 // indirect go.opentelemetry.io/otel v1.47.0 // indirect go.opentelemetry.io/otel/exporters/jaeger v1.17.0 // indirect - go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.45.0 // indirect - go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.45.0 // indirect + go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.47.0 // indirect + go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.47.0 // indirect + go.opentelemetry.io/otel/log v1.47.0 // indirect go.opentelemetry.io/otel/metric v1.47.0 // indirect go.opentelemetry.io/otel/sdk v1.47.0 // indirect go.opentelemetry.io/otel/trace v1.47.0 // indirect go.opentelemetry.io/proto/otlp v1.11.0 // indirect - golang.org/x/crypto v0.55.0 // indirect - golang.org/x/exp v0.0.0-20260410095643-746e56fc9e2f // indirect - golang.org/x/mod v0.40.0 // indirect - golang.org/x/net v0.58.0 // indirect - golang.org/x/oauth2 v0.36.0 // indirect - golang.org/x/sync v0.22.0 // indirect - golang.org/x/sys v0.48.0 // indirect - golang.org/x/text v0.41.0 // indirect - golang.org/x/tools v0.49.0 // indirect - google.golang.org/genproto/googleapis/api v0.0.0-20260803160001-6ac0973c030d // indirect - google.golang.org/genproto/googleapis/rpc v0.0.0-20260803160001-6ac0973c030d // indirect - google.golang.org/grpc v1.83.2 // indirect + go.uber.org/multierr v1.11.0 // indirect + go.uber.org/zap v1.27.1 // indirect + golang.org/x/crypto v0.58.0 // indirect + golang.org/x/mod v0.41.0 // indirect + golang.org/x/net v0.62.0 // indirect + golang.org/x/oauth2 v0.37.0 // indirect + golang.org/x/sync v0.24.0 // indirect + golang.org/x/sys v0.49.0 // indirect + golang.org/x/text v0.43.0 // indirect + golang.org/x/tools v0.51.0 // indirect + google.golang.org/genproto/googleapis/api v0.0.0-20260928230214-8a89bd6388cc // indirect + google.golang.org/genproto/googleapis/rpc v0.0.0-20260928230214-8a89bd6388cc // indirect + google.golang.org/grpc v1.86.0-dev // indirect google.golang.org/protobuf v1.36.12 // indirect + gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 // indirect + gopkg.in/warnings.v0 v0.1.2 // indirect ) diff --git a/ocis_helpers/go.sum b/ocis_helpers/go.sum index acf93730..fd0b0fb4 100644 --- a/ocis_helpers/go.sum +++ b/ocis_helpers/go.sum @@ -1,5 +1,5 @@ -github.com/Acconut/go-httptest-recorder v1.0.0 h1:TAv2dfnqp/l+SUvIaMAUK4GeN4+wqb6KZsFFFTGhoJg= -github.com/Acconut/go-httptest-recorder v1.0.0/go.mod h1:CwQyhTH1kq/gLyWiRieo7c0uokpu3PXeyF/nZjUNtmM= +dario.cat/mergo v1.0.2 h1:85+piFYR1tMbRrLcDwR18y4UKJ3aH1Tbzi24VRW1TK8= +dario.cat/mergo v1.0.2/go.mod h1:E/hbnu0NxMFBjpMIE34DRGLWqDy0g5FuKDhCb31ngxA= github.com/Azure/go-ntlmssp v0.1.1 h1:l+FM/EEMb0U9QZE7mKNEDw5Mu3mFiaa2GKOoTSsNDPw= github.com/Azure/go-ntlmssp v0.1.1/go.mod h1:NYqdhxd/8aAct/s4qSYZEerdPuH1liG2/X9DiVTbhpk= github.com/KimMachineGun/automemlimit v0.7.5 h1:RkbaC0MwhjL1ZuBKunGDjE/ggwAX43DwZrJqVwyveTk= @@ -10,26 +10,61 @@ github.com/Masterminds/semver/v3 v3.5.0 h1:kQceYJfbupGfZOKZQg0kou0DgAKhzDg2NZPAw github.com/Masterminds/semver/v3 v3.5.0/go.mod h1:4V+yj/TJE1HU9XfppCwVMZq3I84lprf4nC11bSS5beM= github.com/MicahParks/keyfunc/v2 v2.1.0 h1:6ZXKb9Rp6qp1bDbJefnG7cTH8yMN1IC/4nf+GVjO99k= github.com/MicahParks/keyfunc/v2 v2.1.0/go.mod h1:rW42fi+xgLJ2FRRXAfNx9ZA8WpD4OeE/yHVMteCkw9k= +github.com/Microsoft/go-winio v0.5.2/go.mod h1:WpS1mjBmmwHBEWmogvA2mj8546UReBk4v8QkMxJ6pZY= +github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY= +github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU= +github.com/ProtonMail/go-crypto v1.1.6 h1:ZcV+Ropw6Qn0AX9brlQLAUXfqLBc7Bl+f/DmNxpLfdw= +github.com/ProtonMail/go-crypto v1.1.6/go.mod h1:rA3QumHc/FZ8pAHreoekgiAbzpNsfQAosU5td4SnOrE= github.com/ajg/form v1.5.1 h1:t9c7v8JUKu/XxOGBU0yjNpaMloxGEJhUkqFRq0ibGeU= github.com/ajg/form v1.5.1/go.mod h1:uL1WgH+h2mgNtvBq0339dVnzXdBETtL2LeUXaIv25UY= github.com/alexbrainman/sspi v0.0.0-20250919150558-7d374ff0d59e h1:4dAU9FXIyQktpoUAgOJK3OTFc/xug0PCXYCqU0FgDKI= github.com/alexbrainman/sspi v0.0.0-20250919150558-7d374ff0d59e/go.mod h1:cEWa1LVoE5KvSD9ONXsZrj0z6KqySlCCNKHlLzbqAt4= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4= +github.com/antithesishq/antithesis-sdk-go v0.8.0-default-no-op h1:1BOWQJweNyvZMlpAHXGLiZQn9S+QXGcz3xh94lC0w6E= +github.com/antithesishq/antithesis-sdk-go v0.8.0-default-no-op/go.mod h1:FQyySiasQQM8735Ddel3MRojmy4dA1IqCeyJ5jmPMbI= +github.com/armon/go-radix v1.0.0 h1:F4z6KzEeeQIMeLFa97iZU6vupzoecKdU5TX24SNppXI= +github.com/armon/go-radix v1.0.0/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM= github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw= +github.com/bitly/go-simplejson v0.5.0 h1:6IH+V8/tVMab511d5bn4M7EwGXZf9Hj6i2xSwkNEM+Y= +github.com/bitly/go-simplejson v0.5.0/go.mod h1:cXHtHw4XUPsvGaxgjIAn8PhEWG9NfngEKAMDJEczWVA= +github.com/bmizerany/assert v0.0.0-20160611221934-b7ed37b82869 h1:DDGfHa7BWjL4YnC6+E63dPcxHo2sUxDIu8g3QgEJdRY= +github.com/bmizerany/assert v0.0.0-20160611221934-b7ed37b82869/go.mod h1:Ekp36dRnpXw/yCqJaO+ZrUyxD+3VXMFFr56k5XYrpB4= github.com/bufbuild/protocompile v0.14.1 h1:iA73zAf/fyljNjQKwYzUHD6AD4R8KMasmwa/FBatYVw= github.com/bufbuild/protocompile v0.14.1/go.mod h1:ppVdAIhbr2H8asPk6k4pY7t9zB1OU5DoEw9xY/FUi1c= +github.com/cenkalti/backoff v2.2.1+incompatible h1:tNowT99t7UNflLxfYYSlKYsBpXdEet03Pg2g16Swow4= +github.com/cenkalti/backoff v2.2.1+incompatible/go.mod h1:90ReRw6GdpyfrHakVjL/QHaoyV4aDUVVkXQJJJ3NXXM= github.com/cenkalti/backoff/v5 v5.0.3 h1:ZN+IMa753KfX5hd8vVaMixjnqRZ3y8CuJKRKj1xcsSM= github.com/cenkalti/backoff/v5 v5.0.3/go.mod h1:rkhZdG3JZukswDf7f0cwqPNk4K0sa+F97BxZthm/crw= github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs= github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs= -github.com/coreos/go-oidc/v3 v3.20.0 h1:EtE0WIBHk03N+DqGkY4+UONzzZHk7amKt6IyNd7OsZE= -github.com/coreos/go-oidc/v3 v3.20.0/go.mod h1:DYCf24+ncYi+XkIH97GY1+dqoRlbaSI26KVTCI9SrY4= +github.com/cloudflare/circl v1.6.3 h1:9GPOhQGF9MCYUeXyMYlqTR6a5gTrgR/fBLXvUgtVcg8= +github.com/cloudflare/circl v1.6.3/go.mod h1:2eXP6Qfat4O/Yhh8BznvKnJ+uzEoTQ6jVKJRn81BiS4= +github.com/coreos/go-oidc/v3 v3.21.0 h1:wZo4Q9Pum8dYEj0eMUPrqR+kvuGkeUplbLpNCkBqoWM= +github.com/coreos/go-oidc/v3 v3.21.0/go.mod h1:DYCf24+ncYi+XkIH97GY1+dqoRlbaSI26KVTCI9SrY4= +github.com/coreos/go-semver v0.3.1 h1:yi21YpKnrx1gt5R+la8n5WgS0kCrsPp33dmEyHReZr4= +github.com/coreos/go-semver v0.3.1/go.mod h1:irMmmIw/7yzSRPWryHsK7EYSg09caPQL03VsM8rvUec= +github.com/coreos/go-systemd/v22 v22.7.0 h1:LAEzFkke61DFROc7zNLX/WA2i5J8gYqe0rSj9KI28KA= +github.com/coreos/go-systemd/v22 v22.7.0/go.mod h1:xNUYtjHu2EDXbsxz1i41wouACIwT7Ybq9o0BQhMwD0w= +github.com/cornelk/hashmap v1.0.8 h1:nv0AWgw02n+iDcawr5It4CjQIAcdMMKRrs10HOJYlrc= +github.com/cornelk/hashmap v1.0.8/go.mod h1:RfZb7JO3RviW/rT6emczVuC/oxpdz4UsSB2LJSclR1k= +github.com/cpuguy83/go-md2man/v2 v2.0.7 h1:zbFlGlXEAKlwXpmvle3d8Oe3YnkKIK4xSRTd3sHPnBo= +github.com/cpuguy83/go-md2man/v2 v2.0.7/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g= github.com/cs3org/go-cs3apis v0.0.0-20241105092511-3ad35d174fc1 h1:RU6LT6mkD16xZs011+8foU7T3LrPvTTSWeTQ9OgfhkA= github.com/cs3org/go-cs3apis v0.0.0-20241105092511-3ad35d174fc1/go.mod h1:DedpcqXl193qF/08Y04IO0PpxyyMu8+GrkD6kWK2MEQ= +github.com/cyphar/filepath-securejoin v0.6.1 h1:5CeZ1jPXEiYt3+Z6zqprSAgSWiggmpVyciv8syjIpVE= +github.com/cyphar/filepath-securejoin v0.6.1/go.mod h1:A8hd4EnAeyujCJRrICiOWqjS1AX0a9kM5XL+NwKoYSc= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= -github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM= -github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78= +github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f/go.mod h1:cuUVRXasLTGF7a8hSLbxyZXjz+1KgoB3wDUb6vlszIc= +github.com/elazarl/goproxy v1.7.2 h1:Y2o6urb7Eule09PjlhQRGNsqRfPmYI3KKQLFpCAV3+o= +github.com/elazarl/goproxy v1.7.2/go.mod h1:82vkLNir0ALaW14Rc399OTTjyNREgmdL2cVoIbS6XaE= +github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc= +github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= github.com/evanphx/json-patch/v5 v5.5.0 h1:bAmFiUJ+o0o2B4OiTFeE3MqCOtyo+jjPP9iZ0VRxYUc= github.com/evanphx/json-patch/v5 v5.5.0/go.mod h1:G79N1coSVB93tBe7j6PhzjmR3/2VvlbKOFpnXhI9Bw4= github.com/fatih/color v1.13.0/go.mod h1:kLAiJbzzSOZDVNGyDpeOxJ47H46qBXwg5ILebYFFOfk= @@ -38,22 +73,29 @@ github.com/fatih/color v1.19.0/go.mod h1:zNk67I0ZUT1bEGsSGyCZYZNrHuTkJJB+r6Q9VuM github.com/felixge/httpsnoop v1.0.1/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U= github.com/felixge/httpsnoop v1.1.0 h1:3YtUj32ZZkqZtt3sZZsClsymw/QDuVfpNhoA31zeORc= github.com/felixge/httpsnoop v1.1.0/go.mod h1:Zqxgdd+1Rkcz8euOqdr7lqgCRJztwr5hp9vDSi5UZCE= +github.com/fsnotify/fsnotify v1.4.9/go.mod h1:znqG4EE+3YCdAaPaxE2ZRY/06pZUdp0tY4IgpuI1SZQ= github.com/fsnotify/fsnotify v1.10.1 h1:b0/UzAf9yR5rhf3RPm9gf3ehBPpf0oZKIjtpKrx59Ho= github.com/fsnotify/fsnotify v1.10.1/go.mod h1:TLheqan6HD6GBK6PrDWyDPBaEV8LspOxvPSjC+bVfgo= +github.com/gliderlabs/ssh v0.3.8 h1:a4YXD1V7xMF9g5nTkdfnja3Sxy1PVDCj1Zg4Wb8vY6c= +github.com/gliderlabs/ssh v0.3.8/go.mod h1:xYoytBv1sV0aL3CavoDuJIQNURXkkfPA/wxQ1pL1fAU= github.com/go-acme/lego/v4 v4.34.0 h1:oRsIuPJ4ORX7ufviXvelUpBSez2XxeKGwo5pNG9BVeY= github.com/go-acme/lego/v4 v4.34.0/go.mod h1:gsmdlx/ZS6OUeXbOj0U+VnCLLfEFj4WCYRkcGpZw+pc= github.com/go-asn1-ber/asn1-ber v1.5.8 h1:H9AZkK22UOmfX8J84ubyaZxKJZ3FMHVwn8swoMML7iQ= github.com/go-asn1-ber/asn1-ber v1.5.8/go.mod h1:hEBeB/ic+5LoWskz+yKT7vGhhPYkProFKoKdwZRWMe0= -github.com/go-chi/chi/v5 v5.3.1 h1:3j4HZLGZQ3JpMCrPJF/Jl3mYJfWLKBfNJ6quurUGCf8= -github.com/go-chi/chi/v5 v5.3.1/go.mod h1:R+tYY2hNuVUUjxoPtqUdgBqevM9s9njzkTLutVsOCto= github.com/go-chi/chi/v5 v5.4.0 h1:+ufzvFTGKyin26Or5DLrlIDq4ygIDBVcj7oVNeeaYFE= github.com/go-chi/chi/v5 v5.4.0/go.mod h1:d1IG7GtKPSjPyBP365PH8sAGVHk3qfB/IhjFNRH1wWM= github.com/go-chi/httprate v0.16.0 h1:8V5DH9j6pSK6UQoBsTpvMyFxycqaKEIToyPKzHJjUa8= github.com/go-chi/httprate v0.16.0/go.mod h1:A8lo+qRhk+s9LiuP5saS7XCGDXRXMcrueq0NfIuCa/I= github.com/go-chi/render v1.0.3 h1:AsXqd2a1/INaIfUSKq3G5uA8weYx20FOsM7uSoCyyt4= github.com/go-chi/render v1.0.3/go.mod h1:/gr3hVkmYR0YlEy3LxCuVRFzEu9Ruok+gFqbIofjao0= -github.com/go-jose/go-jose/v4 v4.1.4 h1:moDMcTHmvE6Groj34emNPLs/qtYXRVcd6S7NHbHz3kA= -github.com/go-jose/go-jose/v4 v4.1.4/go.mod h1:x4oUasVrzR7071A4TnHLGSPpNOm2a21K9Kf04k1rs08= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 h1:+zs/tPmkDkHx3U66DAb0lQFJrpS6731Oaa12ikc+DiI= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376/go.mod h1:an3vInlBmSxCcxctByoQdvwPiA7DTK7jaaFDBTtu0ic= +github.com/go-git/go-billy/v5 v5.9.0 h1:jItGXszUDRtR/AlferWPTMN4j38BQ88XnXKbilmmBPA= +github.com/go-git/go-billy/v5 v5.9.0/go.mod h1:jCnQMLj9eUgGU7+ludSTYoZL/GGmii14RxKFj7ROgHw= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399 h1:eMje31YglSBqCdIqdhKBW8lokaMrL3uTkpGYlE2OOT4= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399/go.mod h1:1OCfN199q1Jm3HZlxleg+Dw/mwps2Wbk9frAWm+4FII= +github.com/go-git/go-git/v5 v5.19.2 h1:wkfn7vOlUBu8ivAWKBWisTiwJK4jYHzTF8Ndv1LyGqY= +github.com/go-git/go-git/v5 v5.19.2/go.mod h1:QqCBE1EFN5ddFmrliLQ3/ntRCUjZU3EJuwuB/jWEHjk= github.com/go-jose/go-jose/v4 v4.1.6 h1:sNRkftxFJxwsILiQukqp5z83QBSmntVwmgRY7AqBDO4= github.com/go-jose/go-jose/v4 v4.1.6/go.mod h1:x4oUasVrzR7071A4TnHLGSPpNOm2a21K9Kf04k1rs08= github.com/go-ldap/ldap/v3 v3.4.14 h1:D6PYdEgsaVzsXyr6w/yDC06Ria4uUhWm+Rb+er8lfAs= @@ -65,6 +107,12 @@ github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag= github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE= github.com/go-micro/plugins/v4/logger/zerolog v1.2.0 h1:JZ516VQ9zekRoi868XG7x0EWxZ2AMq/euHIBChITsTI= github.com/go-micro/plugins/v4/logger/zerolog v1.2.0/go.mod h1:AieYOIeOxobYa5B8WGEqxXM3Ndi26tDIu9fZ4RYkCvQ= +github.com/go-micro/plugins/v4/store/nats-js v1.2.1 h1:gf+UkY3zPtDjcIaXliotAU8SSB0x29eXQPUN5S1wiPY= +github.com/go-micro/plugins/v4/store/nats-js v1.2.1/go.mod h1:aCRl8JQmqIaonOl88nFPY/BOQnHPVHY9ngStzLkXnYk= +github.com/go-micro/plugins/v4/store/redis v1.2.1 h1:d9kwr9bSpoK9vkHkqcv+isQUbgBCHpfwCV57pcAPS6c= +github.com/go-micro/plugins/v4/store/redis v1.2.1/go.mod h1:MbCG0YiyPqETTtm7uHFmxQNCaW1o9hBoYtFwhbVjLUg= +github.com/go-redis/redis/v8 v8.11.5 h1:AcZZR7igkdvfVmQTPnu9WE37LRrO/YrBH5zWyjDC0oI= +github.com/go-redis/redis/v8 v8.11.5/go.mod h1:gREzHqY1hg6oD9ngVRbLStwAWKhA0FEgq8Jd4h5lpwo= github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572 h1:tfuBGBXKqDEevZMzYi5KSi8KkcZtzBcTgAUUtapy0OI= github.com/go-task/slim-sprig/v3 v3.0.0 h1:sUs3vkvUymDpBKi3qH1YSqBQk9+9D/8M2mN1vB6EwHI= github.com/go-task/slim-sprig/v3 v3.0.0/go.mod h1:W848ghGpv3Qj3dhTPRyJypKRiqCdHZiAzKg9hl15HA8= @@ -76,20 +124,22 @@ github.com/gobwas/ws v1.2.1 h1:F2aeBZrm2NDsc7vbovKrWSogd4wvfAxg0FQ89/iqOTk= github.com/gobwas/ws v1.2.1/go.mod h1:hRKAFb8wOxFROYNsT1bqfWnhX+b5MFeJM9r2ZSwg/KY= github.com/golang-jwt/jwt/v5 v5.3.1 h1:kYf81DTWFe7t+1VvL7eS+jKFVWaUnK9cB1qbwn63YCY= github.com/golang-jwt/jwt/v5 v5.3.1/go.mod h1:fxCRLWMO43lRc8nhHWY6LGqRcf+1gQWArsqaEUEa5bE= -github.com/golang/mock v1.6.0 h1:ErTB+efbowRARo13NNdxyJji2egdxLGQhRaY+DUumQc= -github.com/golang/mock v1.6.0/go.mod h1:p6yTPP+5HYm5mzsMV8JkE6ZKdX+/wYM6Hr+LicevLPs= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 h1:f+oWsMOmNPc8JmEHVZIycC7hBoQxHH9pNKQORJNozsQ= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8/go.mod h1:wcDNUvekVysuuOpQKo3191zZyTpiI6se1N1ULghS0sw= github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek= github.com/golang/protobuf v1.5.4/go.mod h1:lnTiLA8Wa4RWRcIUkrtSVa5nRhsEGBg48fD6rSs7xps= github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= -github.com/google/pprof v0.0.0-20260402051712-545e8a4df936 h1:EwtI+Al+DeppwYX2oXJCETMO23COyaKGP6fHVpkpWpg= -github.com/google/pprof v0.0.0-20260402051712-545e8a4df936/go.mod h1:MxpfABSjhmINe3F1It9d+8exIHFvUqtLIRCdOGNXqiI= +github.com/google/go-tpm v0.9.8 h1:slArAR9Ft+1ybZu0lBwpSmpwhRXaa85hWtMinMyRAWo= +github.com/google/go-tpm v0.9.8/go.mod h1:h9jEsEECg7gtLis0upRBQU+GhYVH6jMjrFxI8u6bVUY= +github.com/google/pprof v0.0.0-20260604005048-7023385849c0 h1:h1QTMDl6q9wDvDCJVpKQSjgleGFYnd2fOxmg2K+6BGE= +github.com/google/pprof v0.0.0-20260604005048-7023385849c0/go.mod h1:MxpfABSjhmINe3F1It9d+8exIHFvUqtLIRCdOGNXqiI= github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/gorilla/handlers v1.5.1 h1:9lRY6j8DEeeBT10CvO9hGW0gmky0BprnvDI5vfhUHH4= github.com/gorilla/handlers v1.5.1/go.mod h1:t8XrUpc4KVXb7HGyJ4/cEnwQiaxrX/hz1Zv/4g96P1Q= -github.com/grpc-ecosystem/grpc-gateway/v2 v2.30.0 h1:/Tnpcb2E0Pz/tN9s3bfEY2Q8ePCEX9iuS+cneUwncnw= -github.com/grpc-ecosystem/grpc-gateway/v2 v2.30.0/go.mod h1:zOBXOsUaBSjKgmH4OGzV1esUpR3oUSCPYVd2cUBjKYY= +github.com/grpc-ecosystem/grpc-gateway/v2 v2.31.0 h1:Bd7KaOxzULLxtZ/K5s1aLbWhR0+5RToO65TXHsf3bqQ= +github.com/grpc-ecosystem/grpc-gateway/v2 v2.31.0/go.mod h1:nN7ts3dFXKtCZWc//yfkpcQNKJABg16/uDVAZpLDalo= github.com/hashicorp/go-hclog v1.6.3 h1:Qr2kF+eVWjTiYmU7Y31tYlP1h0q/X3Nl3tPGdaB11/k= github.com/hashicorp/go-hclog v1.6.3/go.mod h1:W4Qnvbt70Wk/zYJryRzDRU/4r0kIg0PVHBcfoyhpF5M= github.com/hashicorp/go-plugin v1.8.0 h1:ie8S6RRY8RvB2usYZv+AAZ/wBvx2AU5p5QeP5j/FORs= @@ -98,6 +148,10 @@ github.com/hashicorp/go-uuid v1.0.3 h1:2gKiV6YVmrJ1i2CKKa9obLvRieoRGviZFL26PcT/C github.com/hashicorp/go-uuid v1.0.3/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/yamux v0.1.2 h1:XtB8kyFOyHXYVFnwT5C3+Bdo8gArse7j2AQ0DA0Uey8= github.com/hashicorp/yamux v0.1.2/go.mod h1:C+zze2n6e/7wshOZep2A70/aQU6QBRWJO/G6FT1wIns= +github.com/imdario/mergo v0.3.15 h1:M8XP7IuFNsqUx6VPK2P9OSmsYsI/YFaGil0uD21V3dM= +github.com/imdario/mergo v0.3.15/go.mod h1:WBLT9ZmE3lPoWsEzCh9LPo3TiwVN+ZKEjmz+hD27ysY= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= github.com/jcmturner/aescts/v2 v2.0.0 h1:9YKLH6ey7H4eDBXW8khjYslgyqG2xZikXP0EQFKrle8= github.com/jcmturner/aescts/v2 v2.0.0/go.mod h1:AiaICIRyfYg35RUkr8yESTqvSy7csK90qZ5xfvvsoNs= github.com/jcmturner/dnsutils/v2 v2.0.0 h1:lltnkeZGL0wILNvrNiVCR6Ro5PGU/SeBvVO/8c/iPbo= @@ -113,57 +167,85 @@ github.com/jcmturner/rpc/v2 v2.0.3/go.mod h1:VUJYCIDm3PVOEHw8sgt091/20OJjskO/YJk github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI= github.com/jhump/protoreflect v1.17.0 h1:qOEr613fac2lOuTgWN4tPAtLL7fUSbuJL5X5XumQh94= github.com/jhump/protoreflect v1.17.0/go.mod h1:h9+vUUL38jiBzck8ck+6G/aeMX8Z4QUY/NiJPwPNi+8= -github.com/klauspost/cpuid/v2 v2.3.0 h1:S4CRMLnYUhGeDFDqkGriYKdfoFlDnMtqTiI/sFzhA9Y= -github.com/klauspost/cpuid/v2 v2.3.0/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0= +github.com/kevinburke/ssh_config v1.2.0 h1:x584FjTGwHzMwvHx18PXxbBVzfnxogHaAReU4gf13a4= +github.com/kevinburke/ssh_config v1.2.0/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM= +github.com/klauspost/compress v1.20.2 h1:v5tiZvm1KGLyg5d5oXdXe3lsSPrbEUiKoXGia//I7Qo= +github.com/klauspost/compress v1.20.2/go.mod h1:LUdAzn7YLVvxLpc7y3V1m40wESHTgc1422pwwBSKYuI= +github.com/klauspost/cpuid/v2 v2.4.0 h1:S6Hrbc7+ywsr0r+RLapfGBHfyefhCTwEh3A0tV913Dw= +github.com/klauspost/cpuid/v2 v2.4.0/go.mod h1:19jmZ9mjzoF//ddRSUsv0zfBTJWh3QJh9FNxZTMrGxU= +github.com/kobergj/go-micro/v4 v4.0.0-20250610135441-d0b187215699 h1:3TOdtI6WPyvBB+uCykapjRtQX8vTHMlyhINzR+58B4k= +github.com/kobergj/go-micro/v4 v4.0.0-20250610135441-d0b187215699/go.mod h1:eE/tD53n3KbVrzrWxKLxdkGw45Fg1qaNLWjpJMvIUF4= +github.com/kobergj/plugins/v4/events/natsjs v1.2.1-0.20261030085317-811a2ded849b h1:ZHS4QAR8uvLWVFLDx4TfGmtsVGTc4kp36QyErxq4dbE= +github.com/kobergj/plugins/v4/events/natsjs v1.2.1-0.20261030085317-811a2ded849b/go.mod h1:XtyfEYt0MT+1OQwQXaZ0Ez9onbW3DJnKLOY3lfagmFU= +github.com/kobergj/plugins/v4/store/nats-js-kv v0.0.0-20261030085317-811a2ded849b h1:822uZuexGaBfpEhMpK6f55izI1eKkxRZUBPURlta5j0= +github.com/kobergj/plugins/v4/store/nats-js-kv v0.0.0-20261030085317-811a2ded849b/go.mod h1:jHG0DF69hKf+o6uEJ/O4D5iGoAJnatURDXGzV9o0Ouw= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= github.com/leonelquinteros/gotext v1.7.2 h1:bDPndU8nt+/kRo1m4l/1OXiiy2v7Z7dfPQ9+YP7G1Mc= github.com/leonelquinteros/gotext v1.7.2/go.mod h1:9/haCkm5P7Jay1sxKDGJ5WIg4zkz8oZKw4ekNpALob8= github.com/mattn/go-colorable v0.1.9/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc= github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4= -github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE= -github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= +github.com/mattn/go-colorable v0.1.15 h1:+u9SLTRGnXv73cEsnsmoZBom+dMU88B2M0aDcWy0/jY= +github.com/mattn/go-colorable v0.1.15/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU= github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= -github.com/mattn/go-isatty v0.0.21 h1:xYae+lCNBP7QuW4PUnNG61ffM4hVIfm+zUzDuSzYLGs= -github.com/mattn/go-isatty v0.0.21/go.mod h1:ZXfXG4SQHsB/w3ZeOYbR0PrPwLy+n6xiMrJlRFqopa4= +github.com/mattn/go-isatty v0.0.22 h1:j8l17JJ9i6VGPUFUYoTUKPSgKe/83EYU2zBC7YNKMw4= +github.com/mattn/go-isatty v0.0.22/go.mod h1:ZXfXG4SQHsB/w3ZeOYbR0PrPwLy+n6xiMrJlRFqopa4= github.com/miekg/dns v1.1.72 h1:vhmr+TF2A3tuoGNkLDFK9zi36F2LS+hKTRW0Uf8kbzI= github.com/miekg/dns v1.1.72/go.mod h1:+EuEPhdHOsfk6Wk5TT2CzssZdqkmFhf8r+aVyDEToIs= github.com/mileusna/useragent v1.3.5 h1:SJM5NzBmh/hO+4LGeATKpaEX9+b4vcGg2qXGLiNGDws= github.com/mileusna/useragent v1.3.5/go.mod h1:3d8TOmwL/5I8pJjyVDteHtgDGcefrFUX4ccGOMKNYYc= +github.com/minio/highwayhash v1.0.4 h1:asJizugGgchQod2ja9NJlGOWq4s7KsAWr5XUc9Clgl4= +github.com/minio/highwayhash v1.0.4/go.mod h1:GGYsuwP/fPD6Y9hMiXuapVvlIUEhFhMTh0rxU3ik1LQ= github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY= github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo= github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA= github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ= +github.com/nats-io/jwt/v2 v2.8.2 h1:XXRgB60MSTnqsRwejQurVDs/hcv2dkt+86GjI+I/bMc= +github.com/nats-io/jwt/v2 v2.8.2/go.mod h1:Ag/56sq9OblL4JgdYufDd16Egb17Kr/8WwwuO/forVc= +github.com/nats-io/nats-server/v2 v2.15.0 h1:M99yf0y05rTr46/qc/Is6ZAowI58Ryp2SjufLCUeVJc= +github.com/nats-io/nats-server/v2 v2.15.0/go.mod h1:5qLF4CDGzZVFt//3fUrY1ePpwbi05r7QHPNroSUtolk= +github.com/nats-io/nats.go v1.54.0 h1:vsXoOxjHp/GmPUN+EcI7uOf/uB+iAP+kEsAFNQN0yzA= +github.com/nats-io/nats.go v1.54.0/go.mod h1:y+DZoD1oBOYfZTU681eTUiUjI0vbqYGixNVFHcjHJ0k= +github.com/nats-io/nkeys v0.4.16 h1:rd5oAuLOb8mnAycB0xleuEBNS1pVVnN0fv/FF34Eypg= +github.com/nats-io/nkeys v0.4.16/go.mod h1:llLgWoI0o4z/Q57q2R1kHfmocyhGV6VG/U18Glg1Afs= +github.com/nats-io/nuid v1.0.1 h1:5iA8DT8V7q8WK2EScv2padNa/rTESc1KdnPw4TC2paw= +github.com/nats-io/nuid v1.0.1/go.mod h1:19wcPz3Ph3q0Jbyiqsd0kePYG7A95tJPxeL+1OSON2c= +github.com/nxadm/tail v1.4.8 h1:nPr65rt6Y5JFSKQO7qToXr7pePgD6Gwiw05lkbyAQTE= +github.com/nxadm/tail v1.4.8/go.mod h1:+ncqLTQzXmGhMZNUePPaPqPvBxHAIsmXswZKocGu+AU= github.com/oklog/run v1.2.0 h1:O8x3yXwah4A73hJdlrwo/2X6J62gE5qTMusH0dvz60E= github.com/oklog/run v1.2.0/go.mod h1:mgDbKRSwPhJfesJ4PntqFUbKQRZ50NgmZTSPlFA0YFk= github.com/onsi/ginkgo v1.16.5 h1:8xi0RTUf59SOSfEtZMvwTvXYMzG4gV23XVHOZiXNtnE= -github.com/onsi/ginkgo/v2 v2.32.1 h1:6tlvcDm/3sE8lGJbZ4+d4mO3RLy24/tQWOFzVSQNIfw= -github.com/onsi/ginkgo/v2 v2.32.1/go.mod h1:+aXOY+vzZ5mu2iI2HpTZUPmM//oQfsNFX6gU9kNcA44= -github.com/onsi/gomega v1.42.1 h1:iN1rCUX+44NZ1Dc97MPoeFYbFR0vh8zxoxMFwKdyZ6I= -github.com/onsi/gomega v1.42.1/go.mod h1:REff/hsDsodHoKlWsP2mAPhu1+5/6hVYNf9rIEBpeSg= +github.com/onsi/ginkgo v1.16.5/go.mod h1:+E8gABHa3K6zRBolWtd+ROzc/U5bkGt0FwiG042wbpU= +github.com/onsi/ginkgo/v2 v2.33.0 h1:C8gBA6Uc2ZEubiV+SXiu5tZnMTwEmXHgkJwGozKtZf8= +github.com/onsi/ginkgo/v2 v2.33.0/go.mod h1:+aXOY+vzZ5mu2iI2HpTZUPmM//oQfsNFX6gU9kNcA44= +github.com/onsi/gomega v1.44.0 h1:eAiGl3Pw5jz5GQdDff0BcxYpAX1JxW8xD7mFUuwNfZQ= +github.com/onsi/gomega v1.44.0/go.mod h1:e/C2HwaZ1DhvjzXXuFhcR7hY7Sh9pl7MmoWKEjzwcdA= github.com/owncloud/libre-graph-api-go v1.0.5-0.20260216101009-eeac018af245 h1:JRidLTAKhnvyLMRtVtSF4lhBa0NSAOs6fof+d6JnKII= github.com/owncloud/libre-graph-api-go v1.0.5-0.20260216101009-eeac018af245/go.mod h1:z61VMGAJRtR1nbgXWiNoCkxUXP1B3Je9rMuJbnGd+Og= -github.com/owncloud/reva/v2 v2.0.0-20260813121157-d386075a0421 h1:orjzG6JMpulTJvkeg//KwgeqdrOMGXAO0K6GaH4XCxI= -github.com/owncloud/reva/v2 v2.0.0-20260813121157-d386075a0421/go.mod h1:f4ymc4PUG6a3QSOHXq7Q9Ck5udiSNU6Lv2Im2Q0jvRc= +github.com/owncloud/reva/v2 v2.0.0-20261111080110-3e71db9f7bf2 h1:cu8AdG6pZfl0lS/OAjISeH4fXKverHsMLolzjKnKGtw= +github.com/owncloud/reva/v2 v2.0.0-20261111080110-3e71db9f7bf2/go.mod h1:31RqxvdGj3j7vqgV0MO95HF4mgioOYTTRD4BK4ecQ7g= github.com/oxtoacart/bpool v0.0.0-20190530202638-03653db5a59c h1:rp5dCmg/yLR3mgFuSOe4oEnDDmGLROTvMragMUXpTQw= github.com/oxtoacart/bpool v0.0.0-20190530202638-03653db5a59c/go.mod h1:X07ZCGwUbLaax7L0S3Tw4hpejzu63ZrrQiUe6W0hcy0= github.com/patrickmn/go-cache v2.1.0+incompatible h1:HRMgzkcYKYpi3C8ajMPV8OFXaaRUnok+kx1WdO15EQc= github.com/patrickmn/go-cache v2.1.0+incompatible/go.mod h1:3Qf8kWWT7OJRJbdiICTKqZju1ZixQ/KpMGzzAfe6+WQ= github.com/pbnjay/memory v0.0.0-20210728143218-7b4eea64cf58 h1:onHthvaw9LFnH4t2DcNVpwGmV9E1BkGknEliJkfwQj0= github.com/pbnjay/memory v0.0.0-20210728143218-7b4eea64cf58/go.mod h1:DXv8WO4yhMYhSNPKjeNKa5WY9YCIEBRbNzFFPJbWO6Y= +github.com/pjbgf/sha1cd v0.6.0 h1:3WJ8Wz8gvDz29quX1OcEmkAlUg9diU4GxJHqs0/XiwU= +github.com/pjbgf/sha1cd v0.6.0/go.mod h1:lhpGlyHLpQZoxMv8HcgXvZEhcGs0PG/vsZnEJ7H0iCM= github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= -github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U= -github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/prometheus/client_golang v1.24.1 h1:JnJkREXzWxUdCuPFpIWZiPispT9xVV59uiuyR2bPlnU= github.com/prometheus/client_golang v1.24.1/go.mod h1:F+oSRECHg4sse5ucfYpYDeIv/hu68Zo0uoHKetWnzcE= -github.com/prometheus/client_model v0.6.2 h1:oBsgwpGs7iVziMvrGhE53c/GrLUsZdHnqNwqPLxwZyk= -github.com/prometheus/client_model v0.6.2/go.mod h1:y3m2F6Gdpfy6Ut/GBsUqTWZqCUvMVzSfMLjcu6wAwpE= +github.com/prometheus/client_model v0.6.3 h1:O0jaTVAYNxTHYInEPFJt5I3+sN8zqBtVMPTB1qyxiEo= +github.com/prometheus/client_model v0.6.3/go.mod h1:gpN5P9S7Rr6Yr92PiQ+Ixvhf6JZEkF1dnxsYL2aPBEM= github.com/prometheus/common v0.70.1 h1:1HvjP4D5oL3t8RsPlwxA9onvvStjtIHYE5XuuwOi/PY= github.com/prometheus/common v0.70.1/go.mod h1:VdFUQDMZK3VLkurFUVhia6uys/0suUp86TJz5qbJRhc= github.com/prometheus/procfs v0.21.1 h1:GljZCt+zSTS+NZq88cyQ1LjZ+RCHp3uVuabBWA5+OJI= @@ -174,104 +256,137 @@ github.com/rs/cors v1.11.1 h1:eU3gRzXLRK57F5rKMGMZURNdIG4EoAmX8k94r9wXWHA= github.com/rs/cors v1.11.1/go.mod h1:XyqrcTp5zjWr1wsJ8PIRZssZ8b/WMcMf71DJnit4EMU= github.com/rs/zerolog v1.35.1 h1:m7xQeoiLIiV0BCEY4Hs+j2NG4Gp2o2KPKmhnnLiazKI= github.com/rs/zerolog v1.35.1/go.mod h1:EjML9kdfa/RMA7h/6z6pYmq1ykOuA8/mjWaEvGI+jcw= +github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk= +github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/sercand/kuberesolver/v5 v5.1.1 h1:CYH+d67G0sGBj7q5wLK61yzqJJ8gLLC8aeprPTHb6yY= github.com/sercand/kuberesolver/v5 v5.1.1/go.mod h1:Fs1KbKhVRnB2aDWN12NjKCB+RgYMWZJ294T3BtmVCpQ= -github.com/sirupsen/logrus v1.10.0 h1:T8MxJJXVZkfcC5zSRMRAg2F8+lxjmUCGGWPzFxO+Msc= -github.com/sirupsen/logrus v1.10.0/go.mod h1:FXZFonkDAnFozmO+5hGAFvB0Yg9/j2SIhA/QuIkP180= +github.com/sergi/go-diff v1.4.0 h1:n/SP9D5ad1fORl+llWyN+D6qoUETXNZARKjyY2/KVCw= +github.com/sergi/go-diff v1.4.0/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4= +github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= +github.com/sirupsen/logrus v1.10.2 h1:G2SED73/qrAu6YwbdxOD6peLkCBI3z7L+ykJFTXJBBo= +github.com/sirupsen/logrus v1.10.2/go.mod h1:SLEg8TqYulVKKfIGHldVp2K2aYz2DKSVBq4g/H5bR7Q= +github.com/skeema/knownhosts v1.3.1 h1:X2osQ+RAjK76shCbvhHHHVl3ZlgDm8apHEHFqRjnBY8= +github.com/skeema/knownhosts v1.3.1/go.mod h1:r7KTdC8l4uxWRyK2TpQZ/1o5HaSzh06ePQNxPwTcfiY= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/objx v0.5.3 h1:jmXUvGomnU1o3W/V5h2VEradbpJDwGrzugQQvL0POH4= github.com/stretchr/objx v0.5.3/go.mod h1:rDQraq+vQZU7Fde9LOZLr8Tax6zZvy4kuNKF+QYS+U0= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= github.com/stretchr/testify v1.7.2/go.mod h1:R6va5+xMeoiuVRoj+gSkQ7d3FALtqAAGI1FQKckRals= -github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= -github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= github.com/stretchr/testify v1.12.1 h1:EuwCh5fleGS7H32xRwO3wRGT7DxrDhLAT6FF8MpWDWE= -github.com/tus/tusd/v2 v2.10.0 h1:2yOGmkrDl9RQmRIt/00DR2WvYWOoiEu3CoygILb+WRw= -github.com/tus/tusd/v2 v2.10.0/go.mod h1:T/OuJHIAC2NHpkEUyQyyaoWyDNRDcQVpJzWl8tX5GY4= +github.com/stretchr/testify v1.12.1/go.mod h1:MDEgiDPPsNp5cuIrHPPCyornHKgEVbtFUmoNlxoYthg= +github.com/test-go/testify v1.1.4 h1:Tf9lntrKUMHiXQ07qBScBTSA0dhYQlu83hswqelv1iE= +github.com/test-go/testify v1.1.4/go.mod h1:rH7cfJo/47vWGdi4GPj16x3/t1xGOj2YxzmNQzk2ghU= +github.com/urfave/cli/v2 v2.27.7 h1:bH59vdhbjLv3LAvIu6gd0usJHgoTTPhCFib8qqOwXYU= +github.com/urfave/cli/v2 v2.27.7/go.mod h1:CyNAG/xg+iAOg0N4MPGZqVmv2rCoP267496AOXUZjA4= +github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM= +github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw= +github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 h1:gEOO8jv9F4OT7lGCjxCBTO/36wtF6j2nSip77qHd4x4= +github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1/go.mod h1:Ohn+xnUBiLI6FVj/9LpzZWtj1/D6lUovWYBkxHVV3aM= github.com/zeebo/assert v1.3.0 h1:g7C04CbJuIDKNPFHmsk4hwZDO5O+kntRxzaUoNXj+IQ= github.com/zeebo/assert v1.3.0/go.mod h1:Pq9JiuJQpG8JLJdtkwrJESF0Foym2/D9XMU5ciN/wJ0= github.com/zeebo/xxh3 v1.1.0 h1:s7DLGDK45Dyfg7++yxI0khrfwq9661w9EN78eP/UZVs= github.com/zeebo/xxh3 v1.1.0/go.mod h1:IisAie1LELR4xhVinxWS5+zf1lA4p0MW4T+w+W07F5s= -go-micro.dev/v4 v4.11.0 h1:DZ2xcr0pnZJDlp6MJiCLhw4tXRxLw9xrJlPT91kubr0= -go-micro.dev/v4 v4.11.0/go.mod h1:eE/tD53n3KbVrzrWxKLxdkGw45Fg1qaNLWjpJMvIUF4= +go.etcd.io/etcd/api/v3 v3.7.2 h1:xgt/6el1LsPWWYNLkhMAK4tZm6dF+1sCqDecpE5gdbk= +go.etcd.io/etcd/api/v3 v3.7.2/go.mod h1:RoRCBRt9BfBff1pIGZLUVMiz7wu3bY+b2qLysGu1HY4= +go.etcd.io/etcd/client/pkg/v3 v3.7.2 h1:SVtlR7tiSVAYOQ4nWPIyFXb4RMgEcnzeAG9RQ8MoNDU= +go.etcd.io/etcd/client/pkg/v3 v3.7.2/go.mod h1:HsSux/B3ahgyw/D5+d4YbZqicOi0mEbuxm6lIUdjAoI= +go.etcd.io/etcd/client/v3 v3.7.2 h1:Z66GqDQDI7zPDfVSsIBqGSK4mJYLtv8ESwXa4mPf+wY= +go.etcd.io/etcd/client/v3 v3.7.2/go.mod h1:x03t1qMs4tGZirCDJlMuzPBJdQffXJImIyEjLhNBCsY= go.opentelemetry.io/auto/sdk v1.2.1 h1:jXsnJ4Lmnqd11kwkBV2LgLoFMZKizbCi5fNZ/ipaZ64= go.opentelemetry.io/auto/sdk v1.2.1/go.mod h1:KRTj+aOaElaLi+wW1kO/DZRXwkF4C5xPbEe3ZiIhN7Y= -go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.70.0 h1:oECp5f+hN7nkwjU/8BxQ/q23bGPb8FIrD839owX222E= -go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.70.0/go.mod h1:DqEFwLumhzMBDQv9PcWbyoDxHI/4lAk6CM4nJBH39sc= -go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.70.0 h1:LMuyCAyfalSjDyjdC65nK6N0zoTT63+E/u95X0JovZI= -go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.70.0/go.mod h1:085m8qbm4hgc8rZWGDEa4vmyyo2c3nPxUslYUKUIU04= -go.opentelemetry.io/otel v1.45.0 h1:pdrWmLHofpubmArBv1LgFSv1Z0Ie/ppdZzu+kUN5EeU= -go.opentelemetry.io/otel v1.45.0/go.mod h1:XZxIqPapzEYnhNSScF5DIqXhm/rYi0FzCe2XddAwZfQ= +go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.72.0 h1:Tq+E65HaNbZTeqcLw6QUhsV+/EIWdkfUH2CQzcrlE5M= +go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.72.0/go.mod h1:A+EVhDakAj1waJBPhmTszZaSr08ww8MRRKy1nB1rqck= +go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.71.0 h1:3g7B90UzBltIDKq1/5mrTGxTnOFDV0ICOhLoxiZ8jlg= +go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.71.0/go.mod h1:Ef8SuTh59BT7+ofpDxN9z+yOlc4t2GjLmKDgYNJL/NU= go.opentelemetry.io/otel v1.47.0 h1:j7ALJ/zgkS7Z6aeJW09p8VC9804bC+PpeTfCD4XPnOM= go.opentelemetry.io/otel v1.47.0/go.mod h1:8wS9O2qfXrYrzp6hIF/HOYJJf/wIhFPhR2xLuP+iXQU= go.opentelemetry.io/otel/exporters/jaeger v1.17.0 h1:D7UpUy2Xc2wsi1Ras6V40q806WM07rqoCWzXu7Sqy+4= go.opentelemetry.io/otel/exporters/jaeger v1.17.0/go.mod h1:nPCqOnEH9rNLKqH/+rrUjiMzHJdV1BlpKcTwRTyKkKI= -go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.45.0 h1:QRefszxJmfPdjXUUm3j6iDzY03mTPXMjqErFqQ67vUg= -go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.45.0/go.mod h1:Tiz03lTBVBrm7eWZBOidzEaYaJa8tjwGUGv6d8mlTyk= -go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.45.0 h1:fG5MCxGz8+2VtrN/WgqSpJFctVz24gpxj8CxkKmc8Ww= -go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.45.0/go.mod h1:BmAYTn+3ysbRe+IU2msxmf5Rx3g6DHvex+tWI3LdhYI= -go.opentelemetry.io/otel/metric v1.45.0 h1:7Eg1uH7CJ5cXv9is6tnBe1FI6rj1nwUdbFypRm3br/M= -go.opentelemetry.io/otel/metric v1.45.0/go.mod h1:HAPbm1nd3p1PmFH7v2dR+6BjXxw+Lq4a2+pndMAm08s= +go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.47.0 h1:julhjPeUH/q/7hinbSdDdqt5h7Zw9YWmRlWRhI0jd54= +go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.47.0/go.mod h1:Ao2mz688LH/tFf0yMAenidq6k2YNSx6SIY2q6jDACck= +go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.47.0 h1:UFpxOpYPmMNUtOWhdb+nC1WELIgVf8z9higURrbzYU4= +go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.47.0/go.mod h1:YBGjxe3lt0jtXoEXxGrGhv/jM7oUBUDVK7zhAvNyEjc= +go.opentelemetry.io/otel/log v1.47.0 h1:cOTS1CcLbSQeZKanGJ+0JpF/+t4PELi3O3bbl2lqCcI= +go.opentelemetry.io/otel/log v1.47.0/go.mod h1:9byitSQ5pLC6PpqwGXjqdMKya6ZTswHRZh2vvXT33nw= go.opentelemetry.io/otel/metric v1.47.0 h1:4PptaldXx3Eat1XjMZ68pPJEs5wrhlemctZE9a3UdWY= go.opentelemetry.io/otel/metric v1.47.0/go.mod h1:ADGSXxRrXM6bjbvLo535EstVFlPpPYZm4LBKixjDHwU= -go.opentelemetry.io/otel/sdk v1.45.0 h1:4VVSMgQ83dUgW2aoX5f6JgLvHwIvzcuLnF9lUdCSpCw= -go.opentelemetry.io/otel/sdk v1.45.0/go.mod h1:Sr40LgXV7DsKMMJMKOhUWOgMWTfAaqvm2kF0g7ilwuA= go.opentelemetry.io/otel/sdk v1.47.0 h1:zWXEr4j2lFefG87TU6Yg8a7ngfohIKFZHKp0Hf5hC6I= go.opentelemetry.io/otel/sdk v1.47.0/go.mod h1:VUc24kiOeoGsxG8G9ULx3fWKvB7jMhnGE8Oi607lgR0= -go.opentelemetry.io/otel/sdk/metric v1.45.0 h1:oVFszMfyj1Am6s24Vtc7wBb8BKLcwepJjNEYILuiE3o= -go.opentelemetry.io/otel/sdk/metric v1.45.0/go.mod h1:vUWUxDZvu1WVRj8JA8S0AdhsPrZoDpA2DdZauIh4mDA= go.opentelemetry.io/otel/sdk/metric v1.47.0 h1:lfISg2j93VT6yqdk9OfUaZmw/GfcZqCCV3jdXtsPnKw= -go.opentelemetry.io/otel/trace v1.45.0 h1:l/mP6Uv7oNO7/TblbhpbgMidxhq1uO/rPsikOyVhxag= -go.opentelemetry.io/otel/trace v1.45.0/go.mod h1:qoJJA2xNMnxRrdISU/kLtfUH2wNeQbiv+jhs/CxI8bc= +go.opentelemetry.io/otel/sdk/metric v1.47.0/go.mod h1:ypLp+mW1Nt2x+Szt3b5/i1syodyts49lMOwxpDI3VGw= go.opentelemetry.io/otel/trace v1.47.0 h1:JOjX/Oci8K94QHddo+bbfya/Ai/nf6/dt9ZfrFNWSrM= go.opentelemetry.io/otel/trace v1.47.0/go.mod h1:jNaSLa2PZEYFG6fRjJABAu+bw4FS08uDmPg28lTghu0= go.opentelemetry.io/proto/otlp v1.11.0 h1:5rrYs0Ykyj50sdU/JU0x8etU+LubXWb+gED6TbEdMIk= go.opentelemetry.io/proto/otlp v1.11.0/go.mod h1:SmVizdCOAm3XBtG1g1NnOdhW6jtddT72hLMhv8VwA8E= go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto= go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE= +go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0= +go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y= +go.uber.org/zap v1.27.1 h1:08RqriUEv8+ArZRYSTXy1LeBScaMpVSTBhCeaZYfMYc= +go.uber.org/zap v1.27.1/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E= go.yaml.in/yaml/v2 v2.4.4 h1:tuyd0P+2Ont/d6e2rl3be67goVK4R6deVxCUX5vyPaQ= go.yaml.in/yaml/v2 v2.4.4/go.mod h1:gMZqIpDtDqOfM0uNfy0SkpRhvUryYH0Z6wdMYcacYXQ= go.yaml.in/yaml/v3 v3.0.5 h1:N6y/pJk8buWs9NY5ERU2HSMfm+IuD/OtfdAnq6kESPw= go.yaml.in/yaml/v3 v3.0.5/go.mod h1:HVTZu1O7/Vkt2N+BFy8Zza+lnLsABggaTM2ZpNIGuKg= -golang.org/x/crypto v0.55.0 h1:+KWHjbgOaAQ66dh/YlkZKHlz9ZUlq61AFirAR9ntP8M= -golang.org/x/crypto v0.55.0/go.mod h1:uq0V9dE/fzQuJtbnL+2EhWOE63vo164FY8xqEnV9xis= -golang.org/x/exp v0.0.0-20260410095643-746e56fc9e2f h1:W3F4c+6OLc6H2lb//N1q4WpJkhzJCK5J6kUi1NTVXfM= -golang.org/x/exp v0.0.0-20260410095643-746e56fc9e2f/go.mod h1:J1xhfL/vlindoeF/aINzNzt2Bket5bjo9sdOYzOsU80= -golang.org/x/mod v0.40.0 h1:hUv+3cXcdRHz08UmSiOob7sadHig73uo5bkXxQ/tvUs= -golang.org/x/mod v0.40.0/go.mod h1:0/weTWkPWGBikyTWAX3dkjVztMmBA5hM0DH6BElSupE= -golang.org/x/net v0.58.0 h1:ynWG7rqYi4ccpTEuPZ2QGWHktVEM9DMCj9yzDE0Q7To= -golang.org/x/net v0.58.0/go.mod h1:YwCddHnFlT7eLQqVprV19OnhLGtc5xOKgE0RyqgfWAU= -golang.org/x/oauth2 v0.36.0 h1:peZ/1z27fi9hUOFCAZaHyrpWG5lwe0RJEEEeH0ThlIs= -golang.org/x/oauth2 v0.36.0/go.mod h1:YDBUJMTkDnJS+A4BP4eZBjCqtokkg1hODuPjwiGPO7Q= -golang.org/x/sync v0.22.0 h1:SZjpbeLmrCk4xhRSZFNZW5gFUeCeFgjekvI/+gfScek= -golang.org/x/sync v0.22.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0= +golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/crypto v0.58.0 h1:COkYLr4k7nDI4r6QtMML2AfzeIswWHAJthLS6K/M/54= +golang.org/x/crypto v0.58.0/go.mod h1:Xh+kl5A+M0gMiWDytH2Hhr5Z7WbNCpv/eB/EFgfSk+w= +golang.org/x/mod v0.41.0 h1:qJmnOUb4YB+FsEuM3HcWucdZASCPGhsX6uljO6pog0c= +golang.org/x/mod v0.41.0/go.mod h1:Ek9pY8RKWXwsWvd3rQiHYtMqkjSUV+s1Rj7j4H5Ur6o= +golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.62.0 h1:18ELalfM5+XNRwzM2nYqXsZQ9ByS1uhj2O/U7+5jqRY= +golang.org/x/net v0.62.0/go.mod h1:WgDCOTH8iwtB66T4/GfI94AHo/hhdb7Hah9NDseQfiI= +golang.org/x/oauth2 v0.37.0 h1:JUlcxA8oAtauLfiH8FX2/FkAWHAdi0QtGCGc+hofE98= +golang.org/x/oauth2 v0.37.0/go.mod h1:IxwZNxUULJmpBFf9K/9NTMSIfZZuvuTy1gGxhigP/58= +golang.org/x/sync v0.24.0 h1:iqiDrGoDgyuvAKrhLQthUEzU/R378N78gXbBjxed7oA= +golang.org/x/sync v0.24.0/go.mod h1:sUUOizhqBxiL6pEWpqNLUiaJn1ShEbZ6BBqskPbjZm0= +golang.org/x/sys v0.0.0-20191005200804-aed5e4c7ecf9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220503163025-988cb79eb6c6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.47.0 h1:o7XGOvZQCADBQQ4Y7VNq2dRWQR7JmOUW8Kxx4ZsNgWs= -golang.org/x/sys v0.47.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw= -golang.org/x/sys v0.48.0 h1:bbX/i/6MgT9BVLM9RT1thmxL04yeTAhbEz4SyadbXoo= -golang.org/x/sys v0.48.0/go.mod h1:hNLxWAXmnKAxqDtdwIYC4bM9oQPEecfsnNMuSxOs3og= -golang.org/x/text v0.41.0 h1:vz/seA0lnX87Othu2f/0L24RcgrXD9/YFTSuGjj3rH8= -golang.org/x/text v0.41.0/go.mod h1:jvf1O8ajNzZqhSrQBPbutR/EB83Cc0CFrezNQIwbb5M= -golang.org/x/tools v0.49.0 h1:3NI7VXzL9+1WZD52Dx2ttoPwD5DWrFGpl9mFZDlmisI= -golang.org/x/tools v0.49.0/go.mod h1:SJNXV9DBKT0UbdttsQjbfJlAE/q+y36++zo3uL3N0Oo= +golang.org/x/sys v0.49.0 h1:XbzkgYJHdqh/8m2Uu0W/dQv8nktxx4BFHp1M0gROTXA= +golang.org/x/sys v0.49.0/go.mod h1:hNLxWAXmnKAxqDtdwIYC4bM9oQPEecfsnNMuSxOs3og= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.47.0 h1:cpyOwQkr2Nzxe2p6KnrTG7Ei2wtzjsuSjhpXXepZ/BM= +golang.org/x/term v0.47.0/go.mod h1:efAfAuG6RKABvg1ArGebRkvX6LXul14SM67o2e4mUCY= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.43.0 h1:1QivrlhwAsnMOcqgOdl9my7s9OyZl8O5/UGUTJVXoWc= +golang.org/x/text v0.43.0/go.mod h1:hbSIYA/amXcRXTFSZqh8tWHEoqRvvbKPJ2uz/KU+a+s= +golang.org/x/time v0.16.0 h1:vMb6ptszcQMkcwiRTAuNNU50gom6++Q/6gY2hDM6VDE= +golang.org/x/time v0.16.0/go.mod h1:rVKOqvZeKvrDKTQiAHJ7wmwP0RzleSphoEA9RcdLA0s= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.51.0 h1:k4Xc/1Om9jwkBJBo4NVLMSARBoWtK10mx+W5BnXCeAI= +golang.org/x/tools v0.51.0/go.mod h1:9eEncMayCV6zRMGhR5eZEC2iBx98qWcF1HZ9Z7wJOoA= gonum.org/v1/gonum v0.17.0 h1:VbpOemQlsSMrYmn7T2OUvQ4dqxQXU+ouZFQsZOx50z4= gonum.org/v1/gonum v0.17.0/go.mod h1:El3tOrEuMpv2UdMrbNlKEh9vd86bmQ6vqIcDwxEOc1E= -google.golang.org/genproto/googleapis/api v0.0.0-20260803160001-6ac0973c030d h1:FarXi840EJWSHYTN3ERkADbPWjl307+FGrA22KAVjjc= -google.golang.org/genproto/googleapis/api v0.0.0-20260803160001-6ac0973c030d/go.mod h1:K/+WGbmBY7aNW1HDw1fJnKYo10i0DkAX6pows00dLig= -google.golang.org/genproto/googleapis/rpc v0.0.0-20260803160001-6ac0973c030d h1:IL4hdHzcUv2l/gcg98/Rj3FbtE6axwqslOW8SW0C+S0= -google.golang.org/genproto/googleapis/rpc v0.0.0-20260803160001-6ac0973c030d/go.mod h1:4Hqkh8ycfw05ld/3BWL7rJOSfebL2Q+DVDeRgYgxUU8= -google.golang.org/grpc v1.83.2 h1:EManeRomTObA0BU7I8vXgg/78uE5MJ9M8B39EX2WscU= -google.golang.org/grpc v1.83.2/go.mod h1:YPI1hK3kDked6iHvgX3tR0y+nX/qpMFKhPgFsokw1S8= +google.golang.org/genproto/googleapis/api v0.0.0-20260928230214-8a89bd6388cc h1:rZHRz0ogq4Pid1IKtA/ivHi8XONVF5tqUQXA2TtgpkE= +google.golang.org/genproto/googleapis/api v0.0.0-20260928230214-8a89bd6388cc/go.mod h1:K/n0XLazCJHjD73YuMyNJsN38BPPy1kfFnKxUXaThFU= +google.golang.org/genproto/googleapis/rpc v0.0.0-20260928230214-8a89bd6388cc h1:4bNTbnb44EqGVy9HaQxSY2jnafSUdgV3qHtedvNpDKg= +google.golang.org/genproto/googleapis/rpc v0.0.0-20260928230214-8a89bd6388cc/go.mod h1:OaIUM3+LpYcK2GXM4FTmhWoIq371Owdr+Cc7/BsYHHc= +google.golang.org/grpc v1.86.0-dev h1:FLq7hcApuJeJ70J9+k0FvmXsNCwS8B2/MeAfYdy3GHY= +google.golang.org/grpc v1.86.0-dev/go.mod h1:Ovl0ECo4xx5r4kn/6d4BPSNB7OIFuu6EAjOzjtVAKaM= google.golang.org/protobuf v1.36.12 h1:pJOKDDOyeXErUroCihFAd5LQuwXBSpVnKGrj5o/fwxc= google.golang.org/protobuf v1.36.12/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= +gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 h1:uRGJdciOHaEIrze2W8Q3AKkepLTh2hOroT7a+7czfdQ= +gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw= +gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= +gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= diff --git a/ocis_helpers/main.go b/ocis_helpers/main.go index 7242bbfc..f6e7cc8d 100644 --- a/ocis_helpers/main.go +++ b/ocis_helpers/main.go @@ -117,7 +117,19 @@ func main() { case "extended": RenderRogueEnvs() case "deltas": - RenderEnvVarDeltas(isDryrun) + subTask := "" + if len(positionalArgs) > 2 { + subTask = positionalArgs[2] + switch subTask { + case "added", "removed", "deprecated": + // valid + default: + fmt.Fprintf(os.Stderr, "Unknown deltas sub-task %q — valid values: added, removed, deprecated\n\n", subTask) + printUsage() + exitCleanly(1) + } + } + RenderEnvVarDeltas(isDryrun, subTask) case "copy": CopyToExamples() case "cleanup_s": @@ -428,6 +440,7 @@ func printUsage() { fmt.Printf(" rogue: create/update the extended_vars.yaml file\n") fmt.Printf(" extended: generate extended_configvars table\n") fmt.Printf(" deltas: generate the added, deprecated and removed envvar tables\n") + fmt.Printf(" optional sub-task: added | removed | deprecated (regenerates only that file, others on disk are untouched)\n") fmt.Printf(" copy: copy the subfolders of %s to %s except 'persistent_files'\n", services_dir, examples_dir) fmt.Printf(" cleanup_s: cleanup folders in %s except 'persistent_files'. run services, extended, deltas to recreate\n", services_dir) fmt.Printf(" cleanup_h: remove the folder %s. folder contents is build relevant for antora\n\n", examples_dir) diff --git a/ocis_helpers/ocis_helpers b/ocis_helpers/ocis_helpers index 8231ff8b..91717cd3 100755 Binary files a/ocis_helpers/ocis_helpers and b/ocis_helpers/ocis_helpers differ diff --git a/ocis_helpers/templates/ADOC_extended.tmpl b/ocis_helpers/templates/ADOC_extended.tmpl index e9a921e4..deec8e5f 100644 --- a/ocis_helpers/templates/ADOC_extended.tmpl +++ b/ocis_helpers/templates/ADOC_extended.tmpl @@ -9,10 +9,7 @@ | Default Value | Description {{- range .Variables}} - -{{- if .Ignore }} - {{ continue }} -{{- end }} +{{- if not .Ignore }} a| `{{- .Name }}` + a| [subs=-attributes] @@ -21,6 +18,6 @@ a| [subs=-attributes] ++{{.DefaultValue}} ++ a| [subs=-attributes] ++{{.Description}} ++ - +{{- end }} {{- end }} |=== diff --git a/ocis_helpers/templates/adoc-generator.go.tmpl b/ocis_helpers/templates/adoc-generator.go.tmpl index 3168e694..201cc673 100644 --- a/ocis_helpers/templates/adoc-generator.go.tmpl +++ b/ocis_helpers/templates/adoc-generator.go.tmpl @@ -7,6 +7,7 @@ import ( "path/filepath" "reflect" "regexp" + "strconv" "strings" "text/template" "time" @@ -119,6 +120,8 @@ func doAdocGeneration() { sort.Slice(env.Services, func(i, j int) bool { return env.Services[i] < env.Services[j] }) + incoming := replaceEnvVarPlaceHolder(f.IntroductionVersion) + env.IntroductionVersion = lowestVersion(env.IntroductionVersion, incoming) all[e] = env } else { all[e] = EnvVar{ @@ -209,6 +212,68 @@ func doAdocGeneration() { } +const preVersion = "pre5.0" + +// lowestVersion returns the lower of two version strings; preVersion beats any numeric version. +func lowestVersion(a, b string) string { + if a == preVersion || b == preVersion { + return preVersion + } + if isVersion(a) && isVersion(b) { + if compareVersions(a, b) <= 0 { + return a + } + return b + } + if isVersion(a) { + return a + } + return b +} + +func isVersion(value string) bool { + if value == "" { + return false + } + for _, part := range strings.Split(value, ".") { + if _, err := strconv.Atoi(part); err != nil { + return false + } + } + return true +} + +func compareVersions(first, second string) int { + partsFirst := strings.Split(first, ".") + partsSecond := strings.Split(second, ".") + count := len(partsFirst) + if len(partsSecond) > count { + count = len(partsSecond) + } + for i := 0; i < count; i++ { + a := versionPart(partsFirst, i) + b := versionPart(partsSecond, i) + if a < b { + return -1 + } + if a > b { + return 1 + } + } + return 0 +} + +func versionPart(parts []string, index int) int { + if index >= len(parts) { + return 0 + } + n, err := strconv.Atoi(parts[index]) + if err != nil { + return 0 + } + return n +} + func replaceEnvVarPlaceHolder(s string) string { return strings.Replace( s, diff --git a/ui/supplemental/css/owncloud.css b/ui/supplemental/css/owncloud.css index 82e90d47..c374dce4 100644 --- a/ui/supplemental/css/owncloud.css +++ b/ui/supplemental/css/owncloud.css @@ -177,7 +177,7 @@ pre { .navbar .navbar-item:hover, .navbar .navbar-link:hover { - background-color: var(--oc-navy-deep); + background-color: var(--oc-navy); color: #fff; } @@ -375,3 +375,43 @@ footer.footer .footer-logo img { .footer-nav ul li a { color: #aaa; } + +/* ── Search-filter announcement banner ────────────────────────────────────── + Injected by js/search-announcement.js. Remove that file and these rules + once the announcement has run its course. */ +#oc-search-announcement { + display: flex; + align-items: center; + justify-content: center; + gap: 0.75rem; + background-color: var(--oc-navy); + color: #fff; + padding: 0.5rem 1rem; + font-size: 0.875rem; + line-height: 1.4; +} + +.oc-announcement-text kbd { + display: inline-block; + padding: 0.1em 0.35em; + font-size: 0.8em; + font-family: var(--monospace-font-family); + background: rgba(255,255,255,0.15); + border: 1px solid rgba(255,255,255,0.35); + border-radius: 3px; +} + +.oc-announcement-close { + background: none; + border: none; + color: rgba(255,255,255,0.7); + font-size: 1.25rem; + line-height: 1; + cursor: pointer; + padding: 0 0.25rem; + flex-shrink: 0; +} + +.oc-announcement-close:hover { + color: #fff; +} diff --git a/ui/supplemental/js/pagefind-filters.js b/ui/supplemental/js/pagefind-filters.js new file mode 100644 index 00000000..78eae0fa --- /dev/null +++ b/ui/supplemental/js/pagefind-filters.js @@ -0,0 +1,18 @@ +// Injects a pagefind-filter-pane into the search modal body after the modal has +// rendered. Creating it here (rather than as a static HTML child of +// ) avoids the double-init problem: the modal's render() moves +// its custom children from into the inner , triggering +// a disconnect/reconnect cycle that re-runs connectedCallback and creates +// duplicate filter containers. Dynamic insertion puts the pane directly into +// its final position with a single connect. +// +// One shows ALL indexed filter types automatically; the +// data-pagefind-filter tags on each page (component and version) determine what +// appears. No filter attribute is needed. +customElements.whenDefined('pagefind-modal-body').then(function () { + var body = document.querySelector('pagefind-modal-body') + if (!body) return + var summary = body.querySelector('pagefind-summary') + var pane = document.createElement('pagefind-filter-pane') + body.insertBefore(pane, summary) +}) diff --git a/ui/supplemental/js/search-announcement.js b/ui/supplemental/js/search-announcement.js new file mode 100644 index 00000000..b6393717 --- /dev/null +++ b/ui/supplemental/js/search-announcement.js @@ -0,0 +1,38 @@ +/* + * One-time dismissible announcement banner for the Pagefind filter feature. + * Uses localStorage so the banner disappears permanently once dismissed. + * + * TO REMOVE THIS BANNER (3 steps): + * 1. Delete this file: + * ui/supplemental/js/search-announcement.js + * 2. Remove the +{{!-- Injects component/version filter panes into the search modal after it renders. + Must load after pagefind-component-ui.js so pagefind-modal-body is defined. --}} + {{!-- Companion behavior for the AsciiDoc tabs extension (asciidoc-extensions/tabs.js): removes the is-loading fallback and wires tab switching. --}} @@ -14,3 +17,5 @@ scripts run in document order. --}} +{{!-- One-time search-filter feature announcement. Remove once the banner has run its course. --}} + diff --git a/ui/supplemental/partials/header-content.hbs b/ui/supplemental/partials/header-content.hbs index b0b6d617..8afc5bfe 100644 --- a/ui/supplemental/partials/header-content.hbs +++ b/ui/supplemental/partials/header-content.hbs @@ -14,7 +14,7 @@ domain doc.owncloud.com, so the index is at /pagefind/ -- which is also where it sits under `npm run serve`. A repo-subpath prefix here would 404 on both. --}} - +