Update docs by openclouders · Pull Request #626 · opencloud-eu/docs

openclouders · 2026-01-28T17:10:04Z

This PR updates the documentation.

Copilot

Pull request overview

This PR updates the documentation by adding autogenerated configuration documentation for multiple OpenCloud services.

Changes:

Added README files, configuration variable documentation, and YAML configuration examples for various services
Included documentation for webfinger, webdav, web, users, userlog, thumbnails, and many other core services
Added deprecation notices for services with deprecated environment variables (frontend, storage-users)

Reviewed changes

Copilot reviewed 127 out of 166 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
docs/dev/server/_static/env-vars/webfinger_readme.md	WebFinger service documentation for OpenID Connect and instance discovery
docs/dev/server/_static/env-vars/webfinger_configvars.md	Environment variable configuration for webfinger service
docs/dev/server/_static/env-vars/webfinger.yaml	Default YAML configuration for webfinger service
docs/dev/server/_static/env-vars/webdav_readme.md	WebDAV service documentation for thumbnails and search endpoints
docs/dev/server/_static/env-vars/webdav_configvars.md	Environment variable configuration for webdav service
docs/dev/server/_static/env-vars/webdav.yaml	Default YAML configuration for webdav service
docs/dev/server/_static/env-vars/web.yaml	Default YAML configuration for web service
docs/dev/server/_static/env-vars/users_readme.md	Users service documentation for CS3 API implementation
docs/dev/server/_static/env-vars/users.yaml	Default YAML configuration for users service
docs/dev/server/_static/env-vars/userlog_readme.md	Userlog service documentation for event processing
docs/dev/server/_static/env-vars/userlog_configvars.md	Environment variable configuration for userlog service
docs/dev/server/_static/env-vars/userlog.yaml	Default YAML configuration for userlog service
docs/dev/server/_static/env-vars/thumbnails_readme.md	Thumbnails service documentation for file preview generation
docs/dev/server/_static/env-vars/thumbnails_configvars.md	Environment variable configuration for thumbnails service
docs/dev/server/_static/env-vars/thumbnails.yaml	Default YAML configuration for thumbnails service
Multiple storage service files	Documentation for storage-users, storage-system, storage-shares, and storage-publiclink services
Multiple auth service files	Documentation for auth-service, auth-machine, auth-bearer, auth-basic, and auth-app services
Multiple additional service files	Documentation for remaining services including sse, sharing, search, postprocessing, policies, and others

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-28T17:12:28Z

docs/dev/server/_static/env-vars/webfinger_readme.md

+## Abstract
+
+
+The webfinger service provides an RFC7033 WebFinger lookup of OpenCloud resources, relevant for a given user account at the /.well-known/webfinger enpoint.


Corrected spelling of 'enpoint' to 'endpoint'.

Suggested change

The webfinger service provides an RFC7033 WebFinger lookup of OpenCloud resources, relevant for a given user account at the /.well-known/webfinger enpoint.

The webfinger service provides an RFC7033 WebFinger lookup of OpenCloud resources, relevant for a given user account at the /.well-known/webfinger endpoint.

Copilot · 2026-01-28T17:12:29Z

docs/dev/server/_static/env-vars/webfinger_readme.md

