Skip to content

Update docs - #1393

Merged
AlexAndBear merged 1 commit into
mainfrom
docs-update-ece7978d-c7a2-496b-9004-fa2e17b7258e
Nov 18, 2026
Merged

AlexAndBear merged 1 commit into
mainfrom
docs-update-ece7978d-c7a2-496b-9004-fa2e17b7258e

Conversation

@openclouders

Copy link
Copy Markdown
Contributor

This PR updates the documentation.

@AlexAndBear
AlexAndBear marked this pull request as ready for review November 18, 2026 02:21
Copilot AI balanced review requested due to automatic review settings November 18, 2026 02:21
@AlexAndBear
AlexAndBear merged commit 8a25758 into main Nov 18, 2026
10 checks passed
@AlexAndBear
AlexAndBear deleted the docs-update-ece7978d-c7a2-496b-9004-fa2e17b7258e branch November 18, 2026 02:21
@openclouders openclouders mentioned this pull request Nov 18, 2026
1 task

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The global environment-variable documentation misstates thumbnail-limit availability and scope, omits the proxy setting’s broader effect and private-network warning, and describes OC_URL too narrowly despite its authentication impact.

3 open issues
What changed in this PR

Refreshes OpenCloud’s administrator configuration reference with release-specific metadata and updated gateway caching documentation.

Changes:

  • Replaces release placeholders with 9.1.1 removal versions and 9.2.0 introduction versions, and removes generated timestamps.
  • Removes gateway create-home cache settings and documents proxy-side tracking.
  • Updates global environment-variable descriptions, defaults, and version metadata.
File Description
docs/​_static/​env-vars/​webdav_configvars.md Updates thumbnail-cache deprecation metadata and removes the timestamp.
docs/​_static/​env-vars/​web_configvars.md Updates the EOS option’s removal version and removes the timestamp.
docs/​_static/​env-vars/​storage-users_configvars.md Removes the generated timestamp.
docs/​_static/​env-vars/​graph_configvars.md Updates deprecation and feature-introduction versions.
docs/​_static/​env-vars/​global_configvars.md Refreshes global variable descriptions, defaults, and availability metadata.
docs/​_static/​env-vars/​gateway.yaml Removes create-home cache configuration from the YAML reference.
docs/​_static/​env-vars/​gateway_readme.md Describes provider caching and proxy-side personal-space tracking.
docs/​_static/​env-vars/​gateway_configvars.md Removes create-home cache environment-variable entries.
docs/​_static/​env-vars/​frontend_configvars.md Updates removal versions and managed-spaces availability metadata.

Review effort: Balanced

| `OC_SYSTEM_USER_IDP` | 4.0.0 | string | IDP of the OpenCloud STORAGE-SYSTEM system user. | "internal" |
| `OC_THUMBNAILS_ADDITIONAL_SOURCE_TYPES` | 9.0.0 | []string | Additional mime types oc:has-preview is answered with 1 for, the same list the webdav service attempts previews for. The types the build ships are included; this only adds to them. | "[]" |
| `OC_THUMBNAILS_MAX_INPUT_IMAGE_FILE_SIZE` | 9.0.0 | string | Maximum file size of an input image a thumbnail is made of. The generator refuses a larger body, so both read the same name by default. Usable common abbreviations: [KB, KiB, MB, MiB, GB, GiB], example: 50MB | "50MB" |
| `OC_THUMBNAILS_MAX_INPUT_IMAGE_FILE_SIZE` | 9.2.0 | string | The maximum file size of an image that can be set as the image of a space. A larger one is refused with HTTP 413, because no thumbnail can be made of it, and space images are only shown as thumbnails. Usable common abbreviations: [KB, KiB, MB, MiB, GB, GiB], example: 50MB. An empty value means unlimited. | "50MB" |
| `OC_TRANSLATION_PATH` | 1.0.0 | string | (optional) Set this to a path with custom translations to overwrite the builtin translations. Note that file and folder naming rules apply, see the documentation for more details. | "" |
| `OC_TRUSTED_PROXIES` | 9.1.0 | []string | IP addresses and CIDR ranges of the reverse proxies in front of OpenCloud. The client address is only taken from the header set in PROXY_CLIENT_IP_HEADER if the request comes from one of these. Defaults to the loopback and private network ranges. Set it to the addresses of your reverse proxies if clients can reach OpenCloud from a private network. See the Environment Variable Types description for more details. | "[127.0.0.0/8 ::1/128 10.0.0.0/8 172.16.0.0/12 192.168.0.0/16 fc00::/7]" |
| `OC_URL` | 1.0.0 | string | The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. | "https://localhost:9200" |
| `OC_TRUSTED_PROXIES` | 9.1.0 | []string | IP addresses and CIDR ranges of the reverse proxies in front of the collaboration service. The client address in the access log is only taken from the header set in COLLABORATION_HTTP_CLIENT_IP_HEADER if the request comes from one of these. Defaults to the loopback and private network ranges. See the Environment Variable Types description for more details. | "[127.0.0.0/8 ::1/128 10.0.0.0/8 172.16.0.0/12 192.168.0.0/16 fc00::/7]" |
| `OC_TRUSTED_PROXIES` | 9.1.0 | []string | IP addresses and CIDR ranges of the reverse proxies in front of OpenCloud. The client address is only taken from the header set in PROXY_CLIENT_IP_HEADER if the request comes from one of these. Defaults to the loopback and private network ranges. Set it to the addresses of your reverse proxies if clients can reach OpenCloud from a private network. See the Environment Variable Types description for more details. | "[127.0.0.0/8 ::1/128 10.0.0.0/8 172.16.0.0/12 192.168.0.0/16 fc00::/7]" |
| `OC_URL` | 1.0.0 | string | The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. | "https://localhost:9200" |
| `OC_TRUSTED_PROXIES` | 9.1.0 | []string | IP addresses and CIDR ranges of the reverse proxies in front of the collaboration service. The client address in the access log is only taken from the header set in COLLABORATION_HTTP_CLIENT_IP_HEADER if the request comes from one of these. Defaults to the loopback and private network ranges. See the Environment Variable Types description for more details. | "[127.0.0.0/8 ::1/128 10.0.0.0/8 172.16.0.0/12 192.168.0.0/16 fc00::/7]" |
| `OC_URL` | 1.0.0 | string | Base url to navigate back from the app to the containing folder in the file list. | "https://localhost:9200/" |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants