eliott/ocis
1
0
Fork 0
mirror of https://github.com/owncloud/ocis synced 2026-04-25 17:25:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

[docs-only] Update envvar description

Browse Source
This commit is contained in:
Martin Mattel
2025-07-07 15:54:48 +02:00
parent 9bfa5f9fef
commit 581b2dbac3
36 changed files with 718 additions and 344 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Makefile
View File

@@ -169,7 +169,9 @@ docs-generate:
done
$(MAKE) --no-print-directory -C docs docs-generate || exit 1
cp docs/services/general-info/env-var-deltas/*.adoc docs/services/_includes/adoc/env-var-deltas/
# .adoc for admin docs, .md for dev docs
cp docs/services/general-info/envvars/env-var-deltas/*.adoc docs/services/_includes/adoc/env-var-deltas/
cp docs/services/general-info/envvars/env-var-deltas/*.md docs/services/_includes/adoc/env-var-deltas/
.PHONY: check-env-var-annotations
check-env-var-annotations:

213
docs/helpers/README.md
View File

@@ -1,29 +1,41 @@
# Docs Helpers
* [Introduction](#introduction)
* [Output Generated](#output)
* [Admin Doc Process](#admin-doc-process)
* [Branching](#branching)
* [Service-Dependent Output](#service-dependent-output)
* [Generate Envvar Docs for Config Structs](#generate-envvar-docs-for-config-structs)
* [Output Generated](#output-generated)
* [Process for Admin Docs](#process-for-admin-docs)
* [Working With Branches](#working-with-branches)
* [Service-Dependent Envvars](#service-dependent-envvars)
* [Generate Envvar Docs From Config Structs](#generate-envvar-docs-from-config-structs)
* [Deprecation Process](#deprecation-process)
* [Global Envvars](#global-envvars)
* [Extended Envvars](#extended-envvars)
* [General Extended Envvars Info](#general-extended-envvars-info)
* [Extract Extended Envvars](#extract-extended-envvars)
* [Special Envvars](#special-envvars)
* [Special Scope Envvars](#special-scope-envvars)
* [Extended Envvars](#extended-envvars)
* [Extract Extended Envvars](#extract-extended-envvars)
* [Generate Extended Envvar Docs](#generate-extended-envvar-docs)
* [Tasks for New Releases](#tasks-for-new-releases)
* [Doc Tasks for New Releases](#doc-tasks-for-new-releases)
* [Backporting](#backporting)
* [Old Processes](#old-processes)
## Introduction
`docs/helpers` contains a go program named `main.go` which creates docs by extracting information from the code using additional go programs. Individual steps (programs) can be called manually if needed. Note that not all programs are called automatically on purpose, see the [Tasks for New Releases](#tasks-for-new-releases) below. `main.go` is used by `make docs-generate` (or `make -C docs docs-generate` when running manually from the repos root) which is triggered by the CI or can be called manually. It calls the other required programs and has these main responsibilities for automatic runs:
This readme file describes how envvars are managed internally for the documentation process.
`docs/helpers` contains a go program named `main.go` which creates docs by extracting information from the code using additional go programs.
In `./docs/helpers` run: `go run . --help`\
This will give you an overview of available commands.
Individual steps (programs) can be called manually if needed. Note that not all programs are called automatically on purpose, see the [Doc Tasks for New Releases](#doc-tasks-for-new-releases) below. `main.go` is used by `make docs-generate` (or `make -C docs docs-generate` when running manually from the repos root) which is triggered by the CI or can be called manually. It calls the other required programs and has these main responsibilities for automatic runs:
- Generate docs for envvars in config structs including deprecations if there are any.
- Extract and generate docs for `extended` envvars that are not mentioned in config structs (aka "rogue" envvars).
- Extract and generate docs for `global` envvars which occur in multiple services.
- Create `docs/service/<service-name>/_index.md` from `service/<service-name>/README.md` files while keeping the existing `_index.md` if the service README.md has not been created so far. Also see the important note at [docs README](../README.md).
Note that whenever you run `make docs-generate`, a file named `env_vars.yaml` will appear to have changed content. Usually, this change can safely be dropped and no merge is required. BUT, before a new production release ocis is generated, this file neds close attention, manual intervention and changes need to be merged. See the [developer documentation](https://owncloud.dev/general-info/envvars/new-release-process/) for more details.
## Output Generated
- The generated yaml files can be found at: `docs/services/_includes` when running locally respectively in the `docs branch` after the CI has finished.
@@ -31,93 +43,88 @@
- The file name for global envvars is named: `global_configvars.adoc`.
- The file name for extended envvars is named: `extended_configvars.adoc`.
- A file named `docs/helpers/env_vars.yaml` containing envvar changes gets updated if changes have been identified.
- A file named `docs/helpers/extended_vars.yaml` containing changes for extended envvars gets updated if changes have been identified. Note, if changes appear, **this file needs manual treatment** before committing, see [Extended Envvars](#extended-envvars) below.
- A file named `docs/helpers/extended_vars.yaml` containing changes for extended envvars gets updated if changes have been identified.\
Note, if changes appear, **this file needs manual treatment** before committing, see [Extended Envvars](#extended-envvars) below.
## Admin Doc Process
## Process for Admin Docs
Whenever a build from the [ocis admin](https://github.com/owncloud/docs-ocis) documentation or any other admin related documentation is triggered, files generated here in the ocis repo are included into the build process and added in a proper manner defined by the admin documentation. The updated documentation will then show up on the public [admin documentation](https://doc.owncloud.com/ocis/next/).
Whenever a build is triggered from the [ocis Admin](https://github.com/owncloud/docs-ocis) docs or any other admin-related documentation, the files generated in this ocis repository are included in the build process and added in the manner defined by the admin documentation. The updated documentation will then appear on the public [admin documentation](https://doc.owncloud.com/ocis/next) page. The same is true for ocis production releases.
## Branching
**Notes**
* When docs relevant data will be generated in ocis, they will be written into the `docs/servcies/...` folder structure, but they are in the master branch. When merging, an automated process will **move** them into the `docs` branch.\
**When running make commands locally, the relocation is not done and files reside on the generated location!**
* The above is the reason you should have an up-to-date docs branch before deriving a `docs-stable-x.y` branch from docs - though backports can be done.
* .adoc file generation
* Service related adoc files are autogenerated and saved in `/docs/services/<service-name>` but will be _relocated_ by each merge into the docs branch into a subfolder named `services/_include/adoc/<service-name.adoc>`.
* Release based envvar changes are saved during manual generation in `/docs/services/general-info/env-var-deltas/<filename>` but will be _copied_ on each merge into the doc branch into a subfolder named `services/_include/adoc/env-var-deltas/<filename>`.
* Exclude paths for Hugo
* The paths defined above for .adoc files are excluded from parsing by Hugo. The source of what to exclude is defined in the `config.yaml` file located in [owncloud.github.io](https://github.com/owncloud/owncloud.github.io/). Any folder containg .adoc files must be added there else `make -C docs docs-serve` or CI will fail reporting an adoc related parsing error. (We could also add an asciidoc parser to Hugo as alternative...)
**Backgroud Information**\
The admin docs rely on the existence of the following branches in the ocis repository. Note that the admin docs define which ocis branch is accessed via the attributes in the `antora.yml` file in the respective admin docs branch.
* `docs`\
This reflects ocis master and is referenced from the admin docs from the master branch showing as `next` in the documentation.
* `docs-stable-x.y`\
This reflects a published ocis release and is referenced from the admin docs via the corresponding admin docs branch such as `7.2`.
Because of this, branching and parametrizing admin docs occurs **after** branching an ocis release with its necessary branches! If you branch admin docs before the required ocis branches are available, you must set the ocis source branch to import data from to `docs` and reconfigure afterwards.
## Working With Branches
The following is valid for envvars and yaml files related to the doc process:
* When filing a pull request in the ocis master branch relating to docs, CI runs `make docs-generate` and copies the result into the `docs` branch of ocis. This branch is then taken as base for owncloud.dev and as reference for the [admin docs](https://doc.owncloud.com/ocis/next/).
* When filing a pull request in the ocis master branch relating to docs, CI runs `make docs-generate` and copies the result into the `docs` branch of ocis. The `docs` branch is taken as base for the [developer documnetation](owncloud.dev) and as reference for the [admin docs](https://doc.owncloud.com/ocis/next/).
* When running `make docs-generate` _locally_, the same output is created as above but it stays in the same branch where the make command was issued.
In both cases, `make docs-generate` removes files in the target folder `_includes` to avoid remnants. All content is recreated.
On a side note (unrelated to the `docs` branch), [deployment examples](https://github.com/owncloud/ocis/tree/master/deployments/examples) have their own branch related to an ocis stable version to keep the state consistent, which is necessary for the admin documentation.
## Service-Dependent Output
## Service-Dependent Envvars
For each service available, a file named like `<service name>_configvars.adoc` is created containing a:
* table on top defining deprecated envvars - if applicable
* table containing all envvars with their name, type, default value and description
The table with deprecations is always printed in the final adoc file even if there are none, but is rendered in the docs build process only if the `HasDeprecations` value is set. This value is automatically handed over via the adoc file. The template file can be found at `docs/templates/ADOC.tmpl`.
The table with deprecations is always printed in the final adoc file even if there are none, but is rendered in the docs build process only if the `HasDeprecations` value is set. This value is automatically handed over via the .adoc file. The template file can be found at `docs/templates/ADOC.tmpl`.
### Generate Envvar Docs for Config Structs
### Generate Envvar Docs From Config Structs
Generates docs from a template file, mainly extracting `"env"` and `"desc"` tags from the config structs.
Templates can be found in `docs/helpers` folder. (Same as this `README`.) Check `.tmpl` files
Templates can be found in `docs/helpers` folder. (Same as this `README`). Check the `.tmpl` files.
### Deprecation Process
For details on deprecation see the [deprecating-variables](https://github.com/owncloud/ocis/blob/master/docs/ocis/development/deprecating-variables.md) documentation.
For details on deprecation see the [deprecating-variables](https://owncloud.dev/services/general-info/envvars/deprecating-variables/) documentation in the dev docs.
## Global Envvars
Global envvars are gathered by checking if the envvar is available in more than one service. The table created is similar to the service-dependent envvar table but additionally contains a column with all service names where this envvar occurs. The output is rendered in list form where each item is clickable and automatically points to the corresponding service page. The template file can be found at `docs/templates/ADOC_global.tmpl`.
True global envvars are identified by checking if they are available in more than one service. The table created is similar to the service-dependent envvar table but additionally contains a column with all service names where this envvar occurs. The output is rendered in list form where each item is clickable and automatically points to the corresponding service page. The template file can be found at `docs/templates/ADOC_global.tmpl`.
If global envvars do not appear in the list of globals, before checking if the code works, do a manual search in the ocis/services folder with `grep -rn OCIS_xxx` if the envvar in question appears at least twice. If the envvar only appears once, the helpers code works correct.
If global envvars does not appear in the list of globals, before checking if the code works, do a manual search in the `ocis/services` folder with `grep -rn OCIS_xxx` if the envvar in question appears at least twice. If the envvar only appears once, the helpers code works correct.
## Extended Envvars
**IMPORTANT**\
A global envvar may not appear in the globals list though it is named `OCIS_xxx`. This can be the case if a developer decides for a global name but it is currently not used in more than one service!
### General Extended Envvars Info
## Special Envvars
"Extended" envvars are variables that need to be present *before* the core or services are starting up as they depend on the info provided like path for config files etc. Therefore they are _not_ bound to services like other envvars. Extended envvars are identified via `os.Getenv`, usually defined via a subfolder of `ocis-pkg`. The real envvar name name cant be automatically assigned and needs to be manually defined via the code in the `extended_vars.yaml` file.
### Special Scope Envvars
It can happen that extended envvars are found but do not need to be published as they are for internal use only. Those envvars can be defined to be ignored for further processing.
These envvars cant be managed automatically and need a full manualy process. See the [Special Scope Envvars](https://owncloud.dev/general-info/envvars/special-envvars/) documentation in the dev docs.
**IMPORTANT:**
### Extended Envvars
- **First Time Identification**\
Once an extended envvar has been identified, it is added to the `extended_vars.yaml` file found, but never changed or touched by the process anymore. There is one exception with respect to single/double quote usage. While you can (and will) manually define a text like: `"'/var/lib/ocis'"`, quotes are transformed by the process in the .yaml file to: `'''/var/lib/ocis'''`. There is no need to change this back, as the final step transforms this correctly for the adoc table.
For a description and their handling see the [Extended Envvars](https://owncloud.dev/general-info/envvars/special-envvars/) documentation in the dev docs.
- **Item Naming**\
An extended envvar may not have the right naming. It may appear as `name: _registryEnv`. In case, this envvar needs to be named properly like `name: MICRO_REGISTRY` which can only be done in close alignment with development.
#### Extract Extended Envvars
- **Item Uniqueness**\
The identification, if an envvar is already present in the yaml file, is made via the `rawname` and the `path` identifier which includes the line number. **If there is a change in the source file shifting line numbers, new items will get added and old ones do not get touched.** Though technically ok, this can cause confusion to identify which items are correctly present or just added additionally just be cause code location has changed. If there are multiple occurrences of the same `rawname` value, check which one contains relevant data and set `do_ignore` to `false` and all others to `true`. When there are two identical blocks with different source references, mostly the one containing a proper `default_value` is the active one. Populate the false block with the envvar data to be used.
- **Fixing Items**\
If an item has been identified as additionally added because there was a change in the code location, it is mostly sufficient to just fix the line number in the `path` key of the existing/correct one and double check by removing the newly added ones. Then, re-run `make docs-generate`. If the fix was correct, no new items of the same will re-appear.
- **Remove Orphaned Items**\
To get rid of items with wrong line numbers, check `rawname` the `path` and correct the _existing ones_, especially the one containing the description and which is marked `do_ignore` false. Only items that have a real line number match need to be present, orphaned items can safely be removed. You can double-check valid items by creating a dummy branch, delete the `extended_vars.yaml` and run `make docs-generate` to regenerate the file having only items with valid path references. With that info, you can remove orphaned items from the live file. Note to be careful on judging only on `foundincode` set to false indicating an item not existing anymore. Fix all items first, when rerunning `make docs-generate`, this may change back to true!
- **Sort Ordering**\
Do not change the sort order of extended envvar blocks as they are automatically reordered alphabetically.
- **Mandatory Key Values**\
Because extended envvars do not have the same structural setup as "normal" envvars (like type, description or defaults), this info needs to be provided manually once - for each valid block. Any change of this info will be noticed during the next CI run, the corresponding adoc file generated, changes transported to the docs branch and published in the next admin docs build. See the following example with all keys listed and populated:
```yaml
rawname: registryAddressEnv
path: ocis-pkg/registry/registry.go:44
foundincode: true
name: MICRO_REGISTRY_ADDRESS
type: string
default_value: ""
description: The bind address of the internal go micro framework. Only change on
supervision of ownCloud Support.
do_ignore: false
```
### Extract Extended Envvars
The grep command parses the code, looking for `os.Getenv` and passes these contents to a yaml file along with the following information:
The `grep` command parses the code, looking for `os.Getenv` and passes these contents to a yaml file along with the following information:
```golang
// Variable contains all information about one rogue envvar
type Variable struct {
@@ -146,9 +153,9 @@ type Variable struct {
}
```
This yaml file can later be manually edited to add descriptions, default values, etc.
This yaml file **can and must be edited manually** to add descriptions, default values, etc.
**IMPORTANT**: `RawName`, `Path` and `FoundInCode` are automatically filled by the program. DO NOT EDIT THESE VALUES MANUALLY.
**IMPORTANT**: Some value are automatically filled by the program and mujst not be changed. See the developer documentation for more details.
### Generate Extended Envvar Docs
@@ -156,66 +163,7 @@ The process further picks up the `yaml` file generated in the `Extract Rogue Env
## Doc Tasks for New Releases
**IMPORTANT**\
For a new ocis release, some tasks are necessary to be done **before** and **after** releasing. Follow the steps carefully to avoid issues. Most of the docs related tasks are not part of the CI. With each step finished successfully, the next step can be started. Sometimes, due to last minute changes, steps need to be redone!
**Backgroud Information**\
Admin docs rely on the existance of the following branches in the ocis repo. Note that the reference in the admin docs which ocis branch is accessed is defined in the `antora.yml` file via `attributes` existing in each branch.
* `docs`\
This reflects ocis master and is referenced from the admin docs from the master branch showing as `next` in the documentation.
* `docs-stable-x.y`\
This reflects a published ocis release and is referenced from the admin docs from the corresponding branch showing like `7.0`
Because of this, branching and parametrizing admin docs occurs **after** branching an ocis release with its necessary branches! If you branch admin docs before the required ocis branches are available, you must set the ocis source branch to import data from to `docs` and reconfigure afterwards.
**Notes**
* When docs relevant data will be generated in ocis, they will be written into the `docs/servcies/...` folder structure, but they are in the master branch. When merging, an automated process will move/copy them into the `docs`branch. When running make commands locally, the relocation is not done and files reside on the generated location!
* .adoc file generation
* Service related adoc files are autogenerated and saved in `/docs/services/<service-name>` but will be _relocated_ by each merge into the docs branch into a subfolder named `services/_include/adoc/<service-name.adoc>`.
* Release based envvar changes are saved during manual generation in `/docs/services/general-info/env-var-deltas/<filename>` but will be _copied_ on each merge into the doc branch into a subfolder named `services/_include/adoc/env-var-deltas/<filename>`.
* Exclude paths for Hugo
* The paths defined above for .adoc files are excluded from parsing by Hugo. The source of what to exclude is defined in the `config.yaml` file located in [owncloud.github.io](https://github.com/owncloud/owncloud.github.io/). Any folder containg .adoc files must be added there else `make -C docs docs-serve` or CI will fail reporting an adoc related parsing error. (We could also add an asciidoc parser to Hugo as alternative...)
### Task List
The following can be done at any time but it must be done *latest* when no envvar changes are made which is just before a new release gets finally tagged. The data generated **must** be part of the upcoming release and be merged before tagging/branching!
**Before Releasing** Generate required .adoc files necessary for the admin docs
* Run from the ocis root `make -C docs docs-generate`
* **Check for Extended Envvars**\
Check if there is a change in the `extended-envars.yaml` output. In this case, process [Extended Envvars](#extended-envvars). When done, re-run the make command and check if the output of `./docs/services/_includes/adoc/extended_configvars.adoc` matches the expectations.
* **Check for a changed 'env_vars.yaml' File**\
This file will most likely show changes and merging them is essential as base for added/removed or deprecated envvars. This file will get additions/updates only, but things never get automatically deleted.
* **Mandatory for a new release**, remove all envvars from the `env_vars.yaml` file manually that have been removed from the code, either with or without deprecation.
Commit the changes, create a PR and merge it. Next steps are based on this!
* Create added/removed and deprecated envvar .adoc files between versions containing includable tables pulled by the admin docs.
* Parametrize variables in `docs/helpers/changed_envvars.py` according your needs necessary to generate proper output.
* Create a branch and run from the ocis root `python3 docs/helpers/changed_envvars.py`\
This will create three files that need manual treatment before committing/merging. Note that this script accesses sources from github and not locally, therefore an actual `env_vars.yaml` in github is essential.
* Check the output of all three files and fix/delete any envvar in `env_vars.yaml` if required. If fixes have been done, the changed `env_vars.yaml` file **MUST** be _merged_ first, you must rebase and rerun the python script.
* If all three files contain correct data, manually set the xrefs. This cant be done automatically. Use one of the existing `added` files as template to generate a consistent output.
* Merge the three files and rerun the python script to prove all has been done correctly. You should now see only changes in xrefs as they get overwritten by default data. If this is the case, you can safely drop the generated changes.
**After Releasing** Generate required .md files necessary for the dev docs
Similar to the Asciidoc files for the admin docs, Markdown files necessary for the dev docs need to be generated. The program for this is written in go and currently does not compare versions but only checks the introduction version. This is sufficient for devs as details necessary for migration documentation is done via the .adoc files in the admin docs.
* In `./docs/helpers` run: `go run . --help`\
This will give you an overview of available commands.
* Because `env_vars.yaml` has been cleaned up as part of the _before release_ tasks above, we can rely on its actuality for the branches to be compared.
* Create delta files for added, removed and deprecated envvars. To do so type:\
`go run . env-var-delta-table` and use as parameter the versions you want to compare. Example: `v5.0.0 v7.0.0`.
* List and check the files created in `./docs/helpers/output/env-deltas/`. The markdown files created contain a table with dev relevant data. Any other files created are not relevant and can safely be deleted.
* Create a branch and move the markdown files from `./docs/helpers/output/env-deltas/` to `./docs/services/general-info/env-var-deltas/`. The markdown files will be consumed by dev docs from this location.
* Commit all changes, create a PR and merge. Dev docs is now up-to-date.
For details see the [Release Process for Envvars](https://owncloud.dev/general-info/envvars/new-release-process/) documentation in the dev docs.
## Backporting
@@ -223,8 +171,25 @@ The ocis repo contains branches which are necessary for the documentation. The `
Cases for a backport can be a typo in an envvar description you want to have fixed in a stable branch too or a file was created after the stable branch was set up but needs to be available in that branch.
When a new stable ocis release (branch) is published, like `stable-5.0`, an additional branch (including CI) is set up manually by the dev team for referencing docs content like `docs-stable-5.0` - related to envvars and yaml files only - and added to the CI.
When a new stable ocis release (branch) is published, like `stable-7.2`, an additional branch (including CI) is set up manually by the dev team for referencing docs content like `docs-stable-7.2` - related to envvars and yaml files only - and added to the CI.
In case it is necessary to transport a change from master to a stable branch like `docs-stable-5.0`, you must backport the original changes that will create that file to the `stable-5.0` branch. The CI will then take care of creating the results in the target `docs-stable-5.0`.
In case it is necessary to transport a change from master to a stable branch like `docs-stable-7.2`, you must backport the original changes that will create that file to the `stable-7.2` branch. The CI will then take care of creating the results in the target `docs-stable-7.2`.
If the change is expected to have a bigger impact on documenation, you can locally run `make -C docs docs-generate` in the respective branch containing the changes or independently in the `stable-x.y` branch after merging to see if there are additional actions necessary and changed files may need to get checked in.
## Old Processes
The generation of delta files for markdown could also be done using a go helper. This should not be done anymore because:
1. It needs that the production tag is already created for the new release and contains all data.
2. The outcome has a different look and feel compared the new process.
For the sake of documentation because the code still extists, here is the description:
* Because `env_vars.yaml` has been cleaned up as part of the update tasks, we can rely on its actuality for the branches to be compared.
* Create delta files for added, removed and deprecated envvars. To do so type:\
`go run . env-var-delta-table` and use as parameter the versions you want to compare. Example: `v7.1.0 v7.2.0`.
* List and check the files created in `./docs/helpers/output/env-deltas/`. The markdown files created contain a table with dev relevant data. Any other files created are not relevant and can safely be deleted.
* Create a branch and move the markdown files from `./docs/helpers/output/env-deltas/` to `./docs/services/general-info/env-var-deltas/`. The markdown files will be consumed by dev docs from this location.
* Commit all changes, create a PR and merge. Dev docs is now up-to-date.

295
docs/helpers/env_vars.yaml
View File

@@ -5974,10 +5974,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: ""
@@ -7818,12 +7818,12 @@ OCDAV_WEBDAV_NAMESPACE:
removalVersion: ""
deprecationInfo: ""
OCIS_ADMIN_USER_ID:
name: OCIS_ADMIN_USER_ID;IDM_ADMIN_USER_ID
name: OCIS_ADMIN_USER_ID;STORAGE_USERS_PURGE_TRASH_BIN_USER_ID
defaultValue: ""
type: string
description: ID of the user that should receive admin privileges. Consider that
the UUID can be encoded in some LDAP deployment configurations like in .ldif files.
These need to be decoded beforehand.
description: ID of the user who collects all necessary information for deletion.
Consider that the UUID can be encoded in some LDAP deployment configurations like
in .ldif files. These need to be decoded beforehand.
introductionVersion: pre5.0
deprecationVersion: ""
removalVersion: ""
@@ -7848,21 +7848,21 @@ OCIS_ASYNC_UPLOADS:
removalVersion: ""
deprecationInfo: ""
OCIS_CACHE_AUTH_PASSWORD:
name: OCIS_CACHE_AUTH_PASSWORD;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_PASSWORD
name: OCIS_CACHE_AUTH_PASSWORD
defaultValue: ""
type: string
description: The password to authenticate with the store. Only applies when store
type 'nats-js-kv' is configured.
description: The password to use for authentication. Only applies when using the
'nats-js-kv' store type.
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_CACHE_AUTH_USERNAME:
name: OCIS_CACHE_AUTH_USERNAME;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_USERNAME
name: OCIS_CACHE_AUTH_USERNAME
defaultValue: ""
type: string
description: The username to authenticate with the store. Only applies when store
type 'nats-js-kv' is configured.
description: The username to use for authentication. Only applies when using the
'nats-js-kv' store type.
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
@@ -7887,33 +7887,35 @@ OCIS_CACHE_DISABLE_PERSISTENCE:
removalVersion: ""
deprecationInfo: ""
OCIS_CACHE_STORE:
name: OCIS_CACHE_STORE;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE
defaultValue: nats-js-kv
name: OCIS_CACHE_STORE
defaultValue: memory
type: string
description: 'The type of the signing key store. Supported values are: ''redis-sentinel''
and ''nats-js-kv''. See the text description for details.'
introductionVersion: "5.0"
description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'',
''nats-js-kv'', ''noop''. See the text description for details.'
introductionVersion: pre5.0
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_CACHE_STORE_NODES:
name: OCIS_CACHE_STORE_NODES;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_NODES
name: OCIS_CACHE_STORE_NODES
defaultValue: '[127.0.0.1:9233]'
type: '[]string'
description: 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.
introductionVersion: "5.0"
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
is dependent on the library of the configured store. See the Environment Variable
Types description for more details.
introductionVersion: pre5.0
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_CACHE_TTL:
name: OCIS_CACHE_TTL;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_TTL
defaultValue: 12h0m0s
name: OCIS_CACHE_TTL
defaultValue: 5m0s
type: Duration
description: Default time to live for signing keys. See the Environment Variable
Types description for more details.
introductionVersion: "5.0"
description: 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.
introductionVersion: pre5.0
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
@@ -7955,46 +7957,46 @@ OCIS_CLAIM_MANAGED_SPACES_REGEXP:
removalVersion: ""
deprecationInfo: ""
OCIS_CORS_ALLOW_CREDENTIALS:
name: OCIS_CORS_ALLOW_CREDENTIALS;OCS_CORS_ALLOW_CREDENTIALS
name: OCIS_CORS_ALLOW_CREDENTIALS;SSE_CORS_ALLOW_CREDENTIALS
defaultValue: "true"
type: bool
description: '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.'
introductionVersion: pre5.0
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_CORS_ALLOW_HEADERS:
name: OCIS_CORS_ALLOW_HEADERS;OCS_CORS_ALLOW_HEADERS
name: OCIS_CORS_ALLOW_HEADERS;SSE_CORS_ALLOW_HEADERS
defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id
Cache-Control]'
Ocs-Apirequest]'
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.
See the Environment Variable Types description for more details.'
introductionVersion: pre5.0
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_CORS_ALLOW_METHODS:
name: OCIS_CORS_ALLOW_METHODS;OCS_CORS_ALLOW_METHODS
defaultValue: '[GET POST PUT PATCH DELETE OPTIONS]'
name: OCIS_CORS_ALLOW_METHODS;SSE_CORS_ALLOW_METHODS
defaultValue: '[GET]'
type: '[]string'
description: '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.'
introductionVersion: pre5.0
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_CORS_ALLOW_ORIGINS:
name: OCIS_CORS_ALLOW_ORIGINS;OCS_CORS_ALLOW_ORIGINS
name: OCIS_CORS_ALLOW_ORIGINS;SSE_CORS_ALLOW_ORIGINS
defaultValue: '[*]'
type: '[]string'
description: '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.'
introductionVersion: pre5.0
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
@@ -8111,7 +8113,7 @@ OCIS_ENABLE_OCM:
removalVersion: ""
deprecationInfo: ""
OCIS_EVENTS_AUTH_PASSWORD:
name: OCIS_EVENTS_AUTH_PASSWORD;EVENTHISTORY_EVENTS_AUTH_PASSWORD
name: OCIS_EVENTS_AUTH_PASSWORD;SSE_EVENTS_AUTH_PASSWORD
defaultValue: ""
type: string
description: The password to authenticate with the events broker. The events broker
@@ -8121,7 +8123,7 @@ OCIS_EVENTS_AUTH_PASSWORD:
removalVersion: ""
deprecationInfo: ""
OCIS_EVENTS_AUTH_USERNAME:
name: OCIS_EVENTS_AUTH_USERNAME;EVENTHISTORY_EVENTS_AUTH_USERNAME
name: OCIS_EVENTS_AUTH_USERNAME;SSE_EVENTS_AUTH_USERNAME
defaultValue: ""
type: string
description: The username to authenticate with the events broker. The events broker
@@ -8131,43 +8133,43 @@ OCIS_EVENTS_AUTH_USERNAME:
removalVersion: ""
deprecationInfo: ""
OCIS_EVENTS_CLUSTER:
name: OCIS_EVENTS_CLUSTER;EVENTHISTORY_EVENTS_CLUSTER
name: OCIS_EVENTS_CLUSTER;SSE_EVENTS_CLUSTER
defaultValue: ocis-cluster
type: string
description: 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.
introductionVersion: pre5.0
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_EVENTS_ENABLE_TLS:
name: OCIS_EVENTS_ENABLE_TLS;EVENTHISTORY_EVENTS_ENABLE_TLS
name: OCIS_EVENTS_ENABLE_TLS;SSE_EVENTS_ENABLE_TLS
defaultValue: "false"
type: bool
description: Enable TLS for the connection to the events broker. The events broker
is the ocis service which receives and delivers events between the services.
introductionVersion: pre5.0
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_EVENTS_ENDPOINT:
name: OCIS_EVENTS_ENDPOINT;EVENTHISTORY_EVENTS_ENDPOINT
name: OCIS_EVENTS_ENDPOINT;SSE_EVENTS_ENDPOINT
defaultValue: 127.0.0.1:9233
type: string
description: The address of the event system. The event system is the message queuing
service. It is used as message broker for the microservice architecture.
introductionVersion: pre5.0
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE:
name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;EVENTHISTORY_EVENTS_TLS_ROOT_CA_CERTIFICATE
name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;SSE_EVENTS_TLS_ROOT_CA_CERTIFICATE
defaultValue: ""
type: string
description: The root CA certificate used to validate the server's TLS certificate.
Will be seen as empty if NOTIFICATIONS_EVENTS_TLS_INSECURE is provided.
introductionVersion: pre5.0
If provided SSE_EVENTS_TLS_INSECURE will be seen as false.
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
@@ -8204,10 +8206,10 @@ OCIS_GRPC_CLIENT_TLS_MODE:
removalVersion: ""
deprecationInfo: ""
OCIS_GRPC_PROTOCOL:
name: OCIS_GRPC_PROTOCOL;AUTH_MACHINE_GRPC_PROTOCOL
name: OCIS_GRPC_PROTOCOL;APP_PROVIDER_GRPC_PROTOCOL
defaultValue: ""
type: string
description: The transport protocol of the GRPC service.
description: The transport protocol of the GPRC service.
introductionVersion: pre5.0
deprecationVersion: ""
removalVersion: ""
@@ -8244,25 +8246,25 @@ OCIS_HTTP_TLS_KEY:
removalVersion: ""
deprecationInfo: ""
OCIS_INSECURE:
name: OCIS_INSECURE;EVENTHISTORY_EVENTS_TLS_INSECURE
name: OCIS_INSECURE;SSE_EVENTS_TLS_INSECURE
defaultValue: "false"
type: bool
description: Whether to verify the server TLS certificates.
introductionVersion: pre5.0
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_JWT_SECRET:
name: OCIS_JWT_SECRET;AUTH_MACHINE_JWT_SECRET
name: OCIS_JWT_SECRET;SSE_JWT_SECRET
defaultValue: ""
type: string
description: The secret to mint and validate jwt tokens.
introductionVersion: pre5.0
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_KEYCLOAK_BASE_PATH:
name: OCIS_KEYCLOAK_BASE_PATH;GRAPH_KEYCLOAK_BASE_PATH
name: OCIS_KEYCLOAK_BASE_PATH;INVITATIONS_KEYCLOAK_BASE_PATH
defaultValue: ""
type: string
description: The URL to access keycloak.
@@ -8271,16 +8273,16 @@ OCIS_KEYCLOAK_BASE_PATH:
removalVersion: ""
deprecationInfo: ""
OCIS_KEYCLOAK_CLIENT_ID:
name: OCIS_KEYCLOAK_CLIENT_ID;GRAPH_KEYCLOAK_CLIENT_ID
name: OCIS_KEYCLOAK_CLIENT_ID;INVITATIONS_KEYCLOAK_CLIENT_ID
defaultValue: ""
type: string
description: The client id to authenticate with keycloak.
description: The client ID to authenticate with keycloak.
introductionVersion: pre5.0
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_KEYCLOAK_CLIENT_REALM:
name: OCIS_KEYCLOAK_CLIENT_REALM;GRAPH_KEYCLOAK_CLIENT_REALM
name: OCIS_KEYCLOAK_CLIENT_REALM;INVITATIONS_KEYCLOAK_CLIENT_REALM
defaultValue: ""
type: string
description: The realm the client is defined in.
@@ -8289,7 +8291,7 @@ OCIS_KEYCLOAK_CLIENT_REALM:
removalVersion: ""
deprecationInfo: ""
OCIS_KEYCLOAK_CLIENT_SECRET:
name: OCIS_KEYCLOAK_CLIENT_SECRET;GRAPH_KEYCLOAK_CLIENT_SECRET
name: OCIS_KEYCLOAK_CLIENT_SECRET;INVITATIONS_KEYCLOAK_CLIENT_SECRET
defaultValue: ""
type: string
description: The client secret to use in authentication.
@@ -8298,7 +8300,7 @@ OCIS_KEYCLOAK_CLIENT_SECRET:
removalVersion: ""
deprecationInfo: ""
OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY:
name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;GRAPH_KEYCLOAK_INSECURE_SKIP_VERIFY
name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;INVITATIONS_KEYCLOAK_INSECURE_SKIP_VERIFY
defaultValue: "false"
type: bool
description: Disable TLS certificate validation for Keycloak connections. Do not
@@ -8308,7 +8310,7 @@ OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY:
removalVersion: ""
deprecationInfo: ""
OCIS_KEYCLOAK_USER_REALM:
name: OCIS_KEYCLOAK_USER_REALM;GRAPH_KEYCLOAK_USER_REALM
name: OCIS_KEYCLOAK_USER_REALM;INVITATIONS_KEYCLOAK_USER_REALM
defaultValue: ""
type: string
description: The realm users are defined.
@@ -8317,8 +8319,8 @@ OCIS_KEYCLOAK_USER_REALM:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_BIND_DN:
name: OCIS_LDAP_BIND_DN;GROUPS_LDAP_BIND_DN
defaultValue: uid=reva,ou=sysusers,o=libregraph-idm
name: OCIS_LDAP_BIND_DN;GRAPH_LDAP_BIND_DN
defaultValue: uid=libregraph,ou=sysusers,o=libregraph-idm
type: string
description: LDAP DN to use for simple bind authentication with the target LDAP
server.
@@ -8327,7 +8329,7 @@ OCIS_LDAP_BIND_DN:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_BIND_PASSWORD:
name: OCIS_LDAP_BIND_PASSWORD;GROUPS_LDAP_BIND_PASSWORD
name: OCIS_LDAP_BIND_PASSWORD;GRAPH_LDAP_BIND_PASSWORD
defaultValue: ""
type: string
description: Password to use for authenticating the 'bind_dn'.
@@ -8336,7 +8338,7 @@ OCIS_LDAP_BIND_PASSWORD:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_CACERT:
name: OCIS_LDAP_CACERT;GROUPS_LDAP_CACERT
name: OCIS_LDAP_CACERT;GRAPH_LDAP_CACERT
defaultValue: /var/lib/ocis/idm/ldap.crt
type: string
description: Path/File name for the root CA certificate (in PEM format) used to
@@ -8347,20 +8349,20 @@ OCIS_LDAP_CACERT:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_DISABLE_USER_MECHANISM:
name: OCIS_LDAP_DISABLE_USER_MECHANISM;AUTH_BASIC_DISABLE_USER_MECHANISM
name: OCIS_LDAP_DISABLE_USER_MECHANISM;GRAPH_DISABLE_USER_MECHANISM
defaultValue: attribute
type: string
description: An option to control the behavior for disabling users. Valid options
description: 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.
is not processed. Default is 'attribute'.
introductionVersion: pre5.0
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_DISABLED_USERS_GROUP_DN:
name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;AUTH_BASIC_DISABLED_USERS_GROUP_DN
name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;GRAPH_DISABLED_USERS_GROUP_DN
defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm
type: string
description: The distinguished name of the group to which added users will be classified
@@ -8370,7 +8372,7 @@ OCIS_LDAP_DISABLED_USERS_GROUP_DN:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_GROUP_BASE_DN:
name: OCIS_LDAP_GROUP_BASE_DN;GROUPS_LDAP_GROUP_BASE_DN
name: OCIS_LDAP_GROUP_BASE_DN;GRAPH_LDAP_GROUP_BASE_DN
defaultValue: ou=groups,o=libregraph-idm
type: string
description: Search base DN for looking up LDAP groups.
@@ -8379,7 +8381,7 @@ OCIS_LDAP_GROUP_BASE_DN:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_GROUP_FILTER:
name: OCIS_LDAP_GROUP_FILTER;GROUPS_LDAP_GROUP_FILTER
name: OCIS_LDAP_GROUP_FILTER;GRAPH_LDAP_GROUP_FILTER
defaultValue: ""
type: string
description: LDAP filter to add to the default filters for group searches.
@@ -8388,7 +8390,7 @@ OCIS_LDAP_GROUP_FILTER:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_GROUP_OBJECTCLASS:
name: OCIS_LDAP_GROUP_OBJECTCLASS;GROUPS_LDAP_GROUP_OBJECTCLASS
name: OCIS_LDAP_GROUP_OBJECTCLASS;GRAPH_LDAP_GROUP_OBJECTCLASS
defaultValue: groupOfNames
type: string
description: The object class to use for groups in the default group search filter
@@ -8398,7 +8400,7 @@ OCIS_LDAP_GROUP_OBJECTCLASS:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME:
name: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME;GROUPS_LDAP_GROUP_SCHEMA_DISPLAYNAME
name: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME;AUTH_BASIC_LDAP_GROUP_SCHEMA_DISPLAYNAME
defaultValue: cn
type: string
description: LDAP Attribute to use for the displayname of groups (often the same
@@ -8408,7 +8410,7 @@ OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_GROUP_SCHEMA_GROUPNAME:
name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;GROUPS_LDAP_GROUP_SCHEMA_GROUPNAME
name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;GRAPH_LDAP_GROUP_NAME_ATTRIBUTE
defaultValue: cn
type: string
description: LDAP Attribute to use for the name of groups.
@@ -8417,8 +8419,8 @@ OCIS_LDAP_GROUP_SCHEMA_GROUPNAME:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_GROUP_SCHEMA_ID:
name: OCIS_LDAP_GROUP_SCHEMA_ID;GROUPS_LDAP_GROUP_SCHEMA_ID
defaultValue: ownclouduuid
name: OCIS_LDAP_GROUP_SCHEMA_ID;GRAPH_LDAP_GROUP_ID_ATTRIBUTE
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.
@@ -8427,18 +8429,18 @@ OCIS_LDAP_GROUP_SCHEMA_ID:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING:
name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;GROUPS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING
name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;GRAPH_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING
defaultValue: "false"
type: bool
description: 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.
description: 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.
introductionVersion: pre5.0
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_GROUP_SCHEMA_MAIL:
name: OCIS_LDAP_GROUP_SCHEMA_MAIL;GROUPS_LDAP_GROUP_SCHEMA_MAIL
name: OCIS_LDAP_GROUP_SCHEMA_MAIL;AUTH_BASIC_LDAP_GROUP_SCHEMA_MAIL
defaultValue: mail
type: string
description: LDAP Attribute to use for the email address of groups (can be empty).
@@ -8447,7 +8449,7 @@ OCIS_LDAP_GROUP_SCHEMA_MAIL:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_GROUP_SCHEMA_MEMBER:
name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;GROUPS_LDAP_GROUP_SCHEMA_MEMBER
name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;GRAPH_LDAP_GROUP_MEMBER_ATTRIBUTE
defaultValue: member
type: string
description: LDAP Attribute that is used for group members.
@@ -8456,7 +8458,7 @@ OCIS_LDAP_GROUP_SCHEMA_MEMBER:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_GROUP_SCOPE:
name: OCIS_LDAP_GROUP_SCOPE;GROUPS_LDAP_GROUP_SCOPE
name: OCIS_LDAP_GROUP_SCOPE;GRAPH_LDAP_GROUP_SEARCH_SCOPE
defaultValue: sub
type: string
description: LDAP search scope to use when looking up groups. Supported scopes are
@@ -8466,7 +8468,7 @@ OCIS_LDAP_GROUP_SCOPE:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_INSECURE:
name: OCIS_LDAP_INSECURE;GROUPS_LDAP_INSECURE
name: OCIS_LDAP_INSECURE;GRAPH_LDAP_INSECURE
defaultValue: "false"
type: bool
description: Disable TLS certificate validation for the LDAP connections. Do not
@@ -8488,7 +8490,7 @@ OCIS_LDAP_SERVER_WRITE_ENABLED:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_URI:
name: OCIS_LDAP_URI;GROUPS_LDAP_URI
name: OCIS_LDAP_URI;GRAPH_LDAP_URI
defaultValue: ldaps://localhost:9235
type: string
description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://'
@@ -8498,7 +8500,7 @@ OCIS_LDAP_URI:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_USER_BASE_DN:
name: OCIS_LDAP_USER_BASE_DN;GROUPS_LDAP_USER_BASE_DN
name: OCIS_LDAP_USER_BASE_DN;GRAPH_LDAP_USER_BASE_DN
defaultValue: ou=users,o=libregraph-idm
type: string
description: Search base DN for looking up LDAP users.
@@ -8507,16 +8509,16 @@ OCIS_LDAP_USER_BASE_DN:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_USER_ENABLED_ATTRIBUTE:
name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;AUTH_BASIC_LDAP_USER_ENABLED_ATTRIBUTE
name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;GRAPH_USER_ENABLED_ATTRIBUTE
defaultValue: ownCloudUserEnabled
type: string
description: LDAP attribute to use as a flag telling if the user is enabled or disabled.
description: LDAP Attribute to use as a flag telling if the user is enabled or disabled.
introductionVersion: pre5.0
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_USER_FILTER:
name: OCIS_LDAP_USER_FILTER;GROUPS_LDAP_USER_FILTER
name: OCIS_LDAP_USER_FILTER;GRAPH_LDAP_USER_FILTER
defaultValue: ""
type: string
description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'.
@@ -8525,7 +8527,7 @@ OCIS_LDAP_USER_FILTER:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_USER_OBJECTCLASS:
name: OCIS_LDAP_USER_OBJECTCLASS;GROUPS_LDAP_USER_OBJECTCLASS
name: OCIS_LDAP_USER_OBJECTCLASS;GRAPH_LDAP_USER_OBJECTCLASS
defaultValue: inetOrgPerson
type: string
description: The object class to use for users in the default user search filter
@@ -8535,37 +8537,37 @@ OCIS_LDAP_USER_OBJECTCLASS:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_DISPLAYNAME:
name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;GROUPS_LDAP_USER_SCHEMA_DISPLAYNAME
defaultValue: displayname
name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;GRAPH_LDAP_USER_DISPLAYNAME_ATTRIBUTE
defaultValue: displayName
type: string
description: LDAP Attribute to use for the displayname of users.
description: LDAP Attribute to use for the display name of users.
introductionVersion: pre5.0
deprecationVersion: ""
removalVersion: ""
deprecationInfo: 'LDAP_USER_SCHEMA_DISPLAY_NAME changing name for consistency | | | | | | | | | | | | '
deprecationInfo: 'LDAP_USER_SCHEMA_DISPLAY_NAME changing name for consistency | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | '
OCIS_LDAP_USER_SCHEMA_ID:
name: OCIS_LDAP_USER_SCHEMA_ID;GROUPS_LDAP_USER_SCHEMA_ID
defaultValue: ownclouduuid
name: OCIS_LDAP_USER_SCHEMA_ID;GRAPH_LDAP_USER_UID_ATTRIBUTE
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.
description: LDAP Attribute to use as the unique ID for users. This should be a
stable globally unique ID like a UUID.
introductionVersion: pre5.0
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING:
name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;GROUPS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING
name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;GRAPH_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING
defaultValue: "false"
type: bool
description: 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.
'OCTETSTRING' syntax. This is required when using the 'objectGUID' attribute of
Active Directory for the user ID's.
introductionVersion: pre5.0
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_MAIL:
name: OCIS_LDAP_USER_SCHEMA_MAIL;GROUPS_LDAP_USER_SCHEMA_MAIL
name: OCIS_LDAP_USER_SCHEMA_MAIL;GRAPH_LDAP_USER_EMAIL_ATTRIBUTE
defaultValue: mail
type: string
description: LDAP Attribute to use for the email address of users.
@@ -8584,7 +8586,7 @@ OCIS_LDAP_USER_SCHEMA_USER_TYPE:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_USERNAME:
name: OCIS_LDAP_USER_SCHEMA_USERNAME;GROUPS_LDAP_USER_SCHEMA_USERNAME
name: OCIS_LDAP_USER_SCHEMA_USERNAME;GRAPH_LDAP_USER_NAME_ATTRIBUTE
defaultValue: uid
type: string
description: LDAP Attribute to use for username of users.
@@ -8593,7 +8595,7 @@ OCIS_LDAP_USER_SCHEMA_USERNAME:
removalVersion: ""
deprecationInfo: ""
OCIS_LDAP_USER_SCOPE:
name: OCIS_LDAP_USER_SCOPE;GROUPS_LDAP_USER_SCOPE
name: OCIS_LDAP_USER_SCOPE;GRAPH_LDAP_USER_SCOPE
defaultValue: sub
type: string
description: LDAP search scope to use when looking up users. Supported scopes are
@@ -8603,48 +8605,48 @@ OCIS_LDAP_USER_SCOPE:
removalVersion: ""
deprecationInfo: ""
OCIS_LOG_COLOR:
name: OCIS_LOG_COLOR;IDM_LOG_COLOR
name: OCIS_LOG_COLOR;SSE_LOG_COLOR
defaultValue: "false"
type: bool
description: Activates colorized log output.
introductionVersion: pre5.0
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_LOG_FILE:
name: OCIS_LOG_FILE;IDM_LOG_FILE
name: OCIS_LOG_FILE;SSE_LOG_FILE
defaultValue: ""
type: string
description: The path to the log file. Activates logging to this file if set.
introductionVersion: pre5.0
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_LOG_LEVEL:
name: OCIS_LOG_LEVEL;IDM_LOG_LEVEL
name: OCIS_LOG_LEVEL;SSE_LOG_LEVEL
defaultValue: ""
type: string
description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'',
''warn'', ''info'', ''debug'', ''trace''.'
introductionVersion: pre5.0
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_LOG_PRETTY:
name: OCIS_LOG_PRETTY;IDM_LOG_PRETTY
name: OCIS_LOG_PRETTY;SSE_LOG_PRETTY
defaultValue: "false"
type: bool
description: Activates pretty log output.
introductionVersion: pre5.0
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_MACHINE_AUTH_API_KEY:
name: OCIS_MACHINE_AUTH_API_KEY;AUTH_MACHINE_API_KEY
name: OCIS_MACHINE_AUTH_API_KEY;FRONTEND_MACHINE_AUTH_API_KEY
defaultValue: ""
type: string
description: Machine auth API key used to validate internal requests necessary for
the access to resources from other services.
description: The machine auth API key used to validate internal requests necessary
to access resources from other services.
introductionVersion: pre5.0
deprecationVersion: ""
removalVersion: ""
@@ -8682,10 +8684,10 @@ OCIS_OIDC_CLIENT_ID:
removalVersion: ""
deprecationInfo: ""
OCIS_OIDC_ISSUER:
name: OCIS_URL;OCIS_OIDC_ISSUER
name: OCIS_URL;OCIS_OIDC_ISSUER;IDP_ISS
defaultValue: https://localhost:9200
type: string
description: The OIDC issuer URL to assign to the demo users.
description: The OIDC issuer URL to use.
introductionVersion: pre5.0
deprecationVersion: ""
removalVersion: ""
@@ -8758,54 +8760,54 @@ OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS:
removalVersion: ""
deprecationInfo: ""
OCIS_PERSISTENT_STORE:
name: OCIS_PERSISTENT_STORE;EVENTHISTORY_STORE
name: OCIS_PERSISTENT_STORE;NOTIFICATIONS_STORE
defaultValue: nats-js-kv
type: string
description: 'The type of the store. Supported values are: ''memory'', ''nats-js-kv'',
''redis-sentinel'', ''noop''. See the text description for details.'
introductionVersion: pre5.0
introductionVersion: 7.1.0
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_PERSISTENT_STORE_AUTH_PASSWORD:
name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;EVENTHISTORY_STORE_AUTH_PASSWORD
name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;NOTIFICATIONS_STORE_AUTH_PASSWORD
defaultValue: ""
type: string
description: The password to authenticate with the store. Only applies when store
type 'nats-js-kv' is configured.
introductionVersion: "5.0"
introductionVersion: 7.1.0
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_PERSISTENT_STORE_AUTH_USERNAME:
name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;EVENTHISTORY_STORE_AUTH_USERNAME
name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;NOTIFICATIONS_STORE_AUTH_USERNAME
defaultValue: ""
type: string
description: The username to authenticate with the store. Only applies when store
type 'nats-js-kv' is configured.
introductionVersion: "5.0"
introductionVersion: 7.1.0
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_PERSISTENT_STORE_NODES:
name: OCIS_PERSISTENT_STORE_NODES;EVENTHISTORY_STORE_NODES
name: OCIS_PERSISTENT_STORE_NODES;NOTIFICATIONS_STORE_NODES
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
is dependent on the library of the configured store. See the Environment Variable
Types description for more details.
introductionVersion: pre5.0
introductionVersion: 7.1.0
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_PERSISTENT_STORE_TTL:
name: OCIS_PERSISTENT_STORE_TTL;EVENTHISTORY_STORE_TTL
name: OCIS_PERSISTENT_STORE_TTL;NOTIFICATIONS_STORE_TTL
defaultValue: 336h0m0s
type: Duration
description: Time to live for events in the store. Defaults to '336h' (2 weeks).
See the Environment Variable Types description for more details.
introductionVersion: pre5.0
description: Time to live for notifications in the store. Defaults to '336h' (2
weeks). See the Environment Variable Types description for more details.
introductionVersion: 7.1.0
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
@@ -8822,7 +8824,7 @@ OCIS_REVA_GATEWAY:
name: OCIS_REVA_GATEWAY
defaultValue: com.owncloud.api.gateway
type: string
description: The CS3 gateway endpoint.
description: CS3 gateway used to look up user metadata
introductionVersion: pre5.0
deprecationVersion: ""
removalVersion: ""
@@ -8850,7 +8852,7 @@ OCIS_REVA_GATEWAY_TLS_MODE:
removalVersion: ""
deprecationInfo: ""
OCIS_SERVICE_ACCOUNT_ID:
name: OCIS_SERVICE_ACCOUNT_ID;AUTH_SERVICE_SERVICE_ACCOUNT_ID
name: OCIS_SERVICE_ACCOUNT_ID;NOTIFICATIONS_SERVICE_ACCOUNT_ID
defaultValue: ""
type: string
description: The ID of the service account the service should use. See the 'auth-service'
@@ -8860,7 +8862,7 @@ OCIS_SERVICE_ACCOUNT_ID:
removalVersion: ""
deprecationInfo: ""
OCIS_SERVICE_ACCOUNT_SECRET:
name: OCIS_SERVICE_ACCOUNT_SECRET;AUTH_SERVICE_SERVICE_ACCOUNT_SECRET
name: OCIS_SERVICE_ACCOUNT_SECRET;NOTIFICATIONS_SERVICE_ACCOUNT_SECRET
defaultValue: ""
type: string
description: The service account secret.
@@ -8909,7 +8911,7 @@ OCIS_SPACES_MAX_QUOTA:
removalVersion: ""
deprecationInfo: ""
OCIS_SYSTEM_USER_API_KEY:
name: OCIS_SYSTEM_USER_API_KEY;SHARING_PUBLIC_CS3_SYSTEM_USER_API_KEY
name: OCIS_SYSTEM_USER_API_KEY
defaultValue: ""
type: string
description: API key for the STORAGE-SYSTEM system user.
@@ -8918,10 +8920,10 @@ OCIS_SYSTEM_USER_API_KEY:
removalVersion: ""
deprecationInfo: ""
OCIS_SYSTEM_USER_ID:
name: OCIS_SYSTEM_USER_ID;SHARING_PUBLIC_CS3_SYSTEM_USER_ID
name: OCIS_SYSTEM_USER_ID
defaultValue: ""
type: string
description: ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID
description: ID of the oCIS storage-system system user. Admins need to set the ID
for the STORAGE-SYSTEM system user in this config option which is then used to
reference the user. Any reasonable long string is possible, preferably this would
be an UUIDv4 format.
@@ -8930,7 +8932,7 @@ OCIS_SYSTEM_USER_ID:
removalVersion: ""
deprecationInfo: ""
OCIS_SYSTEM_USER_IDP:
name: OCIS_SYSTEM_USER_IDP;SHARING_PUBLIC_CS3_SYSTEM_USER_IDP
name: OCIS_SYSTEM_USER_IDP;SETTINGS_SYSTEM_USER_IDP
defaultValue: internal
type: string
description: IDP of the oCIS STORAGE-SYSTEM system user.
@@ -8939,40 +8941,40 @@ OCIS_SYSTEM_USER_IDP:
removalVersion: ""
deprecationInfo: ""
OCIS_TRACING_COLLECTOR:
name: OCIS_TRACING_COLLECTOR;IDM_TRACING_COLLECTOR
name: OCIS_TRACING_COLLECTOR;SSE_TRACING_COLLECTOR
defaultValue: ""
type: string
description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces.
Only used if the tracing endpoint is unset.
introductionVersion: pre5.0
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_TRACING_ENABLED:
name: OCIS_TRACING_ENABLED;IDM_TRACING_ENABLED
name: OCIS_TRACING_ENABLED;SSE_TRACING_ENABLED
defaultValue: "false"
type: bool
description: Activates tracing.
introductionVersion: pre5.0
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_TRACING_ENDPOINT:
name: OCIS_TRACING_ENDPOINT;IDM_TRACING_ENDPOINT
name: OCIS_TRACING_ENDPOINT;SSE_TRACING_ENDPOINT
defaultValue: ""
type: string
description: The endpoint of the tracing agent.
introductionVersion: pre5.0
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_TRACING_TYPE:
name: OCIS_TRACING_TYPE;IDM_TRACING_TYPE
name: OCIS_TRACING_TYPE;SSE_TRACING_TYPE
defaultValue: ""
type: string
description: The type of tracing. Defaults to '', which is the same as 'jaeger'.
Allowed tracing types are 'jaeger' and '' as of now.
introductionVersion: pre5.0
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
@@ -8997,10 +8999,11 @@ OCIS_TRANSLATION_PATH:
removalVersion: ""
deprecationInfo: ""
OCIS_URL:
name: OCIS_URL;OCIS_OIDC_ISSUER
name: OCIS_URL;NOTIFICATIONS_WEB_UI_URL
defaultValue: https://localhost:9200
type: string
description: The OIDC issuer URL to assign to the demo users.
description: The public facing URL of the oCIS Web UI, used e.g. when sending notification
eMails
introductionVersion: pre5.0
deprecationVersion: ""
removalVersion: ""

4
docs/ocis/development/envvars.md
View File

@@ -9,5 +9,5 @@ geekdocFilePath: envvars.md
Environment variables are an essential part of configuring services.
If you are going to create new ones or deprecate existing ones, you must read the [Envvar Naming Scope]({{< ref "services/general-info/envvar-scopes.md" >}}) and the
[Deprecating Variables]({{< ref "services/general-info/deprecating-variables.md" >}}) documentation for more details first before doing so.
If you are going to create new ones or deprecate existing ones, you must read the [Envvar Naming Scope]({{< ref "services/general-info/envvars/envvar-naming-scopes.md" >}}) and the
[Deprecating Variables]({{< ref "services/general-info/envvars/deprecating-variables.md" >}}) documentation for more details first before doing so.

2
docs/services/general-info/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
!**/_index.md

