mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2025-12-30 00:40:27 -06:00
Code Issues Packages Projects Releases Wiki Activity

[docs-only] Update the added/removed/deprecated envvars table

Browse Source
This commit is contained in:
Martin Mattel
2024-11-26 15:13:06 +01:00
parent 6c3684a02c
commit 3397197e5a
3 changed files with 287 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,7 +1,7 @@
// # Added Variables between oCIS 5.0.0 and oCIS 7.0.0
// commenting the headline to make it better includable
// table created per 2024.11.15
// table created per 2024.11.26
// the table should be recreated/updated on source () changes
[width="100%",cols="~,~,~,~",options="header"]
@@ -13,35 +13,50 @@
| 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_DEFAULT_LANGUAGE
| The default language used by services and the WebUI. If not defined, English will be used as default. See the documentation for more details.
|
|
| 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_MACHINE_AUTH_API_KEY
| The machine auth API key used to validate internal requests necessary to access resources from other services.
|
|
| 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
|
| OCIS_PERSISTENT_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
|
| OCIS_PERSISTENT_STORE_AUTH_PASSWORD
| The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured.
|
|
| OCIS_PERSISTENT_STORE_AUTH_USERNAME
| The username to authenticate with the store. Only applies when store type 'nats-js-kv' is configured.
|
|
| OCIS_PERSISTENT_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]
|
| OCIS_PERSISTENT_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
|
| 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
| xref:{s-path}/activitylog.adoc[Activitylog]
| ACTIVITYLOG_TRANSLATION_PATH
@@ -53,6 +68,11 @@
| The number of concurrent go routines that fetch events from the event queue.
| 10
| xref:{s-path}/app-provider.adoc[App-Provider]
| APP_PROVIDER_WOPI_DISABLE_CHAT
| Disable chat in the office web frontend. This feature applies to OnlyOffice and Microsoft.
| false
| xref:{s-path}/auth-app.adoc[Auth-App]
| AUTH_APP_DEBUG_ADDR
| Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
@@ -168,11 +188,6 @@
| Enable license checking to edit files. Needs to be enabled when using Microsoft365 with the business flow.
| false
|
| COLLABORATION_APP_LOCKNAME
| Name for the app lock
| com.github.owncloud.collaboration
|
| 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'.
@@ -198,11 +213,6 @@
| Connect to the CS3API data gateway insecurely.
| false
|
| COLLABORATION_CS3API_GATEWAY_NAME
| CS3 gateway used to look up user metadata.
| com.owncloud.api.gateway
|
| COLLABORATION_DEBUG_ADDR
| Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
@@ -449,6 +459,31 @@
| http://localhost:9280/data
| xref:{s-path}/postprocessing.adoc[Postprocessing]
| POSTPROCESSING_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
|
| POSTPROCESSING_STORE_AUTH_PASSWORD
| The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured.
|
|
| POSTPROCESSING_STORE_AUTH_USERNAME
| The username to authenticate with the store. Only applies when store type 'nats-js-kv' is configured.
|
|
| POSTPROCESSING_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]
|
| POSTPROCESSING_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
|
| POSTPROCESSING_WORKERS
| The number of concurrent go routines that fetch events from the event queue.
| 3
@@ -533,6 +568,16 @@
| 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_PERMISSIONS_ENDPOINT
| Endpoint of the permissions service. The endpoints can differ for 'ocis', 'posix' and 's3ng'.
| com.owncloud.api.settings
|
| STORAGE_USERS_OCIS_PERSONAL_SPACE_PATH_TEMPLATE
| Template string to construct the paths of the personal space roots.
@@ -561,7 +606,7 @@
|
| 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

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

