diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 0eeb116ec3c..cd7936ad4b5 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-07T08:36:22+0000" +date: "2021-07-07T15:30:23+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 commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### accounts version +### accounts add -Print the versions of the running instances +Create a new account -Usage: `accounts version [command options] [arguments...]` +Usage: `accounts add [command options] [arguments...]` @@ -90,41 +90,64 @@ Usage: `accounts version [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. --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-gidnumber | +: Set the gidnumber for the account. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. +-mail | +: Set the mail for the account. +-description | +: Set the description for the account. -### accounts add +-password | +: Set the password for the account. -Create a new account -Usage: `accounts add [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. @@ -132,8 +155,11 @@ Usage: `accounts add [command options] [arguments...]` +### accounts inspect +Show detailed data on an existing account +Usage: `accounts inspect [command options] [arguments...]` @@ -171,70 +197,44 @@ 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. +-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 @@ -311,27 +311,17 @@ Usage: `accounts rebuildIndex [command options] [arguments...]` -### accounts ocis-accounts - -Provide accounts and groups for oCIS - -Usage: `accounts ocis-accounts [command options] [arguments...]` +### accounts remove +Removes an existing account --log-level | $ACCOUNTS_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. +Usage: `accounts remove [command options] [arguments...]` --log-pretty | $ACCOUNTS_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $ACCOUNTS_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. --extensions | -: Run specific extensions during supervised mode. @@ -393,8 +383,12 @@ Usage: `accounts ocis-accounts [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"`. @@ -515,15 +509,11 @@ Usage: `accounts update [command options] [arguments...]` -### accounts inspect - -Show detailed data on an existing account - -Usage: `accounts inspect [command options] [arguments...]` - - +### accounts version +Print the versions of the running instances +Usage: `accounts version [command options] [arguments...]` @@ -596,6 +586,10 @@ Usage: `accounts inspect [command options] [arguments...]` -name | $ACCOUNTS_NAME : service name. Default: `"accounts"`. + + + + ### accounts list List existing accounts @@ -677,17 +671,27 @@ Usage: `accounts list [command options] [arguments...]` -### accounts remove +### accounts ocis-accounts -Removes an existing account +Provide accounts and groups for oCIS -Usage: `accounts remove [command options] [arguments...]` +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. +-extensions | +: Run specific extensions during supervised mode. @@ -749,12 +753,8 @@ 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"`. diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index dd86f0c50e3..7b90f7e5bcd 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-07T08:37:08+0000" +date: "2021-07-07T15:31:24+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 1f4bdfa524a..5777e9aa698 100644 --- a/extensions/graph-explorer/configuration.md +++ b/extensions/graph-explorer/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-07T08:37:08+0000" +date: "2021-07-07T15:31:24+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 48214507c91..e24cfa9b8db 100644 --- a/extensions/graph/configuration.md +++ b/extensions/graph/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-07T08:37:08+0000" +date: "2021-07-07T15:31:24+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 01c07645905..f9d722b4e01 100644 --- a/extensions/idp/configuration.md +++ b/extensions/idp/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-07T08:37:08+0000" +date: "2021-07-07T15:31:24+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 93be2f71b9c..cf3373b7c82 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-07T08:37:08+0000" +date: "2021-07-07T15:31:25+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/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 commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### ocs version +### ocs ocis-ocs -Print the versions of the running instances +Serve OCS API for oCIS -Usage: `ocs version [command options] [arguments...]` +Usage: `ocs ocis-ocs [command options] [arguments...]` @@ -67,75 +67,117 @@ Usage: `ocs version [command options] [arguments...]` --http-namespace | $OCS_NAMESPACE -: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. +### ocs server --name | $OCS_NAME -: Service name. Default: `"ocs"`. +Start integrated server -### ocs health +Usage: `ocs server [command options] [arguments...]` -Check health status -Usage: `ocs health [command options] [arguments...]` +-log-file | $OCS_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. --debug-addr | $OCS_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9114"`. +-log-level | $OCS_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $OCS_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $OCS_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. +-config-file | $OCS_CONFIG_FILE +: Path to config file. +-tracing-enabled | $OCS_TRACING_ENABLED +: Enable sending traces. Default: `false`. +-tracing-type | $OCS_TRACING_TYPE +: Tracing backend type. Default: `"jaeger"`. +-tracing-endpoint | $OCS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. +-tracing-collector | $OCS_TRACING_COLLECTOR +: Endpoint for the collector. Default: `""`. +-tracing-service | $OCS_TRACING_SERVICE +: Service name for tracing. Default: `"ocs"`. +-debug-addr | $OCS_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9114"`. +-debug-token | $OCS_DEBUG_TOKEN +: Token to grant metrics access. Default: `""`. +-debug-pprof | $OCS_DEBUG_PPROF +: Enable pprof debugging. +-debug-zpages | $OCS_DEBUG_ZPAGES +: Enable zpages debugging. -### ocs ocis-ocs +-http-addr | $OCS_HTTP_ADDR +: Address to bind http server. Default: `"0.0.0.0:9110"`. -Serve OCS API for oCIS -Usage: `ocs ocis-ocs [command options] [arguments...]` +-http-namespace | $OCS_NAMESPACE +: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. +-name | $OCS_NAME +: Service name. Default: `"ocs"`. +-http-root | $OCS_HTTP_ROOT +: Root path of http server. Default: `"/ocs"`. +-jwt-secret | $OCS_JWT_SECRET , $OCIS_JWT_SECRET +: Used to dismantle the access token, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. +-account-backend-type | $OCS_ACCOUNT_BACKEND_TYPE +: account-backend-type. Default: `"accounts"`. +-reva-gateway-addr | $OCS_REVA_GATEWAY_ADDR +: REVA Gateway Endpoint. Default: `"127.0.0.1:9142"`. +-idm-address | $OCS_IDM_ADDRESS , $OCIS_URL +: keeps track of the IDM Address. Needed because of Reva requisite of uniqueness for users. Default: `"https://localhost:9200"`. +-users-driver | $OCS_STORAGE_USERS_DRIVER , $STORAGE_USERS_DRIVER +: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. +-extensions | +: Run specific extensions during supervised mode. +### ocs version +Print the versions of the running instances +Usage: `ocs version [command options] [arguments...]` @@ -143,108 +185,66 @@ Usage: `ocs ocis-ocs [command options] [arguments...]` -### ocs server -Start integrated server -Usage: `ocs server [command options] [arguments...]` --log-file | $OCS_LOG_FILE , $OCIS_LOG_FILE -: Enable log to file. --log-level | $OCS_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. --log-pretty | $OCS_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $OCS_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. --config-file | $OCS_CONFIG_FILE -: Path to config file. --tracing-enabled | $OCS_TRACING_ENABLED -: Enable sending traces. Default: `false`. --tracing-type | $OCS_TRACING_TYPE -: Tracing backend type. Default: `"jaeger"`. --tracing-endpoint | $OCS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. +-http-namespace | $OCS_NAMESPACE +: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. --tracing-collector | $OCS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `""`. +-name | $OCS_NAME +: Service name. Default: `"ocs"`. --tracing-service | $OCS_TRACING_SERVICE -: Service name for tracing. Default: `"ocs"`. +### ocs health +Check health status --debug-addr | $OCS_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9114"`. +Usage: `ocs health [command options] [arguments...]` --debug-token | $OCS_DEBUG_TOKEN -: Token to grant metrics access. Default: `""`. +-debug-addr | $OCS_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9114"`. --debug-pprof | $OCS_DEBUG_PPROF -: Enable pprof debugging. --debug-zpages | $OCS_DEBUG_ZPAGES -: Enable zpages debugging. --http-addr | $OCS_HTTP_ADDR -: Address to bind http server. Default: `"0.0.0.0:9110"`. --http-namespace | $OCS_NAMESPACE -: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. --name | $OCS_NAME -: Service name. Default: `"ocs"`. --http-root | $OCS_HTTP_ROOT -: Root path of http server. Default: `"/ocs"`. --jwt-secret | $OCS_JWT_SECRET , $OCIS_JWT_SECRET -: Used to dismantle the access token, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. --account-backend-type | $OCS_ACCOUNT_BACKEND_TYPE -: account-backend-type. Default: `"accounts"`. --reva-gateway-addr | $OCS_REVA_GATEWAY_ADDR -: REVA Gateway Endpoint. Default: `"127.0.0.1:9142"`. --idm-address | $OCS_IDM_ADDRESS , $OCIS_URL -: keeps track of the IDM Address. Needed because of Reva requisite of uniqueness for users. Default: `"https://localhost:9200"`. --users-driver | $OCS_STORAGE_USERS_DRIVER , $STORAGE_USERS_DRIVER -: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. --extensions | -: Run specific extensions during supervised mode. diff --git a/extensions/onlyoffice/configuration.md b/extensions/onlyoffice/configuration.md index a78a5670eae..c14ea0e837a 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-07T08:37:08+0000" +date: "2021-07-07T15:31:25+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 6f79d0d9d26..51cf789c1b6 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-07T08:37:08+0000" +date: "2021-07-07T15:31:25+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/proxy/templates @@ -34,54 +34,6 @@ 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. - -### 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 @@ -343,4 +295,52 @@ 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 14abafd3a5a..f5f71d5329e 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-07T08:37:08+0000" +date: "2021-07-07T15:31:25+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/settings/templates @@ -35,23 +35,17 @@ 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. -### settings ocis-settings +### settings version -Provide settings and permissions for oCIS +Print the versions of the running instances -Usage: `settings ocis-settings [command options] [arguments...]` +Usage: `settings version [command options] [arguments...]` --log-level | $SETTINGS_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. --log-pretty | $SETTINGS_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $SETTINGS_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. @@ -73,111 +67,81 @@ Usage: `settings ocis-settings [command options] [arguments...]` +-grpc-namespace | $SETTINGS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $SETTINGS_NAME +: service name. Default: `"settings"`. +### settings health -### settings server +Check health status -Start integrated server +Usage: `settings health [command options] [arguments...]` -Usage: `settings server [command options] [arguments...]` +-debug-addr | $SETTINGS_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9194"`. --config-file | $SETTINGS_CONFIG_FILE -: Path to config file. --tracing-enabled | $SETTINGS_TRACING_ENABLED -: Enable sending traces. --tracing-type | $SETTINGS_TRACING_TYPE -: Tracing backend type. Default: `"jaeger"`. --tracing-endpoint | $SETTINGS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. --tracing-collector | $SETTINGS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `""`. --tracing-service | $SETTINGS_TRACING_SERVICE -: Service name for tracing. Default: `"settings"`. --debug-addr | $SETTINGS_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9194"`. --debug-token | $SETTINGS_DEBUG_TOKEN -: Token to grant metrics access. Default: `""`. --debug-pprof | $SETTINGS_DEBUG_PPROF -: Enable pprof debugging. --debug-zpages | $SETTINGS_DEBUG_ZPAGES -: Enable zpages debugging. --http-addr | $SETTINGS_HTTP_ADDR -: Address to bind http server. Default: `"0.0.0.0:9190"`. --http-namespace | $SETTINGS_HTTP_NAMESPACE -: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. +### settings ocis-settings +Provide settings and permissions for oCIS --http-root | $SETTINGS_HTTP_ROOT -: Root path of http server. Default: `"/"`. +Usage: `settings ocis-settings [command options] [arguments...]` --http-cache-ttl | $SETTINGS_CACHE_TTL -: Set the static assets caching duration in seconds. Default: `604800`. +-log-level | $SETTINGS_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. --grpc-addr | $SETTINGS_GRPC_ADDR -: Address to bind grpc server. Default: `"0.0.0.0:9191"`. +-log-pretty | $SETTINGS_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. --asset-path | $SETTINGS_ASSET_PATH -: Path to custom assets. Default: `""`. +-log-color | $SETTINGS_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. --grpc-namespace | $SETTINGS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $SETTINGS_NAME -: service name. Default: `"settings"`. --data-path | $SETTINGS_DATA_PATH -: Mount path for the storage. Default: `"/var/tmp/ocis/settings"`. --jwt-secret | $SETTINGS_JWT_SECRET , $OCIS_JWT_SECRET -: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. --extensions | -: Run specific extensions during supervised mode. This flag is set by the runtime. -### settings version -Print the versions of the running instances -Usage: `settings version [command options] [arguments...]` @@ -188,63 +152,99 @@ Usage: `settings version [command options] [arguments...]` +### settings server +Start integrated server +Usage: `settings server [command options] [arguments...]` +-config-file | $SETTINGS_CONFIG_FILE +: Path to config file. +-tracing-enabled | $SETTINGS_TRACING_ENABLED +: Enable sending traces. +-tracing-type | $SETTINGS_TRACING_TYPE +: Tracing backend type. Default: `"jaeger"`. +-tracing-endpoint | $SETTINGS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. +-tracing-collector | $SETTINGS_TRACING_COLLECTOR +: Endpoint for the collector. Default: `""`. --grpc-namespace | $SETTINGS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-tracing-service | $SETTINGS_TRACING_SERVICE +: Service name for tracing. Default: `"settings"`. --name | $SETTINGS_NAME -: service name. Default: `"settings"`. -### settings health +-debug-addr | $SETTINGS_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9194"`. -Check health status -Usage: `settings health [command options] [arguments...]` +-debug-token | $SETTINGS_DEBUG_TOKEN +: Token to grant metrics access. Default: `""`. +-debug-pprof | $SETTINGS_DEBUG_PPROF +: Enable pprof debugging. +-debug-zpages | $SETTINGS_DEBUG_ZPAGES +: Enable zpages debugging. --debug-addr | $SETTINGS_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9194"`. +-http-addr | $SETTINGS_HTTP_ADDR +: Address to bind http server. Default: `"0.0.0.0:9190"`. +-http-namespace | $SETTINGS_HTTP_NAMESPACE +: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. +-http-root | $SETTINGS_HTTP_ROOT +: Root path of http server. Default: `"/"`. +-http-cache-ttl | $SETTINGS_CACHE_TTL +: Set the static assets caching duration in seconds. Default: `604800`. +-grpc-addr | $SETTINGS_GRPC_ADDR +: Address to bind grpc server. Default: `"0.0.0.0:9191"`. +-asset-path | $SETTINGS_ASSET_PATH +: Path to custom assets. Default: `""`. +-grpc-namespace | $SETTINGS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $SETTINGS_NAME +: service name. Default: `"settings"`. +-data-path | $SETTINGS_DATA_PATH +: Mount path for the storage. Default: `"/var/tmp/ocis/settings"`. +-jwt-secret | $SETTINGS_JWT_SECRET , $OCIS_JWT_SECRET +: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. +-extensions | +: Run specific extensions during supervised mode. This flag is set by the runtime. diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index 0dd412a95ab..93ebbae7ab1 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-07T08:37:09+0000" +date: "2021-07-07T15:31:25+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -101,12 +101,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. @@ -262,20 +270,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. @@ -298,11 +298,11 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage gateway +### storage storage-home -Start gateway +Start storage-home service -Usage: `storage gateway [command options] [arguments...]` +Usage: `storage storage-home [command options] [arguments...]` @@ -407,132 +407,114 @@ 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 + + + + + + + + + + + + + + +-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"`. --addr | $STORAGE_GATEWAY_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9142"`. +-grpc-addr | $STORAGE_HOME_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9154"`. --endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9142"`. +-http-network | $STORAGE_HOME_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --service | $STORAGE_GATEWAY_SERVICES -: --service gateway [--service authregistry]. Default: `cli.NewStringSlice("gateway", "authregistry", "storageregistry")`. +-http-addr | $STORAGE_HOME_HTTP_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9155"`. --commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT -: Commit shares to the share manager. Default: `true`. +-driver | $STORAGE_HOME_DRIVER +: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. --commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF -: Commit shares to the storage. Default: `true`. +-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `"/home"`. --share-folder | $STORAGE_GATEWAY_SHARE_FOLDER -: mount shares in this folder of the home storage provider. Default: `"Shares"`. +-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. --disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN -: Disable creation of home folder on login. +-expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. --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: `""`. +-data-server-url | $STORAGE_HOME_DATA_SERVER_URL +: data server url. Default: `"http://localhost:9155/data"`. --etag-cache-ttl | $STORAGE_GATEWAY_ETAG_CACHE_TTL -: TTL for the home and shares directory etags cache. Default: `0`. +-http-prefix | $STORAGE_HOME_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `"data"`. --auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT -: endpoint to use for the basic auth provider. Default: `"localhost:9146"`. +-tmp-folder | $STORAGE_HOME_TMP_FOLDER +: path to tmp folder. Default: `"/var/tmp/ocis/tmp/home"`. --auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT -: endpoint to use for the bearer auth provider. Default: `"localhost:9148"`. +-enable-home | $STORAGE_HOME_ENABLE_HOME +: enable the creation of home directories. Default: `true`. --storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER -: driver of the storage registry. Default: `"static"`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `"localhost:9142"`. --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()`. +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9144"`. --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: `""`. --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"`. --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"`. @@ -610,8 +592,11 @@ Usage: `storage gateway [command options] [arguments...]` +### storage storage-public-link +Start storage-public-link service +Usage: `storage storage-public-link [command options] [arguments...]` @@ -643,11 +628,8 @@ Usage: `storage gateway [command options] [arguments...]` -### storage storage-users -Start storage-users service -Usage: `storage storage-users [command options] [arguments...]` @@ -681,14 +663,24 @@ Usage: `storage storage-users [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"`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `"localhost:9142"`. @@ -864,8 +856,11 @@ Usage: `storage storage-users [command options] [arguments...]` +### storage users +Start users service +Usage: `storage users [command options] [arguments...]` @@ -874,71 +869,97 @@ 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9145"`. + + +-network | $STORAGE_USERPROVIDER_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"`. +-addr | $STORAGE_USERPROVIDER_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9144"`. --driver | $STORAGE_USERS_DRIVER -: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. +-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `"localhost:9144"`. --mount-path | $STORAGE_USERS_MOUNT_PATH -: mount path. Default: `"/users"`. +-service | $STORAGE_USERPROVIDER_SERVICES +: --service userprovider [--service otherservice]. Default: `cli.NewStringSlice("userprovider")`. --mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. +-driver | $STORAGE_USERPROVIDER_DRIVER +: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `"ldap"`. --expose-data-server | $STORAGE_USERS_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. +-json-config | $STORAGE_USERPROVIDER_JSON +: Path to users.json file. Default: `""`. --data-server-url | $STORAGE_USERS_DATA_SERVER_URL -: data server url. Default: `"http://localhost:9158/data"`. +-user-groups-cache-expiration | $STORAGE_USER_CACHE_EXPIRATION +: Time in minutes for redis cache expiration.. Default: `5`. --http-prefix | $STORAGE_USERS_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `"data"`. --tmp-folder | $STORAGE_USERS_TMP_FOLDER -: path to tmp folder. Default: `"/var/tmp/ocis/tmp/users"`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `"localhost:9142"`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9144"`. -### storage groups -Start groups service -Usage: `storage groups [command options] [arguments...]` @@ -1108,8 +1129,11 @@ Usage: `storage groups [command options] [arguments...]` +### storage auth-basic +Start authprovider for basic auth +Usage: `storage auth-basic [command options] [arguments...]` @@ -1143,36 +1167,20 @@ Usage: `storage groups [command options] [arguments...]` --debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9161"`. --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`. @@ -1197,21 +1205,32 @@ Usage: `storage groups [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: `""`. +-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"`. -### storage sharing +-service | $STORAGE_AUTH_BASIC_SERVICES +: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. -Start sharing service -Usage: `storage sharing [command options] [arguments...]` +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `"localhost:9142"`. @@ -1249,48 +1268,26 @@ Usage: `storage sharing [command options] [arguments...]` --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9151"`. --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`. @@ -1402,8 +1399,11 @@ Usage: `storage sharing [command options] [arguments...]` +### storage health +Check health status +Usage: `storage health [command options] [arguments...]` @@ -1489,12 +1489,11 @@ Usage: `storage sharing [command options] [arguments...]` -### storage storage-home -Start storage-home service -Usage: `storage storage-home [command options] [arguments...]` +-debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9109"`. @@ -1630,64 +1629,37 @@ Usage: `storage storage-home [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"`. --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"`. +### storage frontend +Start frontend service --enable-home | $STORAGE_HOME_ENABLE_HOME -: enable the creation of home directories. Default: `true`. +Usage: `storage frontend [command options] [arguments...]` --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `"localhost:9142"`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9144"`. @@ -1783,11 +1755,8 @@ Usage: `storage storage-home [command options] [arguments...]` -### storage users -Start users service -Usage: `storage users [command options] [arguments...]` @@ -1852,54 +1821,89 @@ Usage: `storage users [command options] [arguments...]` --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9145"`. --network | $STORAGE_USERPROVIDER_NETWORK + + + +-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/"`. + + +-network | $STORAGE_FRONTEND_HTTP_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"`. +-addr | $STORAGE_FRONTEND_HTTP_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9140"`. --endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `"localhost:9144"`. +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `"https://localhost:9200"`. --service | $STORAGE_USERPROVIDER_SERVICES -: --service userprovider [--service otherservice]. Default: `cli.NewStringSlice("userprovider")`. +-service | $STORAGE_FRONTEND_SERVICES +: --service ocdav [--service ocs]. Default: `cli.NewStringSlice("datagateway", "ocdav", "ocs")`. --driver | $STORAGE_USERPROVIDER_DRIVER -: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `"ldap"`. +-datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX +: datagateway prefix. Default: `"data"`. --json-config | $STORAGE_USERPROVIDER_JSON -: Path to users.json file. Default: `""`. +-ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX +: owncloud webdav endpoint prefix. Default: `""`. --user-groups-cache-expiration | $STORAGE_USER_CACHE_EXPIRATION -: Time in minutes for redis cache expiration.. Default: `5`. +-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"`. +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `"localhost: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-suppored-type | $STORAGE_FRONTEND_CHECKSUM_SUPPORTED_TYPES +: --checksum-suppored-type sha1 [--checksum-suppored-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: `""`. +-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.. @@ -1956,8 +1960,11 @@ Usage: `storage users [command options] [arguments...]` +### storage gateway +Start gateway +Usage: `storage gateway [command options] [arguments...]` @@ -1968,64 +1975,132 @@ Usage: `storage users [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 storage service. Default: `"0.0.0.0:9142"`. +-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9142"`. +-service | $STORAGE_GATEWAY_SERVICES +: --service gateway [--service authregistry]. Default: `cli.NewStringSlice("gateway", "authregistry", "storageregistry")`. +-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: `""`. +-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"`. +-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"`. @@ -2056,39 +2131,22 @@ Usage: `storage users [command options] [arguments...]` -### 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: `""`. --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")`. --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `"localhost:9142"`. @@ -2247,8 +2305,11 @@ Usage: `storage auth-basic [command options] [arguments...]` +### storage storage +Storage service for oCIS +Usage: `storage storage [command options] [arguments...]` @@ -2310,12 +2371,20 @@ Usage: `storage auth-basic [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. @@ -2326,11 +2395,8 @@ Usage: `storage auth-basic [command options] [arguments...]` -### storage frontend -Start frontend service -Usage: `storage frontend [command options] [arguments...]` @@ -2500,8 +2566,11 @@ Usage: `storage frontend [command options] [arguments...]` +### storage sharing +Start sharing service +Usage: `storage sharing [command options] [arguments...]` @@ -2515,94 +2584,77 @@ 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/"`. --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")`. --datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `"data"`. --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"`. --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `"localhost:9142"`. --default-upload-protocol | $STORAGE_FRONTEND_DEFAULT_UPLOAD_PROTOCOL -: Default upload chunking protocol to be used out of tus/v1/ng. Default: `"tus"`. + +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9151"`. --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`. +-network | $STORAGE_SHARING_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --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: `""`. +-addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9150"`. --checksum-suppored-type | $STORAGE_FRONTEND_CHECKSUM_SUPPORTED_TYPES -: --checksum-suppored-type sha1 [--checksum-suppored-type adler32]. Default: `cli.NewStringSlice("sha1", "md5", "adler32")`. +-service | $STORAGE_SHARING_SERVICES +: --service usershareprovider [--service publicshareprovider]. Default: `cli.NewStringSlice("usershareprovider", "publicshareprovider")`. --checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE -: Specify the preferred checksum algorithm used for uploads. Default: `""`. +-user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `"json"`. --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.. +-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`. @@ -2635,11 +2687,8 @@ Usage: `storage frontend [command options] [arguments...]` -### storage storage -Storage service for oCIS -Usage: `storage storage [command options] [arguments...]` @@ -2799,8 +2848,11 @@ Usage: `storage storage [command options] [arguments...]` +### storage storage-metadata +Start storage-metadata service +Usage: `storage storage-metadata [command options] [arguments...]` @@ -2896,11 +2948,14 @@ Usage: `storage storage [command options] [arguments...]` -### storage storage-metadata -Start storage-metadata service -Usage: `storage storage-metadata [command options] [arguments...]` + + + + + + @@ -3087,8 +3142,11 @@ Usage: `storage storage-metadata [command options] [arguments...]` +### storage storage-users +Start storage-users service +Usage: `storage storage-users [command options] [arguments...]` @@ -3155,21 +3213,10 @@ 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. @@ -3190,11 +3237,8 @@ Usage: `storage storage-metadata [command options] [arguments...]` -### storage storage-public-link -Start storage-public-link service -Usage: `storage storage-public-link [command options] [arguments...]` @@ -3254,24 +3298,14 @@ 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"`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `"localhost:9142"`. @@ -3344,35 +3378,66 @@ Usage: `storage storage-public-link [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"`. +-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`. +-data-server-url | $STORAGE_USERS_DATA_SERVER_URL +: data server url. Default: `"http://localhost:9158/data"`. +-http-prefix | $STORAGE_USERS_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `"data"`. +-tmp-folder | $STORAGE_USERS_TMP_FOLDER +: path to tmp folder. Default: `"/var/tmp/ocis/tmp/users"`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `"localhost:9142"`. +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9144"`. +### storage auth-bearer +Start authprovider for bearer auth +Usage: `storage auth-bearer [command options] [arguments...]` @@ -3454,11 +3519,8 @@ Usage: `storage storage-public-link [command options] [arguments...]` -### storage auth-bearer -Start authprovider for bearer auth -Usage: `storage auth-bearer [command options] [arguments...]` @@ -3650,8 +3712,11 @@ Usage: `storage auth-bearer [command options] [arguments...]` +### storage groups +Start groups service +Usage: `storage groups [command options] [arguments...]` @@ -3712,85 +3777,6 @@ Usage: `storage auth-bearer [command options] [arguments...]` - - - - - - - - - - - - - - - - - - - - - -### storage health - -Check health status - -Usage: `storage health [command options] [arguments...]` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -3921,20 +3907,36 @@ Usage: `storage health [command options] [arguments...]` +-debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9161"`. +-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`. @@ -3950,8 +3952,6 @@ Usage: `storage health [command options] [arguments...]` --debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9109"`. diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index 9ae951f1ac0..374859f3e7d 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-07T08:37:09+0000" +date: "2021-07-07T15:31:25+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates diff --git a/extensions/thumbnails/configuration.md b/extensions/thumbnails/configuration.md index cc8074025e0..2435d0e643d 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-07T08:37:09+0000" +date: "2021-07-07T15:31:26+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates @@ -35,185 +35,181 @@ 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. -### thumbnails server +### thumbnails health -Start integrated server +Check health status -Usage: `thumbnails server [command options] [arguments...]` +Usage: `thumbnails health [command options] [arguments...]` +-debug-addr | $THUMBNAILS_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9189"`. --log-file | $THUMBNAILS_LOG_FILE , $OCIS_LOG_FILE -: Enable log to file. --log-level | $THUMBNAILS_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. --log-pretty | $THUMBNAILS_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $THUMBNAILS_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. --config-file | $THUMBNAILS_CONFIG_FILE -: Path to config file. --tracing-enabled | $THUMBNAILS_TRACING_ENABLED -: Enable sending traces. --tracing-type | $THUMBNAILS_TRACING_TYPE -: Tracing backend type. Default: `"jaeger"`. --tracing-endpoint | $THUMBNAILS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. --tracing-collector | $THUMBNAILS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `""`. --tracing-service | $THUMBNAILS_TRACING_SERVICE -: Service name for tracing. Default: `"thumbnails"`. --debug-addr | $THUMBNAILS_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9189"`. --debug-token | $THUMBNAILS_DEBUG_TOKEN -: Token to grant metrics access. Default: `""`. --debug-pprof | $THUMBNAILS_DEBUG_PPROF -: Enable pprof debugging. +### thumbnails ocis-thumbnails --debug-zpages | $THUMBNAILS_DEBUG_ZPAGES -: Enable zpages debugging. +Example usage +Usage: `thumbnails ocis-thumbnails [command options] [arguments...]` --grpc-name | $THUMBNAILS_GRPC_NAME -: Name of the service. Default: `"thumbnails"`. --grpc-addr | $THUMBNAILS_GRPC_ADDR -: Address to bind grpc server. Default: `"0.0.0.0:9185"`. --grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --filesystemstorage-root | $THUMBNAILS_FILESYSTEMSTORAGE_ROOT -: Root path of the filesystem storage directory. Default: `/var/tmp/ocis/thumbnails`. --reva-gateway-addr | $THUMBNAILS_REVA_GATEWAY , $PROXY_REVA_GATEWAY_ADDR -: Reva gateway address. Default: `"127.0.0.1:9142"`. --webdavsource-insecure | $THUMBNAILS_WEBDAVSOURCE_INSECURE -: Whether to skip certificate checks. Default: `true`. --thumbnail-resolution | $THUMBNAILS_RESOLUTIONS -: --thumbnail-resolution 16x16 [--thumbnail-resolution 32x32]. Default: `cli.NewStringSlice("16x16", "32x32", "64x64", "128x128", "1920x1080", "3840x2160", "7680x4320")`. --webdav-namespace | $STORAGE_WEBDAV_NAMESPACE -: Namespace prefix for the webdav endpoint. Default: `"/home"`. --extensions | -: Run specific extensions during supervised mode. -### thumbnails version -Print the versions of the running instances -Usage: `thumbnails version [command options] [arguments...]` +### thumbnails server +Start integrated server +Usage: `thumbnails server [command options] [arguments...]` +-log-file | $THUMBNAILS_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. +-log-level | $THUMBNAILS_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $THUMBNAILS_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $THUMBNAILS_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. +-config-file | $THUMBNAILS_CONFIG_FILE +: Path to config file. +-tracing-enabled | $THUMBNAILS_TRACING_ENABLED +: Enable sending traces. +-tracing-type | $THUMBNAILS_TRACING_TYPE +: Tracing backend type. Default: `"jaeger"`. +-tracing-endpoint | $THUMBNAILS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. --grpc-name | $THUMBNAILS_GRPC_NAME -: Name of the service. Default: `"thumbnails"`. +-tracing-collector | $THUMBNAILS_TRACING_COLLECTOR +: Endpoint for the collector. Default: `""`. --grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-tracing-service | $THUMBNAILS_TRACING_SERVICE +: Service name for tracing. Default: `"thumbnails"`. -### thumbnails health -Check health status +-debug-addr | $THUMBNAILS_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9189"`. -Usage: `thumbnails health [command options] [arguments...]` +-debug-token | $THUMBNAILS_DEBUG_TOKEN +: Token to grant metrics access. Default: `""`. --debug-addr | $THUMBNAILS_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9189"`. +-debug-pprof | $THUMBNAILS_DEBUG_PPROF +: Enable pprof debugging. +-debug-zpages | $THUMBNAILS_DEBUG_ZPAGES +: Enable zpages debugging. +-grpc-name | $THUMBNAILS_GRPC_NAME +: Name of the service. Default: `"thumbnails"`. +-grpc-addr | $THUMBNAILS_GRPC_ADDR +: Address to bind grpc server. Default: `"0.0.0.0:9185"`. +-grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-filesystemstorage-root | $THUMBNAILS_FILESYSTEMSTORAGE_ROOT +: Root path of the filesystem storage directory. Default: `/var/tmp/ocis/thumbnails`. +-reva-gateway-addr | $THUMBNAILS_REVA_GATEWAY , $PROXY_REVA_GATEWAY_ADDR +: Reva gateway address. Default: `"127.0.0.1:9142"`. +-webdavsource-insecure | $THUMBNAILS_WEBDAVSOURCE_INSECURE +: Whether to skip certificate checks. Default: `true`. +-thumbnail-resolution | $THUMBNAILS_RESOLUTIONS +: --thumbnail-resolution 16x16 [--thumbnail-resolution 32x32]. Default: `cli.NewStringSlice("16x16", "32x32", "64x64", "128x128", "1920x1080", "3840x2160", "7680x4320")`. +-webdav-namespace | $STORAGE_WEBDAV_NAMESPACE +: Namespace prefix for the webdav endpoint. Default: `"/home"`. +-extensions | +: Run specific extensions during supervised mode. +### thumbnails version +Print the versions of the running instances -### thumbnails ocis-thumbnails +Usage: `thumbnails version [command options] [arguments...]` -Example usage -Usage: `thumbnails ocis-thumbnails [command options] [arguments...]` @@ -238,6 +234,10 @@ Usage: `thumbnails ocis-thumbnails [command options] [arguments...]` +-grpc-name | $THUMBNAILS_GRPC_NAME +: Name of the service. Default: `"thumbnails"`. +-grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. diff --git a/extensions/web/configuration.md b/extensions/web/configuration.md index 8e0c4227fb1..709de48cab0 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-07T08:37:10+0000" +date: "2021-07-07T15:31:26+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 7dd452e39ca..f638cc963a1 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-07T08:37:10+0000" +date: "2021-07-07T15:31:27+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates diff --git a/ocis/configuration.md b/ocis/configuration.md index 9c1cad89eaf..882eda145e8 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-07T08:37:08+0000" +date: "2021-07-07T15:31:25+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -139,11 +139,11 @@ Usage: `ocis health [command options] [arguments...]` -### ocis kill +### ocis server -Kill an extension by name +Start fullstack server -Usage: `ocis kill [command options] [arguments...]` +Usage: `ocis server [command options] [arguments...]` @@ -160,26 +160,42 @@ Usage: `ocis kill [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 list -Lists running ocis extensions +-http-addr | $OCIS_HTTP_ADDR +: Address to bind http server. Default: `0.0.0.0:9000`. -Usage: `ocis list [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`. +-extensions | $OCIS_RUN_EXTENSIONS +: Run specific extensions during supervised mode. +### ocis kill +Kill an extension by name +Usage: `ocis kill [command options] [arguments...]` @@ -195,19 +211,19 @@ Usage: `ocis list [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...]` @@ -216,36 +232,20 @@ 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. --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`. --extensions | $OCIS_RUN_EXTENSIONS -: Run specific extensions during supervised mode. ### ocis run @@ -279,41 +279,13 @@ 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 glauth - -Start glauth server - -#### ocis storage-sharing - -Start storage sharing service - -#### ocis storage-auth-bearer - -Start storage auth-bearer service - -#### ocis onlyoffice - -Start onlyoffice server - -#### ocis storage-frontend - -Start storage frontend - -#### ocis storage-home - -Start storage and data provider for /home mount - -#### ocis storage-public-link - -Start storage public link storage - -#### ocis storage-users +#### ocis storage-userprovider -Start storage and data provider for /users mount +Start storage userprovider service -#### ocis version +#### ocis webdav -Lists running services with version +Start webdav server #### ocis accounts @@ -323,9 +295,17 @@ Start accounts server Start ocs server -#### ocis storage-userprovider +#### ocis storage-auth-basic -Start storage userprovider service +Start storage auth-basic service + +#### ocis storage-gateway + +Start storage gateway + +#### ocis storage-sharing + +Start storage sharing service #### ocis proxy @@ -339,29 +319,37 @@ Start settings server Start storage groupprovider service -#### ocis thumbnails +#### ocis store -Start thumbnails server +Start a go-micro store -#### ocis storage-gateway +#### ocis storage-auth-bearer -Start storage gateway +Start storage auth-bearer service -#### ocis webdav +#### ocis storage-frontend -Start webdav server +Start storage frontend -#### ocis storage-auth-basic +#### ocis storage-home -Start storage auth-basic service +Start storage and data provider for /home mount -#### ocis storage-metadata +#### ocis storage-public-link -Start storage and data service for metadata +Start storage public link storage -#### ocis store +#### ocis storage-users -Start a go-micro store +Start storage and data provider for /users mount + +#### ocis thumbnails + +Start thumbnails server + +#### ocis glauth + +Start glauth server #### ocis idp @@ -371,3 +359,15 @@ Start idp server Start web server +#### ocis onlyoffice + +Start onlyoffice server + +#### ocis storage-metadata + +Start storage and data service for metadata + +#### ocis version + +Lists running services with version +