From 7c73e386e9a1705cdb7dee93ce4c7a4036008c4a Mon Sep 17 00:00:00 2001 From: Phil Davis Date: Mon, 14 Dec 2020 14:46:32 +0000 Subject: [PATCH] commit 0722d453521006644205388135ecaded16e28262 Merge: ddfe2ba2 8b73f7bb Author: Phil Davis Date: Mon Dec 14 20:30:24 2020 +0545 Merge pull request #973 from owncloud/refactor_drone_definition [tests-only] refactor drone definition --- extensions/accounts/configuration.md | 68 +++--- extensions/glauth/configuration.md | 2 +- extensions/konnectd/configuration.md | 26 +-- extensions/ocs/configuration.md | 2 +- extensions/onlyoffice/configuration.md | 2 +- extensions/proxy/configuration.md | 44 ++-- extensions/settings/configuration.md | 56 ++--- extensions/storage/configuration.md | 296 ++++++++++++------------- extensions/store/configuration.md | 26 +-- extensions/thumbnails/configuration.md | 2 +- extensions/web/configuration.md | 2 +- extensions/webdav/configuration.md | 26 +-- ocis/configuration.md | 124 +++++------ 13 files changed, 338 insertions(+), 338 deletions(-) diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index d62094e4dbc..4d8a45f1b9f 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-14T13:41:11+0000" +date: "2020-12-14T14:45:46+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -33,6 +33,30 @@ If you prefer to configure the service with environment variables you can see th 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 rebuildIndex + +Rebuilds the service's index, i.e. deleting and then re-adding all existing documents + +Usage: `accounts rebuildIndex [command options] [arguments...]` + +### accounts update + +Make changes to an existing account + +Usage: `accounts update [command options] [arguments...]` + ### accounts server Start ocis accounts service @@ -105,12 +129,6 @@ Create a new account Usage: `accounts add [command options] [arguments...]` -### accounts rebuildIndex - -Rebuilds the service's index, i.e. deleting and then re-adding all existing documents - -Usage: `accounts rebuildIndex [command options] [arguments...]` - ### accounts ocis-accounts Provide accounts and groups for oCIS @@ -126,23 +144,11 @@ Usage: `accounts ocis-accounts [command options] [arguments...]` --log-color | $ACCOUNTS_LOG_COLOR : Enable colored logging. Default: `true`. -### 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 remove +### accounts inspect -Removes an existing account +Show detailed data on an existing account -Usage: `accounts remove [command options] [arguments...]` +Usage: `accounts inspect [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. @@ -150,11 +156,11 @@ Usage: `accounts remove [command options] [arguments...]` --name | $ACCOUNTS_NAME : service name. Default: `accounts`. -### accounts list +### accounts version -List existing accounts +Print the versions of the running instances -Usage: `accounts list [command options] [arguments...]` +Usage: `accounts version [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. @@ -162,11 +168,11 @@ Usage: `accounts list [command options] [arguments...]` --name | $ACCOUNTS_NAME : service name. Default: `accounts`. -### accounts inspect +### accounts remove -Show detailed data on an existing account +Removes an existing account -Usage: `accounts inspect [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`. @@ -174,9 +180,3 @@ Usage: `accounts inspect [command options] [arguments...]` --name | $ACCOUNTS_NAME : service name. Default: `accounts`. -### accounts update - -Make changes to an existing account - -Usage: `accounts update [command options] [arguments...]` - diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index b7b5ac1fe22..c92f0d39455 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-14T13:41:13+0000" +date: "2020-12-14T14:45:49+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 ac75eb49bd3..5ffd62cb8ab 100644 --- a/extensions/konnectd/configuration.md +++ b/extensions/konnectd/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-14T13:41:15+0000" +date: "2020-12-14T14:45:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/konnectd/templates @@ -33,18 +33,6 @@ If you prefer to configure the service with environment variables you can see th 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 @@ -183,3 +171,15 @@ Usage: `konnectd ocis-konnectd [command options] [arguments...]` --log-color | $KONNECTD_LOG_COLOR : Enable colored logging. 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 c4876ca9412..ad73603d2ad 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-14T13:41:19+0000" +date: "2020-12-14T14:45:56+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/templates diff --git a/extensions/onlyoffice/configuration.md b/extensions/onlyoffice/configuration.md index 13f9a32c806..9d471e3e9e8 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-14T13:41:25+0000" +date: "2020-12-14T14:46:03+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 72a660ba3e0..1c03f7701ae 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-14T13:41:20+0000" +date: "2020-12-14T14:45:57+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/proxy/templates @@ -33,27 +33,6 @@ If you prefer to configure the service with environment variables you can see th 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 version - -Print the versions of the running instances - -Usage: `proxy version [command options] [arguments...]` - ---service-namespace | $PROXY_SERVICE_NAMESPACE -: Set the base namespace for the service namespace. Default: `com.owncloud.web`. - ---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`. - ### proxy server Start integrated server @@ -156,3 +135,24 @@ Usage: `proxy ocis-proxy [command options] [arguments...]` --log-color | $PROXY_LOG_COLOR : Enable colored logging. Default: `true`. +### proxy version + +Print the versions of the running instances + +Usage: `proxy version [command options] [arguments...]` + +--service-namespace | $PROXY_SERVICE_NAMESPACE +: Set the base namespace for the service namespace. Default: `com.owncloud.web`. + +--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 95d8c791a0b..75824c8c709 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-14T13:41:20+0000" +date: "2020-12-14T14:45:58+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/settings/templates @@ -33,33 +33,6 @@ If you prefer to configure the service with environment variables you can see th 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 - -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 version - -Print the versions of the running instances - -Usage: `settings version [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 Check health status @@ -132,3 +105,30 @@ Usage: `settings server [command options] [arguments...]` --jwt-secret | $SETTINGS_JWT_SECRET : Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `Pive-Fumkiu4`. +### 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 version + +Print the versions of the running instances + +Usage: `settings version [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`. + diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index a98e810ab68..5397caa0ace 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-14T13:41:21+0000" +date: "2020-12-14T14:45:59+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -53,6 +53,57 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands +### 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 sharing Start sharing service @@ -80,56 +131,77 @@ Usage: `storage sharing [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`. -### storage frontend +### storage storage-home -Start frontend service +Start storage-home service -Usage: `storage frontend [command options] [arguments...]` +Usage: `storage storage-home [command options] [arguments...]` ---debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9141`. +--debug-addr | $STORAGE_HOME_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9156`. ---transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. +--grpc-network | $STORAGE_HOME_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---chunk-folder | $STORAGE_CHUNK_FOLDER -: temp directory for chunked uploads. Default: `/var/tmp/ocis/tmp/chunks`. +--grpc-addr | $STORAGE_HOME_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9154`. ---webdav-namespace | $STORAGE_WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `/home/`. +--http-network | $STORAGE_HOME_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `/users/`. +--http-addr | $STORAGE_HOME_HTTP_ADDR +: Address to bind storage service. Default: `0.0.0.0:9155`. ---network | $STORAGE_FRONTEND_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--driver | $STORAGE_HOME_DRIVER +: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. ---addr | $STORAGE_FRONTEND_HTTP_ADDR -: Address to bind storage service. Default: `0.0.0.0:9140`. +--mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `/home`. ---public-url | $STORAGE_FRONTEND_PUBLIC_URL -: URL to use for the storage service. Default: `https://localhost:9200`. +--mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009157`. ---datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `data`. +--expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. ---ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. +--data-server-url | $STORAGE_HOME_DATA_SERVER_URL +: data server url. Default: `http://localhost:9155/data`. ---ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX -: open collaboration services endpoint prefix. Default: `ocs`. +--http-prefix | $STORAGE_HOME_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `data`. ---ocs-share-prefix | $STORAGE_FRONTEND_OCS_Share_PREFIX -: the prefix prepended to the path of shared files. Default: `/Shares`. +--tmp-folder | $STORAGE_HOME_TMP_FOLDER +: path to tmp folder. Default: `/var/tmp/ocis/tmp/home`. ---gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `localhost:9142`. +--enable-home | $STORAGE_HOME_ENABLE_HOME +: enable the creation of home directories. Default: `true`. ---upload-disable-tus | $STORAGE_FRONTEND_UPLOAD_DISABLE_TUS -: Disables TUS upload mechanism. Default: `false`. +--gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `localhost:9142`. ---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. +--users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `localhost:9144`. + +### storage storage-public-link + +Start storage-public-link service + +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`. ### storage gateway @@ -233,56 +305,56 @@ Usage: `storage auth-basic [command options] [arguments...]` --addr | $STORAGE_AUTH_BASIC_GRPC_ADDR : Address to bind storage service. Default: `0.0.0.0:9146`. -### storage users +### storage frontend -Start users service +Start frontend service -Usage: `storage users [command options] [arguments...]` +Usage: `storage frontend [command options] [arguments...]` ---debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9145`. +--debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9141`. ---network | $STORAGE_USERPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. ---addr | $STORAGE_USERPROVIDER_ADDR -: Address to bind storage service. Default: `0.0.0.0:9144`. +--chunk-folder | $STORAGE_CHUNK_FOLDER +: temp directory for chunked uploads. Default: `/var/tmp/ocis/tmp/chunks`. ---endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `localhost:9144`. +--webdav-namespace | $STORAGE_WEBDAV_NAMESPACE +: Namespace prefix for the /webdav endpoint. Default: `/home/`. ---driver | $STORAGE_USERPROVIDER_DRIVER -: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. +--dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE +: Namespace prefix for the webdav /dav/files endpoint. Default: `/users/`. ---json-config | $STORAGE_USERPROVIDER_JSON -: Path to users.json file. +--network | $STORAGE_FRONTEND_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---rest-client-id | $STORAGE_REST_CLIENT_ID -: User rest driver Client ID. +--addr | $STORAGE_FRONTEND_HTTP_ADDR +: Address to bind storage service. Default: `0.0.0.0:9140`. ---rest-client-secret | $STORAGE_REST_CLIENT_SECRET -: User rest driver Client Secret. +--public-url | $STORAGE_FRONTEND_PUBLIC_URL +: URL to use for the storage service. Default: `https://localhost:9200`. ---rest-redis-address | $STORAGE_REST_REDIS_ADDRESS -: Address for redis server. Default: `localhost:6379`. +--datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX +: datagateway prefix. Default: `data`. ---rest-redis-username | $STORAGE_REST_REDIS_USERNAME -: Username for redis server. +--ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX +: owncloud webdav endpoint prefix. ---rest-redis-password | $STORAGE_REST_REDIS_PASSWORD -: Password for redis server. +--ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX +: open collaboration services endpoint prefix. Default: `ocs`. ---rest-id-provider | $STORAGE_REST_ID_PROVIDER -: The OIDC Provider. +--ocs-share-prefix | $STORAGE_FRONTEND_OCS_Share_PREFIX +: the prefix prepended to the path of shared files. Default: `/Shares`. ---rest-api-base-url | $STORAGE_REST_API_BASE_URL -: Base API Endpoint. +--gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `localhost:9142`. ---rest-oidc-token-endpoint | $STORAGE_REST_OIDC_TOKEN_ENDPOINT -: Endpoint to generate token to access the API. +--upload-disable-tus | $STORAGE_FRONTEND_UPLOAD_DISABLE_TUS +: Disables TUS upload mechanism. Default: `false`. ---rest-target-api | $STORAGE_REST_TARGET_API -: The target application. +--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. ### storage storage @@ -332,87 +404,6 @@ 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 storage-home - -Start storage-home service - -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`. - ---enable-home | $STORAGE_HOME_ENABLE_HOME -: enable the creation of home directories. Default: `true`. - ---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 health - -Check health status - -Usage: `storage health [command options] [arguments...]` - ---debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9109`. - -### storage storage-public-link - -Start storage-public-link service - -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`. - ### storage storage-metadata Start storage-metadata service @@ -452,6 +443,15 @@ Usage: `storage storage-metadata [command options] [arguments...]` --storage-root | $STORAGE_METADATA_ROOT : the path to the metadata storage root. Default: `/var/tmp/ocis/storage/metadata`. +### storage health + +Check health status + +Usage: `storage health [command options] [arguments...]` + +--debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9109`. + ### storage storage-users Start storage-users service diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index 165c0970e20..8057741dd7c 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-14T13:41:22+0000" +date: "2020-12-14T14:46:00+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates @@ -33,18 +33,6 @@ If you prefer to configure the service with environment variables you can see th 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 @@ -114,3 +102,15 @@ Usage: `store ocis-store [command options] [arguments...]` --log-color | $STORE_LOG_COLOR : Enable colored logging. Default: `true`. +### 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`. + diff --git a/extensions/thumbnails/configuration.md b/extensions/thumbnails/configuration.md index 56dba6a17e6..86a829aeb8d 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-14T13:41:23+0000" +date: "2020-12-14T14:46:01+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates diff --git a/extensions/web/configuration.md b/extensions/web/configuration.md index 182499b45ee..dd98ecdd367 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-14T13:41:17+0000" +date: "2020-12-14T14:45:54+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 3300af7aedb..fcecd1f73db 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-14T13:41:24+0000" +date: "2020-12-14T14:46:02+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates @@ -50,6 +50,18 @@ Usage: `webdav [global options] command [command options] [arguments...]` ## Sub Commands +### webdav version + +Print the versions of the running instances + +Usage: `webdav version [command options] [arguments...]` + +--http-namespace | $WEBDAV_HTTP_NAMESPACE +: Set the base namespace for service discovery. Default: `com.owncloud.web`. + +--service-name | $WEBDAV_SERVICE_NAME +: Service name. Default: `webdav`. + ### webdav health Check health status @@ -107,15 +119,3 @@ Usage: `webdav server [command options] [arguments...]` --http-root | $WEBDAV_HTTP_ROOT : Root path of http server. Default: `/`. -### webdav version - -Print the versions of the running instances - -Usage: `webdav version [command options] [arguments...]` - ---http-namespace | $WEBDAV_HTTP_NAMESPACE -: Set the base namespace for service discovery. Default: `com.owncloud.web`. - ---service-name | $WEBDAV_SERVICE_NAME -: Service name. Default: `webdav`. - diff --git a/ocis/configuration.md b/ocis/configuration.md index 22840cea25c..198dfc56daf 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-14T13:41:16+0000" +date: "2020-12-14T14:45:53+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -75,6 +75,27 @@ Usage: `ocis [global options] command [command options] [arguments...]` ## Sub Commands +### ocis run + +Runs an extension + +Usage: `ocis run [command options] [arguments...]` + +### ocis kill + +Kill an extension by name + +Usage: `ocis kill [command options] [arguments...]` + +### ocis health + +Check health status + +Usage: `ocis health [command options] [arguments...]` + +--debug-addr | $OCIS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9010`. + ### ocis server Start fullstack server @@ -102,122 +123,101 @@ 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...]` - ### ocis list Lists running ocis extensions Usage: `ocis list [command options] [arguments...]` -### ocis run - -Runs an extension - -Usage: `ocis run [command options] [arguments...]` - -### ocis health +### List of available Extension subcommands -Check health status +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. -Usage: `ocis health [command options] [arguments...]` +#### ocis settings ---debug-addr | $OCIS_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9010`. +Start settings server -### List of available Extension subcommands +#### ocis web -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. +Start web server #### ocis store Start a go-micro store -#### ocis storage-metadata +#### ocis ocs -Start storage and data service for metadata +Start ocs server -#### ocis storage-gateway +#### ocis proxy -Start storage gateway +Start proxy server -#### ocis storage-home +#### ocis glauth -Start storage and data provider for /home mount +Start glauth server -#### ocis storage-users +#### ocis storage-frontend -Start storage and data provider for /users mount +Start storage frontend #### ocis webdav Start webdav server -#### ocis ocs - -Start ocs server - -#### ocis thumbnails +#### ocis storage-gateway -Start thumbnails server +Start storage gateway -#### ocis storage-auth-bearer +#### ocis accounts -Start storage auth-bearer service +Start accounts server -#### ocis version +#### ocis onlyoffice -Lists running services with version +Start onlyoffice server -#### ocis glauth +#### ocis storage-public-link -Start glauth server +Start storage public link storage #### ocis storage-auth-basic Start storage auth-basic service -#### ocis accounts - -Start accounts server - -#### ocis web +#### ocis thumbnails -Start web server +Start thumbnails server -#### ocis konnectd +#### ocis version -Start konnectd server +Lists running services with version -#### ocis proxy +#### ocis storage-metadata -Start proxy server +Start storage and data service for metadata -#### ocis onlyoffice +#### ocis storage-userprovider -Start onlyoffice server +Start storage userprovider service -#### ocis storage-sharing +#### ocis konnectd -Start storage sharing service +Start konnectd server -#### ocis storage-userprovider +#### ocis storage-home -Start storage userprovider service +Start storage and data provider for /home mount -#### ocis storage-frontend +#### ocis storage-sharing -Start storage frontend +Start storage sharing service -#### ocis storage-public-link +#### ocis storage-auth-bearer -Start storage public link storage +Start storage auth-bearer service -#### ocis settings +#### ocis storage-users -Start settings server +Start storage and data provider for /users mount