commit a3c4a9d

Merge: 8bfb589 9d7c9d3 Author: Christian Richter <1058116+dragonchaser@users.noreply.github.com> Date: Wed May 4 14:40:05 2022 +0200 Merge pull request #3659 from owncloud/add-adoc-export Adoc export
owncloud · May 4, 2022 · 46696e0 · 46696e0
1 parent 5f728c0
commit 46696e0
Show file tree

Hide file tree

Showing 79 changed files with 4,560 additions and 11 deletions.
diff --git a/extensions/_includes/accounts-config-example.yaml b/extensions/_includes/accounts-config-example.yaml
@@ -1,4 +1,6 @@
 # Autogenerated
+# Filename: accounts-config-example.yaml
+
 tracing:
   enabled: false
   type: ""

diff --git a/extensions/_includes/adoc/.gitkeep b/extensions/_includes/adoc/.gitkeep
diff --git a/extensions/_includes/adoc/accounts_configvars.adoc b/extensions/_includes/adoc/accounts_configvars.adoc
@@ -0,0 +1,144 @@
+[caption=]
+.Environment variables for the accounts extension
+[width="100%",cols="~,~,~,~",options="header"]
+|===
+| Name
+| Type
+| Default Value
+| Description
+| `OCIS_TRACING_ENABLED +
+ACCOUNTS_TRACING_ENABLED`
+| bool
+| false
+| Activates tracing.
+| `OCIS_TRACING_TYPE +
+ACCOUNTS_TRACING_TYPE`
+| string
+| 
+| 
+| `OCIS_TRACING_ENDPOINT +
+ACCOUNTS_TRACING_ENDPOINT`
+| string
+| 
+| The endpoint to the tracing collector.
+| `OCIS_TRACING_COLLECTOR +
+ACCOUNTS_TRACING_COLLECTOR`
+| string
+| 
+| 
+| `OCIS_LOG_LEVEL +
+ACCOUNTS_LOG_LEVEL`
+| string
+| 
+| The log level.
+| `OCIS_LOG_PRETTY +
+ACCOUNTS_LOG_PRETTY`
+| bool
+| false
+| Activates pretty log output.
+| `OCIS_LOG_COLOR +
+ACCOUNTS_LOG_COLOR`
+| bool
+| false
+| Activates colorized log output.
+| `OCIS_LOG_FILE +
+ACCOUNTS_LOG_FILE`
+| string
+| 
+| The target log file.
+| `ACCOUNTS_DEBUG_ADDR`
+| string
+| 127.0.0.1:9182
+| 
+| `ACCOUNTS_DEBUG_TOKEN`
+| string
+| 
+| 
+| `ACCOUNTS_DEBUG_PPROF`
+| bool
+| false
+| 
+| `ACCOUNTS_DEBUG_ZPAGES`
+| bool
+| false
+| 
+| `ACCOUNTS_HTTP_ADDR`
+| string
+| 127.0.0.1:9181
+| The address of the http service.
+| `ACCOUNTS_HTTP_ROOT`
+| string
+| /
+| The root path of the http service.
+| `ACCOUNTS_CACHE_TTL`
+| int
+| 604800
+| The cache time for the static assets.
+| `ACCOUNTS_GRPC_ADDR`
+| string
+| 127.0.0.1:9180
+| The address of the grpc service.
+| `OCIS_JWT_SECRET +
+ACCOUNTS_JWT_SECRET`
+| string
+| 
+| 
+| `ACCOUNTS_ASSET_PATH`
+| string
+| 
+| The path to the ui assets.
+| `ACCOUNTS_STORAGE_BACKEND`
+| string
+| cs3
+| Defines which storage implementation is to be used
+| `ACCOUNTS_STORAGE_DISK_PATH`
+| string
+| ~/.ocis/accounts
+| The path where the accounts data is stored.
+| `ACCOUNTS_STORAGE_CS3_PROVIDER_ADDR`
+| string
+| localhost:9215
+| The address to the storage provider.
+| `ACCOUNTS_UID_INDEX_LOWER_BOUND`
+| int64
+| 0
+| The lowest possible uid value for the indexer.
+| `ACCOUNTS_UID_INDEX_UPPER_BOUND`
+| int64
+| 1000
+| The highest possible uid value for the indexer.
+| `ACCOUNTS_GID_INDEX_LOWER_BOUND`
+| int64
+| 0
+| The lowest possible gid value for the indexer.
+| `ACCOUNTS_GID_INDEX_UPPER_BOUND`
+| int64
+| 1000
+| The highest possible gid value for the indexer.
+| `ACCOUNTS_SERVICE_USER_UUID`
+| string
+| 95cb8724-03b2-11eb-a0a6-c33ef8ef53ad
+| The id of the accounts service user.
+| `ACCOUNTS_SERVICE_USER_USERNAME`
+| string
+| 95cb8724-03b2-11eb-a0a6-c33ef8ef53ad
+| The username of the accounts service user.
+| `ACCOUNTS_SERVICE_USER_UID`
+| int64
+| 0
+| The uid of the accounts service user.
+| `ACCOUNTS_SERVICE_USER_GID`
+| int64
+| 0
+| The gid of the accounts service user.
+| `ACCOUNTS_HASH_DIFFICULTY`
+| int
+| 11
+| The hash difficulty makes sure that validating a password takes at least a certain amount of time.
+| `ACCOUNTS_DEMO_USERS_AND_GROUPS`
+| bool
+| false
+| If this flag is set the service will setup the demo users and groups.
+|===
+
+Since Version: `+` added, `-` deprecated
diff --git a/extensions/_includes/adoc/app-provider_configvars.adoc b/extensions/_includes/adoc/app-provider_configvars.adoc
@@ -0,0 +1,120 @@
+[caption=]
+.Environment variables for the app-provider extension
+[width="100%",cols="~,~,~,~",options="header"]
+|===
+| Name
+| Type
+| Default Value
+| Description
+| `OCIS_TRACING_ENABLED +
+APP_PROVIDER_TRACING_ENABLED`
+| bool
+| false
+| Activates tracing.
+| `OCIS_TRACING_TYPE +
+APP_PROVIDER_TRACING_TYPE`
+| string
+| 
+| 
+| `OCIS_TRACING_ENDPOINT +
+APP_PROVIDER_TRACING_ENDPOINT`
+| string
+| 
+| The endpoint to the tracing collector.
+| `OCIS_TRACING_COLLECTOR +
+APP_PROVIDER_TRACING_COLLECTOR`
+| string
+| 
+| 
+| `OCIS_LOG_LEVEL +
+APP_PROVIDER_LOG_LEVEL`
+| string
+| 
+| The log level.
+| `OCIS_LOG_PRETTY +
+APP_PROVIDER_LOG_PRETTY`
+| bool
+| false
+| Activates pretty log output.
+| `OCIS_LOG_COLOR +
+APP_PROVIDER_LOG_COLOR`
+| bool
+| false
+| Activates colorized log output.
+| `OCIS_LOG_FILE +
+APP_PROVIDER_LOG_FILE`
+| string
+| 
+| The target log file.
+| `APP_PROVIDER_DEBUG_ADDR`
+| string
+| 127.0.0.1:9165
+| 
+| `APP_PROVIDER_DEBUG_TOKEN`
+| string
+| 
+| 
+| `APP_PROVIDER_DEBUG_PPROF`
+| bool
+| false
+| 
+| `APP_PROVIDER_DEBUG_ZPAGES`
+| bool
+| false
+| 
+| `APP_PROVIDER_GRPC_ADDR`
+| string
+| 127.0.0.1:9164
+| The address of the grpc service.
+| `APP_PROVIDER_GRPC_PROTOCOL`
+| string
+| tcp
+| The transport protocol of the grpc service.
+| `OCIS_JWT_SECRET +
+APP_PROVIDER_JWT_SECRET`
+| string
+| 
+| 
+| `REVA_GATEWAY`
+| string
+| 127.0.0.1:9142
+| 
+| `APP_PROVIDER_WOPI_APP_API_KEY`
+| string
+| 
+| api key for the wopi app
+| `APP_PROVIDER_WOPI_APP_DESKTOP_ONLY`
+| bool
+| false
+| offer this app only on desktop
+| `APP_PROVIDER_WOPI_APP_ICON_URI`
+| string
+| 
+| uri to an app icon to be used by clients
+| `APP_PROVIDER_WOPI_APP_INTERNAL_URL`
+| string
+| 
+| internal url to the app, eg in your DMZ
+| `APP_PROVIDER_WOPI_APP_NAME`
+| string
+| 
+| human readable app name
+| `APP_PROVIDER_WOPI_APP_URL`
+| string
+| 
+| url for end users to access the app
+| `APP_PROVIDER_WOPI_INSECURE`
+| bool
+| false
+| allow insecure connections to the app
+| `APP_PROVIDER_WOPI_WOPI_SERVER_IOP_SECRET`
+| string
+| 
+| shared secret of the CS3org WOPI server
+| `APP_PROVIDER_WOPI_WOPI_SERVER_EXTERNAL_URL`
+| string
+| 
+| external url of the CS3org WOPI server
+|===
+
+Since Version: `+` added, `-` deprecated
diff --git a/extensions/_includes/adoc/app-registry_configvars.adoc b/extensions/_includes/adoc/app-registry_configvars.adoc
@@ -0,0 +1,84 @@
+[caption=]
+.Environment variables for the app-registry extension
+[width="100%",cols="~,~,~,~",options="header"]
+|===
+| Name
+| Type
+| Default Value
+| Description
+| `OCIS_TRACING_ENABLED +
+APP_REGISTRY_TRACING_ENABLED`
+| bool
+| false
+| Activates tracing.
+| `OCIS_TRACING_TYPE +
+APP_REGISTRY_TRACING_TYPE`
+| string
+| 
+| 
+| `OCIS_TRACING_ENDPOINT +
+APP_REGISTRY_TRACING_ENDPOINT`
+| string
+| 
+| The endpoint to the tracing collector.
+| `OCIS_TRACING_COLLECTOR +
+APP_REGISTRY_TRACING_COLLECTOR`
+| string
+| 
+| 
+| `OCIS_LOG_LEVEL +
+APP_REGISTRY_LOG_LEVEL`
+| string
+| 
+| The log level.
+| `OCIS_LOG_PRETTY +
+APP_REGISTRY_LOG_PRETTY`
+| bool
+| false
+| Activates pretty log output.
+| `OCIS_LOG_COLOR +
+APP_REGISTRY_LOG_COLOR`
+| bool
+| false
+| Activates colorized log output.
+| `OCIS_LOG_FILE +
+APP_REGISTRY_LOG_FILE`
+| string
+| 
+| The target log file.
+| `APP_REGISTRY_DEBUG_ADDR`
+| string
+| 127.0.0.1:9243
+| 
+| `APP_REGISTRY_DEBUG_TOKEN`
+| string
+| 
+| 
+| `APP_REGISTRY_DEBUG_PPROF`
+| bool
+| false
+| 
+| `APP_REGISTRY_DEBUG_ZPAGES`
+| bool
+| false
+| 
+| `APP_REGISTRY_GRPC_ADDR`
+| string
+| 127.0.0.1:9242
+| The address of the grpc service.
+| `APP_REGISTRY_GRPC_PROTOCOL`
+| string
+| tcp
+| The transport protocol of the grpc service.
+| `OCIS_JWT_SECRET +
+APP_REGISTRY_JWT_SECRET`
+| string
+| 
+| 
+| `REVA_GATEWAY`
+| string
+| 127.0.0.1:9142
+| 
+|===
+
+Since Version: `+` added, `-` deprecated