diff --git a/extensions/konnectd/configuration.md b/extensions/konnectd/configuration.md index b8dfff23208..fdcb4a9b3e4 100644 --- a/extensions/konnectd/configuration.md +++ b/extensions/konnectd/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-19T03:16:51+0000" +date: "2020-10-19T09:04:46+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 fd48cc84659..c8d406010a3 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-19T03:16:55+0000" +date: "2020-10-19T09:04:49+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis-proxy geekdocEditPath: edit/master/docs @@ -57,27 +57,6 @@ Usage: `ocis-proxy [global options] command [command options] [arguments...]` ## Sub Commands -### 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`. - ### ocis-proxy server Start integrated server @@ -150,3 +129,24 @@ 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`. + +### 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`. + diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index 1e535047972..f21fd708360 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-19T03:16:53+0000" +date: "2020-10-19T09:04:48+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/extensions/storage @@ -57,81 +57,48 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage storage-home-data +### storage storage-home -Start storage-home-data service +Start storage-home service -Usage: `storage storage-home-data [command options] [arguments...]` +Usage: `storage storage-home [command options] [arguments...]` ---debug-addr | $STORAGE_STORAGE_HOME_DATA_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9157`. +--debug-addr | $STORAGE_STORAGE_HOME_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9155`. ---network | $STORAGE_STORAGE_HOME_DATA_NETWORK +--network | $STORAGE_STORAGE_HOME_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`. +--protocol | $STORAGE_STORAGE_HOME_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. ---addr | $STORAGE_STORAGE_HOME_DATA_ADDR -: Address to bind storage service. Default: `0.0.0.0:9156`. +--addr | $STORAGE_STORAGE_HOME_ADDR +: Address to bind storage service. Default: `0.0.0.0:9154`. ---url | $STORAGE_STORAGE_HOME_DATA_URL -: URL to use for the storage service. Default: `localhost:9156`. +--url | $STORAGE_STORAGE_HOME_URL +: URL to use for the storage service. Default: `localhost:9154`. ---driver | $STORAGE_STORAGE_HOME_DATA_DRIVER -: storage driver for home data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. +--driver | $STORAGE_STORAGE_HOME_DRIVER +: storage driver for home 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`. +--mount-path | $STORAGE_STORAGE_HOME_MOUNT_PATH +: mount path. Default: `/home`. ---temp-folder | $STORAGE_STORAGE_HOME_DATA_TEMP_FOLDER -: temp folder. Default: `/var/tmp/`. +--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`. ---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-eos - -Start storage-eos service - -Usage: `storage storage-eos [command options] [arguments...]` - ---debug-addr | $STORAGE_STORAGE_EOS_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9159`. - ---network | $STORAGE_STORAGE_EOS_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---protocol | $STORAGE_STORAGE_EOS_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`. - ---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 frontend Start frontend service @@ -180,107 +147,113 @@ 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 sharing +### storage storage-eos -Start sharing service +Start storage-eos service -Usage: `storage sharing [command options] [arguments...]` +Usage: `storage storage-eos [command options] [arguments...]` ---debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9151`. +--debug-addr | $STORAGE_STORAGE_EOS_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9159`. ---network | $STORAGE_SHARING_NETWORK +--network | $STORAGE_STORAGE_EOS_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $STORAGE_SHARING_PROTOCOL +--protocol | $STORAGE_STORAGE_EOS_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`. +--addr | $STORAGE_STORAGE_EOS_ADDR +: Address to bind storage service. Default: `0.0.0.0:9158`. ---url | $STORAGE_SHARING_URL -: URL to use for the storage service. Default: `localhost:9150`. +--url | $STORAGE_STORAGE_EOS_URL +: URL to use for the storage service. Default: `localhost:9158`. ---user-driver | $STORAGE_SHARING_USER_DRIVER -: driver to use for the UserShareProvider. Default: `json`. +--driver | $STORAGE_STORAGE_EOS_DRIVER +: storage driver for eos mount: eg. local, eos, owncloud, ocis or s3. Default: `eos`. ---user-json-file | $STORAGE_SHARING_USER_JSON_FILE -: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/shares.json`. +--mount-path | $STORAGE_STORAGE_EOS_MOUNT_PATH +: mount path. Default: `/eos`. ---public-driver | $STORAGE_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `json`. +--mount-id | $STORAGE_STORAGE_EOS_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009158`. -### storage storage-metadata +--expose-data-server | $STORAGE_STORAGE_EOS_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. -Start storage-metadata service +--data-server-url | $STORAGE_STORAGE_EOS_DATA_SERVER_URL +: data server url. Default: `http://localhost:9160/data`. -Usage: `storage storage-metadata [command options] [arguments...]` +### storage storage-public-link ---debug-addr | $STORAGE_STORAGE_METADATA_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9217`. +Start storage-public-link service ---network | $STORAGE_STORAGE_METADATA_NETWORK +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`. + +--network | $STORAGE_STORAGE_PUBLIC_LINK_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`. +--protocol | $STORAGE_STORAGE_PUBLIC_LINK_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. ---data-server-url | $STORAGE_STORAGE_METADATA_DATA_SERVER_URL -: URL of the data-server the storage-provider uses. Default: `http://localhost:9216`. +--addr | $STORAGE_STORAGE_PUBLIC_LINK_ADDR +: Address to bind storage service. Default: `0.0.0.0:9178`. ---data-server-addr | $STORAGE_STORAGE_METADATA_DATA_SERVER_ADDR -: Address to bind the metadata data-server to. Default: `0.0.0.0:9216`. +--url | $STORAGE_STORAGE_PUBLIC_LINK_URL +: Address to bind storage service. Default: `localhost:9178`. ---storage-provider-driver | $STORAGE_STORAGE_METADATA_PROVIDER_DRIVER -: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `local`. +--mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `/public/`. ---data-provider-driver | $STORAGE_STORAGE_METADATA_DATA_PROVIDER_DRIVER -: storage driver for data-provider mount: eg. local, eos, owncloud, ocis or s3. Default: `local`. +--gateway-url | $STORAGE_GATEWAY_URL +: URL to use for the storage gateway service. Default: `localhost:9142`. ---storage-root | $STORAGE_STORAGE_METADATA_ROOT -: the path to the metadata storage root. Default: `/var/tmp/ocis/metadata`. +### storage health -### storage storage-home +Check health status -Start storage-home service +Usage: `storage health [command options] [arguments...]` -Usage: `storage storage-home [command options] [arguments...]` +--debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9109`. ---debug-addr | $STORAGE_STORAGE_HOME_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9155`. +### storage auth-bearer ---network | $STORAGE_STORAGE_HOME_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +Start authprovider for bearer auth ---protocol | $STORAGE_STORAGE_HOME_PROTOCOL -: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. +Usage: `storage auth-bearer [command options] [arguments...]` ---addr | $STORAGE_STORAGE_HOME_ADDR -: Address to bind storage service. Default: `0.0.0.0:9154`. +--debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9149`. ---url | $STORAGE_STORAGE_HOME_URL -: URL to use for the storage service. Default: `localhost:9154`. +--oidc-issuer | $STORAGE_OIDC_ISSUER +: OIDC issuer. Default: `https://localhost:9200`. ---driver | $STORAGE_STORAGE_HOME_DRIVER -: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. +--oidc-insecure | $STORAGE_OIDC_INSECURE +: OIDC allow insecure communication. Default: `true`. ---mount-path | $STORAGE_STORAGE_HOME_MOUNT_PATH -: mount path. Default: `/home`. +--oidc-id-claim | $STORAGE_OIDC_ID_CLAIM +: OIDC id claim. Default: `preferred_username`. ---mount-id | $STORAGE_STORAGE_HOME_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. +--oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM +: OIDC uid claim. ---expose-data-server | $STORAGE_STORAGE_HOME_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. +--oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM +: OIDC gid claim. ---data-server-url | $STORAGE_STORAGE_HOME_DATA_SERVER_URL -: data server url. Default: `http://localhost:9156/data`. +--network | $STORAGE_AUTH_BEARER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---enable-home | $STORAGE_STORAGE_HOME_ENABLE_HOME -: enable the creation of home directories. Default: `true`. +--protocol | $STORAGE_AUTH_BEARER_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. ---users-url | $STORAGE_USERS_URL -: URL to use for the storage service. Default: `localhost:9144`. +--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 @@ -294,11 +267,104 @@ Usage: `storage storage [command options] [arguments...]` --log-level | $STORAGE_LOG_LEVEL : Set logging level. Default: `info`. ---log-pretty | $STORAGE_LOG_PRETTY -: Enable pretty logging. +--log-pretty | $STORAGE_LOG_PRETTY +: Enable pretty logging. + +--log-color | $STORAGE_LOG_COLOR +: Enable colored logging. + +### 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 + +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_USERS_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--protocol | $STORAGE_USERS_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. + +--addr | $STORAGE_USERS_ADDR +: Address to bind storage service. Default: `0.0.0.0:9144`. + +--url | $STORAGE_USERS_URL +: URL to use for the storage service. Default: `localhost:9144`. + +--driver | $STORAGE_USERS_DRIVER +: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. + +--json-config | $STORAGE_USERS_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. ---log-color | $STORAGE_LOG_COLOR -: Enable colored logging. +--rest-target-api | $STORAGE_REST_TARGET_API +: The target application. ### storage gateway @@ -438,117 +504,6 @@ Usage: `storage storage-root [command options] [arguments...]` --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 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 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 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-oc-data Start storage-oc-data service @@ -585,59 +540,92 @@ Usage: `storage storage-oc-data [command options] [arguments...]` --users-url | $STORAGE_USERS_URL : URL to use for the storage service. Default: `localhost:9144`. -### storage users +### storage storage-metadata -Start users service +Start storage-metadata service -Usage: `storage users [command options] [arguments...]` +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 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:9145`. +: Address to bind debug server. Default: `0.0.0.0:9151`. ---network | $STORAGE_USERS_NETWORK +--network | $STORAGE_SHARING_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $STORAGE_USERS_PROTOCOL +--protocol | $STORAGE_SHARING_PROTOCOL : protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. ---addr | $STORAGE_USERS_ADDR -: Address to bind storage service. Default: `0.0.0.0:9144`. +--addr | $STORAGE_SHARING_ADDR +: Address to bind storage service. Default: `0.0.0.0:9150`. ---url | $STORAGE_USERS_URL -: URL to use for the storage service. Default: `localhost:9144`. +--url | $STORAGE_SHARING_URL +: URL to use for the storage service. Default: `localhost:9150`. ---driver | $STORAGE_USERS_DRIVER -: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. +--user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `json`. ---json-config | $STORAGE_USERS_JSON -: Path to users.json file. +--user-json-file | $STORAGE_SHARING_USER_JSON_FILE +: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/shares.json`. ---rest-client-id | $STORAGE_REST_CLIENT_ID -: User rest driver Client ID. +--public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `json`. ---rest-client-secret | $STORAGE_REST_CLIENT_SECRET -: User rest driver Client Secret. +### storage auth-basic ---rest-redis-address | $STORAGE_REST_REDIS_ADDRESS -: Address for redis server. Default: `localhost:6379`. +Start authprovider for basic auth ---rest-redis-username | $STORAGE_REST_REDIS_USERNAME -: Username for redis server. +Usage: `storage auth-basic [command options] [arguments...]` ---rest-redis-password | $STORAGE_REST_REDIS_PASSWORD -: Password for redis server. +--debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9147`. ---rest-id-provider | $STORAGE_REST_ID_PROVIDER -: The OIDC Provider. +--auth-driver | $STORAGE_AUTH_DRIVER +: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. ---rest-api-base-url | $STORAGE_REST_API_BASE_URL -: Base API Endpoint. +--auth-json | $STORAGE_AUTH_JSON +: Path to users.json file. ---rest-oidc-token-endpoint | $STORAGE_REST_OIDC_TOKEN_ENDPOINT -: Endpoint to generate token to access the API. +--network | $STORAGE_AUTH_BASIC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---rest-target-api | $STORAGE_REST_TARGET_API -: The target application. +--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 storage-eos-data @@ -675,33 +663,45 @@ 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 storage-home-data -Start storage-public-link service +Start storage-home-data service -Usage: `storage storage-public-link [command options] [arguments...]` +Usage: `storage storage-home-data [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_STORAGE_HOME_DATA_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9157`. ---network | $STORAGE_STORAGE_PUBLIC_LINK_NETWORK +--network | $STORAGE_STORAGE_HOME_DATA_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $STORAGE_STORAGE_PUBLIC_LINK_PROTOCOL -: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. +--protocol | $STORAGE_STORAGE_HOME_DATA_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `http`. ---addr | $STORAGE_STORAGE_PUBLIC_LINK_ADDR -: Address to bind storage service. Default: `0.0.0.0:9178`. +--addr | $STORAGE_STORAGE_HOME_DATA_ADDR +: Address to bind storage service. Default: `0.0.0.0:9156`. ---url | $STORAGE_STORAGE_PUBLIC_LINK_URL -: Address to bind storage service. Default: `localhost:9178`. +--url | $STORAGE_STORAGE_HOME_DATA_URL +: URL to use for the storage service. Default: `localhost:9156`. ---mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `/public/`. +--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`. + ## 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 6d7c5d96cdb..a1f2877f864 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-19T03:16:57+0000" +date: "2020-10-19T09:04:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/extensions/webdav @@ -57,27 +57,6 @@ 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 - -Usage: `webdav health [command options] [arguments...]` - ---debug-addr | $WEBDAV_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9119`. - ### webdav server Start integrated server @@ -123,3 +102,24 @@ 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`. + +### 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`. +