From e9f956784f737987f93246d0b8158333ff323084 Mon Sep 17 00:00:00 2001 From: Phil Davis Date: Thu, 1 Jul 2021 07:55:42 +0000 Subject: [PATCH] commit 2300ab003311b4c35783ca8bddd64ae2afcaa43b Merge: 8a2dcc22 f1b733f0 Author: Phil Davis Date: Thu Jul 1 13:36:49 2021 +0545 Merge pull request #2238 from owncloud/update-commitid-2021-07-01 [Tests-Only] bump the web commit id for ci tests with expected failure files --- extensions/accounts/configuration.md | 246 ++++---- extensions/glauth/configuration.md | 92 +-- extensions/graph-explorer/configuration.md | 60 +- extensions/graph/configuration.md | 2 +- extensions/idp/configuration.md | 2 +- extensions/ocs/configuration.md | 2 +- extensions/onlyoffice/configuration.md | 2 +- extensions/proxy/configuration.md | 2 +- extensions/settings/configuration.md | 2 +- extensions/storage/configuration.md | 616 ++++++++++----------- extensions/store/configuration.md | 60 +- extensions/thumbnails/configuration.md | 2 +- extensions/web/configuration.md | 76 +-- extensions/webdav/configuration.md | 72 +-- ocis/configuration.md | 148 ++--- 15 files changed, 692 insertions(+), 692 deletions(-) diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index e2f671d48a3..7a46412890b 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-30T13:07:29+0000" +date: "2021-07-01T07:53:44+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -35,22 +35,11 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### accounts add - -Create a new account - -Usage: `accounts add [command options] [arguments...]` - - - - - - - - - +### accounts update +Make changes to an existing account +Usage: `accounts update [command options] [arguments...]` @@ -93,10 +82,6 @@ Usage: `accounts add [command options] [arguments...]` : 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. @@ -130,11 +115,8 @@ Usage: `accounts add [command options] [arguments...]` -### accounts rebuildIndex -Rebuilds the service's index, i.e. deleting and then re-adding all existing documents -Usage: `accounts rebuildIndex [command options] [arguments...]` @@ -145,8 +127,11 @@ Usage: `accounts rebuildIndex [command options] [arguments...]` +### accounts version +Print the versions of the running instances +Usage: `accounts version [command options] [arguments...]` @@ -189,25 +174,29 @@ Usage: `accounts rebuildIndex [command options] [arguments...]` -### accounts remove -Removes an existing account -Usage: `accounts remove [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. +-name | $ACCOUNTS_NAME +: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. +### accounts add +Create a new account +Usage: `accounts add [command options] [arguments...]` @@ -253,33 +242,44 @@ Usage: `accounts remove [command options] [arguments...]` : service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. +-enabled | +: Enable the account. -### accounts ocis-accounts -Provide accounts and groups for oCIS +-displayname | +: Set the displayname for the account. -Usage: `accounts ocis-accounts [command options] [arguments...]` +-username | +: Username will be written to preferred-name and on_premises_sam_account_name. --log-level | $ACCOUNTS_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. +-preferred-name | +: Set the preferred-name for the account. --log-pretty | $ACCOUNTS_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. +-on-premises-sam-account-name | +: Set the on-premises-sam-account-name. --log-color | $ACCOUNTS_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. +-mail | +: Set the mail for the account. +-description | +: Set the description for the account. +-password | +: Set the password for the account. +-force-password-change | +: Force password change on next sign-in. +-force-password-change-mfa | +: Force password change on next sign-in with mfa. @@ -287,8 +287,11 @@ Usage: `accounts ocis-accounts [command options] [arguments...]` +### accounts inspect +Show detailed data on an existing account +Usage: `accounts inspect [command options] [arguments...]` @@ -322,11 +325,8 @@ Usage: `accounts ocis-accounts [command options] [arguments...]` -### accounts version -Print the versions of the running instances -Usage: `accounts version [command options] [arguments...]` @@ -345,17 +345,30 @@ Usage: `accounts version [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. +-name | $ACCOUNTS_NAME +: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. +### accounts ocis-accounts +Provide accounts and groups for oCIS +Usage: `accounts ocis-accounts [command options] [arguments...]` +-log-level | $ACCOUNTS_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $ACCOUNTS_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $ACCOUNTS_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. @@ -376,22 +389,15 @@ Usage: `accounts version [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. --name | $ACCOUNTS_NAME -: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. -### accounts inspect -Show detailed data on an existing account -Usage: `accounts inspect [command options] [arguments...]` @@ -414,60 +420,98 @@ Usage: `accounts inspect [command options] [arguments...]` +### accounts server +Start ocis accounts service +Usage: `accounts server [command options] [arguments...]` +-log-file | $ACCOUNTS_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. +-tracing-enabled | $ACCOUNTS_TRACING_ENABLED +: Enable sending traces. +-tracing-type | $ACCOUNTS_TRACING_TYPE +: Tracing backend type. Default: `flags.OverrideDefaultString(cfg.Tracing.Type, "jaeger")`. +-tracing-endpoint | $ACCOUNTS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `flags.OverrideDefaultString(cfg.Tracing.Endpoint, "")`. +-tracing-collector | $ACCOUNTS_TRACING_COLLECTOR +: Endpoint for the collector. Default: `flags.OverrideDefaultString(cfg.Tracing.Collector, "")`. +-tracing-service | $ACCOUNTS_TRACING_SERVICE +: Service name for tracing. Default: `flags.OverrideDefaultString(cfg.Tracing.Service, "accounts")`. +-http-namespace | $ACCOUNTS_HTTP_NAMESPACE +: Set the base namespace for the http namespace. Default: `flags.OverrideDefaultString(cfg.HTTP.Namespace, "com.owncloud.web")`. +-http-addr | $ACCOUNTS_HTTP_ADDR +: Address to bind http server. Default: `flags.OverrideDefaultString(cfg.HTTP.Addr, "0.0.0.0:9181")`. +-http-root | $ACCOUNTS_HTTP_ROOT +: Root path of http server. Default: `flags.OverrideDefaultString(cfg.HTTP.Root, "/")`. +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. +-grpc-addr | $ACCOUNTS_GRPC_ADDR +: Address to bind grpc server. Default: `flags.OverrideDefaultString(cfg.GRPC.Addr, "0.0.0.0:9180")`. +-name | $ACCOUNTS_NAME +: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. +-asset-path | $ACCOUNTS_ASSET_PATH +: Path to custom assets. Default: `flags.OverrideDefaultString(cfg.Asset.Path, "")`. --name | $ACCOUNTS_NAME -: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. +-jwt-secret | $ACCOUNTS_JWT_SECRET , $OCIS_JWT_SECRET +: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `flags.OverrideDefaultString(cfg.TokenManager.JWTSecret, "Pive-Fumkiu4")`. -### accounts list -List existing accounts +-storage-disk-path | $ACCOUNTS_STORAGE_DISK_PATH +: Path on the local disk, e.g. /var/tmp/ocis/accounts. Default: `flags.OverrideDefaultString(cfg.Repo.Disk.Path, "")`. -Usage: `accounts list [command options] [arguments...]` +-storage-cs3-provider-addr | $ACCOUNTS_STORAGE_CS3_PROVIDER_ADDR +: bind address for the metadata storage provider. Default: `flags.OverrideDefaultString(cfg.Repo.CS3.ProviderAddr, "localhost:9215")`. +-storage-cs3-data-url | $ACCOUNTS_STORAGE_CS3_DATA_URL +: http endpoint of the metadata storage. Default: `flags.OverrideDefaultString(cfg.Repo.CS3.DataURL, "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: `flags.OverrideDefaultString(cfg.Repo.CS3.DataPrefix, "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: `flags.OverrideDefaultString(cfg.Repo.CS3.JWTSecret, "Pive-Fumkiu4")`. +-service-user-uuid | $ACCOUNTS_SERVICE_USER_UUID +: uuid of the internal service user (required on EOS). Default: `flags.OverrideDefaultString(cfg.ServiceUser.UUID, "95cb8724-03b2-11eb-a0a6-c33ef8ef53ad")`. +-service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME +: username of the internal service user (required on EOS). Default: `flags.OverrideDefaultString(cfg.ServiceUser.Username, "")`. @@ -498,6 +542,16 @@ Usage: `accounts list [command options] [arguments...]` +### accounts list + +List existing accounts + +Usage: `accounts list [command options] [arguments...]` + + + + + @@ -506,109 +560,69 @@ Usage: `accounts list [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. --name | $ACCOUNTS_NAME -: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "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. --tracing-enabled | $ACCOUNTS_TRACING_ENABLED -: Enable sending traces. --tracing-type | $ACCOUNTS_TRACING_TYPE -: Tracing backend type. Default: `flags.OverrideDefaultString(cfg.Tracing.Type, "jaeger")`. --tracing-endpoint | $ACCOUNTS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `flags.OverrideDefaultString(cfg.Tracing.Endpoint, "")`. --tracing-collector | $ACCOUNTS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `flags.OverrideDefaultString(cfg.Tracing.Collector, "")`. --tracing-service | $ACCOUNTS_TRACING_SERVICE -: Service name for tracing. Default: `flags.OverrideDefaultString(cfg.Tracing.Service, "accounts")`. --http-namespace | $ACCOUNTS_HTTP_NAMESPACE -: Set the base namespace for the http namespace. Default: `flags.OverrideDefaultString(cfg.HTTP.Namespace, "com.owncloud.web")`. --http-addr | $ACCOUNTS_HTTP_ADDR -: Address to bind http server. Default: `flags.OverrideDefaultString(cfg.HTTP.Addr, "0.0.0.0:9181")`. --http-root | $ACCOUNTS_HTTP_ROOT -: Root path of http server. Default: `flags.OverrideDefaultString(cfg.HTTP.Root, "/")`. --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. --grpc-addr | $ACCOUNTS_GRPC_ADDR -: Address to bind grpc server. Default: `flags.OverrideDefaultString(cfg.GRPC.Addr, "0.0.0.0:9180")`. + + +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. -name | $ACCOUNTS_NAME : service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. --asset-path | $ACCOUNTS_ASSET_PATH -: Path to custom assets. Default: `flags.OverrideDefaultString(cfg.Asset.Path, "")`. --jwt-secret | $ACCOUNTS_JWT_SECRET , $OCIS_JWT_SECRET -: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `flags.OverrideDefaultString(cfg.TokenManager.JWTSecret, "Pive-Fumkiu4")`. +### accounts rebuildIndex --storage-disk-path | $ACCOUNTS_STORAGE_DISK_PATH -: Path on the local disk, e.g. /var/tmp/ocis/accounts. Default: `flags.OverrideDefaultString(cfg.Repo.Disk.Path, "")`. +Rebuilds the service's index, i.e. deleting and then re-adding all existing documents +Usage: `accounts rebuildIndex [command options] [arguments...]` --storage-cs3-provider-addr | $ACCOUNTS_STORAGE_CS3_PROVIDER_ADDR -: bind address for the metadata storage provider. Default: `flags.OverrideDefaultString(cfg.Repo.CS3.ProviderAddr, "localhost:9215")`. --storage-cs3-data-url | $ACCOUNTS_STORAGE_CS3_DATA_URL -: http endpoint of the metadata storage. Default: `flags.OverrideDefaultString(cfg.Repo.CS3.DataURL, "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: `flags.OverrideDefaultString(cfg.Repo.CS3.DataPrefix, "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: `flags.OverrideDefaultString(cfg.Repo.CS3.JWTSecret, "Pive-Fumkiu4")`. --service-user-uuid | $ACCOUNTS_SERVICE_USER_UUID -: uuid of the internal service user (required on EOS). Default: `flags.OverrideDefaultString(cfg.ServiceUser.UUID, "95cb8724-03b2-11eb-a0a6-c33ef8ef53ad")`. --service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME -: username of the internal service user (required on EOS). Default: `flags.OverrideDefaultString(cfg.ServiceUser.Username, "")`. @@ -639,11 +653,8 @@ Usage: `accounts server [command options] [arguments...]` -### accounts update -Make changes to an existing account -Usage: `accounts update [command options] [arguments...]` @@ -655,7 +666,11 @@ Usage: `accounts update [command options] [arguments...]` +### accounts remove +Removes an existing account + +Usage: `accounts remove [command options] [arguments...]` @@ -670,48 +685,26 @@ Usage: `accounts update [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. --name | $ACCOUNTS_NAME -: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "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. --mail | -: Set the mail for the account. --description | -: Set the description for the account. --password | -: Set the password for the account. --force-password-change | -: Force password change on next sign-in. --force-password-change-mfa | -: Force password change on next sign-in with mfa. @@ -728,6 +721,13 @@ Usage: `accounts update [command options] [arguments...]` + +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. + + +-name | $ACCOUNTS_NAME +: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index 452265d36c0..a8f7451c24f 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-30T13:08:18+0000" +date: "2021-07-01T07:54:43+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/glauth/templates @@ -34,6 +34,51 @@ If multiple variables are listed for one option, they are in order of precedence ### Commandline flags If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. + +### glauth health + +Check health status + +Usage: `glauth health [command options] [arguments...]` + + + + + +-debug-addr | $GLAUTH_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9129")`. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ### glauth ocis-glauth @@ -223,49 +268,4 @@ Usage: `glauth server [command options] [arguments...]` -fallback-use-graphapi | $GLAUTH_FALLBACK_USE_GRAPHAPI : use Graph API, only for owncloud datastore. Default: `flags.OverrideDefaultBool(cfg.Fallback.UseGraphAPI, true)`. - -### glauth health - -Check health status - -Usage: `glauth health [command options] [arguments...]` - - - - - --debug-addr | $GLAUTH_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9129")`. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/extensions/graph-explorer/configuration.md b/extensions/graph-explorer/configuration.md index 91b96c9f0e5..81541b5a525 100644 --- a/extensions/graph-explorer/configuration.md +++ b/extensions/graph-explorer/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-30T13:08:18+0000" +date: "2021-07-01T07:54:43+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph-explorer/templates @@ -72,35 +72,6 @@ Usage: `graph-explorer [global options] command [command options] [arguments...] ## Sub Commands -### graph-explorer health - -Check health status - -Usage: `graph-explorer health [command options] [arguments...]` - - - - - --debug-addr | $GRAPH_EXPLORER_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9136")`. - - - - - - - - - - - - - - - - - ### graph-explorer server Start integrated server @@ -175,3 +146,32 @@ Usage: `graph-explorer server [command options] [arguments...]` -graph-url | $GRAPH_EXPLORER_GRAPH_URL : Set the url to the graph api service. Default: `flags.OverrideDefaultString(cfg.GraphExplorer.GraphURL, "https://localhost:9200/graph")`. +### graph-explorer health + +Check health status + +Usage: `graph-explorer health [command options] [arguments...]` + + + + + +-debug-addr | $GRAPH_EXPLORER_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9136")`. + + + + + + + + + + + + + + + + + diff --git a/extensions/graph/configuration.md b/extensions/graph/configuration.md index 6dfa5760529..6af867440f0 100644 --- a/extensions/graph/configuration.md +++ b/extensions/graph/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-30T13:08:18+0000" +date: "2021-07-01T07:54:43+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 1797083b795..d55023a56d5 100644 --- a/extensions/idp/configuration.md +++ b/extensions/idp/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-30T13:08:18+0000" +date: "2021-07-01T07:54:43+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/idp/templates diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index 7bfb0dd77df..179ebe275ed 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-30T13:08:18+0000" +date: "2021-07-01T07:54:44+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/templates diff --git a/extensions/onlyoffice/configuration.md b/extensions/onlyoffice/configuration.md index c4fbde037a3..1598eee44d1 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-30T13:08:18+0000" +date: "2021-07-01T07:54:44+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/onlyoffice/templates diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index ba729424c5e..844a7a4d0c1 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-30T13:08:18+0000" +date: "2021-07-01T07:54:44+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/proxy/templates diff --git a/extensions/settings/configuration.md b/extensions/settings/configuration.md index 94d610cf878..20b4eee8ea6 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-30T13:08:18+0000" +date: "2021-07-01T07:54:44+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 9127f593344..6c6529b67e0 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-30T13:08:19+0000" +date: "2021-07-01T07:54:44+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -191,20 +191,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. @@ -252,12 +244,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. @@ -365,16 +365,28 @@ Usage: `storage auth-basic [command options] [arguments...]` +-debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.DebugAddr, "0.0.0.0:9147")`. +-auth-driver | $STORAGE_AUTH_DRIVER +: auth driver: 'demo', 'json' or 'ldap'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthProvider.Driver, "ldap")`. +-auth-json | $STORAGE_AUTH_JSON +: Path to users.json file. Default: `flags.OverrideDefaultString(cfg.Reva.AuthProvider.JSON, "")`. +-network | $STORAGE_AUTH_BASIC_GRPC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.GRPCNetwork, "tcp")`. +-addr | $STORAGE_AUTH_BASIC_GRPC_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.GRPCAddr, "0.0.0.0:9146")`. +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. @@ -439,28 +451,16 @@ Usage: `storage auth-basic [command options] [arguments...]` --debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.DebugAddr, "0.0.0.0:9147")`. --auth-driver | $STORAGE_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthProvider.Driver, "ldap")`. --auth-json | $STORAGE_AUTH_JSON -: Path to users.json file. Default: `flags.OverrideDefaultString(cfg.Reva.AuthProvider.JSON, "")`. --network | $STORAGE_AUTH_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.GRPCNetwork, "tcp")`. --addr | $STORAGE_AUTH_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.GRPCAddr, "0.0.0.0:9146")`. --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. @@ -507,11 +507,11 @@ Usage: `storage auth-basic [command options] [arguments...]` -### storage auth-bearer +### storage storage-metadata -Start authprovider for bearer auth +Start storage-metadata service -Usage: `storage auth-bearer [command options] [arguments...]` +Usage: `storage storage-metadata [command options] [arguments...]` @@ -658,65 +658,69 @@ Usage: `storage auth-bearer [command options] [arguments...]` +-debug-addr | $STORAGE_METADATA_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.DebugAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.GRPCNetwork, "tcp")`. +-grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.GRPCAddr, "0.0.0.0:9215")`. +-data-server-url | $STORAGE_METADATA_DATA_SERVER_URL +: URL of the data-provider the storage-provider uses. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.DataServerURL, "http://localhost:9216")`. +-http-network | $STORAGE_METADATA_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.HTTPNetwork, "tcp")`. +-http-addr | $STORAGE_METADATA_HTTP_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.HTTPAddr, "0.0.0.0:9216")`. +-tmp-folder | $STORAGE_METADATA_TMP_FOLDER +: path to tmp folder. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.TempFolder, "/var/tmp/ocis/tmp/metadata")`. +-driver | $STORAGE_METADATA_DRIVER +: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.Driver, "ocis")`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. +-storage-root | $STORAGE_METADATA_ROOT +: the path to the metadata storage root. Default: `flags.OverrideDefaultString(cfg.Reva.Storages.Common.Root, "/var/tmp/ocis/storage/metadata")`. --debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.DebugAddr, "0.0.0.0:9149")`. --oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL -: OIDC issuer. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.Issuer, "https://localhost:9200")`. --oidc-insecure | $STORAGE_OIDC_INSECURE -: OIDC allow insecure communication. Default: `flags.OverrideDefaultBool(cfg.Reva.OIDC.Insecure, true)`. --oidc-id-claim | $STORAGE_OIDC_ID_CLAIM -: OIDC id claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.IDClaim, "preferred_username")`. --oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM -: OIDC uid claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.UIDClaim, "")`. --oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM -: OIDC gid claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.GIDClaim, "")`. --network | $STORAGE_AUTH_BEARER_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.GRPCNetwork, "tcp")`. --addr | $STORAGE_AUTH_BEARER_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.GRPCAddr, "0.0.0.0:9148")`. --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. @@ -745,26 +749,34 @@ Usage: `storage auth-bearer [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. -### storage frontend -Start frontend service -Usage: `storage frontend [command options] [arguments...]` +### storage storage +Storage service for oCIS +Usage: `storage storage [command options] [arguments...]` @@ -836,68 +848,36 @@ Usage: `storage frontend [command options] [arguments...]` --debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.DebugAddr, "0.0.0.0:9141")`. --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `flags.OverrideDefaultString(cfg.Reva.TransferSecret, "replace-me-with-a-transfer-secret")`. --webdav-namespace | $STORAGE_WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `flags.OverrideDefaultString(cfg.Reva.OCDav.WebdavNamespace, "/home/")`. --dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `flags.OverrideDefaultString(cfg.Reva.OCDav.DavFilesNamespace, "/users/")`. --network | $STORAGE_FRONTEND_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.HTTPNetwork, "tcp")`. --addr | $STORAGE_FRONTEND_HTTP_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.HTTPAddr, "0.0.0.0:9140")`. --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.PublicURL, "https://localhost:9200")`. --datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.DatagatewayPrefix, "data")`. --ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCDavPrefix, "")`. --ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX -: open collaboration services endpoint prefix. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCSPrefix, "ocs")`. --ocs-share-prefix | $STORAGE_FRONTEND_OCS_SHARE_PREFIX -: the prefix prepended to the path of shared files. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCSSharePrefix, "/Shares")`. --ocs-home-namespace | $STORAGE_FRONTEND_OCS_HOME_NAMESPACE -: the prefix prepended to the incoming requests in OCS. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCSHomeNamespace, "/home")`. --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. --default-upload-protocol | $STORAGE_FRONTEND_DEFAULT_UPLOAD_PROTOCOL -: Default upload chunking protocol to be used out of tus/v1/ng. Default: `flags.OverrideDefaultString(cfg.Reva.DefaultUploadProtocol, "tus")`. --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: `flags.OverrideDefaultString(cfg.Reva.UploadHTTPMethodOverride, "")`. --checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE -: Specify the preferred checksum algorithm used for uploads. Default: `flags.OverrideDefaultString(cfg.Reva.ChecksumPreferredUploadType, "")`. @@ -1001,12 +981,20 @@ Usage: `storage frontend [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. @@ -1016,17 +1004,17 @@ Usage: `storage frontend [command options] [arguments...]` +### storage storage-home +Start storage-home service +Usage: `storage storage-home [command options] [arguments...]` -### storage gateway -Start gateway -Usage: `storage gateway [command options] [arguments...]` @@ -1092,144 +1080,118 @@ Usage: `storage gateway [command options] [arguments...]` +-debug-addr | $STORAGE_HOME_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.DebugAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageHome.GRPCNetwork, "tcp")`. +-grpc-addr | $STORAGE_HOME_GRPC_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.GRPCAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPNetwork, "tcp")`. +-http-addr | $STORAGE_HOME_HTTP_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPAddr, "0.0.0.0:9155")`. +-driver | $STORAGE_HOME_DRIVER +: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.Driver, "ocis")`. +-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountPath, "/home")`. +-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountID, "1284d238-aa92-42ce-bdc4-0b0000009157")`. +-expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `flags.OverrideDefaultBool(cfg.Reva.StorageHome.ExposeDataServer, false)`. +-data-server-url | $STORAGE_HOME_DATA_SERVER_URL +: data server url. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.DataServerURL, "http://localhost:9155/data")`. +-http-prefix | $STORAGE_HOME_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPPrefix, "data")`. +-tmp-folder | $STORAGE_HOME_TMP_FOLDER +: path to tmp folder. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.TempFolder, "/var/tmp/ocis/tmp/home")`. +-enable-home | $STORAGE_HOME_ENABLE_HOME +: enable the creation of home directories. Default: `flags.OverrideDefaultBool(cfg.Reva.Storages.Home.EnableHome, true)`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. --debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.DebugAddr, "0.0.0.0:9143")`. +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `flags.OverrideDefaultString(cfg.Reva.TransferSecret, "replace-me-with-a-transfer-secret")`. --network | $STORAGE_GATEWAY_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.GRPCNetwork, "tcp")`. --addr | $STORAGE_GATEWAY_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.GRPCAddr, "0.0.0.0:9142")`. --endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. --commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT -: Commit shares to the share manager. Default: `flags.OverrideDefaultBool(cfg.Reva.Gateway.CommitShareToStorageGrant, true)`. --commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF -: Commit shares to the storage. Default: `flags.OverrideDefaultBool(cfg.Reva.Gateway.CommitShareToStorageRef, true)`. --share-folder | $STORAGE_GATEWAY_SHARE_FOLDER -: mount shares in this folder of the home storage provider. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.ShareFolder, "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: `flags.OverrideDefaultString(cfg.Reva.Gateway.HomeMapping, "")`. --auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT -: endpoint to use for the basic auth provider. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.Endpoint, "localhost:9146")`. --auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT -: endpoint to use for the bearer auth provider. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.Endpoint, "localhost:9148")`. --storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER -: driver of the storage registry. Default: `flags.OverrideDefaultString(cfg.Reva.StorageRegistry.Driver, "static")`. --storage-home-provider | $STORAGE_STORAGE_REGISTRY_HOME_PROVIDER -: mount point of the storage provider for user homes in the global namespace. Default: `flags.OverrideDefaultString(cfg.Reva.StorageRegistry.HomeProvider, "/home")`. --storage-registry-json | $STORAGE_STORAGE_REGISTRY_JSON -: JSON file containing the storage registry rules. Default: `flags.OverrideDefaultString(cfg.Reva.StorageRegistry.JSON, "")`. --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.PublicURL, "https://localhost:9200")`. --datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL -: URL to use for the storage datagateway, defaults to /data. Default: `flags.OverrideDefaultString(cfg.Reva.DataGateway.PublicURL, "")`. --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. --groupprovider-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: endpoint to use for the groupprovider. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Endpoint, "localhost:9160")`. --sharing-endpoint | $STORAGE_SHARING_ENDPOINT -: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.Endpoint, "localhost:9150")`. --storage-home-endpoint | $STORAGE_HOME_ENDPOINT -: endpoint to use for the home storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.Endpoint, "localhost:9154")`. --storage-home-mount-path | $STORAGE_HOME_MOUNT_PATH -: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountPath, "/home")`. --storage-home-mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountID, "1284d238-aa92-42ce-bdc4-0b0000009154")`. --storage-users-endpoint | $STORAGE_USERS_ENDPOINT -: endpoint to use for the users storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.Endpoint, "localhost:9157")`. --storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH -: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountPath, "/users")`. --storage-users-mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountID, "1284d238-aa92-42ce-bdc4-0b0000009157")`. --public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT -: endpoint to use for the public links service. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.Endpoint, "localhost:9178")`. --storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.MountPath, "/public")`. @@ -1307,8 +1269,11 @@ Usage: `storage gateway [command options] [arguments...]` +### storage storage-public-link +Start storage-public-link service +Usage: `storage storage-public-link [command options] [arguments...]` @@ -1326,11 +1291,8 @@ Usage: `storage gateway [command options] [arguments...]` -### storage groups -Start groups service -Usage: `storage groups [command options] [arguments...]` @@ -1398,14 +1360,24 @@ Usage: `storage groups [command options] [arguments...]` +-debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.DebugAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.GRPCNetwork, "tcp")`. +-addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.GRPCAddr, "0.0.0.0:9178")`. +-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.MountPath, "/public")`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. @@ -1475,28 +1447,16 @@ Usage: `storage groups [command options] [arguments...]` --debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.DebugAddr, "0.0.0.0:9161")`. --network | $STORAGE_GROUPPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.GRPCNetwork, "tcp")`. --addr | $STORAGE_GROUPPROVIDER_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.GRPCAddr, "0.0.0.0:9160")`. --endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Endpoint, "localhost:9160")`. --driver | $STORAGE_GROUPPROVIDER_DRIVER -: group driver: 'json', 'ldap', or 'rest'. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Driver, "ldap")`. --json-config | $STORAGE_GROUPPROVIDER_JSON -: Path to groups.json file. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.JSON, "")`. @@ -1544,8 +1504,11 @@ Usage: `storage groups [command options] [arguments...]` +### storage gateway +Start gateway +Usage: `storage gateway [command options] [arguments...]` @@ -1564,11 +1527,8 @@ Usage: `storage groups [command options] [arguments...]` -### storage health -Check health status -Usage: `storage health [command options] [arguments...]` @@ -1716,62 +1676,116 @@ Usage: `storage health [command options] [arguments...]` +-debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.DebugAddr, "0.0.0.0:9143")`. +-transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `flags.OverrideDefaultString(cfg.Reva.TransferSecret, "replace-me-with-a-transfer-secret")`. --debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9109")`. +-network | $STORAGE_GATEWAY_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.GRPCNetwork, "tcp")`. +-addr | $STORAGE_GATEWAY_GRPC_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.GRPCAddr, "0.0.0.0:9142")`. +-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. +-commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT +: Commit shares to the share manager. Default: `flags.OverrideDefaultBool(cfg.Reva.Gateway.CommitShareToStorageGrant, true)`. +-commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF +: Commit shares to the storage. Default: `flags.OverrideDefaultBool(cfg.Reva.Gateway.CommitShareToStorageRef, true)`. +-share-folder | $STORAGE_GATEWAY_SHARE_FOLDER +: mount shares in this folder of the home storage provider. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.ShareFolder, "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: `flags.OverrideDefaultString(cfg.Reva.Gateway.HomeMapping, "")`. +-auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT +: endpoint to use for the basic auth provider. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.Endpoint, "localhost:9146")`. +-auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT +: endpoint to use for the bearer auth provider. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.Endpoint, "localhost:9148")`. +-storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER +: driver of the storage registry. Default: `flags.OverrideDefaultString(cfg.Reva.StorageRegistry.Driver, "static")`. +-storage-home-provider | $STORAGE_STORAGE_REGISTRY_HOME_PROVIDER +: mount point of the storage provider for user homes in the global namespace. Default: `flags.OverrideDefaultString(cfg.Reva.StorageRegistry.HomeProvider, "/home")`. +-storage-registry-json | $STORAGE_STORAGE_REGISTRY_JSON +: JSON file containing the storage registry rules. Default: `flags.OverrideDefaultString(cfg.Reva.StorageRegistry.JSON, "")`. +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.PublicURL, "https://localhost:9200")`. +-datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL +: URL to use for the storage datagateway, defaults to /data. Default: `flags.OverrideDefaultString(cfg.Reva.DataGateway.PublicURL, "")`. +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. +-groupprovider-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: endpoint to use for the groupprovider. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Endpoint, "localhost:9160")`. +-sharing-endpoint | $STORAGE_SHARING_ENDPOINT +: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.Endpoint, "localhost:9150")`. +-storage-home-endpoint | $STORAGE_HOME_ENDPOINT +: endpoint to use for the home storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.Endpoint, "localhost:9154")`. +-storage-home-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountPath, "/home")`. +-storage-home-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountID, "1284d238-aa92-42ce-bdc4-0b0000009154")`. +-storage-users-endpoint | $STORAGE_USERS_ENDPOINT +: endpoint to use for the users storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.Endpoint, "localhost:9157")`. +-storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH +: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountPath, "/users")`. +-storage-users-mount-id | $STORAGE_USERS_MOUNT_ID +: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountID, "1284d238-aa92-42ce-bdc4-0b0000009157")`. +-public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT +: endpoint to use for the public links service. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.Endpoint, "localhost:9178")`. +-storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.MountPath, "/public")`. @@ -1787,18 +1801,18 @@ Usage: `storage health [command options] [arguments...]` -### storage storage -Storage service for oCIS -Usage: `storage storage [command options] [arguments...]` +### storage groups +Start groups service +Usage: `storage groups [command options] [arguments...]` @@ -1864,16 +1878,28 @@ Usage: `storage storage [command options] [arguments...]` +-debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.DebugAddr, "0.0.0.0:9161")`. +-network | $STORAGE_GROUPPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.GRPCNetwork, "tcp")`. +-addr | $STORAGE_GROUPPROVIDER_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.GRPCAddr, "0.0.0.0:9160")`. +-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Endpoint, "localhost:9160")`. +-driver | $STORAGE_GROUPPROVIDER_DRIVER +: group driver: 'json', 'ldap', or 'rest'. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Driver, "ldap")`. +-json-config | $STORAGE_GROUPPROVIDER_JSON +: Path to groups.json file. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.JSON, "")`. @@ -1943,20 +1969,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. @@ -2019,11 +2037,8 @@ Usage: `storage storage [command options] [arguments...]` -### storage sharing -Start sharing service -Usage: `storage sharing [command options] [arguments...]` @@ -2031,8 +2046,11 @@ Usage: `storage sharing [command options] [arguments...]` +### storage frontend +Start frontend service +Usage: `storage frontend [command options] [arguments...]` @@ -2052,36 +2070,68 @@ Usage: `storage sharing [command options] [arguments...]` +-debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.DebugAddr, "0.0.0.0:9141")`. +-transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `flags.OverrideDefaultString(cfg.Reva.TransferSecret, "replace-me-with-a-transfer-secret")`. +-webdav-namespace | $STORAGE_WEBDAV_NAMESPACE +: Namespace prefix for the /webdav endpoint. Default: `flags.OverrideDefaultString(cfg.Reva.OCDav.WebdavNamespace, "/home/")`. +-dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE +: Namespace prefix for the webdav /dav/files endpoint. Default: `flags.OverrideDefaultString(cfg.Reva.OCDav.DavFilesNamespace, "/users/")`. +-network | $STORAGE_FRONTEND_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.HTTPNetwork, "tcp")`. +-addr | $STORAGE_FRONTEND_HTTP_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.HTTPAddr, "0.0.0.0:9140")`. +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.PublicURL, "https://localhost:9200")`. +-datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX +: datagateway prefix. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.DatagatewayPrefix, "data")`. +-ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX +: owncloud webdav endpoint prefix. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCDavPrefix, "")`. +-ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX +: open collaboration services endpoint prefix. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCSPrefix, "ocs")`. +-ocs-share-prefix | $STORAGE_FRONTEND_OCS_SHARE_PREFIX +: the prefix prepended to the path of shared files. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCSSharePrefix, "/Shares")`. +-ocs-home-namespace | $STORAGE_FRONTEND_OCS_HOME_NAMESPACE +: the prefix prepended to the incoming requests in OCS. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCSHomeNamespace, "/home")`. +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. +-default-upload-protocol | $STORAGE_FRONTEND_DEFAULT_UPLOAD_PROTOCOL +: Default upload chunking protocol to be used out of tus/v1/ng. Default: `flags.OverrideDefaultString(cfg.Reva.DefaultUploadProtocol, "tus")`. +-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: `flags.OverrideDefaultString(cfg.Reva.UploadHTTPMethodOverride, "")`. +-checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE +: Specify the preferred checksum algorithm used for uploads. Default: `flags.OverrideDefaultString(cfg.Reva.ChecksumPreferredUploadType, "")`. @@ -2232,42 +2282,23 @@ Usage: `storage sharing [command options] [arguments...]` --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.DebugAddr, "0.0.0.0:9151")`. --network | $STORAGE_SHARING_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.GRPCNetwork, "tcp")`. --addr | $STORAGE_SHARING_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.GRPCAddr, "0.0.0.0:9150")`. --user-driver | $STORAGE_SHARING_USER_DRIVER -: driver to use for the UserShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.UserDriver, "json")`. --user-json-file | $STORAGE_SHARING_USER_JSON_FILE -: file used to persist shares for the UserShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.UserJSONFile, "/var/tmp/ocis/storage/shares.json")`. --public-driver | $STORAGE_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.PublicDriver, "json")`. --public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE -: file used to persist shares for the PublicShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.PublicJSONFile, "/var/tmp/ocis/storage/publicshares.json")`. --public-enable-expired-shares-cleanup | $STORAGE_SHARING_PUBLIC_ENABLE_EXPIRED_SHARES_CLEANUP -: whether to periodically delete expired public shares. Default: `flags.OverrideDefaultBool(cfg.Reva.Sharing.PublicEnableExpiredSharesCleanup, true)`. -### storage storage-metadata -Start storage-metadata service -Usage: `storage storage-metadata [command options] [arguments...]` @@ -2283,13 +2314,18 @@ Usage: `storage storage-metadata [command options] [arguments...]` +### storage health +Check health status +Usage: `storage health [command options] [arguments...]` +-debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9109")`. @@ -2310,48 +2346,26 @@ Usage: `storage storage-metadata [command options] [arguments...]` --debug-addr | $STORAGE_METADATA_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.DebugAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.GRPCNetwork, "tcp")`. --grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.GRPCAddr, "0.0.0.0:9215")`. --data-server-url | $STORAGE_METADATA_DATA_SERVER_URL -: URL of the data-provider the storage-provider uses. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.DataServerURL, "http://localhost:9216")`. --http-network | $STORAGE_METADATA_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.HTTPNetwork, "tcp")`. --http-addr | $STORAGE_METADATA_HTTP_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.HTTPAddr, "0.0.0.0:9216")`. --tmp-folder | $STORAGE_METADATA_TMP_FOLDER -: path to tmp folder. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.TempFolder, "/var/tmp/ocis/tmp/metadata")`. --driver | $STORAGE_METADATA_DRIVER -: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.Driver, "ocis")`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. --storage-root | $STORAGE_METADATA_ROOT -: the path to the metadata storage root. Default: `flags.OverrideDefaultString(cfg.Reva.Storages.Common.Root, "/var/tmp/ocis/storage/metadata")`. @@ -2452,20 +2466,12 @@ Usage: `storage storage-metadata [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. @@ -2528,14 +2534,14 @@ Usage: `storage storage-metadata [command options] [arguments...]` -### storage storage-public-link -Start storage-public-link service -Usage: `storage storage-public-link [command options] [arguments...]` +### storage storage-users +Start storage-users service +Usage: `storage storage-users [command options] [arguments...]` @@ -2668,49 +2674,67 @@ Usage: `storage storage-public-link [command options] [arguments...]` +-debug-addr | $STORAGE_USERS_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.DebugAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.GRPCNetwork, "tcp")`. +-grpc-addr | $STORAGE_USERS_GRPC_ADDR +: GRPC Address to bind users storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.GRPCAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.HTTPNetwork, "tcp")`. +-http-addr | $STORAGE_USERS_HTTP_ADDR +: HTTP Address to bind users storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.HTTPAddr, "0.0.0.0:9158")`. +-driver | $STORAGE_USERS_DRIVER +: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.Driver, "ocis")`. +-mount-path | $STORAGE_USERS_MOUNT_PATH +: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountPath, "/users")`. +-mount-id | $STORAGE_USERS_MOUNT_ID +: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountID, "1284d238-aa92-42ce-bdc4-0b0000009157")`. +-expose-data-server | $STORAGE_USERS_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `flags.OverrideDefaultBool(cfg.Reva.StorageUsers.ExposeDataServer, false)`. +-data-server-url | $STORAGE_USERS_DATA_SERVER_URL +: data server url. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.DataServerURL, "http://localhost:9158/data")`. +-http-prefix | $STORAGE_USERS_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.HTTPPrefix, "data")`. +-tmp-folder | $STORAGE_USERS_TMP_FOLDER +: path to tmp folder. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.TempFolder, "/var/tmp/ocis/tmp/users")`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. --debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.DebugAddr, "0.0.0.0:9179")`. +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. --network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.GRPCNetwork, "tcp")`. --addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.GRPCAddr, "0.0.0.0:9178")`. --mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.MountPath, "/public")`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. @@ -2763,11 +2787,8 @@ Usage: `storage storage-public-link [command options] [arguments...]` -### storage storage-users -Start storage-users service -Usage: `storage storage-users [command options] [arguments...]` @@ -2778,8 +2799,11 @@ Usage: `storage storage-users [command options] [arguments...]` +### storage auth-bearer +Start authprovider for bearer auth +Usage: `storage auth-bearer [command options] [arguments...]` @@ -2821,60 +2845,32 @@ Usage: `storage storage-users [command options] [arguments...]` --debug-addr | $STORAGE_USERS_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.DebugAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.GRPCNetwork, "tcp")`. --grpc-addr | $STORAGE_USERS_GRPC_ADDR -: GRPC Address to bind users storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.GRPCAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.HTTPNetwork, "tcp")`. --http-addr | $STORAGE_USERS_HTTP_ADDR -: HTTP Address to bind users storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.HTTPAddr, "0.0.0.0:9158")`. --driver | $STORAGE_USERS_DRIVER -: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.Driver, "ocis")`. --mount-path | $STORAGE_USERS_MOUNT_PATH -: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountPath, "/users")`. --mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountID, "1284d238-aa92-42ce-bdc4-0b0000009157")`. --expose-data-server | $STORAGE_USERS_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `flags.OverrideDefaultBool(cfg.Reva.StorageUsers.ExposeDataServer, false)`. --data-server-url | $STORAGE_USERS_DATA_SERVER_URL -: data server url. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.DataServerURL, "http://localhost:9158/data")`. --http-prefix | $STORAGE_USERS_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.HTTPPrefix, "data")`. --tmp-folder | $STORAGE_USERS_TMP_FOLDER -: path to tmp folder. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.TempFolder, "/var/tmp/ocis/tmp/users")`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. @@ -2905,22 +2901,40 @@ Usage: `storage storage-users [command options] [arguments...]` +-debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.DebugAddr, "0.0.0.0:9149")`. +-oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL +: OIDC issuer. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.Issuer, "https://localhost:9200")`. +-oidc-insecure | $STORAGE_OIDC_INSECURE +: OIDC allow insecure communication. Default: `flags.OverrideDefaultBool(cfg.Reva.OIDC.Insecure, true)`. +-oidc-id-claim | $STORAGE_OIDC_ID_CLAIM +: OIDC id claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.IDClaim, "preferred_username")`. +-oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM +: OIDC uid claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.UIDClaim, "")`. +-oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM +: OIDC gid claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.GIDClaim, "")`. +-network | $STORAGE_AUTH_BEARER_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.GRPCNetwork, "tcp")`. +-addr | $STORAGE_AUTH_BEARER_GRPC_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.GRPCAddr, "0.0.0.0:9148")`. +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. @@ -3025,18 +3039,18 @@ Usage: `storage storage-users [command options] [arguments...]` -### storage storage-home -Start storage-home service -Usage: `storage storage-home [command options] [arguments...]` +### storage sharing +Start sharing service +Usage: `storage sharing [command options] [arguments...]` @@ -3057,64 +3071,34 @@ Usage: `storage storage-home [command options] [arguments...]` --debug-addr | $STORAGE_HOME_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.DebugAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageHome.GRPCNetwork, "tcp")`. --grpc-addr | $STORAGE_HOME_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.GRPCAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPNetwork, "tcp")`. --http-addr | $STORAGE_HOME_HTTP_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPAddr, "0.0.0.0:9155")`. --driver | $STORAGE_HOME_DRIVER -: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.Driver, "ocis")`. --mount-path | $STORAGE_HOME_MOUNT_PATH -: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountPath, "/home")`. --mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountID, "1284d238-aa92-42ce-bdc4-0b0000009157")`. --expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `flags.OverrideDefaultBool(cfg.Reva.StorageHome.ExposeDataServer, false)`. --data-server-url | $STORAGE_HOME_DATA_SERVER_URL -: data server url. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.DataServerURL, "http://localhost:9155/data")`. --http-prefix | $STORAGE_HOME_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPPrefix, "data")`. --tmp-folder | $STORAGE_HOME_TMP_FOLDER -: path to tmp folder. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.TempFolder, "/var/tmp/ocis/tmp/home")`. --enable-home | $STORAGE_HOME_ENABLE_HOME -: enable the creation of home directories. Default: `flags.OverrideDefaultBool(cfg.Reva.Storages.Home.EnableHome, true)`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. @@ -3275,20 +3259,36 @@ Usage: `storage storage-home [command options] [arguments...]` +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.DebugAddr, "0.0.0.0:9151")`. +-network | $STORAGE_SHARING_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.GRPCNetwork, "tcp")`. +-addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.GRPCAddr, "0.0.0.0:9150")`. +-user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.UserDriver, "json")`. +-user-json-file | $STORAGE_SHARING_USER_JSON_FILE +: file used to persist shares for the UserShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.UserJSONFile, "/var/tmp/ocis/storage/shares.json")`. +-public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.PublicDriver, "json")`. +-public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE +: file used to persist shares for the PublicShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.PublicJSONFile, "/var/tmp/ocis/storage/publicshares.json")`. +-public-enable-expired-shares-cleanup | $STORAGE_SHARING_PUBLIC_ENABLE_EXPIRED_SHARES_CLEANUP +: whether to periodically delete expired public shares. Default: `flags.OverrideDefaultBool(cfg.Reva.Sharing.PublicEnableExpiredSharesCleanup, true)`. ### storage users @@ -3362,28 +3362,16 @@ Usage: `storage users [command options] [arguments...]` --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Users.DebugAddr, "0.0.0.0:9145")`. --network | $STORAGE_USERPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Users.GRPCNetwork, "tcp")`. --addr | $STORAGE_USERPROVIDER_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.GRPCAddr, "0.0.0.0:9144")`. --endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. --driver | $STORAGE_USERPROVIDER_DRIVER -: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Driver, "ldap")`. --json-config | $STORAGE_USERPROVIDER_JSON -: Path to users.json file. Default: `flags.OverrideDefaultString(cfg.Reva.Users.JSON, "")`. @@ -3464,16 +3452,28 @@ Usage: `storage users [command options] [arguments...]` +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Users.DebugAddr, "0.0.0.0:9145")`. +-network | $STORAGE_USERPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Users.GRPCNetwork, "tcp")`. +-addr | $STORAGE_USERPROVIDER_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.GRPCAddr, "0.0.0.0:9144")`. +-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. +-driver | $STORAGE_USERPROVIDER_DRIVER +: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Driver, "ldap")`. +-json-config | $STORAGE_USERPROVIDER_JSON +: Path to users.json file. Default: `flags.OverrideDefaultString(cfg.Reva.Users.JSON, "")`. diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index f366a075d02..f53e77649d3 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-30T13:08:19+0000" +date: "2021-07-01T07:54:44+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates @@ -35,35 +35,6 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### store health - -Check health status - -Usage: `store health [command options] [arguments...]` - - - - - - --debug-addr | $STORE_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9460")`. - - - - - - - - - - - - - - - - ### store ocis-store Service to store values for ocis extensions @@ -199,3 +170,32 @@ Usage: `store version [command options] [arguments...]` -name | $STORE_NAME : Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "store")`. +### store health + +Check health status + +Usage: `store health [command options] [arguments...]` + + + + + + +-debug-addr | $STORE_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9460")`. + + + + + + + + + + + + + + + + diff --git a/extensions/thumbnails/configuration.md b/extensions/thumbnails/configuration.md index d2712e0109c..3350c3be5e6 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-30T13:08:19+0000" +date: "2021-07-01T07:54:45+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 1c9cd285f88..bb0657ab8d5 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-30T13:08:20+0000" +date: "2021-07-01T07:54:45+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/web/templates @@ -70,43 +70,6 @@ Usage: `web [global options] command [command options] [arguments...]` ## Sub Commands - -### web health - -Check health status - -Usage: `web health [command options] [arguments...]` - - - - - --debug-addr | $WEB_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9104")`. - - - - - - - - - - - - - - - - - - - - - - - - ### web server @@ -222,4 +185,41 @@ Usage: `web server [command options] [arguments...]` -oidc-scope | $WEB_OIDC_SCOPE : OpenID Connect scope. Default: `flags.OverrideDefaultString(cfg.Web.Config.OpenIDConnect.Scope, "openid profile email")`. + +### web health + +Check health status + +Usage: `web health [command options] [arguments...]` + + + + + +-debug-addr | $WEB_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9104")`. + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index 5d44e32a07c..1b47deb3fd2 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-30T13:08:20+0000" +date: "2021-07-01T07:54:45+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates @@ -66,41 +66,6 @@ Usage: `webdav [global options] command [command options] [arguments...]` ## Sub Commands -### webdav version - -Print the versions of the running instances - -Usage: `webdav version [command options] [arguments...]` - - - - - - - - - - - - - - - - - - - - - - - --http-namespace | $WEBDAV_HTTP_NAMESPACE -: Set the base namespace for service discovery. Default: `flags.OverrideDefaultString(cfg.Service.Namespace, "com.owncloud.web")`. - - --service-name | $WEBDAV_SERVICE_NAME -: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "webdav")`. - ### webdav health Check health status @@ -222,3 +187,38 @@ Usage: `webdav server [command options] [arguments...]` +### webdav version + +Print the versions of the running instances + +Usage: `webdav version [command options] [arguments...]` + + + + + + + + + + + + + + + + + + + + + + + +-http-namespace | $WEBDAV_HTTP_NAMESPACE +: Set the base namespace for service discovery. Default: `flags.OverrideDefaultString(cfg.Service.Namespace, "com.owncloud.web")`. + + +-service-name | $WEBDAV_SERVICE_NAME +: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "webdav")`. + diff --git a/ocis/configuration.md b/ocis/configuration.md index a803aac59b9..e53afea53cd 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-30T13:08:18+0000" +date: "2021-07-01T07:54:43+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -107,11 +107,11 @@ Usage: `ocis [global options] command [command options] [arguments...]` ## Sub Commands -### ocis run +### ocis health -Runs an extension +Check health status -Usage: `ocis run [command options] [arguments...]` +Usage: `ocis health [command options] [arguments...]` @@ -127,6 +127,8 @@ Usage: `ocis run [command options] [arguments...]` +-debug-addr | $OCIS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9010`. @@ -134,12 +136,12 @@ Usage: `ocis run [command options] [arguments...]` -### ocis server -Start fullstack server +### ocis list -Usage: `ocis server [command options] [arguments...]` +Lists running ocis extensions +Usage: `ocis list [command options] [arguments...]` @@ -155,38 +157,24 @@ Usage: `ocis server [command options] [arguments...]` --debug-addr | $OCIS_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9010`. --debug-token | $OCIS_DEBUG_TOKEN -: Token to grant metrics access. --debug-pprof | $OCIS_DEBUG_PPROF -: Enable pprof debugging. --debug-zpages | $OCIS_DEBUG_ZPAGES -: Enable zpages debugging. +### ocis run --http-addr | $OCIS_HTTP_ADDR -: Address to bind http server. Default: `0.0.0.0:9000`. +Runs an extension +Usage: `ocis run [command options] [arguments...]` --http-root | $OCIS_HTTP_ROOT -: Root path of http server. Default: `/`. --grpc-addr | $OCIS_GRPC_ADDR -: Address to bind grpc server. Default: `0.0.0.0:9001`. -### ocis health -Check health status -Usage: `ocis health [command options] [arguments...]` @@ -202,21 +190,19 @@ Usage: `ocis health [command options] [arguments...]` --debug-addr | $OCIS_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9010`. +### ocis kill +Kill an extension by name +Usage: `ocis kill [command options] [arguments...]` -### ocis kill -Kill an extension by name -Usage: `ocis kill [command options] [arguments...]` @@ -232,18 +218,18 @@ Usage: `ocis kill [command options] [arguments...]` +### ocis server +Start fullstack server +Usage: `ocis server [command options] [arguments...]` -### ocis list -Lists running ocis extensions -Usage: `ocis list [command options] [arguments...]` @@ -253,110 +239,124 @@ Usage: `ocis list [command options] [arguments...]` +-debug-addr | $OCIS_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9010`. +-debug-token | $OCIS_DEBUG_TOKEN +: Token to grant metrics access. +-debug-pprof | $OCIS_DEBUG_PPROF +: Enable pprof debugging. +-debug-zpages | $OCIS_DEBUG_ZPAGES +: Enable zpages debugging. +-http-addr | $OCIS_HTTP_ADDR +: Address to bind http server. Default: `0.0.0.0:9000`. +-http-root | $OCIS_HTTP_ROOT +: Root path of http server. Default: `/`. +-grpc-addr | $OCIS_GRPC_ADDR +: Address to bind grpc server. Default: `0.0.0.0:9001`. ### List of available Extension subcommands 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 webdav +#### ocis storage-metadata -Start webdav server +Start storage and data service for metadata -#### ocis settings +#### ocis storage-userprovider -Start settings server +Start storage userprovider service -#### ocis storage-auth-bearer +#### ocis version -Start storage auth-bearer service +Lists running services with version -#### ocis storage-groupprovider +#### ocis glauth -Start storage groupprovider service +Start glauth server -#### ocis storage-metadata +#### ocis storage-sharing -Start storage and data service for metadata +Start storage sharing service -#### ocis thumbnails +#### ocis store -Start thumbnails server +Start a go-micro store -#### ocis version +#### ocis thumbnails -Lists running services with version +Start thumbnails server -#### ocis storage-userprovider +#### ocis onlyoffice -Start storage userprovider service +Start onlyoffice server -#### ocis storage-users +#### ocis storage-frontend -Start storage and data provider for /users mount +Start storage frontend -#### ocis glauth +#### ocis accounts -Start glauth server +Start accounts server -#### ocis onlyoffice +#### ocis storage-home -Start onlyoffice server +Start storage and data provider for /home mount -#### ocis storage-auth-basic +#### ocis storage-public-link -Start storage auth-basic service +Start storage public link storage -#### ocis proxy +#### ocis storage-users -Start proxy server +Start storage and data provider for /users mount -#### ocis store +#### ocis web -Start a go-micro store +Start web server -#### ocis accounts +#### ocis settings -Start accounts server +Start settings server -#### ocis storage-frontend +#### ocis storage-groupprovider -Start storage frontend +Start storage groupprovider service -#### ocis storage-public-link +#### ocis webdav -Start storage public link storage +Start webdav server #### ocis ocs Start ocs server -#### ocis idp +#### ocis storage-auth-basic -Start idp server +Start storage auth-basic service -#### ocis web +#### ocis storage-auth-bearer -Start web server +Start storage auth-bearer service -#### ocis storage-home +#### ocis idp -Start storage and data provider for /home mount +Start idp server -#### ocis storage-sharing +#### ocis proxy -Start storage sharing service +Start proxy server #### ocis storage-gateway