From 8f906430b76d5326b8537de8f463dde150d1486d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Friedrich=20Dreyer?= Date: Fri, 23 Oct 2020 19:59:40 +0000 Subject: [PATCH] =?UTF-8?q?commit=20eb47947ae39d95b16f6570763b9cdfa08b58b5?= =?UTF-8?q?c4=20Merge:=207f1b58d7=20df9fa95c=20Author:=20J=C3=B6rn=20Fried?= =?UTF-8?q?rich=20Dreyer=20=20Date:=20=20=20Fri=20Oct=2023?= =?UTF-8?q?=2021:39:12=202020=20+0200?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Merge pull request #748 from butonic/update-reva-to-cdb3d6688da5 Update reva to cdb3d6688da5 --- extensions/konnectd/configuration.md | 26 +- extensions/proxy/configuration.md | 20 +- extensions/storage/configuration.md | 392 +++++++++++++-------------- extensions/webdav/configuration.md | 20 +- 4 files changed, 229 insertions(+), 229 deletions(-) diff --git a/extensions/konnectd/configuration.md b/extensions/konnectd/configuration.md index 68dd4fe4199..258f5a594a7 100644 --- a/extensions/konnectd/configuration.md +++ b/extensions/konnectd/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-23T16:08:26+0000" +date: "2020-10-23T19:59:22+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis-konnectd geekdocEditPath: edit/master/docs @@ -57,6 +57,18 @@ Usage: `ocis-konnectd [global options] command [command options] [arguments...]` ## Sub Commands +### ocis-konnectd version + +Print the versions of the running instances + +Usage: `ocis-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`. + ### ocis-konnectd server Start integrated server @@ -177,15 +189,3 @@ Usage: `ocis-konnectd health [command options] [arguments...]` --debug-addr | $KONNECTD_DEBUG_ADDR : Address to debug endpoint. Default: `0.0.0.0:9134`. -### ocis-konnectd version - -Print the versions of the running instances - -Usage: `ocis-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/proxy/configuration.md b/extensions/proxy/configuration.md index fe5b16f88d0..1a380115630 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-23T16:08:30+0000" +date: "2020-10-23T19:59:26+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis-proxy geekdocEditPath: edit/master/docs @@ -57,6 +57,15 @@ Usage: `ocis-proxy [global options] command [command options] [arguments...]` ## Sub Commands +### ocis-proxy health + +Check health status + +Usage: `ocis-proxy health [command options] [arguments...]` + +--debug-addr | $PROXY_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9109`. + ### ocis-proxy version Print the versions of the running instances @@ -141,12 +150,3 @@ Usage: `ocis-proxy server [command options] [arguments...]` --autoprovision-accounts | $PROXY_AUTOPROVISION_ACCOUNTS : create accounts from OIDC access tokens to learn new users. Default: `false`. -### ocis-proxy health - -Check health status - -Usage: `ocis-proxy health [command options] [arguments...]` - ---debug-addr | $PROXY_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9109`. - diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index 58931f80f59..f9a8747ee8f 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-23T16:08:28+0000" +date: "2020-10-23T19:59:24+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/extensions/storage @@ -57,6 +57,201 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands +### 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 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 + +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/shares.json`. + +--public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `json`. + +### 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 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`. + +--webdav-namespace | $WEBDAV_NAMESPACE +: Namespace prefix for the /webdav endpoint. Default: `/home/`. + +--dav-files-namespace | $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 +: URL to use for the storage service. Default: `https://localhost:9200`. + +--datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX +: datagateway prefix. Default: `data`. + +--ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX +: owncloud webdav endpoint prefix. + +--ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX +: open collaboration services endpoint prefix. Default: `ocs`. + +--gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `localhost:9142`. + +--upload-disable-tus | $STORAGE_FRONTEND_UPLOAD_DISABLE_TUS +: Disables TUS upload mechanism. Default: `false`. + +--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-users + +Start storage-users service + +Usage: `storage storage-users [command options] [arguments...]` + +--debug-addr | $STORAGE_USERS_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9159`. + +--grpc-network | $STORAGE_USERS_GRPC_NETWORK +: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--grpc-addr | $STORAGE_USERS_GRPC_ADDR +: GRPC Address to bind users storage. Default: `0.0.0.0:9157`. + +--http-network | $STORAGE_USERS_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--http-addr | $STORAGE_USERS_HTTP_ADDR +: HTTP Address to bind users storage. Default: `0.0.0.0:9158`. + +--driver | $STORAGE_USERS_DRIVER +: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. + +--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`. + +--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 @@ -87,27 +282,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-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-home Start storage-home service @@ -237,51 +411,6 @@ Usage: `storage gateway [command options] [arguments...]` --storage-public-link-mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH : mount path. Default: `/public`. -### storage storage-users - -Start storage-users service - -Usage: `storage storage-users [command options] [arguments...]` - ---debug-addr | $STORAGE_USERS_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9159`. - ---grpc-network | $STORAGE_USERS_GRPC_NETWORK -: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---grpc-addr | $STORAGE_USERS_GRPC_ADDR -: GRPC Address to bind users storage. Default: `0.0.0.0:9157`. - ---http-network | $STORAGE_USERS_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---http-addr | $STORAGE_USERS_HTTP_ADDR -: HTTP Address to bind users storage. Default: `0.0.0.0:9158`. - ---driver | $STORAGE_USERS_DRIVER -: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. - ---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`. - ---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-basic Start authprovider for basic auth @@ -357,135 +486,6 @@ Usage: `storage storage [command options] [arguments...]` --log-color | $STORAGE_LOG_COLOR : Enable colored logging. -### 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 - -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/shares.json`. - ---public-driver | $STORAGE_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `json`. - -### 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 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`. - ---webdav-namespace | $WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `/home/`. - ---dav-files-namespace | $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 -: URL to use for the storage service. Default: `https://localhost:9200`. - ---datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `data`. - ---ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. - ---ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX -: open collaboration services endpoint prefix. Default: `ocs`. - ---gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `localhost:9142`. - ---upload-disable-tus | $STORAGE_FRONTEND_UPLOAD_DISABLE_TUS -: Disables TUS upload mechanism. Default: `false`. - ---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. - ## 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/webdav/configuration.md b/extensions/webdav/configuration.md index 9c2918de585..3d3395b1406 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-23T16:08:31+0000" +date: "2020-10-23T19:59:27+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/extensions/webdav @@ -57,6 +57,15 @@ Usage: `webdav [global options] command [command options] [arguments...]` ## Sub Commands +### webdav health + +Check health status + +Usage: `webdav health [command options] [arguments...]` + +--debug-addr | $WEBDAV_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9119`. + ### webdav version Print the versions of the running instances @@ -114,12 +123,3 @@ Usage: `webdav server [command options] [arguments...]` --http-root | $WEBDAV_HTTP_ROOT : Root path of http server. Default: `/`. -### webdav health - -Check health status - -Usage: `webdav health [command options] [arguments...]` - ---debug-addr | $WEBDAV_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9119`. -