64
docs/services/general-info/added-services.md
View File

@@ -1,64 +0,0 @@
---
title: Added Services per Release
date: 2024-07-12T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/general-info
geekdocFilePath: added-services.md
geekdocCollapseSection: true
---
Over time, services get added with new releases published. This page gives an overview of which services exist and which
have been added per release.
## Added Services
The following table gives an overview about releases and their services. Note that v6.x were rolling releases only and not mentioned therefore. Any changes from v6.x were incorporated in v7.
[//]: # (for ease of handling, use the .excel table from the same folder and convert it via https://tabletomarkdown.com/convert-spreadsheet-to-markdown/)
| 3.0 | 4.0 | 5.0 | 7.0 | Rolling |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| | | | activitylog | activitylog |
| antivirus | antivirus | antivirus | antivirus | antivirus |
| app-provider | app-provider | app-provider | app-provider | app-provider |
| app-registry | app-registry | app-registry | app-registry | app-registry |
| audit | audit | audit | audit | audit |
| | | | | auth-app |
| auth-basic | auth-basic | auth-basic | auth-basic | auth-basic |
| auth-bearer | auth-bearer | auth-bearer | auth-bearer | auth-bearer |
| auth-machine | auth-machine | auth-machine | auth-machine | auth-machine |
| eventhistory | eventhistory | auth-service | auth-service | auth-service |
| | | clientlog | clientlog | clientlog |
| | | | collaboration | collaboration |
| | | eventhistory | eventhistory | eventhistory |
| frontend | frontend | frontend | frontend | frontend |
| gateway | gateway | gateway | gateway | gateway |
| graph | graph | graph | graph | graph |
| groups | groups | groups | groups | groups |
| idm | idm | idm | idm | idm |
| idp | idp | idp | idp | idp |
| invitations | invitations | invitations | invitations | invitations |
| nats | nats | nats | nats | nats |
| notifications | notifications | notifications | notifications | notifications |
| ocdav | ocdav | ocdav | ocdav | ocdav |
| | | ocm | ocm | ocm |
| ocs | ocs | ocs | ocs | ocs |
| policies | policies | policies | policies | policies |
| postprocessing | postprocessing | postprocessing | postprocessing | postprocessing |
| proxy | proxy | proxy | proxy | proxy |
| search | search | search | search | search |
| settings | settings | settings | settings | settings |
| sharing | sharing | sharing | sharing | sharing |
| | | sse | sse | sse |
| store | store | store | store | store |
| storage-publiclink | storage-publiclink | storage-publiclink | storage-publiclink | storage-publiclink |
| storage-shares | storage-shares | storage-shares | storage-shares | storage-shares |
| storage-system | storage-system | storage-system | storage-system | storage-system |
| storage-users | storage-users | storage-users | storage-users | storage-users |
| thumbnails | thumbnails | thumbnails | thumbnails | thumbnails |
| userlog | userlog | userlog | userlog | userlog |
| users | users | users | users | users |
| web | web | web | web | web |
| webdav | webdav | webdav | webdav | webdav |
| webfinger | webfinger | webfinger | webfinger | webfinger |

BIN
docs/services/general-info/added-services.xlsx
View File

Binary file not shown.

1
docs/services/general-info/env-var-deltas/make-adoc-and-md-files.txt
View File

@@ -1 +0,0 @@
see docs/helpers/README.md#doc-tasks-for-new-releases for details how to create the necessary .adoc and .md files

15
docs/services/general-info/envvars/_index.md Normal file
View File

@@ -0,0 +1,15 @@
---
title: Environment Variables
date: 2025-07-03T00:00:00+00:00
weight: 10
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/general-info/envvars
geekdocFilePath: _index.md
geekdocCollapseSection: true
---
## General Information
This section provides general information how to manage environment variables.
Additionally read the [helper README](https://github.com/owncloud/ocis/tree/master/docs/helpers#readme) for internal details how envvars are managed.

4
docs/services/general-info/deprecating-variables.md → docs/services/general-info/envvars/deprecating-variables.md
View File

@@ -1,9 +1,9 @@
---
title: "Envvar Deprecation"
date: 2024-08-22T15:41:00+01:00
weight: 20
weight: 15
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/general-info
geekdocEditPath: edit/master/docs/services/general-info/envvars
geekdocFilePath: deprecating-variables.md
---

0
docs/services/general-info/env-var-deltas/4.0.0-5.0.0-added.adoc → docs/services/general-info/envvars/env-var-deltas/4.0.0-5.0.0-added.adoc
View File

0
docs/services/general-info/env-var-deltas/4.0.0-5.0.0-added.md → docs/services/general-info/envvars/env-var-deltas/4.0.0-5.0.0-added.md
View File

0
docs/services/general-info/env-var-deltas/4.0.0-5.0.0-removed.adoc → docs/services/general-info/envvars/env-var-deltas/4.0.0-5.0.0-removed.adoc
View File

0
docs/services/general-info/env-var-deltas/4.0.0-5.0.0-removed.md → docs/services/general-info/envvars/env-var-deltas/4.0.0-5.0.0-removed.md
View File

0
docs/services/general-info/env-var-deltas/5.0.0-7.0.0-added.adoc → docs/services/general-info/envvars/env-var-deltas/5.0.0-7.0.0-added.adoc
View File

129
docs/services/general-info/envvars/env-var-deltas/5.0.0-7.0.0-added.md Normal file
View File

@@ -0,0 +1,129 @@
Note that the links provided in the service column are non functional when clicked.
| Service | Variable | Description | Default |
| --- | --- | --- | --- |
| [Special Scope Envvars](deployment/services/env-vars-special-scope.adoc) | OCIS_ASSET_THEMES_PATH | Serve ownCloud themes from a path on the filesystem instead of the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/web/assets/themes | /var/lib/ocis/web/assets/themes |
| | OCIS_DISABLE_VERSIONING | Disables versioning of files. When set to true, new uploads with the same filename will overwrite existing files instead of creating a new version. | false |
| | OCIS_SHOW_USER_EMAIL_IN_RESULTS | Include user email addresses in responses. If absent or set to false emails will be omitted from results. Please note that admin users can always see all email addresses. | false |
| | OCIS_TRANSLATION_PATH | (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. | |
| | OCIS_WOPI_DISABLE_CHAT | Disable chat in the office web frontend. This feature applies to OnlyOffice and Microsoft. | false |
| [Activitylog]({s-path}/activitylog.adoc) | ACTIVITYLOG_TRANSLATION_PATH | (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. | |
| [Antivirus]({s-path}/antivirus.adoc) | ANTIVIRUS_WORKERS | The number of concurrent go routines that fetch events from the event queue. | 10 |
| [Auth-App]({s-path}/auth-app.adoc) | AUTH_APP_DEBUG_ADDR | Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. | 127.0.0.1:9245 |
| | AUTH_APP_DEBUG_PPROF | Enables pprof, which can be used for profiling. | false |
| | AUTH_APP_DEBUG_TOKEN | Token to secure the metrics endpoint. | |
| | AUTH_APP_DEBUG_ZPAGES | Enables zpages, which can be used for collecting and viewing traces in-memory. | false |
| | AUTH_APP_ENABLE_IMPERSONATION | Allows admins to create app tokens for other users. Used for migration. Do NOT use in productive deployments. | false |
| | AUTH_APP_GRPC_ADDR | The bind address of the GRPC service. | 127.0.0.1:9246 |
| | AUTH_APP_GRPC_PROTOCOL | The transport protocol of the GRPC service. | tcp |
| | AUTH_APP_JWT_SECRET | The secret to mint and validate jwt tokens. | |
| | AUTH_APP_LOG_COLOR | Activates colorized log output. | false |
| | AUTH_APP_LOG_FILE | The path to the log file. Activates logging to this file if set. | |
| | AUTH_APP_LOG_LEVEL | The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'. | |
| | AUTH_APP_LOG_PRETTY | Activates pretty log output. | false |
| | AUTH_APP_MACHINE_AUTH_API_KEY | The machine auth API key used to validate internal requests necessary to access resources from other services. | |
| | AUTH_APP_SKIP_USER_GROUPS_IN_TOKEN | Disables the encoding of the user’s group memberships in the access token. This reduces the token size, especially when users are members of a large number of groups. | false |
| | AUTH_APP_TRACING_COLLECTOR | The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. | |
| | AUTH_APP_TRACING_ENABLED | Activates tracing. | false |
| | AUTH_APP_TRACING_ENDPOINT | The endpoint of the tracing agent. | |
| | AUTH_APP_TRACING_TYPE | The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. | |
| [Collaboration]({s-path}/collaboration.adoc) | COLLABORATION_APP_ADDR | The URL where the WOPI app is located, such as https://127.0.0.1:8080. | https://127.0.0.1:9980 |
| | COLLABORATION_APP_DESCRIPTION | App description | Open office documents with Collabora |
| | COLLABORATION_APP_ICON | Icon for the app | image-edit |
| | COLLABORATION_APP_INSECURE | Skip TLS certificate verification when connecting to the WOPI app | false |
| | COLLABORATION_APP_LICENSE_CHECK_ENABLE | Enable license checking to edit files. Needs to be enabled when using Microsoft365 with the business flow. | false |
| | COLLABORATION_APP_NAME | The name of the app which is shown to the user. You can chose freely but you are limited to a single word without special characters or whitespaces. We recommend to use pascalCase like 'CollaboraOnline'. | Collabora |
| | COLLABORATION_APP_PRODUCT | The WebOffice app, either Collabora, OnlyOffice, Microsoft365 or MicrosoftOfficeOnline. | Collabora |
| | COLLABORATION_APP_PROOF_DISABLE | Disable the proof keys verification | false |
| | COLLABORATION_APP_PROOF_DURATION | Duration for the proof keys to be cached in memory, using time.ParseDuration format. If the duration can’t be parsed, we’ll use the default 12h as duration | 12h |
| | COLLABORATION_CS3API_DATAGATEWAY_INSECURE | Connect to the CS3API data gateway insecurely. | false |
| | COLLABORATION_DEBUG_ADDR | Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. | 127.0.0.1:9304 |
| | COLLABORATION_DEBUG_PPROF | Enables pprof, which can be used for profiling. | false |
| | COLLABORATION_DEBUG_TOKEN | Token to secure the metrics endpoint. | |
| | COLLABORATION_DEBUG_ZPAGES | Enables zpages, which can be used for collecting and viewing in-memory traces. | false |
| | COLLABORATION_GRPC_ADDR | The bind address of the GRPC service. | 127.0.0.1:9301 |
| | COLLABORATION_GRPC_PROTOCOL | The transport protocol of the GRPC service. | tcp |
| | COLLABORATION_HTTP_ADDR | The bind address of the HTTP service. | 127.0.0.1:9300 |
| | COLLABORATION_LOG_COLOR | Activates colorized log output. | false |
| | COLLABORATION_LOG_FILE | The path to the log file. Activates logging to this file if set. | |
| | COLLABORATION_LOG_LEVEL | The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'. | |
| | COLLABORATION_LOG_PRETTY | Activates pretty log output. | false |
| | COLLABORATION_STORE | The type of the store. Supported values are: 'memory', 'nats-js-kv', 'redis-sentinel', 'noop'. See the text description for details. | nats-js-kv |
| | COLLABORATION_STORE_AUTH_PASSWORD | The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. | |
| | COLLABORATION_STORE_AUTH_USERNAME | The username to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. | |
| | COLLABORATION_STORE_DATABASE | The database name the configured store should use. | collaboration |
| | COLLABORATION_STORE_NODES | 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. | [127.0.0.1:9233] |
| | COLLABORATION_STORE_TABLE | The database table the store should use. | |
| | COLLABORATION_STORE_TTL | Time to live for events in the store. Defaults to '30m' (30 minutes). See the Environment Variable Types description for more details. | 30m0s |
| | COLLABORATION_TRACING_COLLECTOR | The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. | |
| | COLLABORATION_TRACING_ENABLED | Activates tracing. | false |
| | COLLABORATION_TRACING_ENDPOINT | The endpoint of the tracing agent. | |
| | COLLABORATION_TRACING_TYPE | The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. | |
| | COLLABORATION_WOPI_DISABLE_CHAT | Disable chat in the office web frontend. This feature applies to OnlyOffice and Microsoft. | false |
| | COLLABORATION_WOPI_PROXY_SECRET | Optional, the secret to authenticate against the ownCloud Office365 WOPI proxy. This secret can be obtained from ownCloud via the office365 proxy subscription. | |
| | COLLABORATION_WOPI_PROXY_URL | The URL to the ownCloud Office365 WOPI proxy. Optional. To use this feature, you need an office365 proxy subscription. If you become part of the Microsoft CSP program (https://learn.microsoft.com/en-us/partner-center/enroll/csp-overview), you can use WebOffice without a proxy. | |
| | COLLABORATION_WOPI_SECRET | Used to mint and verify WOPI JWT tokens and encrypt and decrypt the REVA JWT token embedded in the WOPI JWT token. | |
| | COLLABORATION_WOPI_SHORTTOKENS | Use short access tokens for WOPI access. This is useful for office packages, like Microsoft Office Online, which have URL length restrictions. If enabled, a persistent store must be configured. | false |
| | COLLABORATION_WOPI_SRC | The WOPI source base URL containing schema, host and port. Set this to the schema and domain where the collaboration service is reachable for the wopi app, such as https://office.owncloud.test. | https://localhost:9300 |
| [Frontend]({s-path}/frontend.adoc) | FRONTEND_APP_HANDLER_SECURE_VIEW_APP_ADDR | Service name or address of the app provider to use for secure view. Should match the service name or address of the registered CS3 app provider. | com.owncloud.api.collaboration |
| | FRONTEND_MAX_CONCURRENCY | Maximum number of concurrent go-routines. Higher values can potentially get work done faster but will also cause more load on the system. Values of 0 or below will be ignored and the default value will be used. | 1 |
| [Gateway]({s-path}/gateway.adoc) | GATEWAY_APP_REGISTRY_ENDPOINT | The endpoint of the app-registry service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | com.owncloud.api.app-registry |
| | GATEWAY_AUTH_APP_ENDPOINT | The endpoint of the auth-app service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | com.owncloud.api.auth-app |
| | GATEWAY_AUTH_BASIC_ENDPOINT | The endpoint of the auth-basic service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | com.owncloud.api.auth-basic |
| | GATEWAY_AUTH_BEARER_ENDPOINT | The endpoint of the auth-bearer service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | |
| | GATEWAY_AUTH_MACHINE_ENDPOINT | The endpoint of the auth-machine service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | com.owncloud.api.auth-machine |
| | GATEWAY_AUTH_SERVICE_ENDPOINT | The endpoint of the auth-service service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | com.owncloud.api.auth-service |
| | GATEWAY_GROUPS_ENDPOINT | The endpoint of the groups service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | com.owncloud.api.groups |
| | GATEWAY_OCM_ENDPOINT | The endpoint of the ocm service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | com.owncloud.api.ocm |
| | GATEWAY_PERMISSIONS_ENDPOINT | The endpoint of the permissions service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | com.owncloud.api.settings |
| | GATEWAY_SHARING_ENDPOINT | The endpoint of the shares service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | com.owncloud.api.sharing |
| | GATEWAY_STORAGE_PUBLIC_LINK_ENDPOINT | The endpoint of the storage-publiclink service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | com.owncloud.api.storage-publiclink |
| | GATEWAY_STORAGE_SHARES_ENDPOINT | The endpoint of the storage-shares service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | com.owncloud.api.storage-shares |
| | GATEWAY_STORAGE_USERS_ENDPOINT | The endpoint of the storage-users service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | com.owncloud.api.storage-users |
| | GATEWAY_USERS_ENDPOINT | The endpoint of the users service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | com.owncloud.api.users |
| [Graph]({s-path}/graph.adoc) | GRAPH_AVAILABLE_ROLES | A comma separated list of roles that are available for assignment. | [b1e2218d-eef8-4d4c-b82d-0f1a1b48f3b5 a8d5fe5e-96e3-418d-825b-534dbdf22b99 fb6c3e19-e378-47e5-b277-9732f9de6e21 58c63c02-1d89-4572-916a-870abc5a1b7d 2d00ce52-1fc2-4dbc-8b95-a73b73395f5a 1c996275-f1c9-4e71-abdf-a42f6495e960 312c0871-5ef7-4b3a-85b6-0e4074c64049] |
| | GRAPH_MAX_CONCURRENCY | The maximum number of concurrent requests the service will handle. | 20 |
| | GRAPH_TRANSLATION_PATH | (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. | |
| [OCM]({s-path}/ocm.adoc) | OCM_OCM_INVITE_MANAGER_TIMEOUT | Timeout specifies a time limit for requests made to OCM endpoints. | 30s |
| | OCM_OCM_INVITE_MANAGER_TOKEN_EXPIRATION | Expiry duration for invite tokens. | 24h0m0s |
| | OCM_OCM_STORAGE_DATA_SERVER_URL | URL of the data server, needs to be reachable by the data gateway provided by the frontend service or the user if directly exposed. | http://localhost:9280/data |
| [Postprocessing]({s-path}/postprocessing.adoc) | POSTPROCESSING_WORKERS | The number of concurrent go routines that fetch events from the event queue. | 3 |
| [Proxy]({s-path}/proxy.adoc) | PROXY_AUTOPROVISION_CLAIM_DISPLAYNAME | The name of the OIDC claim that holds the display name. | name |
| | PROXY_AUTOPROVISION_CLAIM_EMAIL | The name of the OIDC claim that holds the email. | email |
| | PROXY_AUTOPROVISION_CLAIM_GROUPS | The name of the OIDC claim that holds the groups. | groups |
| | PROXY_AUTOPROVISION_CLAIM_USERNAME | The name of the OIDC claim that holds the username. | preferred_username |
| | PROXY_CSP_CONFIG_FILE_LOCATION | The location of the CSP configuration file. | |
| | PROXY_ENABLE_APP_AUTH | Allow app authentication. This can be used to authenticate 3rd party applications. Note that auth-app service must be running for this feature to work. | false |
| | PROXY_EVENTS_AUTH_PASSWORD | The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. | |
| | PROXY_EVENTS_AUTH_USERNAME | The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. | |
| | PROXY_EVENTS_CLUSTER | The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. | ocis-cluster |
| | PROXY_EVENTS_ENABLE_TLS | Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. | false |
| | PROXY_EVENTS_ENDPOINT | The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Set to a empty string to disable emitting events. | 127.0.0.1:9233 |
| | PROXY_EVENTS_TLS_INSECURE | Whether to verify the server TLS certificates. | false |
| | PROXY_EVENTS_TLS_ROOT_CA_CERTIFICATE | The root CA certificate used to validate the server’s TLS certificate. If provided PROXY_EVENTS_TLS_INSECURE will be seen as false. | |
| [Sharing]({s-path}/sharing.adoc) | SHARING_USER_JSONCS3_MAX_CONCURRENCY | Maximum number of concurrent go-routines. Higher values can potentially get work done faster but will also cause more load on the system. Values of 0 or below will be ignored and the default value will be used. | 1 |
| [SSE]({s-path}/sse.adoc) | SSE_KEEPALIVE_INTERVAL | To prevent intermediate proxies from closing the SSE connection, send periodic SSE comments to keep it open. | 0s |
| [Storage-Users]({s-path}/storage-users.adoc) | STORAGE_USERS_OCIS_GENERAL_SPACE_PATH_TEMPLATE | Template string to construct the paths of the projects space roots. | |
| | STORAGE_USERS_OCIS_MAX_CONCURRENCY | Maximum number of concurrent go-routines. Higher values can potentially get work done faster but will also cause more load on the system. Values of 0 or below will be ignored and the default value will be used. | 1 |
| | STORAGE_USERS_OCIS_PERSONAL_SPACE_PATH_TEMPLATE | Template string to construct the paths of the personal space roots. | |
| | STORAGE_USERS_PERMISSION_ENDPOINT | Endpoint of the permissions service. The endpoints can differ for 'ocis', 'posix' and 's3ng'. | com.owncloud.api.settings |
| | STORAGE_USERS_POSIX_GENERAL_SPACE_PATH_TEMPLATE | Template string to construct the paths of the projects space roots. | projects/{{.SpaceId}} |
| | STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT | Endpoint of the permissions service. The endpoints can differ for 'ocis', 'posix' and 's3ng'. | com.owncloud.api.settings |
| | STORAGE_USERS_POSIX_PERSONAL_SPACE_PATH_TEMPLATE | Template string to construct the paths of the personal space roots. | users/{{.User.Username}} |
| | 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. | /var/lib/ocis/storage/users |
| | STORAGE_USERS_POSIX_SCAN_DEBOUNCE_DELAY | The time in milliseconds to wait before scanning the filesystem for changes after a change has been detected. | 1s |
| | STORAGE_USERS_POSIX_USE_SPACE_GROUPS | Use space groups to manage permissions on spaces. | false |
| | STORAGE_USERS_POSIX_WATCH_FOLDER_KAFKA_BROKERS | Comma-separated list of kafka brokers to read the watchfolder events from. | |
| | 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. | |
| | 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'. | |
| | STORAGE_USERS_S3NG_GENERAL_SPACE_PATH_TEMPLATE | Template string to construct the paths of the projects space roots. | |
| | STORAGE_USERS_S3NG_PERSONAL_SPACE_PATH_TEMPLATE | Template string to construct the paths of the personal space roots. | |
| | STORAGE_USERS_SERVICE_NAME | Service name to use. Change this when starting an additional storage provider with a custom configuration to prevent it from colliding with the default 'storage-users' service. | storage-users |
| [Thumbnails]({s-path}/thumbnails.adoc) | THUMBNAILS_MAX_CONCURRENT_REQUESTS | Number of maximum concurrent thumbnail requests. Default is 0 which is unlimited. | 0 |
| | THUMBNAILS_MAX_INPUT_HEIGHT | The maximum height of an input image which is being processed. | 7680 |
| | THUMBNAILS_MAX_INPUT_IMAGE_FILE_SIZE | The maximum file size of an input image which is being processed. Usable common abbreviations: [KB, KiB, MB, MiB, GB, GiB, TB, TiB, PB, PiB, EB, EiB], example: 2GB. | 50MB |
| | THUMBNAILS_MAX_INPUT_WIDTH | The maximum width of an input image which is being processed. | 7680 |
| [Userlog]({s-path}/userlog.adoc) | USERLOG_MAX_CONCURRENCY | Maximum number of concurrent go-routines. Higher values can potentially get work done faster but will also cause more load on the system. Values of 0 or below will be ignored and the default value will be used. | 1 |
| [Web]({s-path}/web.adoc) | WEB_ASSET_APPS_PATH | Serve ownCloud Web apps assets from a path on the filesystem instead of the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/web/assets/apps | /var/lib/ocis/web/assets/apps |
| | WEB_ASSET_CORE_PATH | Serve ownCloud Web assets from a path on the filesystem instead of the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/web/assets/core | /var/lib/ocis/web/assets/core |
| | WEB_ASSET_THEMES_PATH | Serve ownCloud themes from a path on the filesystem instead of the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/web/assets/themes | /var/lib/ocis/web/assets/themes |

0
docs/services/general-info/env-var-deltas/5.0.0-7.0.0-deprecated.adoc → docs/services/general-info/envvars/env-var-deltas/5.0.0-7.0.0-deprecated.adoc
View File

19
docs/services/general-info/envvars/env-var-deltas/5.0.0-7.0.0-deprecated.md Normal file
View File

@@ -0,0 +1,19 @@
Note that the links provided in the service column are non functional when clicked.
| Service | Variable | Description | Removal Version | Deprecation Info |
| --- | --- | --- | --- | --- |
| [Clientlog]({s-path}/clientlog.adoc) | CLIENTLOG_REVA_GATEWAY | CS3 gateway used to look up user metadata | %%NEXT_PRODUCTION_VERSION%% | CLIENTLOG_REVA_GATEWAY removed for simplicity. |
| [Frontend]({s-path}/frontend.adoc) | FRONTEND_OCS_ADDITIONAL_INFO_ATTRIBUTE | Additional information attribute for the user like {{.Mail}}. | %%NEXT_PRODUCTION_VERSION%% | The OCS API is deprecated |
| | FRONTEND_OCS_ENABLE_DENIALS | EXPERIMENTAL: enable the feature to deny access on folders. | %%NEXT_PRODUCTION_VERSION%% | The OCS API is deprecated |
| | FRONTEND_OCS_INCLUDE_OCM_SHAREES | Include OCM sharees when listing sharees. | %%NEXT_PRODUCTION_VERSION%% | FRONTEND_OCS_INCLUDE_OCM_SHAREES, the OCS API is deprecated |
| | FRONTEND_OCS_LIST_OCM_SHARES | Include OCM shares when listing shares. See the OCM service documentation for more details. | %%NEXT_PRODUCTION_VERSION%% | FRONTEND_OCS_LIST_OCM_SHARES, the OCS API is deprecated |
| | FRONTEND_OCS_PERSONAL_NAMESPACE | Home namespace identifier. | %%NEXT_PRODUCTION_VERSION%% | The OCS API is deprecated |
| | FRONTEND_OCS_PREFIX | URL path prefix for the OCS service. Note that the string must not start with '/'. | %%NEXT_PRODUCTION_VERSION%% | The OCS API is deprecated |
| | FRONTEND_OCS_SHARE_PREFIX | Path prefix for shares as part of an ocis resource. Note that the path must start with '/'. | %%NEXT_PRODUCTION_VERSION%% | The OCS API is deprecated |
| | FRONTEND_OCS_STAT_CACHE_AUTH_PASSWORD | The password to use for authentication. Only applies when using the 'nats-js-kv' store type. | %%NEXT_PRODUCTION_VERSION%% | FRONTEND_OCS_STAT_CACHE_AUTH_PASSWORD, the OCS API is deprecated |
| | FRONTEND_OCS_STAT_CACHE_AUTH_USERNAME | The username to use for authentication. Only applies when using the 'nats-js-kv' store type. | %%NEXT_PRODUCTION_VERSION%% | FRONTEND_OCS_STAT_CACHE_AUTH_USERNAME, the OCS API is deprecated |
| | FRONTEND_OCS_STAT_CACHE_DISABLE_PERSISTENCE | Disable persistence of the cache. Only applies when using the 'nats-js-kv' store type. Defaults to false. | %%NEXT_PRODUCTION_VERSION%% | FRONTEND_OCS_STAT_CACHE_DISABLE_PERSISTENCE, the OCS API is deprecated |
| | FRONTEND_OCS_STAT_CACHE_STORE | The type of the cache store. Supported values are: 'memory', 'redis-sentinel', 'nats-js-kv', 'noop'. See the text description for details. | %%NEXT_PRODUCTION_VERSION%% | FRONTEND_OCS_STAT_CACHE_STORE, the OCS API is deprecated |
| | FRONTEND_OCS_STAT_CACHE_STORE_NODES | 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. | %%NEXT_PRODUCTION_VERSION%% | FRONTEND_OCS_STAT_CACHE_STORE_NODES, the OCS API is deprecated |
| | FRONTEND_OCS_STAT_CACHE_TABLE | The database table the store should use. | %%NEXT_PRODUCTION_VERSION%% | The OCS API is deprecated |
| | FRONTEND_OCS_STAT_CACHE_TTL | 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. | %%NEXT_PRODUCTION_VERSION%% | FRONTEND_OCS_STAT_CACHE_TTL, the OCS API is deprecated |

0
docs/services/general-info/env-var-deltas/5.0.0-7.0.0-removed.adoc → docs/services/general-info/envvars/env-var-deltas/5.0.0-7.0.0-removed.adoc
View File

53
docs/services/general-info/envvars/env-var-deltas/5.0.0-7.0.0-removed.md Normal file
View File

@@ -0,0 +1,53 @@
Note that the links provided in the service column are non functional when clicked.
| Service | Variable | Description | Default |
| --- | --- | --- | --- |
| [Special Scope Envvars](deployment/services/env-vars-special-scope.adoc) | OCIS_CACHE_SIZE | The maximum quantity of items in the user info cache. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not exclicitly set as default. | 0 |
| | OCIS_DECOMPOSEDFS_METADATA_BACKEND | The backend to use for storing metadata. Supported values are 'messagepack' and 'xattrs'. The setting 'messagepack' uses a dedicated file to store file metadata while 'xattrs' uses extended attributes to store file metadata. Defaults to 'messagepack'. | messagepack |
| | OCIS_ENABLE_RESHARING | Changing this value is NOT supported. Enables the support for re-sharing in the clients. | false |
| | OCIS_PERSISTENT_STORE_SIZE | The maximum quantity of items in the store. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not exclicitly set as default. | 0 |
| [Antivirus]({s-path}/antivirus.adoc) | ANTIVIRUS_ICAP_TIMEOUT | Timeout for the ICAP client. | 0 |
| [Eventhistory]({s-path}/eventhistory.adoc) | EVENTHISTORY_STORE_SIZE | The maximum quantity of items in the store. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived and used from the ocmem package though no explicit default was set. | 0 |
| [Frontend]({s-path}/frontend.adoc) | FRONTEND_ENABLE_RESHARING | Changing this value is NOT supported. Enables the support for re-sharing in the clients. | false |
| | FRONTEND_OCS_STAT_CACHE_SIZE | Max number of entries to hold in the cache. | 0 |
| [Gateway]({s-path}/gateway.adoc) | GATEWAY_CREATE_HOME_CACHE_SIZE | The maximum quantity of items in the cache. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not explicitly set as default. | 0 |
| | GATEWAY_PROVIDER_CACHE_SIZE | The maximum quantity of items in the cache. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not explicitly set as default. | 0 |
| [Graph]({s-path}/graph.adoc) | GRAPH_CACHE_SIZE | The maximum quantity of items in the store. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not explicitly set as default. | 0 |
| | GRAPH_ENABLE_RESHARING | Changing this value is NOT supported. Enables the support for re-sharing. | false |
| [OCM]({s-path}/ocm.adoc) | OCM_OCM_PROVIDER_AUTHORIZER_VERIFY_REQUEST_HOSTNAME | Verify the hostname of the incoming request against the hostname of the OCM provider. | false |
| [Postprocessing]({s-path}/postprocessing.adoc) | POSTPROCESSING_STORE_SIZE | The maximum quantity of items in the store. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not exclicitly set as default. | 0 |
| [Proxy]({s-path}/proxy.adoc) | PROXY_OIDC_USERINFO_CACHE_SIZE | The maximum quantity of items in the user info cache. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not explicitly set as default. | 0 |
| [Settings]({s-path}/settings.adoc) | SETTINGS_CACHE_SIZE | The maximum quantity of items in the cache. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not exclicitly set as default. | 0 |
| | SETTINGS_DATA_PATH | The directory where the filesystem storage will store ocis settings. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/settings. | /var/lib/ocis/settings |
| | SETTINGS_STORE_TYPE | Store type configures the persistency driver. Supported values are 'metadata' and 'filesystem'. Note that the value 'filesystem' is considered deprecated. | metadata |
| [Sharing]({s-path}/sharing.adoc) | SHARING_ENABLE_RESHARING | Changing this value is NOT supported. Enables the support for resharing. | false |
| [Storage-System]({s-path}/storage-system.adoc) | STORAGE_SYSTEM_CACHE_SIZE | The maximum quantity of items in the user info cache. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not exclicitly set as default. | 0 |
| | STORAGE_SYSTEM_OCIS_METADATA_BACKEND | The backend to use for storing metadata. Supported values are 'messagepack' and 'xattrs'. The setting 'messagepack' uses a dedicated file to store file metadata while 'xattrs' uses extended attributes to store file metadata. Defaults to 'messagepack'. | messagepack |
| [Storage-Users]({s-path}/storage-users.adoc) | STORAGE_USERS_FILEMETADATA_CACHE_SIZE | The maximum quantity of items in the user info cache. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not exclicitly set as default. | 0 |
| | STORAGE_USERS_ID_CACHE_SIZE | The maximum quantity of items in the user info cache. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not exclicitly set as default. | 0 |
| | STORAGE_USERS_OCIS_METADATA_BACKEND | The backend to use for storing metadata. Supported values are 'messagepack' and 'xattrs'. The setting 'messagepack' uses a dedicated file to store file metadata while 'xattrs' uses extended attributes to store file metadata. Defaults to 'messagepack'. | messagepack |
| | STORAGE_USERS_S3NG_METADATA_BACKEND | The backend to use for storing metadata. Supported values are 'xattrs' and 'messagepack'. The setting 'xattrs' uses extended attributes to store file metadata while 'messagepack' uses a dedicated file to store file metadata. Defaults to 'xattrs'. | messagepack |
| The `Store` service has been removed completely | STORE_DATA_PATH | The directory where the filesystem storage will store ocis settings. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/store. | /var/lib/ocis/store |
| | STORE_DEBUG_ADDR | Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. | 127.0.0.1:9464 |
| | STORE_DEBUG_PPROF | Enables pprof, which can be used for profiling. | false |
| | STORE_DEBUG_TOKEN | Token to secure the metrics endpoint. | |
| | STORE_DEBUG_ZPAGES | Enables zpages, which can be used for collecting and viewing in-memory traces. | false |
| | STORE_GRPC_ADDR | The bind address of the GRPC service. | 127.0.0.1:9460 |
| | STORE_LOG_COLOR | Activates colorized log output. | false |
| | STORE_LOG_FILE | The path to the log file. Activates logging to this file if set. | |
| | STORE_LOG_LEVEL | The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'. | |
| | STORE_LOG_PRETTY | Activates pretty log output. | false |
| | STORE_TRACING_COLLECTOR | The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. | |
| | STORE_TRACING_ENABLED | Activates tracing. | false |
| | STORE_TRACING_ENDPOINT | The endpoint of the tracing agent. | |
| | STORE_TRACING_TYPE | The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. | |
| [Userlog]({s-path}/userlog.adoc) | USERLOG_STORE_SIZE | The maximum quantity of items in the store. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not exclicitly set as default. | 0 |
| [Web]({s-path}/web.adoc) | WEB_ASSET_PATH | Serve ownCloud Web assets from a path on the filesystem instead of the builtin assets. | |
| | WEB_OPTION_DISABLE_PREVIEWS | Set this option to 'true' to disable previews in all the different web file listing views. This can speed up file listings in folders with many files. The only list view that is not affected by this setting is the trash bin, as it does not allow previewing at all. | false |
| | WEB_OPTION_HOME_FOLDER | Specifies a folder that is used when the user navigates 'home'. Navigating home gets triggered by clicking on the 'All files' menu item. The user will not be jailed in that directory, it simply serves as a default location. A static location can be provided, or variables of the user object to come up with a user specific home path can be used. This uses the twig template variable style and allows picking a value or a substring of a value of the authenticated user. Examples are '/Shares', '/{{.Id}}' and '/{{substr 0 3 .Id}}/{{.Id}'. | |
| | WEB_OPTION_HOVERABLE_QUICK_ACTIONS | Set this option to 'true' to hide quick actions (buttons appearing on file rows) and only show them when the user hovers over the row with his mouse. Defaults to 'false'. | false |
| | WEB_OPTION_OPEN_LINKS_WITH_DEFAULT_APP | Specifies whether single file link shares should be opened with the default app or not. If not opened by the default app, the Web UI just displays the file details. | true |
| | WEB_OPTION_PREVIEW_FILE_MIMETYPES | A list of mimeTypes to specify which ones will be previewed in the UI. For example, to only preview jpg and text files, set this option to 'image/jpeg,text/plain'. See the Environment Variable Types description for more details. | [image/gif image/png image/jpeg text/plain image/tiff image/bmp image/x-ms-bmp application/vnd.geogebra.slides] |
| | WEB_OPTION_ROUTING_ID_BASED | Enable or disable fileIds being added to the URL. Defaults to 'true', because otherwise spaces with name clashes cannot be resolved correctly. Note: Only disable this if you can guarantee on the server side, that spaces of the same namespace cannot have name clashes. | true |
| | WEB_OPTION_SHARING_RECIPIENTS_PER_PAGE | Sets the number of users shown as recipients in the dropdown menu when sharing resources. | 200 |
| | WEB_OPTION_SIDEBAR_SHARES_SHOW_ALL_ON_LOAD | Sets the list of the (link) shares list in the sidebar to be initially expanded. Default is a collapsed state, only showing the first three shares. | false |

0
docs/services/general-info/env-var-deltas/7.0.0-7.1.0-added.adoc → docs/services/general-info/envvars/env-var-deltas/7.0.0-7.1.0-added.adoc
View File

13
docs/services/general-info/envvars/env-var-deltas/7.0.0-7.1.0-added.md Normal file
View File

@@ -0,0 +1,13 @@
Note that the links provided in the service column are non functional when clicked.
| Service | Variable | Description | Default |
| --- | --- | --- | --- |
| [Fontend]({s-path}/frontend.adoc) | FRONTEND_CONFIGURABLE_NOTIFICATIONS | Allow configuring notifications via web client. | false |
| [Notifications]({s-path}/notifications.adoc) | NOTIFICATIONS_STORE | The type of the store. Supported values are: 'memory', 'nats-js-kv', 'redis-sentinel', 'noop'. See the text description for details. | nats-js-kv |
| | NOTIFICATIONS_STORE_AUTH_PASSWORD | The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. | |
| | NOTIFICATIONS_STORE_AUTH_USERNAME | The username to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. | |
| | NOTIFICATIONS_STORE_DATABASE | The database name the configured store should use. | notifications |
| | NOTIFICATIONS_STORE_NODES | 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. | [127.0.0.1:9233] |
| | NOTIFICATIONS_STORE_TABLE | The database table the store should use. | |
| | NOTIFICATIONS_STORE_TTL | Time to live for notifications in the store. Defaults to '336h' (2 weeks). See the Environment Variable Types description for more details. | 336h0m0s |
| [Settings]({s-path}/settings.adoc) | SETTINGS_TRANSLATION_PATH | (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. | |

0
docs/services/general-info/env-var-deltas/7.0.0-7.1.0-deprecated.adoc → docs/services/general-info/envvars/env-var-deltas/7.0.0-7.1.0-deprecated.adoc
View File

21
docs/services/general-info/envvars/env-var-deltas/7.0.0-7.1.0-deprecated.md Normal file
View File

@@ -0,0 +1,21 @@
Note that the links provided in the service column are non functional when clicked.
Note that these environment variables were listed for deprecation in 7.0.0 already. Removal has been delayed for an upcoming production version. They are listed here for consistency.
| Service | Variable | Description | Removal Version | Deprecation Info |
| --- | --- | --- | --- | --- |
| [Clientlog]({s-path}/clientlog.adoc) | CLIENTLOG_REVA_GATEWAY | CS3 gateway used to look up user metadata | %%NEXT_PRODUCTION_VERSION%% | CLIENTLOG_REVA_GATEWAY removed for simplicity. |
| [Frontend]({s-path}/frontend.adoc) | FRONTEND_OCS_ADDITIONAL_INFO_ATTRIBUTE | Additional information attribute for the user like {{.Mail}}. | %%NEXT_PRODUCTION_VERSION%% | The OCS API is deprecated |
| | FRONTEND_OCS_ENABLE_DENIALS | EXPERIMENTAL: enable the feature to deny access on folders. | %%NEXT_PRODUCTION_VERSION%% | The OCS API is deprecated |
| | FRONTEND_OCS_INCLUDE_OCM_SHAREES | Include OCM sharees when listing sharees. | %%NEXT_PRODUCTION_VERSION%% | FRONTEND_OCS_INCLUDE_OCM_SHAREES, the OCS API is deprecated |
| | FRONTEND_OCS_LIST_OCM_SHARES | Include OCM shares when listing shares. See the OCM service documentation for more details. | %%NEXT_PRODUCTION_VERSION%% | FRONTEND_OCS_LIST_OCM_SHARES, the OCS API is deprecated |
| | FRONTEND_OCS_PERSONAL_NAMESPACE | Home namespace identifier. | %%NEXT_PRODUCTION_VERSION%% | The OCS API is deprecated |
| | FRONTEND_OCS_PREFIX | URL path prefix for the OCS service. Note that the string must not start with '/'. | %%NEXT_PRODUCTION_VERSION%% | The OCS API is deprecated |
| | FRONTEND_OCS_SHARE_PREFIX | Path prefix for shares as part of an ocis resource. Note that the path must start with '/'. | %%NEXT_PRODUCTION_VERSION%% | The OCS API is deprecated |
| | FRONTEND_OCS_STAT_CACHE_AUTH_PASSWORD | The password to use for authentication. Only applies when using the 'nats-js-kv' store type. | %%NEXT_PRODUCTION_VERSION%% | FRONTEND_OCS_STAT_CACHE_AUTH_PASSWORD, the OCS API is deprecated |
| | FRONTEND_OCS_STAT_CACHE_AUTH_USERNAME | The username to use for authentication. Only applies when using the 'nats-js-kv' store type. | %%NEXT_PRODUCTION_VERSION%% | FRONTEND_OCS_STAT_CACHE_AUTH_USERNAME, the OCS API is deprecated |
| | FRONTEND_OCS_STAT_CACHE_DISABLE_PERSISTENCE | Disable persistence of the cache. Only applies when using the 'nats-js-kv' store type. Defaults to false. | %%NEXT_PRODUCTION_VERSION%% | FRONTEND_OCS_STAT_CACHE_DISABLE_PERSISTENCE, the OCS API is deprecated |
| | FRONTEND_OCS_STAT_CACHE_STORE | The type of the cache store. Supported values are: 'memory', 'redis-sentinel', 'nats-js-kv', 'noop'. See the text description for details. | %%NEXT_PRODUCTION_VERSION%% | FRONTEND_OCS_STAT_CACHE_STORE, the OCS API is deprecated |
| | FRONTEND_OCS_STAT_CACHE_STORE_NODES | 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. | %%NEXT_PRODUCTION_VERSION%% | FRONTEND_OCS_STAT_CACHE_STORE_NODES, the OCS API is deprecated |
| | FRONTEND_OCS_STAT_CACHE_TABLE | The database table the store should use. | %%NEXT_PRODUCTION_VERSION%% | The OCS API is deprecated |
| | FRONTEND_OCS_STAT_CACHE_TTL | 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. | %%NEXT_PRODUCTION_VERSION%% | FRONTEND_OCS_STAT_CACHE_TTL, the OCS API is deprecated |

0
docs/services/general-info/env-var-deltas/7.0.0-7.1.0-removed.adoc → docs/services/general-info/envvars/env-var-deltas/7.0.0-7.1.0-removed.adoc
View File

4
docs/services/general-info/envvars/env-var-deltas/7.0.0-7.1.0-removed.md Normal file
View File

@@ -0,0 +1,4 @@
Note that the links provided in the service column are non functional when clicked.
| Service | Variable | Description | Default |
| --- | --- | --- | --- |

0
docs/services/general-info/env-var-deltas/7.1.0-7.2.0-added.adoc → docs/services/general-info/envvars/env-var-deltas/7.1.0-7.2.0-added.adoc
View File

10
docs/services/general-info/envvars/env-var-deltas/7.1.0-7.2.0-added.md Normal file
View File

@@ -0,0 +1,10 @@
Note that the links provided in the service column are non functional when clicked.
| Service | Variable | Description | Default |
| --- | --- | --- | --- |
| [Special Scope Envvars](deployment/services/env-vars-special-scope.adoc) | OCIS_CLAIM_MANAGED_SPACES_CLAIMNAME | The name of the claim used to manage Spaces. | |
| | OCIS_CLAIM_MANAGED_SPACES_ENABLED | Enables Space management through OIDC claims. See the text description for more details. | false |
| | OCIS_CLAIM_MANAGED_SPACES_MAPPING | (Optional) Mapping of OIDC roles to ocis Space roles. Example: 'oidcroleA:viewer,oidcroleB:manager' | [] |
| | OCIS_CLAIM_MANAGED_SPACES_REGEXP | The regular expression that extracts Space IDs and roles from a claim. | |
| | OCIS_MAX_TAG_LENGTH | Define the maximum tag length. Defaults to 100 if not set. Set to 0 to not limit the tag length. Changes only impact the validation of new tags. | 100 |
| [search]({s-path}/search.adoc) | SEARCH_ENGINE_BLEVE_SCALE | Enable scaling of the search index (bleve). If set to 'true', the instance of the search service will no longer have exclusive write access to the index. Note when scaling search, all instances of the search service must be set to true! For 'false', which is the default, the running search service has exclusive access to the index as long it is running. This locks out other search processes tying to access the index. | false |

0
docs/services/general-info/env-var-deltas/7.1.0-7.2.0-deprecated.adoc → docs/services/general-info/envvars/env-var-deltas/7.1.0-7.2.0-deprecated.adoc
View File

4
docs/services/general-info/envvars/env-var-deltas/7.1.0-7.2.0-deprecated.md Normal file
View File

@@ -0,0 +1,4 @@
Note that the links provided in the service column are non functional when clicked.
| Service | Variable | Description | Removal Version | Deprecation Info |
| --- | --- | --- | --- | --- |

0
docs/services/general-info/env-var-deltas/7.1.0-7.2.0-removed.adoc → docs/services/general-info/envvars/env-var-deltas/7.1.0-7.2.0-removed.adoc
View File

21
docs/services/general-info/envvars/env-var-deltas/7.1.0-7.2.0-removed.md Normal file
View File

@@ -0,0 +1,21 @@
Note that the links provided in the service column are non functional when clicked.
| Service | Variable | Description | Default |
| --- | --- | --- | --- |
| [clientlog]({s-path}/clientlog.adoc) | CLIENTLOG_REVA_GATEWAY | CS3 gateway used to look up user metadata | com.owncloud.api.gateway |
| [frontend]({s-path}/frontend.adoc) | FRONTEND_OCS_ADDITIONAL_INFO_ATTRIBUTE | Additional information attribute for the user like {{.Mail}}. | {{.Mail}} |
| | FRONTEND_OCS_ENABLE_DENIALS | EXPERIMENTAL: enable the feature to deny access on folders. | false |
| | FRONTEND_OCS_INCLUDE_OCM_SHAREES | Include OCM sharees when listing sharees. | false |
| | FRONTEND_OCS_LIST_OCM_SHARES | Include OCM shares when listing shares. See the OCM service documentation for more details. | true |
| | FRONTEND_OCS_PERSONAL_NAMESPACE | Home namespace identifier. | /users/{{.Id.OpaqueId}} |
| | FRONTEND_OCS_PREFIX | URL path prefix for the OCS service. Note that the string must not start with '/'. | ocs |
| | FRONTEND_OCS_PUBLIC_SHARE_MUST_HAVE_PASSWORD | Set this to true if you want to enforce passwords on all public shares. | true |
| | FRONTEND_OCS_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD | Set this to true if you want to enforce passwords for writable shares. Only effective if the setting for 'passwords on all public shares' is set to false. | false |
| | FRONTEND_OCS_SHARE_PREFIX | Path prefix for shares as part of an ocis resource. Note that the path must start with '/'. | /Shares |
| | FRONTEND_OCS_STAT_CACHE_AUTH_PASSWORD | The password to use for authentication. Only applies when using the 'nats-js-kv' store type. | |
| | FRONTEND_OCS_STAT_CACHE_AUTH_USERNAME | The username to use for authentication. Only applies when using the 'nats-js-kv' store type. | |
| | FRONTEND_OCS_STAT_CACHE_DISABLE_PERSISTENCE | Disable persistence of the cache. Only applies when using the 'nats-js-kv' store type. Defaults to false. | false |
| | FRONTEND_OCS_STAT_CACHE_STORE | The type of the cache store. Supported values are: 'memory', 'redis-sentinel', 'nats-js-kv', 'noop'. See the text description for details. | memory |
| | FRONTEND_OCS_STAT_CACHE_STORE_NODES | 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. | [127.0.0.1:9233] |
| | FRONTEND_OCS_STAT_CACHE_TABLE | The database table the store should use. | |
| | FRONTEND_OCS_STAT_CACHE_TTL | 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. | 5m0s |

37
docs/services/general-info/envvars/env-var-deltas/_index.md Normal file
View File

@@ -0,0 +1,37 @@
---
title: Deltas Between Versions
date: 2024-02-08T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/general-info/envvars/env-var-deltas
geekdocFilePath: _index.md
geekdocCollapseSection: true
---
## General Information
This section provides information about `added`, `removed` and `deprecated` environment variables between two major/minor versions.
To create the changed envvar tables, you must proceed the following steps in order:
1. Install, if not already done, the converter for adoc to markdown tables: `npm install -g downdoc`\
This is only required when converting adoc to markdown tables but highly recommended!
2. Run `make -C docs docs-generate` from the ocis root.\
A file named `env_vars.yaml` is generated. Check for validity. If issues are found, fix them in the service sources first which need to be merged before you rerun make. When the changes are fine, create a PR and merge it. Any delta information is based on an actual `env_vars.yaml` file which is pull from master by the python script described below!
3. Configure the Python script `docs/helpers/changed_envvars.py` variables for the new version.\
Note that you **must** use semver and not code names!
4. Run the python script from the ocis root such as `python3 docs/helpers/changed_envvars.py`.\
Note that the script pulls data from the master branch only, therefore the `env_vars.yaml` file MUST be up to date.\
adoc tables will be generated which are used for the admin docs and are the basis for markdown.
5. Because the script can not determine the link target in the `Service` column, you must manually adapt them in the generated adoc files with respect to the name and target. Only one entry per identical service block is required, delete the cell content for the rest for ease of readability.
6. Run `npx downdoc <filename.adoc>` for each of the newly generated `added`, `removed` and `deprecated` files.
7. Add in each markdown file on top the following sentence:\
`Note that the links provided in the service column are non functional when clicked.` including a newline.
8. Create a PR and merge it.

12
docs/services/general-info/envvar-scopes.md → docs/services/general-info/envvars/envvar-naming-scopes.md
View File

@@ -1,10 +1,10 @@
---
title: Envvar Naming Scopes
date: 2023-03-23T00:00:00+00:00
weight: 20
weight: 10
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/general-info
geekdocFilePath: envvar-scopes.md
geekdocEditPath: edit/master/docs/services/general-info/envvars
geekdocFilePath: envvar-naming-scopes.md
geekdocCollapseSection: true
---
@@ -36,6 +36,10 @@ Note that this envvar is the global representation of the local example from abo
To get a list of global envvars used in all services, see the [Global Environment Variables](https://doc.owncloud.com/ocis/next/deployment/services/env-vars-special-scope.html#global-environment-variables) table in the ocis admin documentation.
### Reserved Envvar Names
Services and their local envvars **MUST NOT** be named `extended` or `global`. These are reserved names for the automated documentation process.
## Lifecycle of Envvars
The envvar struct tag contains at maximum the following key/value pairs to document the lifecycle of a config variable:
@@ -48,7 +52,7 @@ The envvar struct tag contains at maximum the following key/value pairs to docum
### Introduce new Envvars
If a new envvar is introduced, only the `introductionVersion` is required.
If a new envvar is introduced, the complete struct needs to be added, but only the `introductionVersion` requires data.
{{< hint info >}}
* During development, set `introductionVersion` to a short, **alphabetic code name** that represents the upcoming release (e.g. `releaseX`).

51
docs/services/general-info/envvars/new-release-process.md Normal file
View File

@@ -0,0 +1,51 @@
---
title: "Release Process for Envvars"
date: 2025-07-04T00:00:00+01:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/general-info/envvars
geekdocFilePath: new-release-process.md
---
{{< toc >}}
**IMPORTANT**\
For a new ocis release, some tasks are necessary to be done **before** releasing. Follow the steps carefully to avoid issues. Most of the docs related tasks are not part of the CI. With each step finished successfully, the next step can be started. Sometimes, due to last minute changes, steps need to be redone!
The following can be done at any time but it must be done *latest* when no envvar changes are made which is just before a new release gets finally tagged. The data generated **must** be part of the upcoming release and be merged before tagging/branching!
## Special Scope Envvars
Ask the developers if envvars of this type have been changed (added or removed). See the [Special Envvars]({{< ref "./special-envvars.md" >}}) documentation for more details on how to manage such a change.
## Extended Envvars
* Run from the ocis root `make -C docs docs-generate`\
Drop any changes in `env_vars.yaml`!
* Check if there is a change in the `extended-envars.yaml` output.\
If so, process [Extended Envvars - Fixing Changed Item]({{< ref "./special-envvars.md#fixing-changed-items" >}}).
* When done, re-run the make command and check if the output of `./docs/services/_includes/adoc/extended_configvars.adoc` matches the expectations.
## Ordinary Envvars
### Maintain env_vars.yaml
This is **mandatory for a new release** !
* Run from the ocis root `make -C docs docs-generate`\
Any changes in `env_vars.yaml` are now considered.
* This file will most likely show changes and merging them is essential as base for added/removed or deprecated envvars. Note that this file will get additions/updates only, but things never get deleted automatically !!\
{{< hint info >}}
Note that due to how the code is currently designed, things may get shifted around though no real changes have been introduced.
{{< /hint >}}
* First, check if any **alphabetic code names** are present in the changes. See [Introduce new Envvars]({{< ref "./envvar-naming-scopes.md/#introduce-new-envvars" >}}).
* If so, create a new branch and replace them **in the sourcing service** with the actual semantic version (e.g. `releaseX` → `7.2.0`) first. Note that ALL of major, minor and patch numbers must be present, including patch == `0`.
* If all changes are applied, rerun `make -C docs docs-generate` and check if all changes are incorporated in the yaml file.
* Create a PR and merge these changes, dont forget to rebase master afterwards...
* With a new branch, remove all envvars from the `env_vars.yaml` file manually that have formerly been deprecated and removed from the code.
* Commit the changes and merge it.\
Now `env_vars.yaml` is up to date on the repo in master, next steps are based on this state!
### Create Envvar Delta Files
* Create [Envvar Deltas Between Versions]({{< ref "./env-var-deltas/_index.md" >}}) files according the linked description.

86
docs/services/general-info/envvars/special-envvars.md Normal file
View File

@@ -0,0 +1,86 @@
---
title: "Special Envvars"
date: 2025-07-04T00:00:00+01:00
weight: 14
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/general-info/envvars
geekdocFilePath: special-envvars.md
---
{{< toc >}}
Handling these envvars properly is very important for the automated doc process for both the developer and the admin docs!
## Special Scope Envvars
Variables with special scope are only related to a deployment method such as `OCIS_RUN_SERVICES`. These variables cannot be gathered automatically, rarely change, can be viewed and must be maintained manually via the [admin documentation](https://doc.owncloud.com/ocis/next/deployment/services/env-vars-special-scope.html).
## Extended Envvars
Environment variables with extended scope are not included in a service. They are rarely added or removed, though their code location can change during development.
They are variables that must be present before the core or services start up because they depend on information such as the path to configuration files. Therefore, they are not bound to services like other environment variables. Extended environment variables are identified via `os.Getenv` and are usually defined via a subfolder of `ocis-pkg`. The real envvar name cannot be automatically assigned and must be defined manually via the code in the generated `extended_vars.yaml` file.
While generating the ocis Developer Documentation, the `extended_vars.yaml` file located in `/docs/helpers/` might be updated which needs special care to finalize the process. When merged, an `extended_configvars.adoc` file is internally generated from it. This file, along with the others, is moved to the `doc` branch. The process runs automatically, and no additional effort is required. The admin docs picks this .adoc file for further processing.
The file for the master (`docs`) branch is located at:\
`https://github.com/owncloud/ocis/tree/docs/services/_includes/adoc/extended_configvars.adoc`\
respectivle in any `docs-stable-x.y` branch.
### General Info
The process behind updating the `extended_vars.yaml` is non-destructive. This means, that the process checks the code if values found match those in the file already present. If differences occur, only **new** content blocks are added, independent if it is new or moved code. The file is recreated when deleted - try to avoid this and maintain the changed one.
This also means, that if generating the docs result in a change in the `extended_vars.yaml` file, manual action **must** be taken and the final changes need to be committed/pushed/merged. If this is not done, the `extended_configvars.adoc` will contain invalid and/or corrupt data.
It can happen that extended envvars are found but do not need to be published as they are for internal use only. Those envvars can be defined to be ignored for further processing.
**IMPORTANT:**
- **First Time Identification**\
Once an extended envvar has been identified, it is added to the `extended_vars.yaml` file found, but never changed or touched by the process anymore. There is one exception with respect to single/double quote usage. While you can (and will) manually define a text like: `"'/var/lib/ocis'"`, quotes are transformed by the process in the .yaml file to: `'''/var/lib/ocis'''`. There is no need to change this back, as the final step transforms this correctly for the adoc table.
- **Item Naming**\
An extended envvar may not have the right naming. It may appear as `name: _registryEnv`. In case, this envvar needs to be named properly like `name: MICRO_REGISTRY` which can only be done in close alignment with development.
- **Automatic Data Population**:\
`rawname`, `path` and `foundincode` are automatically filled by the program.\
**IMPORTANT**: DO NOT EDIT THESE VALUES MANUALLY - except the line number in the `path` key.
- **Manual Data Population**:\
The following keys can and must be updated manually: `name`, `type`, `default_value`, `description`, `do_ignore`\
For the `path` key, **only** the line number of the value may be changed, see fixing values below.
- **Item Uniqueness**\
The identification, if an envvar is already present in the yaml file, is made via the `rawname` and the `path` identifier which includes the line number. **If there is a change in the source file shifting line numbers, new items will get added and old ones do not get touched.** Though technically ok, this can cause confusion to identify which items are correctly present or just added additionally just be cause code location has changed. If there are multiple occurrences of the same `rawname` value, check which one contains relevant data and set `do_ignore` to `false` and all others to `true`. When there are two identical blocks with different source references, mostly the one containing a proper `default_value` is the active one. Populate the false block with the envvar data to be used.
- **Sort Ordering**\
Do not change the sort order of extended envvar blocks as they are automatically reordered alphabetically.
- **Mandatory Key Values**\
Because extended envvars do not have the same structural setup as "normal" envvars (like type, description or defaults), this info needs to be provided manually once - for each valid block. Any change of this info will be noticed during the next CI run, the corresponding `extended_configvars.adoc` file will be generated, changes moved to the docs branch and published in the next admin docs build. See the following example with all keys listed and populated:
```yaml
rawname: registryAddressEnv
path: ocis-pkg/registry/registry.go:44
foundincode: true
name: MICRO_REGISTRY_ADDRESS
type: string
default_value: ""
description: The bind address of the internal go micro framework. Only change on
supervision of ownCloud Support.
do_ignore: false
```
### Fixing Changed Items
- **Fixing Items**\
If an item has been identified as additionally added such as there was a change in the code location only, it is mostly sufficient to just fix the line number in the `path` key of the existing/correct one and double check by removing the newly added ones. Then, re-run `make -C docs docs-generate`. If the fix was correct, no new items of the same will re-appear.
- **Remove Orphaned Items**\
To get rid of items with wrong line numbers, check `rawname` the `path` and correct the _existing ones_, especially the one containing the description and which is marked `do_ignore` false. Only items that have a real line number match need to be present, orphaned items can safely be removed.
You can double-check valid items by creating a dummy branch, delete the `extended_vars.yaml` and run `make -C docs docs-generate` to regenerate the file having only items with valid path references. With that info, you can remove orphaned items from the live file. Note to be careful on judging only on `foundincode` set to false indicating an item not existing anymore. Fix all items first, when rerunning `make -C docs docs-generate`, this may change back to true!
I an envvar has been removed from the code completely, you can also remove the respective entry block from the file.
- When all is set, create a PR and merge it.