diff --git a/extensions/konnectd/configuration.md b/extensions/konnectd/configuration.md index 57043c3e376..f9b61db4a93 100644 --- a/extensions/konnectd/configuration.md +++ b/extensions/konnectd/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-07T03:31:21+0000" +date: "2020-10-07T09:34:43+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis-konnectd geekdocEditPath: edit/master/docs @@ -57,6 +57,15 @@ 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 server Start integrated server @@ -180,12 +189,3 @@ Usage: `ocis-konnectd version [command options] [arguments...]` --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 382fd2f1cdf..e6edd03126d 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-07T03:31:25+0000" +date: "2020-10-07T09:34:46+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis-proxy geekdocEditPath: edit/master/docs diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index 707b3f6c1b5..2515c5ca017 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-07T03:31:23+0000" +date: "2020-10-07T09:34:44+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/extensions/storage @@ -57,6 +57,72 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands +### storage storage-metadata + +Start storage-metadata service + +Usage: `storage storage-metadata [command options] [arguments...]` + +--debug-addr | $STORAGE_STORAGE_METADATA_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9217`. + +--network | $STORAGE_STORAGE_METADATA_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--provider-addr | $STORAGE_STORAGE_METADATA_PROVIDER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9215`. + +--data-server-url | $STORAGE_STORAGE_METADATA_DATA_SERVER_URL +: URL of the data-server the storage-provider uses. Default: `http://localhost:9216`. + +--data-server-addr | $STORAGE_STORAGE_METADATA_DATA_SERVER_ADDR +: Address to bind the metadata data-server to. Default: `0.0.0.0:9216`. + +--storage-provider-driver | $STORAGE_STORAGE_METADATA_PROVIDER_DRIVER +: 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 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 storage-home Start storage-home service @@ -99,41 +165,71 @@ Usage: `storage storage-home [command options] [arguments...]` --users-url | $STORAGE_USERS_URL : URL to use for the storage service. Default: `localhost:9144`. -### storage storage-eos +### storage storage-oc -Start storage-eos service +Start storage-oc service -Usage: `storage storage-eos [command options] [arguments...]` +Usage: `storage storage-oc [command options] [arguments...]` ---debug-addr | $STORAGE_STORAGE_EOS_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9159`. +--debug-addr | $STORAGE_STORAGE_OC_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9163`. ---network | $STORAGE_STORAGE_EOS_NETWORK +--network | $STORAGE_STORAGE_OC_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $STORAGE_STORAGE_EOS_PROTOCOL +--protocol | $STORAGE_STORAGE_OC_PROTOCOL : protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. ---addr | $STORAGE_STORAGE_EOS_ADDR -: Address to bind storage service. Default: `0.0.0.0:9158`. +--addr | $STORAGE_STORAGE_OC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9162`. ---url | $STORAGE_STORAGE_EOS_URL -: URL to use for the storage service. Default: `localhost:9158`. +--url | $STORAGE_STORAGE_OC_URL +: URL to use for the storage service. Default: `localhost:9162`. ---driver | $STORAGE_STORAGE_EOS_DRIVER -: storage driver for eos mount: eg. local, eos, owncloud, ocis or s3. Default: `eos`. +--driver | $STORAGE_STORAGE_OC_DRIVER +: storage driver for oc mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. ---mount-path | $STORAGE_STORAGE_EOS_MOUNT_PATH -: mount path. Default: `/eos`. +--mount-path | $STORAGE_STORAGE_OC_MOUNT_PATH +: mount path. Default: `/oc`. ---mount-id | $STORAGE_STORAGE_EOS_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009158`. +--mount-id | $STORAGE_STORAGE_OC_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. ---expose-data-server | $STORAGE_STORAGE_EOS_EXPOSE_DATA_SERVER +--expose-data-server | $STORAGE_STORAGE_OC_EXPOSE_DATA_SERVER : exposes a dedicated data server. Default: `false`. ---data-server-url | $STORAGE_STORAGE_EOS_DATA_SERVER_URL -: data server url. Default: `http://localhost:9160/data`. +--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 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_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--protocol | $STORAGE_AUTH_BASIC_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. + +--addr | $STORAGE_AUTH_BASIC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9146`. + +--url | $STORAGE_AUTH_BASIC_URL +: URL to use for the storage service. Default: `localhost:9146`. ### storage sharing @@ -165,6 +261,63 @@ Usage: `storage sharing [command options] [arguments...]` --public-driver | $STORAGE_SHARING_PUBLIC_DRIVER : driver to use for the PublicShareProvider. Default: `json`. +### 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_STORAGE_HOME_DATA_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`. + +--driver | $STORAGE_STORAGE_HOME_DATA_DRIVER +: storage driver for home data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. + +--prefix | $STORAGE_STORAGE_HOME_DATA_PREFIX +: prefix for the http endpoint, without leading slash. Default: `data`. + +--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`. + +--users-url | $STORAGE_USERS_URL +: URL to use for the storage service. Default: `localhost:9144`. + +### 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 users Start users service @@ -255,155 +408,179 @@ Usage: `storage storage-eos-data [command options] [arguments...]` --users-url | $STORAGE_USERS_URL : URL to use for the storage service. Default: `localhost:9144`. -### storage storage-public-link +### storage gateway -Start storage-public-link service +Start gateway -Usage: `storage storage-public-link [command options] [arguments...]` +Usage: `storage gateway [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_GATEWAY_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9143`. ---network | $STORAGE_STORAGE_PUBLIC_LINK_NETWORK +--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_PUBLIC_LINK_PROTOCOL +--protocol | $STORAGE_GATEWAY_PROTOCOL : protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. ---addr | $STORAGE_STORAGE_PUBLIC_LINK_ADDR -: Address to bind storage service. Default: `0.0.0.0:9178`. +--addr | $STORAGE_GATEWAY_ADDR +: Address to bind storage service. Default: `0.0.0.0:9142`. ---url | $STORAGE_STORAGE_PUBLIC_LINK_URL -: Address to bind storage service. Default: `localhost:9178`. +--url | $STORAGE_GATEWAY_URL +: URL to use for the storage service. Default: `localhost:9142`. ---mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `/public/`. +--commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT +: Commit shares to the share manager. Default: `true`. ---gateway-url | $STORAGE_GATEWAY_URL -: URL to use for the storage gateway service. Default: `localhost:9142`. +--commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF +: Commit shares to the storage. Default: `true`. -### storage storage-metadata +--share-folder | $STORAGE_GATEWAY_SHARE_FOLDER +: mount shares in this folder of the home storage provider. Default: `Shares`. -Start storage-metadata service +--disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN +: Disable creation of home folder on login. -Usage: `storage storage-metadata [command options] [arguments...]` +--storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER +: driver of the storage registry. Default: `static`. ---debug-addr | $STORAGE_STORAGE_METADATA_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9217`. +--storage-home-provider | $STORAGE_STORAGE_HOME_PROVIDER +: mount point of the storage provider for user homes in the global namespace. Default: `/home`. ---network | $STORAGE_STORAGE_METADATA_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--frontend-url | $STORAGE_FRONTEND_URL +: URL to use for the storage service. Default: `https://localhost:9200`. ---provider-addr | $STORAGE_STORAGE_METADATA_PROVIDER_ADDR -: Address to bind storage service. Default: `0.0.0.0:9215`. +--datagateway-url | $STORAGE_DATAGATEWAY_URL +: URL to use for the storage datagateway. Default: `https://localhost:9200/data`. ---data-server-url | $STORAGE_STORAGE_METADATA_DATA_SERVER_URL -: URL of the data-server the storage-provider uses. Default: `http://localhost:9216`. +--users-url | $STORAGE_USERS_URL +: URL to use for the storage service. Default: `localhost:9144`. ---data-server-addr | $STORAGE_STORAGE_METADATA_DATA_SERVER_ADDR -: Address to bind the metadata data-server to. Default: `0.0.0.0:9216`. +--auth-basic-url | $STORAGE_AUTH_BASIC_URL +: URL to use for the storage service. Default: `localhost:9146`. ---storage-provider-driver | $STORAGE_STORAGE_METADATA_PROVIDER_DRIVER -: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `local`. +--auth-bearer-url | $STORAGE_AUTH_BEARER_URL +: URL to use for the storage service. Default: `localhost:9148`. ---data-provider-driver | $STORAGE_STORAGE_METADATA_DATA_PROVIDER_DRIVER -: storage driver for data-provider mount: eg. local, eos, owncloud, ocis or s3. Default: `local`. +--sharing-url | $STORAGE_SHARING_URL +: URL to use for the storage service. Default: `localhost:9150`. ---storage-root | $STORAGE_STORAGE_METADATA_ROOT -: the path to the metadata storage root. Default: `/var/tmp/ocis/metadata`. +--storage-root-url | $STORAGE_STORAGE_ROOT_URL +: URL to use for the storage service. Default: `localhost:9152`. -### storage auth-bearer +--storage-root-mount-path | $STORAGE_STORAGE_ROOT_MOUNT_PATH +: mount path. Default: `/`. -Start authprovider for bearer auth +--storage-root-mount-id | $STORAGE_STORAGE_ROOT_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009152`. -Usage: `storage auth-bearer [command options] [arguments...]` +--storage-home-url | $STORAGE_STORAGE_HOME_URL +: URL to use for the storage service. Default: `localhost:9154`. ---debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9149`. +--storage-home-mount-path | $STORAGE_STORAGE_HOME_MOUNT_PATH +: mount path. Default: `/home`. ---oidc-issuer | $STORAGE_OIDC_ISSUER -: OIDC issuer. Default: `https://localhost:9200`. +--storage-home-mount-id | $STORAGE_STORAGE_HOME_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009154`. ---oidc-insecure | $STORAGE_OIDC_INSECURE -: OIDC allow insecure communication. Default: `true`. +--storage-eos-url | $STORAGE_STORAGE_EOS_URL +: URL to use for the storage service. Default: `localhost:9158`. ---oidc-id-claim | $STORAGE_OIDC_ID_CLAIM -: OIDC id claim. Default: `preferred_username`. +--storage-eos-mount-path | $STORAGE_STORAGE_EOS_MOUNT_PATH +: mount path. Default: `/eos`. ---oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM -: OIDC uid claim. +--storage-eos-mount-id | $STORAGE_STORAGE_EOS_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009158`. ---oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM -: OIDC gid claim. +--storage-oc-url | $STORAGE_STORAGE_OC_URL +: URL to use for the storage service. Default: `localhost:9162`. ---network | $STORAGE_AUTH_BEARER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--storage-oc-mount-path | $STORAGE_STORAGE_OC_MOUNT_PATH +: mount path. Default: `/oc`. ---protocol | $STORAGE_AUTH_BEARER_PROTOCOL -: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. +--storage-oc-mount-id | $STORAGE_STORAGE_OC_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. ---addr | $STORAGE_AUTH_BEARER_ADDR -: Address to bind storage service. Default: `0.0.0.0:9148`. +--public-link-url | $STORAGE_STORAGE_PUBLIC_LINK_URL +: URL to use for the public links service. Default: `localhost:9178`. ---url | $STORAGE_AUTH_BEARER_URL -: URL to use for the storage service. Default: `localhost:9148`. +--storage-public-link-mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `/public/`. -### storage storage-oc +### storage storage-root -Start storage-oc service +Start storage-root service -Usage: `storage storage-oc [command options] [arguments...]` +Usage: `storage storage-root [command options] [arguments...]` ---debug-addr | $STORAGE_STORAGE_OC_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9163`. +--debug-addr | $STORAGE_STORAGE_ROOT_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9153`. ---network | $STORAGE_STORAGE_OC_NETWORK +--network | $STORAGE_STORAGE_ROOT_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $STORAGE_STORAGE_OC_PROTOCOL +--protocol | $STORAGE_STORAGE_ROOT_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`. +--addr | $STORAGE_STORAGE_ROOT_ADDR +: Address to bind storage service. Default: `0.0.0.0:9152`. ---url | $STORAGE_STORAGE_OC_URL -: URL to use for the storage service. Default: `localhost:9162`. +--url | $STORAGE_STORAGE_ROOT_URL +: URL to use for the storage service. Default: `localhost:9152`. ---driver | $STORAGE_STORAGE_OC_DRIVER -: storage driver for oc mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. +--driver | $STORAGE_STORAGE_ROOT_DRIVER +: storage driver for root mount: eg. local, eos, owncloud, ocis or s3. Default: `local`. ---mount-path | $STORAGE_STORAGE_OC_MOUNT_PATH -: mount path. Default: `/oc`. +--mount-path | $STORAGE_STORAGE_ROOT_MOUNT_PATH +: mount path. Default: `/`. ---mount-id | $STORAGE_STORAGE_OC_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. +--mount-id | $STORAGE_STORAGE_ROOT_MOUNT_ID +: mount id. Default: `123e4567-e89b-12d3-a456-426655440001`. ---expose-data-server | $STORAGE_STORAGE_OC_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. +--expose-data-server | $STORAGE_STORAGE_ROOT_EXPOSE_DATA_SERVER +: exposes a dedicated data server. ---data-server-url | $STORAGE_STORAGE_OC_DATA_SERVER_URL -: data server url. Default: `http://localhost:9164/data`. +--data-server-url | $STORAGE_STORAGE_ROOT_DATA_SERVER_URL +: data server url. ---users-url | $STORAGE_USERS_URL -: URL to use for the storage service. Default: `localhost:9144`. +### storage storage-eos -### storage storage +Start storage-eos service -Storage service for oCIS +Usage: `storage storage-eos [command options] [arguments...]` -Usage: `storage storage [command options] [arguments...]` +--debug-addr | $STORAGE_STORAGE_EOS_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9159`. ---config-file | $STORAGE_CONFIG_FILE -: Path to config file. +--network | $STORAGE_STORAGE_EOS_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---log-level | $STORAGE_LOG_LEVEL -: Set logging level. Default: `info`. +--protocol | $STORAGE_STORAGE_EOS_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. ---log-pretty | $STORAGE_LOG_PRETTY -: Enable pretty logging. +--addr | $STORAGE_STORAGE_EOS_ADDR +: Address to bind storage service. Default: `0.0.0.0:9158`. ---log-color | $STORAGE_LOG_COLOR -: Enable colored logging. +--url | $STORAGE_STORAGE_EOS_URL +: URL to use for the storage service. Default: `localhost:9158`. + +--driver | $STORAGE_STORAGE_EOS_DRIVER +: storage driver for eos mount: eg. local, eos, owncloud, ocis or s3. Default: `eos`. + +--mount-path | $STORAGE_STORAGE_EOS_MOUNT_PATH +: mount path. Default: `/eos`. + +--mount-id | $STORAGE_STORAGE_EOS_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009158`. + +--expose-data-server | $STORAGE_STORAGE_EOS_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. + +--data-server-url | $STORAGE_STORAGE_EOS_DATA_SERVER_URL +: data server url. Default: `http://localhost:9160/data`. ### storage storage-oc-data @@ -489,108 +666,6 @@ Usage: `storage frontend [command options] [arguments...]` --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-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_STORAGE_HOME_DATA_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`. - ---driver | $STORAGE_STORAGE_HOME_DATA_DRIVER -: storage driver for home data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. - ---prefix | $STORAGE_STORAGE_HOME_DATA_PREFIX -: prefix for the http endpoint, without leading slash. Default: `data`. - ---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`. - ---users-url | $STORAGE_USERS_URL -: URL to use for the storage service. Default: `localhost:9144`. - -### 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 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_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---protocol | $STORAGE_AUTH_BASIC_PROTOCOL -: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. - ---addr | $STORAGE_AUTH_BASIC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9146`. - ---url | $STORAGE_AUTH_BASIC_URL -: URL to use for the storage service. Default: `localhost:9146`. - ### storage health Check health status @@ -600,105 +675,30 @@ Usage: `storage health [command options] [arguments...]` --debug-addr | $STORAGE_DEBUG_ADDR : Address to debug endpoint. Default: `0.0.0.0:9109`. -### storage gateway - -Start gateway +### storage storage-public-link -Usage: `storage gateway [command options] [arguments...]` +Start storage-public-link service ---debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9143`. +Usage: `storage storage-public-link [command options] [arguments...]` ---transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. +--debug-addr | $STORAGE_STORAGE_PUBLIC_LINK_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9179`. ---network | $STORAGE_GATEWAY_NETWORK +--network | $STORAGE_STORAGE_PUBLIC_LINK_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $STORAGE_GATEWAY_PROTOCOL +--protocol | $STORAGE_STORAGE_PUBLIC_LINK_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`. - ---commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF -: Commit shares to the storage. Default: `true`. - ---share-folder | $STORAGE_GATEWAY_SHARE_FOLDER -: mount shares in this folder of the home storage provider. Default: `Shares`. - ---disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN -: Disable creation of home folder on login. - ---storage-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`. +--addr | $STORAGE_STORAGE_PUBLIC_LINK_ADDR +: Address to bind storage service. Default: `0.0.0.0:9178`. ---public-link-url | $STORAGE_STORAGE_PUBLIC_LINK_URL -: URL to use for the public links service. Default: `localhost:9178`. +--url | $STORAGE_STORAGE_PUBLIC_LINK_URL +: Address to bind storage service. Default: `localhost:9178`. ---storage-public-link-mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH +--mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH : mount path. Default: `/public/`. +--gateway-url | $STORAGE_GATEWAY_URL +: URL to use for the storage gateway service. Default: `localhost:9142`. + diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index 2a07712431e..8c6e59682f5 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-07T03:31:27+0000" +date: "2020-10-07T09:34:48+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/extensions/webdav