@@ -1,7 +1,7 @@
// # Deprecated Variables between oCIS 5.0.0 and oCIS 7.0.0
// commenting the headline to make it better includable
// table created per 2024.11.07
// table created per 2024.11.26
// the table should be recreated/updated on source () changes
[width="100%",cols="~,~,~,~",options="header"]
@@ -13,5 +13,80 @@
| Timeout for the ICAP client.
| %%NEXT_PRODUCTION_VERSION%%
| xref:{s-path}/clientlog.adoc[Clientlog]
| CLIENTLOG_REVA_GATEWAY
| CS3 gateway used to look up user metadata
| %%NEXT_PRODUCTION_VERSION%%
| xref:{s-path}/frontend.adoc[Frontend]
| FRONTEND_OCS_ADDITIONAL_INFO_ATTRIBUTE
| Additional information attribute for the user like {{.Mail}}.
| %%NEXT_PRODUCTION_VERSION%%
|
| FRONTEND_OCS_ENABLE_DENIALS
| EXPERIMENTAL: enable the feature to deny access on folders.
| %%NEXT_PRODUCTION_VERSION%%
|
| FRONTEND_OCS_INCLUDE_OCM_SHAREES
| Include OCM sharees when listing sharees.
| %%NEXT_PRODUCTION_VERSION%%
|
| FRONTEND_OCS_LIST_OCM_SHARES
| Include OCM shares when listing shares. See the OCM service documentation for more details.
| %%NEXT_PRODUCTION_VERSION%%
|
| FRONTEND_OCS_PERSONAL_NAMESPACE
| Home namespace identifier.
| %%NEXT_PRODUCTION_VERSION%%
|
| FRONTEND_OCS_PREFIX
| URL path prefix for the OCS service. Note that the string must not start with '/'.
| %%NEXT_PRODUCTION_VERSION%%
|
| FRONTEND_OCS_SHARE_PREFIX
| Path prefix for shares as part of an ocis resource. Note that the path must start with '/'.
| %%NEXT_PRODUCTION_VERSION%%
|
| 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_USERNAME
| The username to use for authentication. Only applies when using the 'nats-js-kv' store type.
| %%NEXT_PRODUCTION_VERSION%%
|
| 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_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_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_TABLE
| The database table the store should use.
| %%NEXT_PRODUCTION_VERSION%%
|
| 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%%
|===

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

@@ -1,7 +1,7 @@
// # Removed Variables between oCIS 5.0.0 and oCIS 7.0.0
// commenting the headline to make it better includable
// table created per 2024.11.07
// table created per 2024.11.26
// the table should be recreated/updated on source () changes
[width="100%",cols="~,~,~,~",options="header"]
@@ -9,35 +9,130 @@
| Service| Variable| Description| Default
| xref:deployment/services/env-vars-special-scope.adoc[Special Scope Envvars]
| 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
| xref:{s-path}/antivirus.adoc[Antivirus]
| ANTIVIRUS_ICAP_TIMEOUT
| Timeout for the ICAP client.
| 0
| xref:{s-path}/eventhistory.adoc[Eventhistory]
| 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
| xref:{s-path}/frontend.adoc[Frontend]
| 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
| xref:{s-path}/gateway.adoc[Gateway]
| 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
| xref:{s-path}/graph.adoc[Graph]
| 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
| xref:{s-path}/ocm.adoc[OCM]
| OCM_OCM_PROVIDER_AUTHORIZER_VERIFY_REQUEST_HOSTNAME
| Verify the hostname of the incoming request against the hostname of the OCM provider.
| false
| xref:{s-path}/postprocessing.adoc[Postprocessing]
| 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
| xref:{s-path}/proxy.adoc[Proxy]
| 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
| xref:{s-path}/settings.adoc[Settings]
| 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
| xref:{s-path}/sharing.adoc[Sharing]
| SHARING_ENABLE_RESHARING
| Changing this value is NOT supported. Enables the support for resharing.
| false
| xref:{s-path}/storage-system.adoc[Storage-System]
| 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
| xref:{s-path}/storage-users.adoc[Storage-Users]
| 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.
@@ -108,10 +203,55 @@
| The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now.
|
| xref:{s-path}/userlog.adoc[Userlog]
| 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
| xref:{s-path}/web.adoc[Web]
| 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
|===