+1. An [OpenID Connect Discovery](#openid-connect-discovery) for the IdP, based on the OpenCloud URL.
+2. An [Authenticated Instance Discovery](#authenticated-instance-discovery), based on the user account.
+
+These two request are only needed for discovery.


Corrected 'request' to 'requests' for grammatical agreement with 'two'.

Suggested change

These two request are only needed for discovery.

These two requests are only needed for discovery.

Copilot · 2026-01-28T17:12:29Z

docs/dev/server/_static/env-vars/webfinger_configvars.md

+|`OC_CORS_ALLOW_METHODS`<br/>`WEBFINGER_CORS_ALLOW_METHODS`| 1.0.0 |[]string|`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.`|`[]`|
+|`OC_CORS_ALLOW_HEADERS`<br/>`WEBFINGER_CORS_ALLOW_HEADERS`| 1.0.0 |[]string|`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.`|`[]`|
+|`OC_CORS_ALLOW_CREDENTIALS`<br/>`WEBFINGER_CORS_ALLOW_CREDENTIALS`| 1.0.0 |bool|`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.`|`false`|
+|`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`|


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`|

Copilot · 2026-01-28T17:12:29Z

docs/dev/server/_static/env-vars/thumbnails_readme.md

+
+## Thumbnails and SecureView
+
+If a resource is shared using SecureView, the share reciever will get a 403 (forbidden) response when requesting a thumbnail. The requesting client needs to decide what to show and usually a placeholder thumbnail is used.


Corrected spelling of 'reciever' to 'receiver'.

Suggested change

If a resource is shared using SecureView, the share reciever will get a 403 (forbidden) response when requesting a thumbnail. The requesting client needs to decide what to show and usually a placeholder thumbnail is used.

If a resource is shared using SecureView, the share receiver will get a 403 (forbidden) response when requesting a thumbnail. The requesting client needs to decide what to show and usually a placeholder thumbnail is used.

Copilot · 2026-01-28T17:12:30Z

docs/dev/server/_static/env-vars/users.yaml

+    nobody: 90
+    join_username: false
+    join_owncloud_uuid: false
+    enable_medial_search: false


Likely typo: 'medial_search' should probably be 'media_search' or 'median_search' depending on the intended functionality.

Copilot · 2026-01-28T17:12:30Z

docs/dev/server/_static/env-vars/auth-app_configvars.md

+|`OC_SYSTEM_USER_API_KEY`<br/>`AUTH_APP_JSONCS3_SYSTEM_USER_API_KEY`| 4.0.0 |string|`API key for the STORAGE-SYSTEM system user.`|``|
+|`AUTH_APP_JSONCS3_PASSWORD_GENERATOR`| 4.0.0 |string|`The password generator that should be used for generating app tokens. Supported values are: 'diceware' and 'random'.`|`diceware`|
+|`AUTH_APP_JSONCS3_DICEWARE_NUMBER_OF_WORDS`| 4.0.0 |int|`The number of words the generated passphrase will have.`|`6`|
+|`AUTH_APP_JSONCS3_RANDOM_PASSWORD_LENGTH`| 4.0.0 |int|`The number of charactors the generated passwords will have.`|`0`|


Corrected spelling of 'charactors' to 'characters'.

Suggested change

|`AUTH_APP_JSONCS3_RANDOM_PASSWORD_LENGTH`| 4.0.0 |int|`The number of charactors the generated passwords will have.`|`0`|

|`AUTH_APP_JSONCS3_RANDOM_PASSWORD_LENGTH`| 4.0.0 |int|`The number of characters the generated passwords will have.`|`0`|

Update docs with latest env vars

7464075

openclouders added Docs:Build&Tools Docs:CiWeeklyCleanup labels Jan 28, 2026

AlexAndBear marked this pull request as ready for review January 28, 2026 17:11

Copilot AI review requested due to automatic review settings January 28, 2026 17:11

Copilot AI reviewed Jan 28, 2026

View reviewed changes

AlexAndBear approved these changes Jan 28, 2026

View reviewed changes

AlexAndBear merged commit 5ee5ff3 into main Jan 28, 2026
6 checks passed

AlexAndBear deleted the docs-update-1b38b2eb-4fd2-497f-9dc1-481c154f0a6d branch January 28, 2026 17:20

openclouders mentioned this pull request Jan 28, 2026

🎉 Release 3.10.0 #625

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Update docs#626

Update docs#626
AlexAndBear merged 1 commit intomainfrom
docs-update-1b38b2eb-4fd2-497f-9dc1-481c154f0a6d

openclouders commented Jan 28, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		## Abstract


		The webfinger service provides an RFC7033 WebFinger lookup of OpenCloud resources, relevant for a given user account at the /.well-known/webfinger enpoint.

	These two request are only needed for discovery.
	These two requests are only needed for discovery.

	\|`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`\|


		## Thumbnails and SecureView

		If a resource is shared using SecureView, the share reciever will get a 403 (forbidden) response when requesting a thumbnail. The requesting client needs to decide what to show and usually a placeholder thumbnail is used.

	\|`AUTH_APP_JSONCS3_RANDOM_PASSWORD_LENGTH`\| 4.0.0 \|int\|`The number of charactors the generated passwords will have.`\|`0`\|
	\|`AUTH_APP_JSONCS3_RANDOM_PASSWORD_LENGTH`\| 4.0.0 \|int\|`The number of characters the generated passwords will have.`\|`0`\|

Comments

Conversation

openclouders commented Jan 28, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants