From 18a3ca30887424c9994cdeea9f6ca1fc7a654862 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Friedrich=20Dreyer?= Date: Mon, 25 Jan 2021 19:51:48 +0000 Subject: [PATCH] =?UTF-8?q?commit=20706a58c58e6526775b613bae952b65ba4a887e?= =?UTF-8?q?36=20Merge:=201404a8be=204611cc2d=20Author:=20J=C3=B6rn=20Fried?= =?UTF-8?q?rich=20Dreyer=20=20Date:=20=20=20Mon=20Jan=2025?= =?UTF-8?q?=2020:43:50=202021=20+0100?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Merge pull request #1482 from owncloud/update-reva-for-checksums update reva to 0c10b333ee69 --- extensions/accounts/configuration.md | 56 ++-- extensions/glauth/configuration.md | 2 +- extensions/konnectd/configuration.md | 26 +- extensions/ocs/configuration.md | 20 +- extensions/onlyoffice/configuration.md | 20 +- extensions/proxy/configuration.md | 2 +- extensions/settings/configuration.md | 50 ++-- extensions/storage/configuration.md | 365 +++++++++++++------------ extensions/store/configuration.md | 80 +++--- extensions/thumbnails/configuration.md | 50 ++-- extensions/web/configuration.md | 20 +- extensions/webdav/configuration.md | 2 +- ocis/configuration.md | 96 +++---- 13 files changed, 396 insertions(+), 393 deletions(-) diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 049174ff296..32566f5bcd8 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-25T15:04:08+0000" +date: "2021-01-25T19:49:26+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -35,29 +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 list - -List existing accounts - -Usage: `accounts list [command options] [arguments...]` - --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. - --name | $ACCOUNTS_NAME -: service name. Default: `accounts`. - -### accounts remove - -Removes an existing account - -Usage: `accounts remove [command options] [arguments...]` +### accounts rebuildIndex --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. +Rebuilds the service's index, i.e. deleting and then re-adding all existing documents --name | $ACCOUNTS_NAME -: service name. Default: `accounts`. +Usage: `accounts rebuildIndex [command options] [arguments...]` ### accounts ocis-accounts @@ -140,6 +122,18 @@ Usage: `accounts server [command options] [arguments...]` -service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME : username of the internal service user (required on EOS). +### accounts version + +Print the versions of the running instances + +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`. + ### accounts add Create a new account @@ -158,11 +152,11 @@ Usage: `accounts inspect [command options] [arguments...]` -name | $ACCOUNTS_NAME : service name. Default: `accounts`. -### accounts version +### accounts list -Print the versions of the running instances +List existing accounts -Usage: `accounts version [command options] [arguments...]` +Usage: `accounts list [command options] [arguments...]` -grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. @@ -170,11 +164,17 @@ Usage: `accounts version [command options] [arguments...]` -name | $ACCOUNTS_NAME : service name. Default: `accounts`. -### accounts rebuildIndex +### accounts remove -Rebuilds the service's index, i.e. deleting and then re-adding all existing documents +Removes an existing account -Usage: `accounts rebuildIndex [command options] [arguments...]` +Usage: `accounts remove [command options] [arguments...]` + +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. + +-name | $ACCOUNTS_NAME +: service name. Default: `accounts`. ### accounts update diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index 2af89fc84fd..c9c679a803f 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-25T15:04:10+0000" +date: "2021-01-25T19:49:31+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/glauth/templates diff --git a/extensions/konnectd/configuration.md b/extensions/konnectd/configuration.md index 0b3cabda453..d15d59cf32f 100644 --- a/extensions/konnectd/configuration.md +++ b/extensions/konnectd/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-25T15:04:12+0000" +date: "2021-01-25T19:49:38+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/konnectd/templates @@ -35,18 +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. -### konnectd version - -Print the versions of the running instances - -Usage: `konnectd version [command options] [arguments...]` - --http-namespace | $KONNECTD_HTTP_NAMESPACE -: Set the base namespace for service discovery. Default: `com.owncloud.web`. - --name | $KONNECTD_NAME -: Service name. Default: `konnectd`. - ### konnectd health Check health status @@ -185,3 +173,15 @@ Usage: `konnectd server [command options] [arguments...]` -disable-identifier-webapp | $KONNECTD_DISABLE_IDENTIFIER_WEBAPP : Disable built-in identifier-webapp to use a frontend hosted elsewhere.. Default: `true`. +### konnectd version + +Print the versions of the running instances + +Usage: `konnectd version [command options] [arguments...]` + +-http-namespace | $KONNECTD_HTTP_NAMESPACE +: Set the base namespace for service discovery. Default: `com.owncloud.web`. + +-name | $KONNECTD_NAME +: Service name. Default: `konnectd`. + diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index 0f2ed48fad6..97b7f3a56d5 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-25T15:04:16+0000" +date: "2021-01-25T19:49:50+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/templates @@ -35,6 +35,15 @@ 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 health + +Check health status + +Usage: `ocs health [command options] [arguments...]` + +-debug-addr | $OCS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9114`. + ### ocs ocis-ocs Serve OCS API for oCIS @@ -113,12 +122,3 @@ Usage: `ocs version [command options] [arguments...]` -name | $OCS_NAME : Service name. Default: `ocs`. -### ocs health - -Check health status - -Usage: `ocs health [command options] [arguments...]` - --debug-addr | $OCS_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9114`. - diff --git a/extensions/onlyoffice/configuration.md b/extensions/onlyoffice/configuration.md index ac94226e04e..d8b2439f33a 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-25T15:04:22+0000" +date: "2021-01-25T19:50:04+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/onlyoffice/templates @@ -59,6 +59,15 @@ Usage: `onlyoffice [global options] command [command options] [arguments...]` ## Sub Commands +### onlyoffice health + +Check health status + +Usage: `onlyoffice health [command options] [arguments...]` + +-debug-addr | $ONLYOFFICE_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9224`. + ### onlyoffice server Start integrated server @@ -104,12 +113,3 @@ Usage: `onlyoffice server [command options] [arguments...]` -asset-path | $ONLYOFFICE_ASSET_PATH : Path to custom assets. -### onlyoffice health - -Check health status - -Usage: `onlyoffice health [command options] [arguments...]` - --debug-addr | $ONLYOFFICE_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9224`. - diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index 68460620ade..9cfa323840c 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-25T15:04:17+0000" +date: "2021-01-25T19:49:51+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 935a9eaaf42..0cca6421feb 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-25T15:04:17+0000" +date: "2021-01-25T19:49:53+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/settings/templates @@ -35,30 +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. -### settings health - -Check health status - -Usage: `settings health [command options] [arguments...]` - --debug-addr | $SETTINGS_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9194`. - -### settings ocis-settings - -Provide settings and permissions for oCIS - -Usage: `settings ocis-settings [command options] [arguments...]` - --log-level | $SETTINGS_LOG_LEVEL -: Set logging level. Default: `info`. - --log-pretty | $SETTINGS_LOG_PRETTY -: Enable pretty logging. Default: `true`. - --log-color | $SETTINGS_LOG_COLOR -: Enable colored logging. Default: `true`. - ### settings server Start integrated server @@ -134,3 +110,27 @@ Usage: `settings version [command options] [arguments...]` -name | $SETTINGS_NAME : service name. Default: `settings`. +### settings health + +Check health status + +Usage: `settings health [command options] [arguments...]` + +-debug-addr | $SETTINGS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9194`. + +### settings ocis-settings + +Provide settings and permissions for oCIS + +Usage: `settings ocis-settings [command options] [arguments...]` + +-log-level | $SETTINGS_LOG_LEVEL +: Set logging level. Default: `info`. + +-log-pretty | $SETTINGS_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +-log-color | $SETTINGS_LOG_COLOR +: Enable colored logging. Default: `true`. + diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index 1d7869b5ba6..16080677cc6 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-25T15:04:18+0000" +date: "2021-01-25T19:49:54+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -55,122 +55,59 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage storage - -Storage service for oCIS - -Usage: `storage storage [command options] [arguments...]` - --config-file | $STORAGE_CONFIG_FILE -: Path to config file. - --log-level | $STORAGE_LOG_LEVEL -: Set logging level. Default: `info`. - --log-pretty | $STORAGE_LOG_PRETTY -: Enable pretty logging. - --log-color | $STORAGE_LOG_COLOR -: Enable colored logging. - -### storage sharing - -Start sharing service - -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`. - --user-driver | $STORAGE_SHARING_USER_DRIVER -: driver to use for the UserShareProvider. Default: `json`. +### storage frontend --user-json-file | $STORAGE_SHARING_USER_JSON_FILE -: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/storage/shares.json`. +Start frontend service --public-driver | $STORAGE_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `json`. +Usage: `storage frontend [command options] [arguments...]` --public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE -: file used to persist shares for the PublicShareProvider. Default: `/var/tmp/ocis/storage/publicshares.json`. +-debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9141`. -### storage users +-transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. -Start users service +-chunk-folder | $STORAGE_CHUNK_FOLDER +: temp directory for chunked uploads. Default: `/var/tmp/ocis/tmp/chunks`. -Usage: `storage users [command options] [arguments...]` +-webdav-namespace | $STORAGE_WEBDAV_NAMESPACE +: Namespace prefix for the /webdav endpoint. Default: `/home/`. --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9145`. +-dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE +: Namespace prefix for the webdav /dav/files endpoint. Default: `/users/`. --network | $STORAGE_USERPROVIDER_NETWORK +-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`. - --endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `localhost:9144`. - --driver | $STORAGE_USERPROVIDER_DRIVER -: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. - --json-config | $STORAGE_USERPROVIDER_JSON -: Path to users.json file. - --rest-client-id | $STORAGE_REST_CLIENT_ID -: User rest driver Client ID. - --rest-client-secret | $STORAGE_REST_CLIENT_SECRET -: User rest driver Client Secret. - --rest-redis-address | $STORAGE_REST_REDIS_ADDRESS -: Address for redis server. Default: `localhost:6379`. - --rest-redis-username | $STORAGE_REST_REDIS_USERNAME -: Username for redis server. - --rest-redis-password | $STORAGE_REST_REDIS_PASSWORD -: Password for redis server. - --rest-id-provider | $STORAGE_REST_ID_PROVIDER -: The OIDC Provider. - --rest-api-base-url | $STORAGE_REST_API_BASE_URL -: Base API Endpoint. - --rest-oidc-token-endpoint | $STORAGE_REST_OIDC_TOKEN_ENDPOINT -: Endpoint to generate token to access the API. +-addr | $STORAGE_FRONTEND_HTTP_ADDR +: Address to bind storage service. Default: `0.0.0.0:9140`. --rest-target-api | $STORAGE_REST_TARGET_API -: The target application. +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `https://localhost:9200`. -### storage auth-basic +-datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX +: datagateway prefix. Default: `data`. -Start authprovider for basic auth +-ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX +: owncloud webdav endpoint prefix. -Usage: `storage auth-basic [command options] [arguments...]` +-ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX +: open collaboration services endpoint prefix. Default: `ocs`. --debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9147`. +-ocs-share-prefix | $STORAGE_FRONTEND_OCS_Share_PREFIX +: the prefix prepended to the path of shared files. Default: `/Shares`. --auth-driver | $STORAGE_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `localhost:9142`. --auth-json | $STORAGE_AUTH_JSON -: Path to users.json file. +-upload-disable-tus | $STORAGE_FRONTEND_UPLOAD_DISABLE_TUS +: Disables TUS upload mechanism. Default: `false`. --network | $STORAGE_AUTH_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic 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. --addr | $STORAGE_AUTH_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9146`. +-checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE +: Specify the preferred checksum algorithm used for uploads. ### storage gateway @@ -262,6 +199,72 @@ Usage: `storage health [command options] [arguments...]` -debug-addr | $STORAGE_DEBUG_ADDR : Address to debug endpoint. Default: `0.0.0.0:9109`. +### storage sharing + +Start sharing service + +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`. + +-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`. + +### storage storage-metadata + +Start storage-metadata service + +Usage: `storage storage-metadata [command options] [arguments...]` + +-debug-addr | $STORAGE_METADATA_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9217`. + +-grpc-network | $STORAGE_METADATA_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +-grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9215`. + +-data-server-url | $STORAGE_METADATA_DATA_SERVER_URL +: URL of the data-provider the storage-provider uses. Default: `http://localhost:9216`. + +-http-network | $STORAGE_METADATA_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +-http-addr | $STORAGE_METADATA_HTTP_ADDR +: Address to bind storage service. Default: `0.0.0.0:9216`. + +-tmp-folder | $STORAGE_METADATA_TMP_FOLDER +: path to tmp folder. Default: `/var/tmp/ocis/tmp/metadata`. + +-driver | $STORAGE_METADATA_DRIVER +: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. + +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the gateway service. Default: `localhost:9142`. + +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider service. Default: `localhost:9144`. + +-storage-root | $STORAGE_METADATA_ROOT +: the path to the metadata storage root. Default: `/var/tmp/ocis/storage/metadata`. + ### storage storage-public-link Start storage-public-link service @@ -331,6 +334,78 @@ Usage: `storage storage-users [command options] [arguments...]` -users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT : endpoint to use for the storage service. Default: `localhost:9144`. +### storage users + +Start users service + +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 +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +-addr | $STORAGE_USERPROVIDER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9144`. + +-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `localhost:9144`. + +-driver | $STORAGE_USERPROVIDER_DRIVER +: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. + +-json-config | $STORAGE_USERPROVIDER_JSON +: Path to users.json file. + +-rest-client-id | $STORAGE_REST_CLIENT_ID +: User rest driver Client ID. + +-rest-client-secret | $STORAGE_REST_CLIENT_SECRET +: User rest driver Client Secret. + +-rest-redis-address | $STORAGE_REST_REDIS_ADDRESS +: Address for redis server. Default: `localhost:6379`. + +-rest-redis-username | $STORAGE_REST_REDIS_USERNAME +: Username for redis server. + +-rest-redis-password | $STORAGE_REST_REDIS_PASSWORD +: Password for redis server. + +-rest-id-provider | $STORAGE_REST_ID_PROVIDER +: The OIDC Provider. + +-rest-api-base-url | $STORAGE_REST_API_BASE_URL +: Base API Endpoint. + +-rest-oidc-token-endpoint | $STORAGE_REST_OIDC_TOKEN_ENDPOINT +: Endpoint to generate token to access the API. + +-rest-target-api | $STORAGE_REST_TARGET_API +: The target application. + +### 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. + +-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 auth-bearer Start authprovider for bearer auth @@ -361,56 +436,23 @@ Usage: `storage auth-bearer [command options] [arguments...]` -addr | $STORAGE_AUTH_BEARER_GRPC_ADDR : Address to bind storage service. Default: `0.0.0.0:9148`. -### storage frontend - -Start frontend service - -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`. - --chunk-folder | $STORAGE_CHUNK_FOLDER -: temp directory for chunked uploads. Default: `/var/tmp/ocis/tmp/chunks`. - --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`. - --datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `data`. +### storage storage --ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. +Storage service for oCIS --ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX -: open collaboration services endpoint prefix. Default: `ocs`. +Usage: `storage storage [command options] [arguments...]` --ocs-share-prefix | $STORAGE_FRONTEND_OCS_Share_PREFIX -: the prefix prepended to the path of shared files. Default: `/Shares`. +-config-file | $STORAGE_CONFIG_FILE +: Path to config file. --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `localhost:9142`. +-log-level | $STORAGE_LOG_LEVEL +: Set logging level. Default: `info`. --upload-disable-tus | $STORAGE_FRONTEND_UPLOAD_DISABLE_TUS -: Disables TUS upload mechanism. Default: `false`. +-log-pretty | $STORAGE_LOG_PRETTY +: Enable pretty logging. --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. +-log-color | $STORAGE_LOG_COLOR +: Enable colored logging. ### storage storage-home @@ -463,45 +505,6 @@ Usage: `storage storage-home [command options] [arguments...]` -users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT : endpoint to use for the storage service. Default: `localhost:9144`. -### storage storage-metadata - -Start storage-metadata service - -Usage: `storage storage-metadata [command options] [arguments...]` - --debug-addr | $STORAGE_METADATA_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9217`. - --grpc-network | $STORAGE_METADATA_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - --grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR -: Address to bind storage service. Default: `0.0.0.0:9215`. - --data-server-url | $STORAGE_METADATA_DATA_SERVER_URL -: URL of the data-provider the storage-provider uses. Default: `http://localhost:9216`. - --http-network | $STORAGE_METADATA_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - --http-addr | $STORAGE_METADATA_HTTP_ADDR -: Address to bind storage service. Default: `0.0.0.0:9216`. - --tmp-folder | $STORAGE_METADATA_TMP_FOLDER -: path to tmp folder. Default: `/var/tmp/ocis/tmp/metadata`. - --driver | $STORAGE_METADATA_DRIVER -: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. - --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the gateway service. Default: `localhost:9142`. - --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider service. Default: `localhost:9144`. - --storage-root | $STORAGE_METADATA_ROOT -: the path to the metadata storage root. Default: `/var/tmp/ocis/storage/metadata`. - ## Config for the different Storage Drivers You can set different storage drivers for the Storage Providers. Please check the storage provider configuration. diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index 3429dc4f132..885645043bc 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-25T15:04:19+0000" +date: "2021-01-25T19:49:55+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates @@ -35,45 +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 version - -Print the versions of the running instances - -Usage: `store version [command options] [arguments...]` - --grpc-namespace | $STORE_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. - --name | $STORE_NAME -: Service name. Default: `store`. - -### store health - -Check health status - -Usage: `store health [command options] [arguments...]` - --debug-addr | $STORE_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9460`. - -### store ocis-store - -Service to store values for ocis extensions - -Usage: `store ocis-store [command options] [arguments...]` - --config-file | $STORE_CONFIG_FILE -: Path to config file. - --log-level | $STORE_LOG_LEVEL -: Set logging level. Default: `info`. - --log-pretty | $STORE_LOG_PRETTY -: Enable pretty logging. Default: `true`. - --log-color | $STORE_LOG_COLOR -: Enable colored logging. Default: `true`. - ### store server Start integrated server @@ -116,3 +77,42 @@ Usage: `store server [command options] [arguments...]` -data-path | $STORE_DATA_PATH : location of the store data path. Default: `/var/tmp/ocis/store`. +### store version + +Print the versions of the running instances + +Usage: `store version [command options] [arguments...]` + +-grpc-namespace | $STORE_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. + +-name | $STORE_NAME +: Service name. Default: `store`. + +### store health + +Check health status + +Usage: `store health [command options] [arguments...]` + +-debug-addr | $STORE_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9460`. + +### store ocis-store + +Service to store values for ocis extensions + +Usage: `store ocis-store [command options] [arguments...]` + +-config-file | $STORE_CONFIG_FILE +: Path to config file. + +-log-level | $STORE_LOG_LEVEL +: Set logging level. Default: `info`. + +-log-pretty | $STORE_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +-log-color | $STORE_LOG_COLOR +: Enable colored logging. Default: `true`. + diff --git a/extensions/thumbnails/configuration.md b/extensions/thumbnails/configuration.md index f210b98c393..5e7ef4f71c7 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-25T15:04:20+0000" +date: "2021-01-25T19:49:59+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates @@ -35,30 +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. -### thumbnails health - -Check health status - -Usage: `thumbnails health [command options] [arguments...]` - --debug-addr | $THUMBNAILS_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9189`. - -### thumbnails ocis-thumbnails - -Example usage - -Usage: `thumbnails ocis-thumbnails [command options] [arguments...]` - --log-level | $THUMBNAILS_LOG_LEVEL -: Set logging level. Default: `info`. - --log-pretty | $THUMBNAILS_LOG_PRETTY -: Enable pretty logging. Default: `true`. - --log-color | $THUMBNAILS_LOG_COLOR -: Enable colored logging. Default: `true`. - ### thumbnails server Start integrated server @@ -125,3 +101,27 @@ Usage: `thumbnails version [command options] [arguments...]` -grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. +### thumbnails health + +Check health status + +Usage: `thumbnails health [command options] [arguments...]` + +-debug-addr | $THUMBNAILS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9189`. + +### thumbnails ocis-thumbnails + +Example usage + +Usage: `thumbnails ocis-thumbnails [command options] [arguments...]` + +-log-level | $THUMBNAILS_LOG_LEVEL +: Set logging level. Default: `info`. + +-log-pretty | $THUMBNAILS_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +-log-color | $THUMBNAILS_LOG_COLOR +: Enable colored logging. Default: `true`. + diff --git a/extensions/web/configuration.md b/extensions/web/configuration.md index b7605936f99..1514b60460a 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-25T15:04:14+0000" +date: "2021-01-25T19:49:47+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/web/templates @@ -52,15 +52,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: `0.0.0.0:9104`. - ### web server Start integrated server @@ -136,3 +127,12 @@ Usage: `web server [command options] [arguments...]` -oidc-scope | $WEB_OIDC_SCOPE : OpenID Connect scope. Default: `openid profile email`. +### web health + +Check health status + +Usage: `web health [command options] [arguments...]` + +-debug-addr | $WEB_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9104`. + diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index d9aa1d9fc4b..be4ea596571 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-25T15:04:21+0000" +date: "2021-01-25T19:50:02+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 70add02e178..523f8d72de8 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-25T15:04:13+0000" +date: "2021-01-25T19:49:45+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -86,17 +86,23 @@ Usage: `ocis health [command options] [arguments...]` -debug-addr | $OCIS_DEBUG_ADDR : Address to debug endpoint. Default: `0.0.0.0:9010`. +### ocis run + +Runs an extension + +Usage: `ocis run [command options] [arguments...]` + ### ocis list Lists running ocis extensions Usage: `ocis list [command options] [arguments...]` -### ocis run +### ocis kill -Runs an extension +Kill an extension by name -Usage: `ocis run [command options] [arguments...]` +Usage: `ocis kill [command options] [arguments...]` ### ocis server @@ -125,100 +131,94 @@ Usage: `ocis server [command options] [arguments...]` -grpc-addr | $OCIS_GRPC_ADDR : Address to bind grpc server. Default: `0.0.0.0:9001`. -### ocis kill - -Kill an extension by name - -Usage: `ocis kill [command options] [arguments...]` - ### 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 onlyoffice +#### ocis thumbnails -Start onlyoffice server +Start thumbnails server -#### ocis storage-frontend +#### ocis onlyoffice -Start storage frontend +Start onlyoffice server -#### ocis storage-users +#### ocis storage-auth-bearer -Start storage and data provider for /users mount +Start storage auth-bearer service -#### ocis glauth +#### ocis settings -Start glauth server +Start settings server -#### ocis storage-auth-basic +#### ocis storage-public-link -Start storage auth-basic service +Start storage public link storage -#### ocis storage-auth-bearer +#### ocis web -Start storage auth-bearer service +Start web server -#### ocis webdav +#### ocis accounts -Start webdav server +Start accounts server -#### ocis storage-gateway +#### ocis storage-frontend -Start storage gateway +Start storage frontend #### ocis storage-metadata Start storage and data service for metadata -#### ocis thumbnails +#### ocis storage-users -Start thumbnails server +Start storage and data provider for /users mount -#### ocis web +#### ocis store -Start web server +Start a go-micro store -#### ocis storage-public-link +#### ocis ocs -Start storage public link storage +Start ocs server -#### ocis store +#### ocis storage-gateway -Start a go-micro store +Start storage gateway #### ocis storage-sharing Start storage sharing service -#### ocis storage-userprovider - -Start storage userprovider service - #### ocis version Lists running services with version -#### ocis accounts - -Start accounts server - -#### ocis ocs - -Start ocs server - #### ocis proxy Start proxy server -#### ocis settings +#### ocis storage-auth-basic -Start settings server +Start storage auth-basic service #### ocis storage-home Start storage and data provider for /home mount +#### ocis storage-userprovider + +Start storage userprovider service + +#### ocis webdav + +Start webdav server + +#### ocis glauth + +Start glauth server + #### ocis konnectd Start konnectd server