Merged
Conversation
AlexAndBear
approved these changes
Jan 28, 2026
AlexAndBear
deleted the
docs-update-2e3daacf-6997-4960-9420-cddb8948cdb4
branch
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds autogenerated documentation for OpenCloud server service environment variables and configuration for version 4.0.
Changes:
- Adds comprehensive documentation files for multiple OpenCloud services
- Includes README files, configuration variable references, and YAML configuration examples
- Covers services including webfinger, webdav, web, users, storage, sharing, search, and many others
Reviewed changes
Copilot reviewed 130 out of 170 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| webfinger_readme.md | Documents WebFinger service for OpenID Connect and instance discovery |
| webfinger_configvars.md | Environment variable reference for webfinger service |
| webfinger.yaml | Default YAML configuration for webfinger service |
| webdav_readme.md | Documents WebDAV service endpoints for thumbnails and search |
| webdav_configvars.md | Environment variable reference for webdav service |
| webdav.yaml | Default YAML configuration for webdav service |
| web.yaml | Default YAML configuration for web service |
| users_readme.md | Documents users service for CS3 Users API |
| users.yaml | Default YAML configuration for users service |
| userlog_readme.md | Documents userlog service for user-facing notifications |
| userlog.yaml | Default YAML configuration for userlog service |
| thumbnails_configvars.md | Environment variable reference for thumbnails service |
| thumbnails.yaml | Default YAML configuration for thumbnails service |
| storage-users_deprecation.md | Deprecation notice for storage-users service |
| storage-system_readme.md | Documents storage-system service for metadata persistence |
| storage-system_configvars.md | Environment variable reference for storage-system service |
| storage-system.yaml | Default YAML configuration for storage-system service |
| storage-shares_readme.md | Documents storage-shares service for federated sharing |
| storage-shares_configvars.md | Environment variable reference for storage-shares service |
| storage-shares.yaml | Default YAML configuration for storage-shares service |
| storage-publiclink_readme.md | Documents storage-publiclink service for public link shares |
| storage-publiclink_configvars.md | Environment variable reference for storage-publiclink service |
| storage-publiclink.yaml | Default YAML configuration for storage-publiclink service |
| sse_readme.md | Documents SSE service for server-sent events |
| sse_configvars.md | Environment variable reference for sse service |
| sse.yaml | Default YAML configuration for sse service |
| sharing_readme.md | Documents sharing service for CS3 Sharing API |
| sharing.yaml | Default YAML configuration for sharing service |
| settings.yaml | Default YAML configuration for settings service |
| search_readme.md | Documents search service with Bleve and OpenSearch support |
| search.yaml | Default YAML configuration for search service |
| postprocessing_configvars.md | Environment variable reference for postprocessing service |
| postprocessing.yaml | Default YAML configuration for postprocessing service |
| policies_configvars.md | Environment variable reference for policies service |
| policies.yaml | Default YAML configuration for policies service |
| ocs_readme.md | Documents OCS service for signing keys |
| ocs_configvars.md | Environment variable reference for ocs service |
| ocs.yaml | Default YAML configuration for ocs service |
| ocm_readme.md | Documents OCM service for federated sharing workflow |
| ocm.yaml | Default YAML configuration for ocm service |
| ocdav_readme.md | Documents ocdav service providing WebDAV API |
| ocdav_configvars.md | Environment variable reference for ocdav service |
| ocdav.yaml | Default YAML configuration for ocdav service |
| notifications_configvars.md | Environment variable reference for notifications service |
| notifications.yaml | Default YAML configuration for notifications service |
| nats_readme.md | Documents NATS service as the event broker |
| nats_configvars.md | Environment variable reference for nats service |
| nats.yaml | Default YAML configuration for nats service |
| invitations_readme.md | Documents invitations service for guest user management |
| invitations_configvars.md | Environment variable reference for invitations service |
| invitations.yaml | Default YAML configuration for invitations service |
| idp_readme.md | Documents IDP service for OpenID Connect provider |
| idp.yaml | Default YAML configuration for idp service |
| idm_readme.md | Documents IDM service providing minimal LDAP |
| idm_configvars.md | Environment variable reference for idm service |
| idm.yaml | Default YAML configuration for idm service |
| groups_readme.md | Documents groups service for CS3 Groups API |
| groups.yaml | Default YAML configuration for groups service |
| graph.yaml | Default YAML configuration for graph service |
| gateway.yaml | Default YAML configuration for gateway service |
| frontend_deprecation.md | Deprecation notice for frontend service |
| frontend.yaml | Default YAML configuration for frontend service |
| eventhistory_readme.md | Documents eventhistory service for event storage |
| eventhistory_configvars.md | Environment variable reference for eventhistory service |
| eventhistory.yaml | Default YAML configuration for eventhistory service |
| collaboration_readme.md | Documents collaboration service for WOPI integration |
| collaboration_configvars.md | Environment variable reference for collaboration service |
| collaboration.yaml | Default YAML configuration for collaboration service |
| clientlog_readme.md | Documents clientlog service for machine-readable notifications |
| clientlog_configvars.md | Environment variable reference for clientlog service |
| clientlog.yaml | Default YAML configuration for clientlog service |
| auth-service_readme.md | Documents auth-service for service account authentication |
| auth-service_configvars.md | Environment variable reference for auth-service |
| auth-service.yaml | Default YAML configuration for auth-service |
| auth-machine_readme.md | Documents auth-machine for user impersonation |
| auth-machine_configvars.md | Environment variable reference for auth-machine service |
| auth-machine.yaml | Default YAML configuration for auth-machine service |
| auth-bearer_readme.md | Documents auth-bearer for OIDC authentication |
| auth-bearer_configvars.md | Environment variable reference for auth-bearer service |
| auth-bearer.yaml | Default YAML configuration for auth-bearer service |
| auth-basic_readme.md | Documents auth-basic for basic authentication |
| auth-basic.yaml | Default YAML configuration for auth-basic service |
| auth-app_readme.md | Documents auth-app for 3rd party app authentication |
| auth-app_configvars.md | Environment variable reference for auth-app service |
| auth-app.yaml | Default YAML configuration for auth-app service |
| audit_readme.md | Documents audit service for compliance logging |
| audit_configvars.md | Environment variable reference for audit service |
| audit.yaml | Default YAML configuration for audit service |
| app-registry_configvars.md | Environment variable reference for app-registry service |
| app-registry.yaml | Default YAML configuration for app-registry service |
| app-provider_readme.md | Documents app-provider for CS3 App Provider API |
| app-provider_configvars.md | Environment variable reference for app-provider service |
| app-provider.yaml | Default YAML configuration for app-provider service |
| antivirus_readme.md | Documents antivirus service for virus scanning |
| antivirus_configvars.md | Environment variable reference for antivirus service |
| antivirus.yaml | Default YAML configuration for antivirus service |
| activitylog_readme.md | Documents activitylog service for resource activities |
| activitylog_configvars.md | Environment variable reference for activitylog service |
| activitylog.yaml | Default YAML configuration for activitylog service |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Abstract | ||
|
|
||
|
|
||
| The webfinger service provides an RFC7033 WebFinger lookup of OpenCloud instances relevant for a given user account via endpoints a the /.well-known/webfinger implementation. |
There was a problem hiding this comment.
Corrected 'a the' to 'at the'.
Suggested change
| The webfinger service provides an RFC7033 WebFinger lookup of OpenCloud instances relevant for a given user account via endpoints a the /.well-known/webfinger implementation. | |
| The webfinger service provides an RFC7033 WebFinger lookup of OpenCloud instances relevant for a given user account via endpoints at the /.well-known/webfinger implementation. |
| group_object_class: groupOfNames | ||
| idp: https://localhost:9200 | ||
| disable_user_mechanism: attribute | ||
| user_type_attribute: openCloudUserType |
There was a problem hiding this comment.
Inconsistent capitalization: 'openCloudUserType' should be 'openCloudUserType' to match the pattern used elsewhere (e.g., 'openclouduuid' on line 48).
Suggested change
| user_type_attribute: openCloudUserType | |
| user_type_attribute: opencloudusertype |
| nobody: 90 | ||
| join_username: false | ||
| join_owncloud_uuid: false | ||
| enable_medial_search: false |
There was a problem hiding this comment.
Corrected spelling of 'medial' to 'media' assuming this refers to media search functionality.
Suggested change
| enable_medial_search: false | |
| enable_media_search: false |
| ## Abstract | ||
|
|
||
|
|
||
| The `userlog` service is a mediator between the `eventhistory` service and clients who want to be informed about user related events. It provides an API to retrieve those. |
There was a problem hiding this comment.
Corrected 'user related' to 'user-related' for proper hyphenation of compound adjective.
Suggested change
| The `userlog` service is a mediator between the `eventhistory` service and clients who want to be informed about user related events. It provides an API to retrieve those. | |
| The `userlog` service is a mediator between the `eventhistory` service and clients who want to be informed about user-related events. It provides an API to retrieve those. |
| |`THUMBNAILS_GRPC_ADDR`| 1.0.0 |string|`The bind address of the GRPC service.`|`127.0.0.1:9185`| | ||
| |`THUMBNAILS_MAX_CONCURRENT_REQUESTS`| 1.0.0 |int|`Number of maximum concurrent thumbnail requests. Default is 0 which is unlimited.`|`0`| | ||
| |`THUMBNAILS_HTTP_ADDR`| 1.0.0 |string|`The bind address of the HTTP service.`|`127.0.0.1:9186`| | ||
| |`OC_HTTP_TLS_ENABLED`| 1.0.0 |bool|`Activates TLS for the http based services using the server certifcate and key configured via OC_HTTP_TLS_CERTIFICATE and OC_HTTP_TLS_KEY. If OC_HTTP_TLS_CERTIFICATE is not set a temporary server certificate is generated - to be used with PROXY_INSECURE_BACKEND=true.`|`false`| |
There was a problem hiding this comment.
Corrected spelling of 'certifcate' to 'certificate'.
Suggested change
| |`OC_HTTP_TLS_ENABLED`| 1.0.0 |bool|`Activates TLS for the http based services using the server certifcate and key configured via OC_HTTP_TLS_CERTIFICATE and OC_HTTP_TLS_KEY. If OC_HTTP_TLS_CERTIFICATE is not set a temporary server certificate is generated - to be used with PROXY_INSECURE_BACKEND=true.`|`false`| | |
| |`OC_HTTP_TLS_ENABLED`| 1.0.0 |bool|`Activates TLS for the http based services using the server certificate and key configured via OC_HTTP_TLS_CERTIFICATE and OC_HTTP_TLS_KEY. If OC_HTTP_TLS_CERTIFICATE is not set a temporary server certificate is generated - to be used with PROXY_INSECURE_BACKEND=true.`|`false`| |
Comment on lines
+45
to
+48
| id: openCloudUUID | ||
| id_is_octet_string: false | ||
| mail: mail | ||
| display_name: displayname |
There was a problem hiding this comment.
Inconsistent casing: 'openclouduuid' uses lowercase while 'openCloudUUID' is used in other files (e.g., users.yaml line 48). Consider standardizing the attribute naming convention.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the documentation.