diff --git a/extensions/konnectd/configuration.md b/extensions/konnectd/configuration.md index 71f9e0fd149..9d000f0ffb0 100644 --- a/extensions/konnectd/configuration.md +++ b/extensions/konnectd/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-12T12:53:56+0000" +date: "2020-10-13T12:20:21+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis-konnectd geekdocEditPath: edit/master/docs @@ -57,6 +57,27 @@ Usage: `ocis-konnectd [global options] command [command options] [arguments...]` ## Sub Commands +### ocis-konnectd health + +Check health status + +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`. + ### ocis-konnectd server Start integrated server @@ -168,24 +189,3 @@ Usage: `ocis-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`. -### 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 health - -Check health status - -Usage: `ocis-konnectd health [command options] [arguments...]` - ---debug-addr | $KONNECTD_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9134`. - diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index 4c6e4985199..473971b82c6 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-12T12:54:00+0000" +date: "2020-10-13T12:20:24+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis-proxy geekdocEditPath: edit/master/docs @@ -57,6 +57,27 @@ 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 + +Usage: `ocis-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`. + ### ocis-proxy server Start integrated server @@ -129,24 +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 version - -Print the versions of the running instances - -Usage: `ocis-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`. - -### 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 9ccbd3c47bb..9ac0e1cab30 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-12T12:53:58+0000" +date: "2020-10-13T12:20:23+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/extensions/storage @@ -57,144 +57,84 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage auth-bearer - -Start authprovider for bearer auth +### storage storage-root -Usage: `storage auth-bearer [command options] [arguments...]` +Start storage-root service ---debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9149`. +Usage: `storage storage-root [command options] [arguments...]` ---oidc-issuer | $STORAGE_OIDC_ISSUER -: OIDC issuer. Default: `https://localhost:9200`. +--debug-addr | $STORAGE_STORAGE_ROOT_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9153`. ---oidc-insecure | $STORAGE_OIDC_INSECURE -: OIDC allow insecure communication. Default: `true`. +--network | $STORAGE_STORAGE_ROOT_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---oidc-id-claim | $STORAGE_OIDC_ID_CLAIM -: OIDC id claim. Default: `preferred_username`. +--protocol | $STORAGE_STORAGE_ROOT_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. ---oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM -: OIDC uid claim. +--addr | $STORAGE_STORAGE_ROOT_ADDR +: Address to bind storage service. Default: `0.0.0.0:9152`. ---oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM -: OIDC gid claim. +--url | $STORAGE_STORAGE_ROOT_URL +: URL to use for the storage service. Default: `localhost:9152`. ---network | $STORAGE_AUTH_BEARER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--driver | $STORAGE_STORAGE_ROOT_DRIVER +: storage driver for root mount: eg. local, eos, owncloud, ocis or s3. Default: `local`. ---protocol | $STORAGE_AUTH_BEARER_PROTOCOL -: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. +--mount-path | $STORAGE_STORAGE_ROOT_MOUNT_PATH +: mount path. Default: `/`. ---addr | $STORAGE_AUTH_BEARER_ADDR -: Address to bind storage service. Default: `0.0.0.0:9148`. +--mount-id | $STORAGE_STORAGE_ROOT_MOUNT_ID +: mount id. Default: `123e4567-e89b-12d3-a456-426655440001`. ---url | $STORAGE_AUTH_BEARER_URL -: URL to use for the storage service. Default: `localhost:9148`. +--expose-data-server | $STORAGE_STORAGE_ROOT_EXPOSE_DATA_SERVER +: exposes a dedicated data server. -### storage gateway +--data-server-url | $STORAGE_STORAGE_ROOT_DATA_SERVER_URL +: data server url. -Start gateway +### storage storage-home -Usage: `storage gateway [command options] [arguments...]` +Start storage-home service ---debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9143`. +Usage: `storage storage-home [command options] [arguments...]` ---transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. +--debug-addr | $STORAGE_STORAGE_HOME_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9155`. ---network | $STORAGE_GATEWAY_NETWORK +--network | $STORAGE_STORAGE_HOME_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $STORAGE_GATEWAY_PROTOCOL +--protocol | $STORAGE_STORAGE_HOME_PROTOCOL : protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. ---addr | $STORAGE_GATEWAY_ADDR -: Address to bind storage service. Default: `0.0.0.0:9142`. - ---url | $STORAGE_GATEWAY_URL -: URL to use for the storage service. Default: `localhost:9142`. - ---commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT -: Commit shares to the share manager. Default: `true`. +--addr | $STORAGE_STORAGE_HOME_ADDR +: Address to bind storage service. Default: `0.0.0.0:9154`. ---commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF -: Commit shares to the storage. Default: `true`. +--url | $STORAGE_STORAGE_HOME_URL +: URL to use for the storage service. Default: `localhost:9154`. ---share-folder | $STORAGE_GATEWAY_SHARE_FOLDER -: mount shares in this folder of the home storage provider. Default: `Shares`. +--driver | $STORAGE_STORAGE_HOME_DRIVER +: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. ---disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN -: Disable creation of home folder on login. +--mount-path | $STORAGE_STORAGE_HOME_MOUNT_PATH +: mount path. Default: `/home`. ---storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER -: driver of the storage registry. Default: `static`. +--mount-id | $STORAGE_STORAGE_HOME_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. ---storage-home-provider | $STORAGE_STORAGE_HOME_PROVIDER -: mount point of the storage provider for user homes in the global namespace. Default: `/home`. +--expose-data-server | $STORAGE_STORAGE_HOME_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. ---frontend-url | $STORAGE_FRONTEND_URL -: URL to use for the storage service. Default: `https://localhost:9200`. +--data-server-url | $STORAGE_STORAGE_HOME_DATA_SERVER_URL +: data server url. Default: `http://localhost:9156/data`. ---datagateway-url | $STORAGE_DATAGATEWAY_URL -: URL to use for the storage datagateway. Default: `https://localhost:9200/data`. +--enable-home | $STORAGE_STORAGE_HOME_ENABLE_HOME +: enable the creation of home directories. Default: `true`. --users-url | $STORAGE_USERS_URL : URL to use for the storage service. Default: `localhost:9144`. ---auth-basic-url | $STORAGE_AUTH_BASIC_URL -: URL to use for the storage service. Default: `localhost:9146`. - ---auth-bearer-url | $STORAGE_AUTH_BEARER_URL -: URL to use for the storage service. Default: `localhost:9148`. - ---sharing-url | $STORAGE_SHARING_URL -: URL to use for the storage service. Default: `localhost:9150`. - ---storage-root-url | $STORAGE_STORAGE_ROOT_URL -: URL to use for the storage service. Default: `localhost:9152`. - ---storage-root-mount-path | $STORAGE_STORAGE_ROOT_MOUNT_PATH -: mount path. Default: `/`. - ---storage-root-mount-id | $STORAGE_STORAGE_ROOT_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009152`. - ---storage-home-url | $STORAGE_STORAGE_HOME_URL -: URL to use for the storage service. Default: `localhost:9154`. - ---storage-home-mount-path | $STORAGE_STORAGE_HOME_MOUNT_PATH -: mount path. Default: `/home`. - ---storage-home-mount-id | $STORAGE_STORAGE_HOME_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009154`. - ---storage-eos-url | $STORAGE_STORAGE_EOS_URL -: URL to use for the storage service. Default: `localhost:9158`. - ---storage-eos-mount-path | $STORAGE_STORAGE_EOS_MOUNT_PATH -: mount path. Default: `/eos`. - ---storage-eos-mount-id | $STORAGE_STORAGE_EOS_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009158`. - ---storage-oc-url | $STORAGE_STORAGE_OC_URL -: URL to use for the storage service. Default: `localhost:9162`. - ---storage-oc-mount-path | $STORAGE_STORAGE_OC_MOUNT_PATH -: mount path. Default: `/oc`. - ---storage-oc-mount-id | $STORAGE_STORAGE_OC_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. - ---public-link-url | $STORAGE_STORAGE_PUBLIC_LINK_URL -: URL to use for the public links service. Default: `localhost:9178`. - ---storage-public-link-mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `/public/`. - ### storage storage-eos Start storage-eos service @@ -231,6 +171,111 @@ Usage: `storage storage-eos [command options] [arguments...]` --data-server-url | $STORAGE_STORAGE_EOS_DATA_SERVER_URL : data server url. Default: `http://localhost:9160/data`. +### storage auth-bearer + +Start authprovider for bearer auth + +Usage: `storage auth-bearer [command options] [arguments...]` + +--debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9149`. + +--oidc-issuer | $STORAGE_OIDC_ISSUER +: OIDC issuer. Default: `https://localhost:9200`. + +--oidc-insecure | $STORAGE_OIDC_INSECURE +: OIDC allow insecure communication. Default: `true`. + +--oidc-id-claim | $STORAGE_OIDC_ID_CLAIM +: OIDC id claim. Default: `preferred_username`. + +--oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM +: OIDC uid claim. + +--oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM +: OIDC gid claim. + +--network | $STORAGE_AUTH_BEARER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--protocol | $STORAGE_AUTH_BEARER_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. + +--addr | $STORAGE_AUTH_BEARER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9148`. + +--url | $STORAGE_AUTH_BEARER_URL +: URL to use for the storage service. Default: `localhost:9148`. + +### 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_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--protocol | $STORAGE_SHARING_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. + +--addr | $STORAGE_SHARING_ADDR +: Address to bind storage service. Default: `0.0.0.0:9150`. + +--url | $STORAGE_SHARING_URL +: URL to use for the storage service. Default: `localhost: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 storage-oc + +Start storage-oc service + +Usage: `storage storage-oc [command options] [arguments...]` + +--debug-addr | $STORAGE_STORAGE_OC_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9163`. + +--network | $STORAGE_STORAGE_OC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--protocol | $STORAGE_STORAGE_OC_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. + +--addr | $STORAGE_STORAGE_OC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9162`. + +--url | $STORAGE_STORAGE_OC_URL +: URL to use for the storage service. Default: `localhost:9162`. + +--driver | $STORAGE_STORAGE_OC_DRIVER +: storage driver for oc mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. + +--mount-path | $STORAGE_STORAGE_OC_MOUNT_PATH +: mount path. Default: `/oc`. + +--mount-id | $STORAGE_STORAGE_OC_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. + +--expose-data-server | $STORAGE_STORAGE_OC_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. + +--data-server-url | $STORAGE_STORAGE_OC_DATA_SERVER_URL +: data server url. Default: `http://localhost:9164/data`. + +--users-url | $STORAGE_USERS_URL +: URL to use for the storage service. Default: `localhost:9144`. + ### storage users Start users service @@ -285,71 +330,62 @@ Usage: `storage users [command options] [arguments...]` --rest-target-api | $STORAGE_REST_TARGET_API : The target application. -### storage storage-public-link - -Start storage-public-link service - -Usage: `storage storage-public-link [command options] [arguments...]` - ---debug-addr | $STORAGE_STORAGE_PUBLIC_LINK_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9179`. +### storage health ---network | $STORAGE_STORAGE_PUBLIC_LINK_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +Check health status ---protocol | $STORAGE_STORAGE_PUBLIC_LINK_PROTOCOL -: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. +Usage: `storage health [command options] [arguments...]` ---addr | $STORAGE_STORAGE_PUBLIC_LINK_ADDR -: Address to bind storage service. Default: `0.0.0.0:9178`. +--debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9109`. ---url | $STORAGE_STORAGE_PUBLIC_LINK_URL -: Address to bind storage service. Default: `localhost:9178`. +### storage frontend ---mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `/public/`. +Start frontend service ---gateway-url | $STORAGE_GATEWAY_URL -: URL to use for the storage gateway service. Default: `localhost:9142`. +Usage: `storage frontend [command options] [arguments...]` -### storage storage-home-data +--debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9141`. -Start storage-home-data service +--transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. -Usage: `storage storage-home-data [command options] [arguments...]` +--webdav-namespace | $WEBDAV_NAMESPACE +: Namespace prefix for the /webdav endpoint. Default: `/home/`. ---debug-addr | $STORAGE_STORAGE_HOME_DATA_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9157`. +--dav-files-namespace | $DAV_FILES_NAMESPACE +: Namespace prefix for the webdav /dav/files endpoint. Default: `/oc/`. ---network | $STORAGE_STORAGE_HOME_DATA_NETWORK +--network | $STORAGE_FRONTEND_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $STORAGE_STORAGE_HOME_DATA_PROTOCOL +--protocol | $STORAGE_FRONTEND_PROTOCOL : protocol for storage service, can be 'http' or 'grpc'. Default: `http`. ---addr | $STORAGE_STORAGE_HOME_DATA_ADDR -: Address to bind storage service. Default: `0.0.0.0:9156`. - ---url | $STORAGE_STORAGE_HOME_DATA_URL -: URL to use for the storage service. Default: `localhost:9156`. +--addr | $STORAGE_FRONTEND_ADDR +: Address to bind storage service. Default: `0.0.0.0:9140`. ---driver | $STORAGE_STORAGE_HOME_DATA_DRIVER -: storage driver for home data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. +--url | $STORAGE_FRONTEND_URL +: URL to use for the storage service. Default: `https://localhost:9200`. ---prefix | $STORAGE_STORAGE_HOME_DATA_PREFIX -: prefix for the http endpoint, without leading slash. Default: `data`. +--datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX +: datagateway prefix. Default: `data`. ---temp-folder | $STORAGE_STORAGE_HOME_DATA_TEMP_FOLDER -: temp folder. Default: `/var/tmp/`. +--ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX +: owncloud webdav endpoint prefix. ---enable-home | $STORAGE_STORAGE_HOME_ENABLE_HOME -: enable the creation of home directories. Default: `true`. +--ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX +: open collaboration services endpoint prefix. Default: `ocs`. --gateway-url | $STORAGE_GATEWAY_URL : URL to use for the storage gateway service. Default: `localhost:9142`. ---users-url | $STORAGE_USERS_URL -: URL to use for the storage service. Default: `localhost:9144`. +--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-metadata @@ -376,121 +412,10 @@ Usage: `storage storage-metadata [command options] [arguments...]` : storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `local`. --data-provider-driver | $STORAGE_STORAGE_METADATA_DATA_PROVIDER_DRIVER -: storage driver for data-provider mount: eg. local, eos, owncloud, ocis or s3. Default: `local`. - ---storage-root | $STORAGE_STORAGE_METADATA_ROOT -: the path to the metadata storage root. Default: `/var/tmp/ocis/metadata`. - -### 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_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---protocol | $STORAGE_SHARING_PROTOCOL -: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. - ---addr | $STORAGE_SHARING_ADDR -: Address to bind storage service. Default: `0.0.0.0:9150`. - ---url | $STORAGE_SHARING_URL -: URL to use for the storage service. Default: `localhost: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 storage-home - -Start storage-home service - -Usage: `storage storage-home [command options] [arguments...]` - ---debug-addr | $STORAGE_STORAGE_HOME_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9155`. - ---network | $STORAGE_STORAGE_HOME_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---protocol | $STORAGE_STORAGE_HOME_PROTOCOL -: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. - ---addr | $STORAGE_STORAGE_HOME_ADDR -: Address to bind storage service. Default: `0.0.0.0:9154`. - ---url | $STORAGE_STORAGE_HOME_URL -: URL to use for the storage service. Default: `localhost:9154`. - ---driver | $STORAGE_STORAGE_HOME_DRIVER -: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. - ---mount-path | $STORAGE_STORAGE_HOME_MOUNT_PATH -: mount path. Default: `/home`. - ---mount-id | $STORAGE_STORAGE_HOME_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. - ---expose-data-server | $STORAGE_STORAGE_HOME_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. - ---data-server-url | $STORAGE_STORAGE_HOME_DATA_SERVER_URL -: data server url. Default: `http://localhost:9156/data`. - ---enable-home | $STORAGE_STORAGE_HOME_ENABLE_HOME -: enable the creation of home directories. Default: `true`. - ---users-url | $STORAGE_USERS_URL -: URL to use for the storage service. Default: `localhost:9144`. - -### storage storage-oc - -Start storage-oc service - -Usage: `storage storage-oc [command options] [arguments...]` - ---debug-addr | $STORAGE_STORAGE_OC_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9163`. - ---network | $STORAGE_STORAGE_OC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---protocol | $STORAGE_STORAGE_OC_PROTOCOL -: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. - ---addr | $STORAGE_STORAGE_OC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9162`. - ---url | $STORAGE_STORAGE_OC_URL -: URL to use for the storage service. Default: `localhost:9162`. - ---driver | $STORAGE_STORAGE_OC_DRIVER -: storage driver for oc mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. - ---mount-path | $STORAGE_STORAGE_OC_MOUNT_PATH -: mount path. Default: `/oc`. - ---mount-id | $STORAGE_STORAGE_OC_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. - ---expose-data-server | $STORAGE_STORAGE_OC_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. - ---data-server-url | $STORAGE_STORAGE_OC_DATA_SERVER_URL -: data server url. Default: `http://localhost:9164/data`. +: storage driver for data-provider mount: eg. local, eos, owncloud, ocis or s3. Default: `local`. ---users-url | $STORAGE_USERS_URL -: URL to use for the storage service. Default: `localhost:9144`. +--storage-root | $STORAGE_STORAGE_METADATA_ROOT +: the path to the metadata storage root. Default: `/var/tmp/ocis/metadata`. ### storage storage @@ -510,42 +435,6 @@ Usage: `storage storage [command options] [arguments...]` --log-color | $STORAGE_LOG_COLOR : Enable colored logging. -### storage storage-root - -Start storage-root service - -Usage: `storage storage-root [command options] [arguments...]` - ---debug-addr | $STORAGE_STORAGE_ROOT_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9153`. - ---network | $STORAGE_STORAGE_ROOT_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---protocol | $STORAGE_STORAGE_ROOT_PROTOCOL -: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. - ---addr | $STORAGE_STORAGE_ROOT_ADDR -: Address to bind storage service. Default: `0.0.0.0:9152`. - ---url | $STORAGE_STORAGE_ROOT_URL -: URL to use for the storage service. Default: `localhost:9152`. - ---driver | $STORAGE_STORAGE_ROOT_DRIVER -: storage driver for root mount: eg. local, eos, owncloud, ocis or s3. Default: `local`. - ---mount-path | $STORAGE_STORAGE_ROOT_MOUNT_PATH -: mount path. Default: `/`. - ---mount-id | $STORAGE_STORAGE_ROOT_MOUNT_ID -: mount id. Default: `123e4567-e89b-12d3-a456-426655440001`. - ---expose-data-server | $STORAGE_STORAGE_ROOT_EXPOSE_DATA_SERVER -: exposes a dedicated data server. - ---data-server-url | $STORAGE_STORAGE_ROOT_DATA_SERVER_URL -: data server url. - ### storage storage-oc-data Start storage-oc-data service @@ -609,99 +498,210 @@ Usage: `storage auth-basic [command options] [arguments...]` --url | $STORAGE_AUTH_BASIC_URL : URL to use for the storage service. Default: `localhost:9146`. -### storage frontend +### storage storage-eos-data -Start frontend service +Start storage-eos-data service -Usage: `storage frontend [command options] [arguments...]` +Usage: `storage storage-eos-data [command options] [arguments...]` ---debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9141`. +--debug-addr | $STORAGE_STORAGE_OC_DATA_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9161`. ---transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. +--network | $STORAGE_STORAGE_EOS_DATA_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---webdav-namespace | $WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `/home/`. +--protocol | $STORAGE_STORAGE_EOS_DATA_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `http`. ---dav-files-namespace | $DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `/oc/`. +--addr | $STORAGE_STORAGE_EOS_DATA_ADDR +: Address to bind storage service. Default: `0.0.0.0:9160`. ---network | $STORAGE_FRONTEND_NETWORK +--url | $STORAGE_STORAGE_EOS_DATA_URL +: URL to use for the storage service. Default: `localhost:9160`. + +--driver | $STORAGE_STORAGE_EOS_DATA_DRIVER +: storage driver for eos data mount: eg. local, eos, owncloud, ocis or s3. Default: `eos`. + +--prefix | $STORAGE_STORAGE_EOS_DATA_PREFIX +: prefix for the http endpoint, without leading slash. Default: `data`. + +--temp-folder | $STORAGE_STORAGE_EOS_DATA_TEMP_FOLDER +: temp folder. Default: `/var/tmp/`. + +--gateway-url | $STORAGE_GATEWAY_URL +: URL to use for the storage gateway service. Default: `localhost:9142`. + +--users-url | $STORAGE_USERS_URL +: URL to use for the storage service. Default: `localhost:9144`. + +### storage storage-home-data + +Start storage-home-data service + +Usage: `storage storage-home-data [command options] [arguments...]` + +--debug-addr | $STORAGE_STORAGE_HOME_DATA_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9157`. + +--network | $STORAGE_STORAGE_HOME_DATA_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $STORAGE_FRONTEND_PROTOCOL +--protocol | $STORAGE_STORAGE_HOME_DATA_PROTOCOL : protocol for storage service, can be 'http' or 'grpc'. Default: `http`. ---addr | $STORAGE_FRONTEND_ADDR -: Address to bind storage service. Default: `0.0.0.0:9140`. +--addr | $STORAGE_STORAGE_HOME_DATA_ADDR +: Address to bind storage service. Default: `0.0.0.0:9156`. ---url | $STORAGE_FRONTEND_URL -: URL to use for the storage service. Default: `https://localhost:9200`. +--url | $STORAGE_STORAGE_HOME_DATA_URL +: URL to use for the storage service. Default: `localhost:9156`. ---datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `data`. +--driver | $STORAGE_STORAGE_HOME_DATA_DRIVER +: storage driver for home data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. ---ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. +--prefix | $STORAGE_STORAGE_HOME_DATA_PREFIX +: prefix for the http endpoint, without leading slash. Default: `data`. ---ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX -: open collaboration services endpoint prefix. Default: `ocs`. +--temp-folder | $STORAGE_STORAGE_HOME_DATA_TEMP_FOLDER +: temp folder. Default: `/var/tmp/`. + +--enable-home | $STORAGE_STORAGE_HOME_ENABLE_HOME +: enable the creation of home directories. Default: `true`. --gateway-url | $STORAGE_GATEWAY_URL : 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`. +--users-url | $STORAGE_USERS_URL +: URL to use for the storage service. Default: `localhost:9144`. ---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-public-link -### storage health +Start storage-public-link service -Check health status +Usage: `storage storage-public-link [command options] [arguments...]` -Usage: `storage health [command options] [arguments...]` +--debug-addr | $STORAGE_STORAGE_PUBLIC_LINK_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9179`. ---debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9109`. +--network | $STORAGE_STORAGE_PUBLIC_LINK_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. -### storage storage-eos-data +--protocol | $STORAGE_STORAGE_PUBLIC_LINK_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. -Start storage-eos-data service +--addr | $STORAGE_STORAGE_PUBLIC_LINK_ADDR +: Address to bind storage service. Default: `0.0.0.0:9178`. -Usage: `storage storage-eos-data [command options] [arguments...]` +--url | $STORAGE_STORAGE_PUBLIC_LINK_URL +: Address to bind storage service. Default: `localhost:9178`. ---debug-addr | $STORAGE_STORAGE_OC_DATA_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9161`. +--mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `/public/`. ---network | $STORAGE_STORAGE_EOS_DATA_NETWORK +--gateway-url | $STORAGE_GATEWAY_URL +: URL to use for the storage gateway service. Default: `localhost:9142`. + +### storage gateway + +Start gateway + +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`. + +--network | $STORAGE_GATEWAY_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $STORAGE_STORAGE_EOS_DATA_PROTOCOL -: protocol for storage service, can be 'http' or 'grpc'. Default: `http`. +--protocol | $STORAGE_GATEWAY_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. ---addr | $STORAGE_STORAGE_EOS_DATA_ADDR -: Address to bind storage service. Default: `0.0.0.0:9160`. +--addr | $STORAGE_GATEWAY_ADDR +: Address to bind storage service. Default: `0.0.0.0:9142`. ---url | $STORAGE_STORAGE_EOS_DATA_URL -: URL to use for the storage service. Default: `localhost:9160`. +--url | $STORAGE_GATEWAY_URL +: URL to use for the storage service. Default: `localhost:9142`. ---driver | $STORAGE_STORAGE_EOS_DATA_DRIVER -: storage driver for eos data mount: eg. local, eos, owncloud, ocis or s3. Default: `eos`. +--commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT +: Commit shares to the share manager. Default: `true`. ---prefix | $STORAGE_STORAGE_EOS_DATA_PREFIX -: prefix for the http endpoint, without leading slash. Default: `data`. +--commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF +: Commit shares to the storage. Default: `true`. ---temp-folder | $STORAGE_STORAGE_EOS_DATA_TEMP_FOLDER -: temp folder. Default: `/var/tmp/`. +--share-folder | $STORAGE_GATEWAY_SHARE_FOLDER +: mount shares in this folder of the home storage provider. Default: `Shares`. ---gateway-url | $STORAGE_GATEWAY_URL -: URL to use for the storage gateway service. Default: `localhost:9142`. +--disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN +: Disable creation of home folder on login. + +--storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER +: driver of the storage registry. Default: `static`. + +--storage-home-provider | $STORAGE_STORAGE_HOME_PROVIDER +: mount point of the storage provider for user homes in the global namespace. Default: `/home`. + +--frontend-url | $STORAGE_FRONTEND_URL +: URL to use for the storage service. Default: `https://localhost:9200`. + +--datagateway-url | $STORAGE_DATAGATEWAY_URL +: URL to use for the storage datagateway. Default: `https://localhost:9200/data`. --users-url | $STORAGE_USERS_URL : URL to use for the storage service. Default: `localhost:9144`. +--auth-basic-url | $STORAGE_AUTH_BASIC_URL +: URL to use for the storage service. Default: `localhost:9146`. + +--auth-bearer-url | $STORAGE_AUTH_BEARER_URL +: URL to use for the storage service. Default: `localhost:9148`. + +--sharing-url | $STORAGE_SHARING_URL +: URL to use for the storage service. Default: `localhost:9150`. + +--storage-root-url | $STORAGE_STORAGE_ROOT_URL +: URL to use for the storage service. Default: `localhost:9152`. + +--storage-root-mount-path | $STORAGE_STORAGE_ROOT_MOUNT_PATH +: mount path. Default: `/`. + +--storage-root-mount-id | $STORAGE_STORAGE_ROOT_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009152`. + +--storage-home-url | $STORAGE_STORAGE_HOME_URL +: URL to use for the storage service. Default: `localhost:9154`. + +--storage-home-mount-path | $STORAGE_STORAGE_HOME_MOUNT_PATH +: mount path. Default: `/home`. + +--storage-home-mount-id | $STORAGE_STORAGE_HOME_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009154`. + +--storage-eos-url | $STORAGE_STORAGE_EOS_URL +: URL to use for the storage service. Default: `localhost:9158`. + +--storage-eos-mount-path | $STORAGE_STORAGE_EOS_MOUNT_PATH +: mount path. Default: `/eos`. + +--storage-eos-mount-id | $STORAGE_STORAGE_EOS_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009158`. + +--storage-oc-url | $STORAGE_STORAGE_OC_URL +: URL to use for the storage service. Default: `localhost:9162`. + +--storage-oc-mount-path | $STORAGE_STORAGE_OC_MOUNT_PATH +: mount path. Default: `/oc`. + +--storage-oc-mount-id | $STORAGE_STORAGE_OC_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. + +--public-link-url | $STORAGE_STORAGE_PUBLIC_LINK_URL +: URL to use for the public links service. Default: `localhost:9178`. + +--storage-public-link-mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `/public/`. + ## 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 6d122450395..b84c7ff48bb 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-12T12:54:01+0000" +date: "2020-10-13T12:20:26+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/extensions/webdav @@ -57,6 +57,27 @@ 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 + +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 server Start integrated server @@ -102,24 +123,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`. - -### 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`. -