From faee7bd9c0c185df0b7498451d388b97ba246203 Mon Sep 17 00:00:00 2001 From: Willy Kloucek <34452982+wkloucek@users.noreply.github.com> Date: Tue, 12 Oct 2021 08:11:08 +0000 Subject: [PATCH] commit 1a8faffd3f0bca0b55c793993fbd6593132fce27 Merge: f75c781c 121e1337 Author: Willy Kloucek <34452982+wkloucek@users.noreply.github.com> Date: Tue Oct 12 10:07:03 2021 +0200 Merge pull request #2603 from gmgigi96/appregistry-config [full-ci] Updated MimeTypes configuration for AppRegistry --- extensions/accounts/configuration.md | 322 ++++---- extensions/glauth/configuration.md | 2 +- extensions/graph-explorer/configuration.md | 2 +- extensions/graph/configuration.md | 2 +- extensions/idp/configuration.md | 142 ++-- extensions/ocs/configuration.md | 70 +- extensions/proxy/configuration.md | 102 +-- extensions/settings/configuration.md | 2 +- extensions/storage/configuration.md | 878 ++++++++++----------- extensions/store/configuration.md | 110 +-- extensions/thumbnails/configuration.md | 2 +- extensions/web/configuration.md | 2 +- extensions/webdav/configuration.md | 68 +- ocis/configuration.md | 100 +-- 14 files changed, 902 insertions(+), 902 deletions(-) diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 330047fcb68..627618a50a7 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-11T15:11:16+0000" +date: "2021-10-12T08:07:52+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -35,11 +35,11 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### accounts list +### accounts inspect -List existing accounts +Show detailed data on an existing account -Usage: `accounts list [command options] [arguments...]` +Usage: `accounts inspect [command options] [arguments...]` @@ -106,16 +106,16 @@ Usage: `accounts list [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. ### accounts ocis-accounts @@ -205,93 +205,148 @@ Usage: `accounts ocis-accounts [command options] [arguments...]` -### accounts version +### accounts server -Print the versions of the running instances +Start ocis accounts service -Usage: `accounts version [command options] [arguments...]` +Usage: `accounts server [command options] [arguments...]` +-log-file | $ACCOUNTS_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. +-tracing-enabled | $ACCOUNTS_TRACING_ENABLED , $OCIS_TRACING_ENABLED +: Enable sending traces. +-tracing-type | $ACCOUNTS_TRACING_TYPE , $OCIS_TRACING_TYPE +: Tracing backend type. Default: `"jaeger"`. +-tracing-endpoint | $ACCOUNTS_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. +-tracing-collector | $ACCOUNTS_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR +: Endpoint for the collector. Default: `""`. +-tracing-service | $ACCOUNTS_TRACING_SERVICE +: Service name for tracing. Default: `"accounts"`. +-http-namespace | $ACCOUNTS_HTTP_NAMESPACE +: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. +-http-addr | $ACCOUNTS_HTTP_ADDR +: Address to bind http server. Default: `"0.0.0.0:9181"`. +-http-root | $ACCOUNTS_HTTP_ROOT +: Root path of http server. Default: `"/"`. +-http-cache-ttl | $ACCOUNTS_CACHE_TTL +: Set the static assets caching duration in seconds. Default: `604800`. +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-grpc-addr | $ACCOUNTS_GRPC_ADDR +: Address to bind grpc server. Default: `"0.0.0.0:9180"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +-accounts-hash-difficulty | $ACCOUNTS_HASH_DIFFICULTY +: accounts password hash difficulty. Default: `11`. +-demo-users-and-groups | $ACCOUNTS_DEMO_USERS_AND_GROUPS +: Enable demo users and groups. Default: `true`. +-asset-path | $ACCOUNTS_ASSET_PATH +: Path to custom assets. Default: `""`. +-jwt-secret | $ACCOUNTS_JWT_SECRET , $OCIS_JWT_SECRET +: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. +-storage-disk-path | $ACCOUNTS_STORAGE_DISK_PATH +: Path on the local disk, e.g. /var/tmp/ocis/accounts. Default: `""`. +-storage-cs3-provider-addr | $ACCOUNTS_STORAGE_CS3_PROVIDER_ADDR +: bind address for the metadata storage provider. Default: `"localhost:9215"`. +-storage-cs3-data-url | $ACCOUNTS_STORAGE_CS3_DATA_URL +: http endpoint of the metadata storage. Default: `"http://localhost:9216"`. +-storage-cs3-data-prefix | $ACCOUNTS_STORAGE_CS3_DATA_PREFIX +: path prefix for the http endpoint of the metadata storage, without leading slash. Default: `"data"`. +-storage-cs3-jwt-secret | $ACCOUNTS_STORAGE_CS3_JWT_SECRET , $OCIS_JWT_SECRET +: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. +-service-user-uuid | $ACCOUNTS_SERVICE_USER_UUID +: uuid of the internal service user (required on EOS). Default: `"95cb8724-03b2-11eb-a0a6-c33ef8ef53ad"`. +-service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME +: username of the internal service user (required on EOS). Default: `""`. +-service-user-uid | $ACCOUNTS_SERVICE_USER_UID +: uid of the internal service user (required on EOS). Default: `0`. +-service-user-gid | $ACCOUNTS_SERVICE_USER_GID +: gid of the internal service user (required on EOS). Default: `0`. +-uid-index-lower-bound | $ACCOUNTS_UID_INDEX_LOWER_BOUND +: define a starting point for the account UID. Default: `0`. +-gid-index-lower-bound | $ACCOUNTS_GID_INDEX_LOWER_BOUND +: define a starting point for the account GID. Default: `1000`. +-uid-index-upper-bound | $ACCOUNTS_UID_INDEX_UPPER_BOUND +: define an ending point for the account UID. Default: `0`. +-gid-index-upper-bound | $ACCOUNTS_GID_INDEX_UPPER_BOUND +: define an ending point for the account GID. Default: `1000`. --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-extensions | +: Run specific extensions during supervised mode. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. -### accounts add -Create a new account -Usage: `accounts add [command options] [arguments...]` @@ -319,8 +374,11 @@ Usage: `accounts add [command options] [arguments...]` +### accounts remove +Removes an existing account +Usage: `accounts remove [command options] [arguments...]` @@ -343,64 +401,34 @@ Usage: `accounts add [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. --enabled | -: Enable the account. --displayname | -: Set the displayname for the account. --username | -: Username will be written to preferred-name and on_premises_sam_account_name. --preferred-name | -: Set the preferred-name for the account. --on-premises-sam-account-name | -: Set the on-premises-sam-account-name. --uidnumber | -: Set the uidnumber for the account. --gidnumber | -: Set the gidnumber for the account. --mail | -: Set the mail for the account. --description | -: Set the description for the account. --password | -: Set the password for the account. --password-policies | -: Possible policies: DisableStrongPassword, DisablePasswordExpiration. --force-password-change | -: Force password change on next sign-in. --force-password-change-mfa | -: Force password change on next sign-in with mfa. @@ -408,11 +436,8 @@ Usage: `accounts add [command options] [arguments...]` -### accounts inspect -Show detailed data on an existing account -Usage: `accounts inspect [command options] [arguments...]` @@ -422,13 +447,20 @@ Usage: `accounts inspect [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +### accounts update +Make changes to an existing account +Usage: `accounts update [command options] [arguments...]` @@ -466,39 +498,60 @@ Usage: `accounts inspect [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +-enabled | +: Enable the account. +-displayname | +: Set the displayname for the account. +-preferred-name | +: Set the preferred-name for the account. +-on-premises-sam-account-name | +: Set the on-premises-sam-account-name. +-uidnumber | +: Set the uidnumber for the account. +-gidnumber | +: Set the gidnumber for the account. +-mail | +: Set the mail for the account. --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-description | +: Set the description for the account. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. -### accounts rebuildIndex +-password | +: Set the password for the account. -Rebuilds the service's index, i.e. deleting and then re-adding all existing documents -Usage: `accounts rebuildIndex [command options] [arguments...]` +-password-policies | +: Possible policies: DisableStrongPassword, DisablePasswordExpiration. +-force-password-change | +: Force password change on next sign-in. +-force-password-change-mfa | +: Force password change on next sign-in with mfa. @@ -521,8 +574,11 @@ Usage: `accounts rebuildIndex [command options] [arguments...]` +### accounts version +Print the versions of the running instances +Usage: `accounts version [command options] [arguments...]` @@ -566,11 +622,8 @@ Usage: `accounts rebuildIndex [command options] [arguments...]` -### accounts remove -Removes an existing account -Usage: `accounts remove [command options] [arguments...]` @@ -592,15 +645,22 @@ Usage: `accounts remove [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +### accounts add +Create a new account +Usage: `accounts add [command options] [arguments...]` @@ -639,148 +699,112 @@ Usage: `accounts remove [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. -### accounts server -Start ocis accounts service -Usage: `accounts server [command options] [arguments...]` --log-file | $ACCOUNTS_LOG_FILE , $OCIS_LOG_FILE -: Enable log to file. +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --tracing-enabled | $ACCOUNTS_TRACING_ENABLED , $OCIS_TRACING_ENABLED -: Enable sending traces. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. --tracing-type | $ACCOUNTS_TRACING_TYPE , $OCIS_TRACING_TYPE -: Tracing backend type. Default: `"jaeger"`. +-enabled | +: Enable the account. --tracing-endpoint | $ACCOUNTS_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. +-displayname | +: Set the displayname for the account. --tracing-collector | $ACCOUNTS_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `""`. +-username | +: Username will be written to preferred-name and on_premises_sam_account_name. --tracing-service | $ACCOUNTS_TRACING_SERVICE -: Service name for tracing. Default: `"accounts"`. +-preferred-name | +: Set the preferred-name for the account. --http-namespace | $ACCOUNTS_HTTP_NAMESPACE -: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. +-on-premises-sam-account-name | +: Set the on-premises-sam-account-name. --http-addr | $ACCOUNTS_HTTP_ADDR -: Address to bind http server. Default: `"0.0.0.0:9181"`. +-uidnumber | +: Set the uidnumber for the account. --http-root | $ACCOUNTS_HTTP_ROOT -: Root path of http server. Default: `"/"`. +-gidnumber | +: Set the gidnumber for the account. --http-cache-ttl | $ACCOUNTS_CACHE_TTL -: Set the static assets caching duration in seconds. Default: `604800`. +-mail | +: Set the mail for the account. --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-description | +: Set the description for the account. --grpc-addr | $ACCOUNTS_GRPC_ADDR -: Address to bind grpc server. Default: `"0.0.0.0:9180"`. +-password | +: Set the password for the account. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. +-password-policies | +: Possible policies: DisableStrongPassword, DisablePasswordExpiration. --accounts-hash-difficulty | $ACCOUNTS_HASH_DIFFICULTY -: accounts password hash difficulty. Default: `11`. +-force-password-change | +: Force password change on next sign-in. --demo-users-and-groups | $ACCOUNTS_DEMO_USERS_AND_GROUPS -: Enable demo users and groups. Default: `true`. +-force-password-change-mfa | +: Force password change on next sign-in with mfa. --asset-path | $ACCOUNTS_ASSET_PATH -: Path to custom assets. Default: `""`. --jwt-secret | $ACCOUNTS_JWT_SECRET , $OCIS_JWT_SECRET -: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. --storage-disk-path | $ACCOUNTS_STORAGE_DISK_PATH -: Path on the local disk, e.g. /var/tmp/ocis/accounts. Default: `""`. +### accounts list --storage-cs3-provider-addr | $ACCOUNTS_STORAGE_CS3_PROVIDER_ADDR -: bind address for the metadata storage provider. Default: `"localhost:9215"`. +List existing accounts +Usage: `accounts list [command options] [arguments...]` --storage-cs3-data-url | $ACCOUNTS_STORAGE_CS3_DATA_URL -: http endpoint of the metadata storage. Default: `"http://localhost:9216"`. --storage-cs3-data-prefix | $ACCOUNTS_STORAGE_CS3_DATA_PREFIX -: path prefix for the http endpoint of the metadata storage, without leading slash. Default: `"data"`. --storage-cs3-jwt-secret | $ACCOUNTS_STORAGE_CS3_JWT_SECRET , $OCIS_JWT_SECRET -: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. --service-user-uuid | $ACCOUNTS_SERVICE_USER_UUID -: uuid of the internal service user (required on EOS). Default: `"95cb8724-03b2-11eb-a0a6-c33ef8ef53ad"`. --service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME -: username of the internal service user (required on EOS). Default: `""`. --service-user-uid | $ACCOUNTS_SERVICE_USER_UID -: uid of the internal service user (required on EOS). Default: `0`. --service-user-gid | $ACCOUNTS_SERVICE_USER_GID -: gid of the internal service user (required on EOS). Default: `0`. --uid-index-lower-bound | $ACCOUNTS_UID_INDEX_LOWER_BOUND -: define a starting point for the account UID. Default: `0`. --gid-index-lower-bound | $ACCOUNTS_GID_INDEX_LOWER_BOUND -: define a starting point for the account GID. Default: `1000`. --uid-index-upper-bound | $ACCOUNTS_UID_INDEX_UPPER_BOUND -: define an ending point for the account UID. Default: `0`. --gid-index-upper-bound | $ACCOUNTS_GID_INDEX_UPPER_BOUND -: define an ending point for the account GID. Default: `1000`. --extensions | -: Run specific extensions during supervised mode. @@ -817,25 +841,29 @@ Usage: `accounts server [command options] [arguments...]` -### accounts update -Make changes to an existing account -Usage: `accounts update [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +### accounts rebuildIndex +Rebuilds the service's index, i.e. deleting and then re-adding all existing documents +Usage: `accounts rebuildIndex [command options] [arguments...]` @@ -859,60 +887,32 @@ Usage: `accounts update [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. --enabled | -: Enable the account. --displayname | -: Set the displayname for the account. --preferred-name | -: Set the preferred-name for the account. --on-premises-sam-account-name | -: Set the on-premises-sam-account-name. --uidnumber | -: Set the uidnumber for the account. --gidnumber | -: Set the gidnumber for the account. --mail | -: Set the mail for the account. --description | -: Set the description for the account. --password | -: Set the password for the account. --password-policies | -: Possible policies: DisableStrongPassword, DisablePasswordExpiration. --force-password-change | -: Force password change on next sign-in. --force-password-change-mfa | -: Force password change on next sign-in with mfa. diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index 0bb84f33f73..f8405d9c458 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-11T15:12:01+0000" +date: "2021-10-12T08:08:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/glauth/templates diff --git a/extensions/graph-explorer/configuration.md b/extensions/graph-explorer/configuration.md index e237aac8b68..b02beacde93 100644 --- a/extensions/graph-explorer/configuration.md +++ b/extensions/graph-explorer/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-11T15:12:01+0000" +date: "2021-10-12T08:08:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph-explorer/templates diff --git a/extensions/graph/configuration.md b/extensions/graph/configuration.md index 9e88b465a82..382f13c58ba 100644 --- a/extensions/graph/configuration.md +++ b/extensions/graph/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-11T15:12:01+0000" +date: "2021-10-12T08:08:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph/templates diff --git a/extensions/idp/configuration.md b/extensions/idp/configuration.md index 70d731ada31..d7852565529 100644 --- a/extensions/idp/configuration.md +++ b/extensions/idp/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-11T15:12:01+0000" +date: "2021-10-12T08:08:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/idp/templates @@ -34,76 +34,6 @@ If multiple variables are listed for one option, they are in order of precedence ### Command-line flags If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -### idp health - -Check health status - -Usage: `idp health [command options] [arguments...]` - - - - - --debug-addr | $IDP_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9134"`. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ### idp ocis-idp @@ -485,4 +415,74 @@ Usage: `idp version [command options] [arguments...]` -name | $IDP_NAME : Service name. Default: `"idp"`. + +### idp health + +Check health status + +Usage: `idp health [command options] [arguments...]` + + + + + +-debug-addr | $IDP_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9134"`. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index 36e05c0af5c..ac7f597d010 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-11T15:12:01+0000" +date: "2021-10-12T08:08:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/templates @@ -34,40 +34,6 @@ If multiple variables are listed for one option, they are in order of precedence ### Command-line flags If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -### ocs ocis-ocs - -Serve OCS API for oCIS - -Usage: `ocs ocis-ocs [command options] [arguments...]` - - - - - - - - - - - - - - - - - - - - - - - - - - - - ### ocs server @@ -246,6 +212,40 @@ Usage: `ocs health [command options] [arguments...]` + + + + + + + + + +### ocs ocis-ocs + +Serve OCS API for oCIS + +Usage: `ocs ocis-ocs [command options] [arguments...]` + + + + + + + + + + + + + + + + + + + + diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index d861257aa36..54f0843c55d 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-11T15:12:01+0000" +date: "2021-10-12T08:08:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/proxy/templates @@ -34,6 +34,56 @@ If multiple variables are listed for one option, they are in order of precedence ### Command-line flags If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. + +### proxy health + +Check health status + +Usage: `proxy health [command options] [arguments...]` + + + + + + +-debug-addr | $PROXY_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9109"`. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ### proxy ocis-proxy @@ -307,54 +357,4 @@ Usage: `proxy version [command options] [arguments...]` -service-name | $PROXY_SERVICE_NAME : Service name. Default: `"proxy"`. - -### proxy health - -Check health status - -Usage: `proxy health [command options] [arguments...]` - - - - - - --debug-addr | $PROXY_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9109"`. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/extensions/settings/configuration.md b/extensions/settings/configuration.md index d982e8c8c32..f15aef5b9d4 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-11T15:12:01+0000" +date: "2021-10-12T08:08:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/settings/templates diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index 9eb3e061e30..c87c567204b 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-11T15:12:02+0000" +date: "2021-10-12T08:08:52+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -110,12 +110,20 @@ Usage: `storage [global options] command [command options] [arguments...]` +-config-file | $STORAGE_CONFIG_FILE +: Path to config file. +-log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. @@ -257,20 +265,12 @@ Usage: `storage [global options] command [command options] [arguments...]` --config-file | $STORAGE_CONFIG_FILE -: Path to config file. --log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. --log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. @@ -296,11 +296,11 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage storage-metadata +### storage storage-users -Start storage-metadata service +Start storage-users service -Usage: `storage storage-metadata [command options] [arguments...]` +Usage: `storage storage-users [command options] [arguments...]` @@ -318,44 +318,24 @@ Usage: `storage storage-metadata [command options] [arguments...]` --debug-addr | $STORAGE_METADATA_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9217"`. --grpc-network | $STORAGE_METADATA_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9215"`. --data-server-url | $STORAGE_METADATA_DATA_SERVER_URL -: URL of the data-provider the storage-provider uses. Default: `"http://localhost:9216"`. --http-network | $STORAGE_METADATA_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --http-addr | $STORAGE_METADATA_HTTP_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9216"`. --tmp-folder | $STORAGE_METADATA_TMP_FOLDER -: path to tmp folder. Default: `"/var/tmp/ocis/tmp/metadata"`. --driver | $STORAGE_METADATA_DRIVER -: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider service. Default: `"localhost:9144"`. @@ -530,42 +510,64 @@ Usage: `storage storage-metadata [command options] [arguments...]` +-debug-addr | $STORAGE_USERS_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9159"`. +-grpc-network | $STORAGE_USERS_GRPC_NETWORK +: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-grpc-addr | $STORAGE_USERS_GRPC_ADDR +: GRPC Address to bind users storage. Default: `"0.0.0.0:9157"`. +-http-network | $STORAGE_USERS_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-http-addr | $STORAGE_USERS_HTTP_ADDR +: HTTP Address to bind users storage. Default: `"0.0.0.0:9158"`. +-driver | $STORAGE_USERS_DRIVER +: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. +-read-only | $STORAGE_USERS_READ_ONLY , $OCIS_STORAGE_READ_ONLY +: use storage driver in read-only mode. Default: `false`. +-mount-path | $STORAGE_USERS_MOUNT_PATH +: mount path. Default: `"/users"`. +-mount-id | $STORAGE_USERS_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. --config-file | $STORAGE_CONFIG_FILE -: Path to config file. +-expose-data-server | $STORAGE_USERS_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. --log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. +-data-server-url | $STORAGE_USERS_DATA_SERVER_URL +: data server url. Default: `"http://localhost:9158/data"`. --log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. +-http-prefix | $STORAGE_USERS_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `"data"`. --log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. +-tmp-folder | $STORAGE_USERS_TMP_FOLDER +: path to tmp folder. Default: `"/var/tmp/ocis/tmp/users"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9144"`. @@ -585,12 +587,12 @@ Usage: `storage storage-metadata [command options] [arguments...]` -### storage frontend -Start frontend service +### storage users -Usage: `storage frontend [command options] [arguments...]` +Start users service +Usage: `storage users [command options] [arguments...]` @@ -645,124 +647,64 @@ Usage: `storage frontend [command options] [arguments...]` --debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9141"`. --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. --webdav-namespace | $STORAGE_WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `"/home/"`. --dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `"/users/"`. --archiver-max-num-files | $STORAGE_ARCHIVER_MAX_NUM_FILES -: Maximum number of files to be included in the archiver. Default: `10000`. --archiver-max-size | $STORAGE_ARCHIVER_MAX_SIZE -: Maximum size for the sum of the sizes of all the files included in the archive. Default: `1073741824`. --network | $STORAGE_FRONTEND_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_FRONTEND_HTTP_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9140"`. --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `"https://localhost:9200"`. --service | $STORAGE_FRONTEND_SERVICES -: --service ocdav [--service ocs]. Default: `cli.NewStringSlice("datagateway", "ocdav", "ocs", "appprovider")`. --approvider-prefix | $STORAGE_FRONTEND_APPPROVIDER_PREFIX -: approvider prefix. Default: `""`. --archiver-prefix | $STORAGE_FRONTEND_ARCHIVER_PREFIX -: archiver prefix. Default: `"archiver"`. --datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `"data"`. --favorites | $STORAGE_FRONTEND_FAVORITES -: announces favorites support to clients. Default: `false`. --ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. Default: `""`. --ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX -: open collaboration services endpoint prefix. Default: `"ocs"`. --ocs-share-prefix | $STORAGE_FRONTEND_OCS_SHARE_PREFIX -: the prefix prepended to the path of shared files. Default: `"/Shares"`. --ocs-home-namespace | $STORAGE_FRONTEND_OCS_HOME_NAMESPACE -: the prefix prepended to the incoming requests in OCS. Default: `"/home"`. --ocs-resource-info-cache-ttl | $STORAGE_FRONTEND_OCS_RESOURCE_INFO_CACHE_TTL -: the TTL for statted resources in the share cache. Default: `0`. --ocs-cache-warmup-driver | $STORAGE_FRONTEND_OCS_CACHE_WARMUP_DRIVER -: the driver to be used for warming up the share cache. Default: `""`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --default-upload-protocol | $STORAGE_FRONTEND_DEFAULT_UPLOAD_PROTOCOL -: Default upload chunking protocol to be used out of tus/v1/ng. Default: `"tus"`. --upload-max-chunk-size | $STORAGE_FRONTEND_UPLOAD_MAX_CHUNK_SIZE -: Max chunk size in bytes to advertise to clients through capabilities, or 0 for unlimited. Default: `0`. --upload-http-method-override | $STORAGE_FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE -: Specify an HTTP method (ex: POST) that clients should to use when uploading instead of PATCH. Default: `""`. --checksum-supported-type | $STORAGE_FRONTEND_CHECKSUM_SUPPORTED_TYPES -: --checksum-supported-type sha1 [--checksum-supported-type adler32]. Default: `cli.NewStringSlice("sha1", "md5", "adler32")`. --checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE -: Specify the preferred checksum algorithm used for uploads. Default: `""`. --archiver-url | $STORAGE_FRONTEND_ARCHIVER_URL -: URL where the archiver is reachable. Default: `"/archiver"`. --appprovider-apps-url | $STORAGE_FRONTEND_APP_PROVIDER_APPS_URL -: URL where the app listing of the app provider is reachable. Default: `"/app/list"`. --appprovider-open-url | $STORAGE_FRONTEND_APP_PROVIDER_OPEN_URL -: URL where files can be handed over to an application from the app provider. Default: `"/app/open"`. --user-agent-whitelist-lock-in | $STORAGE_FRONTEND_MIDDLEWARE_AUTH_CREDENTIALS_BY_USER_AGENT -: --user-agent-whitelist-lock-in=mirall:basic,foo:bearer Given a tuple of comma separated [UserAgent:challenge] values, it locks a given user agent to the authentication challenge. Particularly useful for old clients whose USer-Agent is known and only support one authentication challenge. When this flag is set in the storage-frontend it configures Reva.. @@ -875,118 +817,140 @@ Usage: `storage frontend [command options] [arguments...]` +-debug-addr | $STORAGE_USERPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9145"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-network | $STORAGE_USERPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_USERPROVIDER_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9144"`. +-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `"localhost:9144"`. +-service | $STORAGE_USERPROVIDER_SERVICES +: --service userprovider [--service otherservice]. Default: `cli.NewStringSlice("userprovider")`. +-driver | $STORAGE_USERPROVIDER_DRIVER +: user driver: 'demo', 'json', 'ldap', 'owncloudsql' or 'rest'. Default: `"ldap"`. +-json-config | $STORAGE_USERPROVIDER_JSON +: Path to users.json file. Default: `""`. +-user-groups-cache-expiration | $STORAGE_USER_CACHE_EXPIRATION +: Time in minutes for redis cache expiration.. Default: `5`. +-owncloudsql-dbhost | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBHOST +: hostname of the mysql db. Default: `"mysql"`. +-owncloudsql-dbport | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBPORT +: port of the mysql db. Default: `3306`. +-owncloudsql-dbname | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBNAME +: database name of the owncloud db. Default: `"owncloud"`. +-owncloudsql-dbuser | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBUSER +: user name to use when connecting to the mysql owncloud db. Default: `"owncloud"`. +-owncloudsql-dbpass | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBPASS +: password to use when connecting to the mysql owncloud db. Default: `"secret"`. +-owncloudsql-idp | $STORAGE_USERPROVIDER_OWNCLOUDSQL_IDP , $OCIS_URL +: Identity provider to use for users. Default: `"https://localhost:9200"`. +-owncloudsql-nobody | $STORAGE_USERPROVIDER_OWNCLOUDSQL_NOBODY +: fallback user id to use when user has no id. Default: `99`. +-owncloudsql-join-username | $STORAGE_USERPROVIDER_OWNCLOUDSQL_JOIN_USERNAME +: join the username from the oc_preferences table. Default: `false`. +-owncloudsql-join-ownclouduuid | $STORAGE_USERPROVIDER_OWNCLOUDSQL_JOIN_OWNCLOUDUUID +: join the ownclouduuid from the oc_preferences table. Default: `false`. +-owncloudsql-enable-medial-search | $STORAGE_USERPROVIDER_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH +: enable medial search when finding users. Default: `false`. +### storage auth-basic +Start authprovider for basic auth +Usage: `storage auth-basic [command options] [arguments...]` +-debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9147"`. +-auth-driver | $STORAGE_AUTH_DRIVER +: auth driver: 'demo', 'json' or 'ldap'. Default: `"ldap"`. +-auth-json | $STORAGE_AUTH_JSON +: Path to users.json file. Default: `""`. -### storage storage-home +-network | $STORAGE_AUTH_BASIC_GRPC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. -Start storage-home service -Usage: `storage storage-home [command options] [arguments...]` +-addr | $STORAGE_AUTH_BASIC_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9146"`. --debug-addr | $STORAGE_HOME_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9156"`. +-service | $STORAGE_AUTH_BASIC_SERVICES +: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. --grpc-network | $STORAGE_HOME_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --grpc-addr | $STORAGE_HOME_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9154"`. --http-network | $STORAGE_HOME_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --http-addr | $STORAGE_HOME_HTTP_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9155"`. --driver | $STORAGE_HOME_DRIVER -: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. --read-only | $STORAGE_HOME_READ_ONLY , $OCIS_STORAGE_READ_ONLY -: use storage driver in read-only mode. Default: `false`. --mount-path | $STORAGE_HOME_MOUNT_PATH -: mount path. Default: `"/home"`. --mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. --expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. --data-server-url | $STORAGE_HOME_DATA_SERVER_URL -: data server url. Default: `"http://localhost:9155/data"`. --http-prefix | $STORAGE_HOME_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `"data"`. --tmp-folder | $STORAGE_HOME_TMP_FOLDER -: path to tmp folder. Default: `"/var/tmp/ocis/tmp/home"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9144"`. @@ -1196,8 +1160,11 @@ Usage: `storage storage-home [command options] [arguments...]` +### storage frontend +Start frontend service +Usage: `storage frontend [command options] [arguments...]` @@ -1210,67 +1177,124 @@ Usage: `storage storage-home [command options] [arguments...]` +-debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9141"`. +-transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. -### storage gateway +-webdav-namespace | $STORAGE_WEBDAV_NAMESPACE +: Namespace prefix for the /webdav endpoint. Default: `"/home/"`. -Start gateway -Usage: `storage gateway [command options] [arguments...]` +-dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE +: Namespace prefix for the webdav /dav/files endpoint. Default: `"/users/"`. +-archiver-max-num-files | $STORAGE_ARCHIVER_MAX_NUM_FILES +: Maximum number of files to be included in the archiver. Default: `10000`. +-archiver-max-size | $STORAGE_ARCHIVER_MAX_SIZE +: Maximum size for the sum of the sizes of all the files included in the archive. Default: `1073741824`. +-network | $STORAGE_FRONTEND_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_FRONTEND_HTTP_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9140"`. +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `"https://localhost:9200"`. +-service | $STORAGE_FRONTEND_SERVICES +: --service ocdav [--service ocs]. Default: `cli.NewStringSlice("datagateway", "ocdav", "ocs", "appprovider")`. +-approvider-prefix | $STORAGE_FRONTEND_APPPROVIDER_PREFIX +: approvider prefix. Default: `""`. +-archiver-prefix | $STORAGE_FRONTEND_ARCHIVER_PREFIX +: archiver prefix. Default: `"archiver"`. +-datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX +: datagateway prefix. Default: `"data"`. +-favorites | $STORAGE_FRONTEND_FAVORITES +: announces favorites support to clients. Default: `false`. +-ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX +: owncloud webdav endpoint prefix. Default: `""`. +-ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX +: open collaboration services endpoint prefix. Default: `"ocs"`. +-ocs-share-prefix | $STORAGE_FRONTEND_OCS_SHARE_PREFIX +: the prefix prepended to the path of shared files. Default: `"/Shares"`. +-ocs-home-namespace | $STORAGE_FRONTEND_OCS_HOME_NAMESPACE +: the prefix prepended to the incoming requests in OCS. Default: `"/home"`. +-ocs-resource-info-cache-ttl | $STORAGE_FRONTEND_OCS_RESOURCE_INFO_CACHE_TTL +: the TTL for statted resources in the share cache. Default: `0`. +-ocs-cache-warmup-driver | $STORAGE_FRONTEND_OCS_CACHE_WARMUP_DRIVER +: the driver to be used for warming up the share cache. Default: `""`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-default-upload-protocol | $STORAGE_FRONTEND_DEFAULT_UPLOAD_PROTOCOL +: Default upload chunking protocol to be used out of tus/v1/ng. Default: `"tus"`. +-upload-max-chunk-size | $STORAGE_FRONTEND_UPLOAD_MAX_CHUNK_SIZE +: Max chunk size in bytes to advertise to clients through capabilities, or 0 for unlimited. Default: `0`. +-upload-http-method-override | $STORAGE_FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE +: Specify an HTTP method (ex: POST) that clients should to use when uploading instead of PATCH. Default: `""`. +-checksum-supported-type | $STORAGE_FRONTEND_CHECKSUM_SUPPORTED_TYPES +: --checksum-supported-type sha1 [--checksum-supported-type adler32]. Default: `cli.NewStringSlice("sha1", "md5", "adler32")`. +-checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE +: Specify the preferred checksum algorithm used for uploads. Default: `""`. +-archiver-url | $STORAGE_FRONTEND_ARCHIVER_URL +: URL where the archiver is reachable. Default: `"/archiver"`. +-appprovider-apps-url | $STORAGE_FRONTEND_APP_PROVIDER_APPS_URL +: URL where the app listing of the app provider is reachable. Default: `"/app/list"`. +-appprovider-open-url | $STORAGE_FRONTEND_APP_PROVIDER_OPEN_URL +: URL where files can be handed over to an application from the app provider. Default: `"/app/open"`. +-user-agent-whitelist-lock-in | $STORAGE_FRONTEND_MIDDLEWARE_AUTH_CREDENTIALS_BY_USER_AGENT +: --user-agent-whitelist-lock-in=mirall:basic,foo:bearer Given a tuple of comma separated [UserAgent:challenge] values, it locks a given user agent to the authentication challenge. Particularly useful for old clients whose USer-Agent is known and only support one authentication challenge. When this flag is set in the storage-frontend it configures Reva.. @@ -1339,144 +1363,74 @@ Usage: `storage gateway [command options] [arguments...]` --debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9143"`. --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. --transfer-expires | $STORAGE_TRANSFER_EXPIRES -: Transfer token ttl in seconds. Default: `24 * 60 * 60`. --network | $STORAGE_GATEWAY_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_GATEWAY_GRPC_ADDR -: Address to bind REVA service. Default: `"0.0.0.0:9142"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --service | $STORAGE_GATEWAY_SERVICES -: --service gateway [--service authregistry]. Default: `cli.NewStringSlice("gateway", "authregistry", "storageregistry", "appregistry")`. --commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT -: Commit shares to the share manager. Default: `true`. --commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF -: Commit shares to the storage. Default: `true`. --share-folder | $STORAGE_GATEWAY_SHARE_FOLDER -: mount shares in this folder of the home storage provider. Default: `"Shares"`. --disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN -: Disable creation of home folder on login. --storage-home-mapping | $STORAGE_GATEWAY_HOME_MAPPING -: mapping template for user home paths to user-specific mount points, e.g. /home/{{substr 0 1 .Username}}. Default: `""`. --etag-cache-ttl | $STORAGE_GATEWAY_ETAG_CACHE_TTL -: TTL for the home and shares directory etags cache. Default: `0`. --auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT -: endpoint to use for the basic auth provider. Default: `"localhost:9146"`. --auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT -: endpoint to use for the bearer auth provider. Default: `"localhost:9148"`. --storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER -: driver of the storage registry. Default: `"static"`. --storage-registry-rule | $STORAGE_STORAGE_REGISTRY_RULES -: `Replaces the generated storage registry rules with this set: --storage-registry-rule "/eos=localhost:9158" [--storage-registry-rule "1284d238-aa92-42ce-bdc4-0b0000009162=localhost:9162"]`. Default: `cli.NewStringSlice()`. --storage-home-provider | $STORAGE_STORAGE_REGISTRY_HOME_PROVIDER -: mount point of the storage provider for user homes in the global namespace. Default: `"/home"`. --storage-registry-json | $STORAGE_STORAGE_REGISTRY_JSON -: JSON file containing the storage registry rules. Default: `""`. --app-registry-driver | $STORAGE_APP_REGISTRY_DRIVER -: driver of the app registry. Default: `"static"`. --app-registry-mimetypes-json | $STORAGE_APP_REGISTRY_MIMETYPES_JSON -: JSON file containing the storage registry rules. Default: `""`. --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `"https://localhost:9200"`. --datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL -: URL to use for the storage datagateway, defaults to /data. Default: `""`. --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider. Default: `"localhost:9144"`. --groupprovider-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: endpoint to use for the groupprovider. Default: `"localhost:9160"`. --sharing-endpoint | $STORAGE_SHARING_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9150"`. --appprovider-endpoint | $STORAGE_APPPROVIDER_ENDPOINT -: endpoint to use for the app provider. Default: `"localhost:9164"`. --storage-home-endpoint | $STORAGE_HOME_ENDPOINT -: endpoint to use for the home storage. Default: `"localhost:9154"`. --storage-home-mount-path | $STORAGE_HOME_MOUNT_PATH -: mount path. Default: `"/home"`. --storage-home-mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009154"`. --storage-users-endpoint | $STORAGE_USERS_ENDPOINT -: endpoint to use for the users storage. Default: `"localhost:9157"`. --storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH -: mount path. Default: `"/users"`. --storage-users-mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. --public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT -: endpoint to use for the public links service. Default: `"localhost:9178"`. --storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `"/public"`. @@ -1543,8 +1497,11 @@ Usage: `storage gateway [command options] [arguments...]` +### storage health +Check health status +Usage: `storage health [command options] [arguments...]` @@ -1566,11 +1523,8 @@ Usage: `storage gateway [command options] [arguments...]` -### storage auth-bearer -Start authprovider for bearer auth -Usage: `storage auth-bearer [command options] [arguments...]` @@ -1614,52 +1568,28 @@ Usage: `storage auth-bearer [command options] [arguments...]` --debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9149"`. --auth-driver | $STORAGE_AUTH_BEARER_DRIVER -: bearer auth driver: 'oidc' or 'machine'. Default: `"oidc"`. --oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL -: OIDC issuer. Default: `"https://localhost:9200"`. --oidc-insecure | $STORAGE_OIDC_INSECURE -: OIDC allow insecure communication. Default: `true`. --oidc-id-claim | $STORAGE_OIDC_ID_CLAIM -: OIDC id claim. Default: `"preferred_username"`. --oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM -: OIDC uid claim. Default: `""`. --oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM -: OIDC gid claim. Default: `""`. --machine-auth-api-key | $STORAGE_AUTH_BEARER_MACHINE_AUTH_API_KEY , $OCIS_MACHINE_AUTH_API_KEY -: the API key to be used for the machine auth driver in reva. Default: `"change-me-please"`. --network | $STORAGE_AUTH_BEARER_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_AUTH_BEARER_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9148"`. --service | $STORAGE_AUTH_BEARER_SERVICES -: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -1667,6 +1597,8 @@ Usage: `storage auth-bearer [command options] [arguments...]` +-debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9109"`. @@ -1815,8 +1747,11 @@ Usage: `storage auth-bearer [command options] [arguments...]` +### storage storage +Storage service for oCIS +Usage: `storage storage [command options] [arguments...]` @@ -1849,11 +1784,8 @@ Usage: `storage auth-bearer [command options] [arguments...]` -### storage groups -Start groups service -Usage: `storage groups [command options] [arguments...]` @@ -1890,12 +1822,20 @@ Usage: `storage groups [command options] [arguments...]` +-config-file | $STORAGE_CONFIG_FILE +: Path to config file. +-log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. @@ -1960,40 +1900,22 @@ Usage: `storage groups [command options] [arguments...]` --debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9161"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --network | $STORAGE_GROUPPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_GROUPPROVIDER_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9160"`. --endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `"localhost:9160"`. --service | $STORAGE_GROUPPROVIDER_SERVICES -: --service groupprovider [--service otherservice]. Default: `cli.NewStringSlice("groupprovider")`. --driver | $STORAGE_GROUPPROVIDER_DRIVER -: group driver: 'json', 'ldap', or 'rest'. Default: `"ldap"`. --json-config | $STORAGE_GROUPPROVIDER_JSON -: Path to groups.json file. Default: `""`. --group-members-cache-expiration | $STORAGE_GROUP_CACHE_EXPIRATION -: Time in minutes for redis cache expiration.. Default: `5`. @@ -2084,8 +2006,11 @@ Usage: `storage groups [command options] [arguments...]` +### storage sharing +Start sharing service +Usage: `storage sharing [command options] [arguments...]` @@ -2123,11 +2048,8 @@ Usage: `storage groups [command options] [arguments...]` -### storage health -Check health status -Usage: `storage health [command options] [arguments...]` @@ -2243,8 +2165,6 @@ Usage: `storage health [command options] [arguments...]` --debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9109"`. @@ -2273,28 +2193,52 @@ Usage: `storage health [command options] [arguments...]` +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9151"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-network | $STORAGE_SHARING_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9150"`. +-service | $STORAGE_SHARING_SERVICES +: --service usershareprovider [--service publicshareprovider]. Default: `cli.NewStringSlice("usershareprovider", "publicshareprovider")`. +-user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `"json"`. +-user-json-file | $STORAGE_SHARING_USER_JSON_FILE +: file used to persist shares for the UserShareProvider. Default: `"/var/tmp/ocis/storage/shares.json"`. +-public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `"json"`. +-public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE +: file used to persist shares for the PublicShareProvider. Default: `"/var/tmp/ocis/storage/publicshares.json"`. +-public-password-hash-cost | $STORAGE_SHARING_PUBLIC_PASSWORD_HASH_COST +: the cost of hashing the public shares passwords. Default: `11`. +-public-enable-expired-shares-cleanup | $STORAGE_SHARING_PUBLIC_ENABLE_EXPIRED_SHARES_CLEANUP +: whether to periodically delete expired public shares. Default: `true`. +-public-janitor-run-interval | $STORAGE_SHARING_PUBLIC_JANITOR_RUN_INTERVAL +: the time period in seconds after which to start a janitor run. Default: `60`. @@ -2345,8 +2289,11 @@ Usage: `storage health [command options] [arguments...]` +### storage storage-public-link +Start storage-public-link service +Usage: `storage storage-public-link [command options] [arguments...]` @@ -2373,11 +2320,8 @@ Usage: `storage health [command options] [arguments...]` -### storage sharing -Start sharing service -Usage: `storage sharing [command options] [arguments...]` @@ -2554,14 +2498,24 @@ Usage: `storage sharing [command options] [arguments...]` +-debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9179"`. +-network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9178"`. +-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `"/public"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -2597,54 +2551,33 @@ Usage: `storage sharing [command options] [arguments...]` +### storage storage-home +Start storage-home service --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9151"`. +Usage: `storage storage-home [command options] [arguments...]` --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --network | $STORAGE_SHARING_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_SHARING_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9150"`. --service | $STORAGE_SHARING_SERVICES -: --service usershareprovider [--service publicshareprovider]. Default: `cli.NewStringSlice("usershareprovider", "publicshareprovider")`. --user-driver | $STORAGE_SHARING_USER_DRIVER -: driver to use for the UserShareProvider. Default: `"json"`. --user-json-file | $STORAGE_SHARING_USER_JSON_FILE -: file used to persist shares for the UserShareProvider. Default: `"/var/tmp/ocis/storage/shares.json"`. --public-driver | $STORAGE_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `"json"`. --public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE -: file used to persist shares for the PublicShareProvider. Default: `"/var/tmp/ocis/storage/publicshares.json"`. --public-password-hash-cost | $STORAGE_SHARING_PUBLIC_PASSWORD_HASH_COST -: the cost of hashing the public shares passwords. Default: `11`. --public-enable-expired-shares-cleanup | $STORAGE_SHARING_PUBLIC_ENABLE_EXPIRED_SHARES_CLEANUP -: whether to periodically delete expired public shares. Default: `true`. --public-janitor-run-interval | $STORAGE_SHARING_PUBLIC_JANITOR_RUN_INTERVAL -: the time period in seconds after which to start a janitor run. Default: `60`. @@ -2656,11 +2589,8 @@ Usage: `storage sharing [command options] [arguments...]` -### storage storage-public-link -Start storage-public-link service -Usage: `storage storage-public-link [command options] [arguments...]` @@ -2749,34 +2679,64 @@ Usage: `storage storage-public-link [command options] [arguments...]` +-debug-addr | $STORAGE_HOME_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9156"`. +-grpc-network | $STORAGE_HOME_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-grpc-addr | $STORAGE_HOME_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9154"`. +-http-network | $STORAGE_HOME_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-http-addr | $STORAGE_HOME_HTTP_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9155"`. +-driver | $STORAGE_HOME_DRIVER +: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. +-read-only | $STORAGE_HOME_READ_ONLY , $OCIS_STORAGE_READ_ONLY +: use storage driver in read-only mode. Default: `false`. +-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `"/home"`. +-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. +-expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. +-data-server-url | $STORAGE_HOME_DATA_SERVER_URL +: data server url. Default: `"http://localhost:9155/data"`. +-http-prefix | $STORAGE_HOME_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `"data"`. +-tmp-folder | $STORAGE_HOME_TMP_FOLDER +: path to tmp folder. Default: `"/var/tmp/ocis/tmp/home"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9144"`. @@ -2883,8 +2843,11 @@ Usage: `storage storage-public-link [command options] [arguments...]` +### storage storage-metadata +Start storage-metadata service +Usage: `storage storage-metadata [command options] [arguments...]` @@ -2894,35 +2857,22 @@ Usage: `storage storage-public-link [command options] [arguments...]` --debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9179"`. --network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9178"`. --mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `"/public"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. -### storage storage-users -Start storage-users service -Usage: `storage storage-users [command options] [arguments...]` @@ -2968,12 +2918,20 @@ Usage: `storage storage-users [command options] [arguments...]` +-config-file | $STORAGE_CONFIG_FILE +: Path to config file. +-log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. @@ -3078,72 +3036,62 @@ Usage: `storage storage-users [command options] [arguments...]` --debug-addr | $STORAGE_USERS_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9159"`. --grpc-network | $STORAGE_USERS_GRPC_NETWORK -: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --grpc-addr | $STORAGE_USERS_GRPC_ADDR -: GRPC Address to bind users storage. Default: `"0.0.0.0:9157"`. --http-network | $STORAGE_USERS_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --http-addr | $STORAGE_USERS_HTTP_ADDR -: HTTP Address to bind users storage. Default: `"0.0.0.0:9158"`. --driver | $STORAGE_USERS_DRIVER -: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. --read-only | $STORAGE_USERS_READ_ONLY , $OCIS_STORAGE_READ_ONLY -: use storage driver in read-only mode. Default: `false`. --mount-path | $STORAGE_USERS_MOUNT_PATH -: mount path. Default: `"/users"`. --mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. --expose-data-server | $STORAGE_USERS_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. +-debug-addr | $STORAGE_METADATA_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9217"`. --data-server-url | $STORAGE_USERS_DATA_SERVER_URL -: data server url. Default: `"http://localhost:9158/data"`. +-grpc-network | $STORAGE_METADATA_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --http-prefix | $STORAGE_USERS_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `"data"`. +-grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9215"`. --tmp-folder | $STORAGE_USERS_TMP_FOLDER -: path to tmp folder. Default: `"/var/tmp/ocis/tmp/users"`. +-data-server-url | $STORAGE_METADATA_DATA_SERVER_URL +: URL of the data-provider the storage-provider uses. Default: `"http://localhost:9216"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-http-network | $STORAGE_METADATA_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9144"`. +-http-addr | $STORAGE_METADATA_HTTP_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9216"`. +-tmp-folder | $STORAGE_METADATA_TMP_FOLDER +: path to tmp folder. Default: `"/var/tmp/ocis/tmp/metadata"`. +-driver | $STORAGE_METADATA_DRIVER +: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider service. Default: `"localhost:9144"`. @@ -3184,8 +3132,11 @@ Usage: `storage storage-users [command options] [arguments...]` +### storage app-provider +Start appprovider for providing apps +Usage: `storage app-provider [command options] [arguments...]` @@ -3210,11 +3161,8 @@ Usage: `storage storage-users [command options] [arguments...]` -### storage users -Start users service -Usage: `storage users [command options] [arguments...]` @@ -3268,36 +3216,68 @@ Usage: `storage users [command options] [arguments...]` +-debug-addr | $APP_PROVIDER_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9165"`. +-network | $APP_PROVIDER_BASIC_GRPC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $APP_PROVIDER_BASIC_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9164"`. +-external-addr | $APP_PROVIDER_BASIC_EXTERNAL_ADDR +: Address to connect to the storage service for other services. Default: `"127.0.0.1:9164"`. +-service | $APP_PROVIDER_BASIC_SERVICES +: --service appprovider [--service otherservice]. Default: `cli.NewStringSlice("appprovider")`. +-driver | $APP_PROVIDER_DRIVER +: Driver to use for app provider. Default: `""`. +-wopi-driver-app-apikey | $APP_PROVIDER_WOPI_DRIVER_APP_API_KEY +: The API key used by the app, if applicable.. Default: `""`. +-wopi-driver-app-desktop-only | $APP_PROVIDER_WOPI_DRIVER_APP_DESKTOP_ONLY +: Whether the app can be opened only on desktop. Default: `false`. +-wopi-driver-app-icon-uri | $APP_PROVIDER_WOPI_DRIVER_APP_ICON_URI +: IOP Secret (Shared with WOPI server). Default: `""`. +-wopi-driver-app-internal-url | $APP_PROVIDER_WOPI_DRIVER_APP_INTERNAL_URL +: The internal app URL in case of dockerized deployments. Defaults to AppURL. Default: `""`. +-wopi-driver-app-name | $APP_PROVIDER_WOPI_DRIVER_APP_NAME +: The App user-friendly name.. Default: `""`. +-wopi-driver-app-url | $APP_PROVIDER_WOPI_DRIVER_APP_URL +: App server URL. Default: `""`. +-wopi-driver-insecure | $APP_PROVIDER_WOPI_DRIVER_INSECURE +: Disable SSL certificate verification of WOPI server and WOPI bridge. Default: `false`. +-wopi-driver-iopsecret | $APP_PROVIDER_WOPI_DRIVER_IOP_SECRET +: IOP Secret (Shared with WOPI server). Default: `""`. +-wopi-driver-wopiurl | $APP_PROVIDER_WOPI_DRIVER_WOPI_URL +: WOPI server URL. Default: `""`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -3385,80 +3365,42 @@ Usage: `storage users [command options] [arguments...]` --debug-addr | $STORAGE_USERPROVIDER_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9145"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --network | $STORAGE_USERPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_USERPROVIDER_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9144"`. --endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `"localhost:9144"`. --service | $STORAGE_USERPROVIDER_SERVICES -: --service userprovider [--service otherservice]. Default: `cli.NewStringSlice("userprovider")`. --driver | $STORAGE_USERPROVIDER_DRIVER -: user driver: 'demo', 'json', 'ldap', 'owncloudsql' or 'rest'. Default: `"ldap"`. --json-config | $STORAGE_USERPROVIDER_JSON -: Path to users.json file. Default: `""`. --user-groups-cache-expiration | $STORAGE_USER_CACHE_EXPIRATION -: Time in minutes for redis cache expiration.. Default: `5`. --owncloudsql-dbhost | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBHOST -: hostname of the mysql db. Default: `"mysql"`. --owncloudsql-dbport | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBPORT -: port of the mysql db. Default: `3306`. --owncloudsql-dbname | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBNAME -: database name of the owncloud db. Default: `"owncloud"`. --owncloudsql-dbuser | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBUSER -: user name to use when connecting to the mysql owncloud db. Default: `"owncloud"`. --owncloudsql-dbpass | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBPASS -: password to use when connecting to the mysql owncloud db. Default: `"secret"`. --owncloudsql-idp | $STORAGE_USERPROVIDER_OWNCLOUDSQL_IDP , $OCIS_URL -: Identity provider to use for users. Default: `"https://localhost:9200"`. --owncloudsql-nobody | $STORAGE_USERPROVIDER_OWNCLOUDSQL_NOBODY -: fallback user id to use when user has no id. Default: `99`. --owncloudsql-join-username | $STORAGE_USERPROVIDER_OWNCLOUDSQL_JOIN_USERNAME -: join the username from the oc_preferences table. Default: `false`. --owncloudsql-join-ownclouduuid | $STORAGE_USERPROVIDER_OWNCLOUDSQL_JOIN_OWNCLOUDUUID -: join the ownclouduuid from the oc_preferences table. Default: `false`. --owncloudsql-enable-medial-search | $STORAGE_USERPROVIDER_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH -: enable medial search when finding users. Default: `false`. @@ -3485,8 +3427,11 @@ Usage: `storage users [command options] [arguments...]` +### storage auth-bearer +Start authprovider for bearer auth +Usage: `storage auth-bearer [command options] [arguments...]` @@ -3514,11 +3459,8 @@ Usage: `storage users [command options] [arguments...]` -### storage auth-basic -Start authprovider for basic auth -Usage: `storage auth-basic [command options] [arguments...]` @@ -3591,59 +3533,69 @@ Usage: `storage auth-basic [command options] [arguments...]` +-debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9149"`. +-auth-driver | $STORAGE_AUTH_BEARER_DRIVER +: bearer auth driver: 'oidc' or 'machine'. Default: `"oidc"`. +-oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL +: OIDC issuer. Default: `"https://localhost:9200"`. +-oidc-insecure | $STORAGE_OIDC_INSECURE +: OIDC allow insecure communication. Default: `true`. +-oidc-id-claim | $STORAGE_OIDC_ID_CLAIM +: OIDC id claim. Default: `"preferred_username"`. +-oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM +: OIDC uid claim. Default: `""`. +-oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM +: OIDC gid claim. Default: `""`. +-machine-auth-api-key | $STORAGE_AUTH_BEARER_MACHINE_AUTH_API_KEY , $OCIS_MACHINE_AUTH_API_KEY +: the API key to be used for the machine auth driver in reva. Default: `"change-me-please"`. +-network | $STORAGE_AUTH_BEARER_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_AUTH_BEARER_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9148"`. +-service | $STORAGE_AUTH_BEARER_SERVICES +: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9147"`. --auth-driver | $STORAGE_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `"ldap"`. --auth-json | $STORAGE_AUTH_JSON -: Path to users.json file. Default: `""`. --network | $STORAGE_AUTH_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_AUTH_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9146"`. --service | $STORAGE_AUTH_BASIC_SERVICES -: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -3758,8 +3710,11 @@ Usage: `storage auth-basic [command options] [arguments...]` +### storage gateway +Start gateway +Usage: `storage gateway [command options] [arguments...]` @@ -3782,11 +3737,8 @@ Usage: `storage auth-basic [command options] [arguments...]` -### storage storage -Storage service for oCIS -Usage: `storage storage [command options] [arguments...]` @@ -3901,74 +3853,144 @@ Usage: `storage storage [command options] [arguments...]` +-debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9143"`. +-transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. +-transfer-expires | $STORAGE_TRANSFER_EXPIRES +: Transfer token ttl in seconds. Default: `24 * 60 * 60`. +-network | $STORAGE_GATEWAY_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_GATEWAY_GRPC_ADDR +: Address to bind REVA service. Default: `"0.0.0.0:9142"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-service | $STORAGE_GATEWAY_SERVICES +: --service gateway [--service authregistry]. Default: `cli.NewStringSlice("gateway", "authregistry", "storageregistry", "appregistry")`. +-commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT +: Commit shares to the share manager. Default: `true`. +-commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF +: Commit shares to the storage. Default: `true`. +-share-folder | $STORAGE_GATEWAY_SHARE_FOLDER +: mount shares in this folder of the home storage provider. Default: `"Shares"`. +-disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN +: Disable creation of home folder on login. +-storage-home-mapping | $STORAGE_GATEWAY_HOME_MAPPING +: mapping template for user home paths to user-specific mount points, e.g. /home/{{substr 0 1 .Username}}. Default: `""`. +-etag-cache-ttl | $STORAGE_GATEWAY_ETAG_CACHE_TTL +: TTL for the home and shares directory etags cache. Default: `0`. +-auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT +: endpoint to use for the basic auth provider. Default: `"localhost:9146"`. +-auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT +: endpoint to use for the bearer auth provider. Default: `"localhost:9148"`. +-storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER +: driver of the storage registry. Default: `"static"`. +-storage-registry-rule | $STORAGE_STORAGE_REGISTRY_RULES +: `Replaces the generated storage registry rules with this set: --storage-registry-rule "/eos=localhost:9158" [--storage-registry-rule "1284d238-aa92-42ce-bdc4-0b0000009162=localhost:9162"]`. Default: `cli.NewStringSlice()`. +-storage-home-provider | $STORAGE_STORAGE_REGISTRY_HOME_PROVIDER +: mount point of the storage provider for user homes in the global namespace. Default: `"/home"`. +-storage-registry-json | $STORAGE_STORAGE_REGISTRY_JSON +: JSON file containing the storage registry rules. Default: `""`. +-app-registry-driver | $STORAGE_APP_REGISTRY_DRIVER +: driver of the app registry. Default: `"static"`. +-app-registry-mimetypes-json | $STORAGE_APP_REGISTRY_MIMETYPES_JSON +: JSON file containing the storage registry rules. Default: `""`. +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `"https://localhost:9200"`. +-datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL +: URL to use for the storage datagateway, defaults to /data. Default: `""`. +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider. Default: `"localhost:9144"`. +-groupprovider-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: endpoint to use for the groupprovider. Default: `"localhost:9160"`. +-sharing-endpoint | $STORAGE_SHARING_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9150"`. +-appprovider-endpoint | $STORAGE_APPPROVIDER_ENDPOINT +: endpoint to use for the app provider. Default: `"localhost:9164"`. +-storage-home-endpoint | $STORAGE_HOME_ENDPOINT +: endpoint to use for the home storage. Default: `"localhost:9154"`. +-storage-home-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `"/home"`. +-storage-home-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009154"`. +-storage-users-endpoint | $STORAGE_USERS_ENDPOINT +: endpoint to use for the users storage. Default: `"localhost:9157"`. +-storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH +: mount path. Default: `"/users"`. +-storage-users-mount-id | $STORAGE_USERS_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. +-public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT +: endpoint to use for the public links service. Default: `"localhost:9178"`. +-storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `"/public"`. @@ -4004,20 +4026,12 @@ Usage: `storage storage [command options] [arguments...]` --config-file | $STORAGE_CONFIG_FILE -: Path to config file. --log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. --log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. @@ -4041,18 +4055,18 @@ Usage: `storage storage [command options] [arguments...]` -### storage app-provider -Start appprovider for providing apps -Usage: `storage app-provider [command options] [arguments...]` +### storage groups +Start groups service +Usage: `storage groups [command options] [arguments...]` @@ -4073,68 +4087,36 @@ Usage: `storage app-provider [command options] [arguments...]` --debug-addr | $APP_PROVIDER_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9165"`. --network | $APP_PROVIDER_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $APP_PROVIDER_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9164"`. --external-addr | $APP_PROVIDER_BASIC_EXTERNAL_ADDR -: Address to connect to the storage service for other services. Default: `"127.0.0.1:9164"`. --service | $APP_PROVIDER_BASIC_SERVICES -: --service appprovider [--service otherservice]. Default: `cli.NewStringSlice("appprovider")`. --driver | $APP_PROVIDER_DRIVER -: Driver to use for app provider. Default: `""`. --wopi-driver-app-apikey | $APP_PROVIDER_WOPI_DRIVER_APP_API_KEY -: The API key used by the app, if applicable.. Default: `""`. --wopi-driver-app-desktop-only | $APP_PROVIDER_WOPI_DRIVER_APP_DESKTOP_ONLY -: Whether the app can be opened only on desktop. Default: `false`. --wopi-driver-app-icon-uri | $APP_PROVIDER_WOPI_DRIVER_APP_ICON_URI -: IOP Secret (Shared with WOPI server). Default: `""`. --wopi-driver-app-internal-url | $APP_PROVIDER_WOPI_DRIVER_APP_INTERNAL_URL -: The internal app URL in case of dockerized deployments. Defaults to AppURL. Default: `""`. --wopi-driver-app-name | $APP_PROVIDER_WOPI_DRIVER_APP_NAME -: The App user-friendly name.. Default: `""`. --wopi-driver-app-url | $APP_PROVIDER_WOPI_DRIVER_APP_URL -: App server URL. Default: `""`. --wopi-driver-insecure | $APP_PROVIDER_WOPI_DRIVER_INSECURE -: Disable SSL certificate verification of WOPI server and WOPI bridge. Default: `false`. --wopi-driver-iopsecret | $APP_PROVIDER_WOPI_DRIVER_IOP_SECRET -: IOP Secret (Shared with WOPI server). Default: `""`. --wopi-driver-wopiurl | $APP_PROVIDER_WOPI_DRIVER_WOPI_URL -: WOPI server URL. Default: `""`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -4258,22 +4240,40 @@ Usage: `storage app-provider [command options] [arguments...]` +-debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9161"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-network | $STORAGE_GROUPPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_GROUPPROVIDER_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9160"`. +-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `"localhost:9160"`. +-service | $STORAGE_GROUPPROVIDER_SERVICES +: --service groupprovider [--service otherservice]. Default: `cli.NewStringSlice("groupprovider")`. +-driver | $STORAGE_GROUPPROVIDER_DRIVER +: group driver: 'json', 'ldap', or 'rest'. Default: `"ldap"`. +-json-config | $STORAGE_GROUPPROVIDER_JSON +: Path to groups.json file. Default: `""`. +-group-members-cache-expiration | $STORAGE_GROUP_CACHE_EXPIRATION +: Time in minutes for redis cache expiration.. Default: `5`. diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index a0093a07cbf..1784b66222e 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-11T15:12:02+0000" +date: "2021-10-12T08:08:52+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates @@ -35,80 +35,62 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### store server +### store health -Start integrated server +Check health status -Usage: `store server [command options] [arguments...]` +Usage: `store health [command options] [arguments...]` +-debug-addr | $STORE_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9460"`. --log-file | $STORE_LOG_FILE , $OCIS_LOG_FILE -: Enable log to file. --tracing-enabled | $STORE_TRACING_ENABLED , $OCIS_TRACING_ENABLED -: Enable sending traces. --tracing-type | $STORE_TRACING_TYPE , $OCIS_TRACING_TYPE -: Tracing backend type. Default: `"jaeger"`. --tracing-endpoint | $STORE_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. --tracing-collector | $STORE_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `""`. --tracing-service | $STORE_TRACING_SERVICE -: Service name for tracing. Default: `"store"`. --debug-addr | $STORE_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9460"`. --debug-token | $STORE_DEBUG_TOKEN -: Token to grant metrics access. Default: `""`. --debug-pprof | $STORE_DEBUG_PPROF -: Enable pprof debugging. +### store ocis-store +Service to store values for ocis extensions --debug-zpages | $STORE_DEBUG_ZPAGES -: Enable zpages debugging. +Usage: `store ocis-store [command options] [arguments...]` --grpc-namespace | $STORE_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-config-file | $STORE_CONFIG_FILE +: Path to config file. --name | $STORE_NAME -: Service name. Default: `"store"`. +-log-level | $STORE_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. --data-path | $STORE_DATA_PATH -: location of the store data path. Default: `"/var/tmp/ocis/store"`. +-log-pretty | $STORE_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. --extensions | -: Run specific extensions during supervised mode. This flag is set by the runtime. +-log-color | $STORE_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. -### store version -Print the versions of the running instances -Usage: `store version [command options] [arguments...]` @@ -122,72 +104,86 @@ Usage: `store version [command options] [arguments...]` +### store server +Start integrated server +Usage: `store server [command options] [arguments...]` --grpc-namespace | $STORE_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-log-file | $STORE_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. --name | $STORE_NAME -: Service name. Default: `"store"`. -### store health +-tracing-enabled | $STORE_TRACING_ENABLED , $OCIS_TRACING_ENABLED +: Enable sending traces. -Check health status -Usage: `store health [command options] [arguments...]` +-tracing-type | $STORE_TRACING_TYPE , $OCIS_TRACING_TYPE +: Tracing backend type. Default: `"jaeger"`. +-tracing-endpoint | $STORE_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. +-tracing-collector | $STORE_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR +: Endpoint for the collector. Default: `""`. --debug-addr | $STORE_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9460"`. +-tracing-service | $STORE_TRACING_SERVICE +: Service name for tracing. Default: `"store"`. +-debug-addr | $STORE_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9460"`. +-debug-token | $STORE_DEBUG_TOKEN +: Token to grant metrics access. Default: `""`. +-debug-pprof | $STORE_DEBUG_PPROF +: Enable pprof debugging. +-debug-zpages | $STORE_DEBUG_ZPAGES +: Enable zpages debugging. +-grpc-namespace | $STORE_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $STORE_NAME +: Service name. Default: `"store"`. +-data-path | $STORE_DATA_PATH +: location of the store data path. Default: `"/var/tmp/ocis/store"`. +-extensions | +: Run specific extensions during supervised mode. This flag is set by the runtime. -### store ocis-store -Service to store values for ocis extensions -Usage: `store ocis-store [command options] [arguments...]` +### store version +Print the versions of the running instances --config-file | $STORE_CONFIG_FILE -: Path to config file. +Usage: `store version [command options] [arguments...]` --log-level | $STORE_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. --log-pretty | $STORE_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $STORE_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. @@ -203,6 +199,10 @@ Usage: `store ocis-store [command options] [arguments...]` +-grpc-namespace | $STORE_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $STORE_NAME +: Service name. Default: `"store"`. diff --git a/extensions/thumbnails/configuration.md b/extensions/thumbnails/configuration.md index 085a601f689..4a8f89396e2 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-11T15:12:02+0000" +date: "2021-10-12T08:08:52+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates diff --git a/extensions/web/configuration.md b/extensions/web/configuration.md index 43df3471c3a..5fc418f7f8f 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-11T15:12:02+0000" +date: "2021-10-12T08:08:53+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/web/templates diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index 9ae04c1eb14..d6b4472b409 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-11T15:12:02+0000" +date: "2021-10-12T08:08:53+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates @@ -66,6 +66,39 @@ Usage: `webdav [global options] command [command options] [arguments...]` ## Sub Commands + +### webdav health + +Check health status + +Usage: `webdav health [command options] [arguments...]` + + +-debug-addr | $WEBDAV_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9119"`. + + + + + + + + + + + + + + + + + + + + + + + ### webdav server @@ -195,37 +228,4 @@ Usage: `webdav version [command options] [arguments...]` -service-name | $WEBDAV_SERVICE_NAME : Service name. Default: `"webdav"`. - -### webdav health - -Check health status - -Usage: `webdav health [command options] [arguments...]` - - --debug-addr | $WEBDAV_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9119"`. - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ocis/configuration.md b/ocis/configuration.md index eec891e42b4..3f00206f070 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-11T15:12:01+0000" +date: "2021-10-12T08:08:51+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -191,11 +191,11 @@ Usage: `ocis health [command options] [arguments...]` -### ocis list +### ocis run -Lists running ocis extensions +Runs an extension -Usage: `ocis list [command options] [arguments...]` +Usage: `ocis run [command options] [arguments...]` @@ -219,11 +219,11 @@ Usage: `ocis list [command options] [arguments...]` -### ocis kill +### ocis list -Kill an extension by name +Lists running ocis extensions -Usage: `ocis kill [command options] [arguments...]` +Usage: `ocis list [command options] [arguments...]` @@ -247,11 +247,11 @@ Usage: `ocis kill [command options] [arguments...]` -### ocis run +### ocis kill -Runs an extension +Kill an extension by name -Usage: `ocis run [command options] [arguments...]` +Usage: `ocis kill [command options] [arguments...]` @@ -279,37 +279,29 @@ Usage: `ocis run [command options] [arguments...]` There are more subcommands to start the individual extensions. Please check the documentation about their usage and options in the dedicated section of the documentation. -#### ocis storage-auth-basic - -Start storage auth-basic service - #### ocis storage-metadata Start storage and data service for metadata -#### ocis storage-sharing - -Start storage sharing service - -#### ocis version +#### ocis idp -Lists running services with version +Start idp server -#### ocis settings +#### ocis ocs -Start settings server +Start ocs server -#### ocis storage-frontend +#### ocis storage-auth-basic -Start storage frontend +Start storage auth-basic service -#### ocis storage-userprovider +#### ocis storage-public-link -Start storage userprovider service +Start storage public link storage -#### ocis storage-app-provider +#### ocis web -Start storage app-provider service +Start web server #### ocis webdav @@ -319,55 +311,63 @@ Start webdav server Start accounts server -#### ocis ocs +#### ocis storage-auth-bearer -Start ocs server +Start storage auth-bearer service -#### ocis web +#### ocis storage-frontend -Start web server +Start storage frontend + +#### ocis storage-groupprovider + +Start storage groupprovider service #### ocis glauth Start glauth server -#### ocis proxy +#### ocis settings -Start proxy server +Start settings server -#### ocis storage-auth-bearer +#### ocis storage-app-provider -Start storage auth-bearer service +Start storage app-provider service -#### ocis storage-groupprovider +#### ocis storage-gateway -Start storage groupprovider service +Start storage gateway -#### ocis storage-home +#### ocis storage-sharing -Start storage and data provider for /home mount +Start storage sharing service -#### ocis storage-users +#### ocis storage-home -Start storage and data provider for /users mount +Start storage and data provider for /home mount #### ocis store Start a go-micro store -#### ocis idp +#### ocis thumbnails -Start idp server +Start thumbnails server -#### ocis storage-gateway +#### ocis proxy -Start storage gateway +Start proxy server -#### ocis storage-public-link +#### ocis storage-userprovider -Start storage public link storage +Start storage userprovider service -#### ocis thumbnails +#### ocis storage-users -Start thumbnails server +Start storage and data provider for /users mount + +#### ocis version + +Lists running services with version