diff --git a/docs/extensions/storage/configuration.md b/docs/extensions/storage/configuration.md index 3c0f272d81..f77e5bbacf 100644 --- a/docs/extensions/storage/configuration.md +++ b/docs/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-09-21T13:14:49+0200" +date: "2020-10-05T21:57:18+0200" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/extensions/storage @@ -39,61 +39,484 @@ If you prefer to configure the service with commandline flags you can see the av ## Root Command -Example service for Reva/oCIS +Storage service for oCIS -Usage: `ocis-reva [global options] command [command options] [arguments...]` +Usage: `storage [global options] command [command options] [arguments...]` ---config-file | $REVA_CONFIG_FILE +--config-file | $STORAGE_CONFIG_FILE : Path to config file. ---log-level | $REVA_LOG_LEVEL +--log-level | $STORAGE_LOG_LEVEL : Set logging level. Default: `info`. ---log-pretty | $REVA_LOG_PRETTY +--log-pretty | $STORAGE_LOG_PRETTY : Enable pretty logging. ---log-color | $REVA_LOG_COLOR +--log-color | $STORAGE_LOG_COLOR : Enable colored logging. ## Sub Commands -### ocis-reva auth-basic +### storage sharing -Start reva authprovider for basic auth +Start sharing service -Usage: `ocis-reva auth-basic [command options] [arguments...]` +Usage: `storage sharing [command options] [arguments...]` ---debug-addr | $REVA_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9147`. +--debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9151`. ---auth-driver | $REVA_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. +--network | $STORAGE_SHARING_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---auth-json | $REVA_AUTH_JSON +--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-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 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. ---network | $REVA_AUTH_BASIC_NETWORK -: Network to use for the reva auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--rest-client-id | $STORAGE_REST_CLIENT_ID +: User rest driver Client ID. ---protocol | $REVA_AUTH_BASIC_PROTOCOL -: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`. +--rest-client-secret | $STORAGE_REST_CLIENT_SECRET +: User rest driver Client Secret. ---addr | $REVA_AUTH_BASIC_ADDR -: Address to bind reva service. Default: `0.0.0.0:9146`. +--rest-redis-address | $STORAGE_REST_REDIS_ADDRESS +: Address for redis server. Default: `localhost:6379`. ---url | $REVA_AUTH_BASIC_URL -: URL to use for the reva service. Default: `localhost:9146`. +--rest-redis-username | $STORAGE_REST_REDIS_USERNAME +: Username for redis server. -### ocis-reva frontend +--rest-redis-password | $STORAGE_REST_REDIS_PASSWORD +: Password for redis server. -Start reva frontend service +--rest-id-provider | $STORAGE_REST_ID_PROVIDER +: The OIDC Provider. -Usage: `ocis-reva frontend [command options] [arguments...]` +--rest-api-base-url | $STORAGE_REST_API_BASE_URL +: Base API Endpoint. ---debug-addr | $REVA_FRONTEND_DEBUG_ADDR +--rest-oidc-token-endpoint | $STORAGE_REST_OIDC_TOKEN_ENDPOINT +: Endpoint to generate token to access the API. + +--rest-target-api | $STORAGE_REST_TARGET_API +: The target application. + +### storage 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_GATEWAY_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`. + +--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 + +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 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-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 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 storage-oc-data + +Start storage-oc-data service + +Usage: `storage storage-oc-data [command options] [arguments...]` + +--debug-addr | $STORAGE_STORAGE_OC_DATA_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9165`. + +--network | $STORAGE_STORAGE_OC_DATA_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--protocol | $STORAGE_STORAGE_OC_DATA_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `http`. + +--addr | $STORAGE_STORAGE_OC_DATA_ADDR +: Address to bind storage service. Default: `0.0.0.0:9164`. + +--url | $STORAGE_STORAGE_OC_DATA_URL +: URL to use for the storage service. Default: `localhost:9164`. + +--driver | $STORAGE_STORAGE_OC_DATA_DRIVER +: storage driver for oc data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. + +--prefix | $STORAGE_STORAGE_OC_DATA_PREFIX +: prefix for the http endpoint, without leading slash. Default: `data`. + +--temp-folder | $STORAGE_STORAGE_OC_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-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`. + +--network | $STORAGE_STORAGE_PUBLIC_LINK_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`. + +--addr | $STORAGE_STORAGE_PUBLIC_LINK_ADDR +: Address to bind storage service. Default: `0.0.0.0:9178`. + +--url | $STORAGE_STORAGE_PUBLIC_LINK_URL +: Address to bind storage service. Default: `localhost:9178`. + +--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`. + +### 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 frontend + +Start frontend service + +Usage: `storage frontend [command options] [arguments...]` + +--debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR : Address to bind debug server. Default: `0.0.0.0:9141`. ---transfer-secret | $REVA_TRANSFER_SECRET +--transfer-secret | $STORAGE_TRANSFER_SECRET : Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. --webdav-namespace | $WEBDAV_NAMESPACE @@ -102,555 +525,180 @@ Usage: `ocis-reva frontend [command options] [arguments...]` --dav-files-namespace | $DAV_FILES_NAMESPACE : Namespace prefix for the webdav /dav/files endpoint. Default: `/oc/`. ---network | $REVA_FRONTEND_NETWORK -: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--network | $STORAGE_FRONTEND_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $REVA_FRONTEND_PROTOCOL -: protocol for reva service, can be 'http' or 'grpc'. Default: `http`. +--protocol | $STORAGE_FRONTEND_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `http`. ---addr | $REVA_FRONTEND_ADDR -: Address to bind reva service. Default: `0.0.0.0:9140`. +--addr | $STORAGE_FRONTEND_ADDR +: Address to bind storage service. Default: `0.0.0.0:9140`. ---url | $REVA_FRONTEND_URL -: URL to use for the reva service. Default: `https://localhost:9200`. +--url | $STORAGE_FRONTEND_URL +: URL to use for the storage service. Default: `https://localhost:9200`. ---datagateway-prefix | $REVA_FRONTEND_DATAGATEWAY_PREFIX +--datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX : datagateway prefix. Default: `data`. ---ocdav-prefix | $REVA_FRONTEND_OCDAV_PREFIX +--ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX : owncloud webdav endpoint prefix. ---ocs-prefix | $REVA_FRONTEND_OCS_PREFIX +--ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX : open collaboration services endpoint prefix. Default: `ocs`. ---gateway-url | $REVA_GATEWAY_URL -: URL to use for the reva gateway service. Default: `localhost:9142`. +--gateway-url | $STORAGE_GATEWAY_URL +: URL to use for the storage gateway service. Default: `localhost:9142`. ---upload-disable-tus | $REVA_FRONTEND_UPLOAD_DISABLE_TUS +--upload-disable-tus | $STORAGE_FRONTEND_UPLOAD_DISABLE_TUS : Disables TUS upload mechanism. Default: `false`. ---upload-http-method-override | $REVA_FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE +--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. -### ocis-reva gateway +### storage auth-basic -Start reva gateway +Start authprovider for basic auth -Usage: `ocis-reva gateway [command options] [arguments...]` +Usage: `storage auth-basic [command options] [arguments...]` ---debug-addr | $REVA_GATEWAY_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9143`. +--debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9147`. ---transfer-secret | $REVA_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. +--auth-driver | $STORAGE_AUTH_DRIVER +: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. ---network | $REVA_GATEWAY_NETWORK -: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--auth-json | $STORAGE_AUTH_JSON +: Path to users.json file. ---protocol | $REVA_GATEWAY_PROTOCOL -: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`. +--network | $STORAGE_AUTH_BASIC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---addr | $REVA_GATEWAY_ADDR -: Address to bind reva service. Default: `0.0.0.0:9142`. +--protocol | $STORAGE_AUTH_BASIC_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. ---url | $REVA_GATEWAY_URL -: URL to use for the reva service. Default: `localhost:9142`. +--addr | $STORAGE_AUTH_BASIC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9146`. ---commit-share-to-storage-grant | $REVA_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT -: Commit shares to the share manager. Default: `true`. +--url | $STORAGE_AUTH_BASIC_URL +: URL to use for the storage service. Default: `localhost:9146`. ---commit-share-to-storage-ref | $REVA_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF -: Commit shares to the storage. Default: `true`. - ---share-folder | $REVA_GATEWAY_SHARE_FOLDER -: mount shares in this folder of the home storage provider. Default: `Shares`. - ---disable-home-creation-on-login | $REVA_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN -: Disable creation of home folder on login. - ---storage-registry-driver | $REVA_STORAGE_REGISTRY_DRIVER -: driver of the storage registry. Default: `static`. - ---storage-home-provider | $REVA_STORAGE_HOME_PROVIDER -: mount point of the storage provider for user homes in the global namespace. Default: `/home`. - ---frontend-url | $REVA_FRONTEND_URL -: URL to use for the reva service. Default: `https://localhost:9200`. - ---datagateway-url | $REVA_DATAGATEWAY_URL -: URL to use for the reva datagateway. Default: `https://localhost:9200/data`. - ---users-url | $REVA_USERS_URL -: URL to use for the reva service. Default: `localhost:9144`. - ---auth-basic-url | $REVA_AUTH_BASIC_URL -: URL to use for the reva service. Default: `localhost:9146`. - ---auth-bearer-url | $REVA_AUTH_BEARER_URL -: URL to use for the reva service. Default: `localhost:9148`. - ---sharing-url | $REVA_SHARING_URL -: URL to use for the reva service. Default: `localhost:9150`. - ---storage-root-url | $REVA_STORAGE_ROOT_URL -: URL to use for the reva service. Default: `localhost:9152`. - ---storage-root-mount-path | $REVA_STORAGE_ROOT_MOUNT_PATH -: mount path. Default: `/`. - ---storage-root-mount-id | $REVA_STORAGE_ROOT_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009152`. - ---storage-home-url | $REVA_STORAGE_HOME_URL -: URL to use for the reva service. Default: `localhost:9154`. - ---storage-home-mount-path | $REVA_STORAGE_HOME_MOUNT_PATH -: mount path. Default: `/home`. - ---storage-home-mount-id | $REVA_STORAGE_HOME_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009154`. - ---storage-eos-url | $REVA_STORAGE_EOS_URL -: URL to use for the reva service. Default: `localhost:9158`. - ---storage-eos-mount-path | $REVA_STORAGE_EOS_MOUNT_PATH -: mount path. Default: `/eos`. - ---storage-eos-mount-id | $REVA_STORAGE_EOS_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009158`. - ---storage-oc-url | $REVA_STORAGE_OC_URL -: URL to use for the reva service. Default: `localhost:9162`. - ---storage-oc-mount-path | $REVA_STORAGE_OC_MOUNT_PATH -: mount path. Default: `/oc`. - ---storage-oc-mount-id | $REVA_STORAGE_OC_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. - ---public-link-url | $REVA_STORAGE_PUBLIC_LINK_URL -: URL to use for the public links service. Default: `localhost:9178`. - ---storage-public-link-mount-path | $REVA_STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `/public/`. - -### ocis-reva sharing - -Start reva sharing service - -Usage: `ocis-reva sharing [command options] [arguments...]` - ---debug-addr | $REVA_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9151`. - ---network | $REVA_SHARING_NETWORK -: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---protocol | $REVA_SHARING_PROTOCOL -: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`. - ---addr | $REVA_SHARING_ADDR -: Address to bind reva service. Default: `0.0.0.0:9150`. - ---url | $REVA_SHARING_URL -: URL to use for the reva service. Default: `localhost:9150`. - ---user-driver | $REVA_SHARING_USER_DRIVER -: driver to use for the UserShareProvider. Default: `json`. - ---user-json-file | $REVA_SHARING_USER_JSON_FILE -: file used to persist shares for the UserShareProvider. Default: `/var/tmp/reva/shares.json`. - ---public-driver | $REVA_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `json`. - -### ocis-reva storage-home-data - -Start reva storage-home-data service - -Usage: `ocis-reva storage-home-data [command options] [arguments...]` - ---debug-addr | $REVA_STORAGE_HOME_DATA_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9157`. - ---network | $REVA_STORAGE_HOME_DATA_NETWORK -: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---protocol | $REVA_STORAGE_HOME_DATA_PROTOCOL -: protocol for reva service, can be 'http' or 'grpc'. Default: `http`. - ---addr | $REVA_STORAGE_HOME_DATA_ADDR -: Address to bind reva service. Default: `0.0.0.0:9156`. - ---url | $REVA_STORAGE_HOME_DATA_URL -: URL to use for the reva service. Default: `localhost:9156`. - ---driver | $REVA_STORAGE_HOME_DATA_DRIVER -: storage driver for home data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. - ---prefix | $REVA_STORAGE_HOME_DATA_PREFIX -: prefix for the http endpoint, without leading slash. Default: `data`. - ---temp-folder | $REVA_STORAGE_HOME_DATA_TEMP_FOLDER -: temp folder. Default: `/var/tmp/`. - ---enable-home | $REVA_STORAGE_HOME_ENABLE_HOME -: enable the creation of home directories. Default: `true`. - ---gateway-url | $REVA_GATEWAY_URL -: URL to use for the reva gateway service. Default: `localhost:9142`. - ---users-url | $REVA_USERS_URL -: URL to use for the reva service. Default: `localhost:9144`. - -### ocis-reva health +### storage health Check health status -Usage: `ocis-reva health [command options] [arguments...]` +Usage: `storage health [command options] [arguments...]` ---debug-addr | $REVA_DEBUG_ADDR +--debug-addr | $STORAGE_DEBUG_ADDR : Address to debug endpoint. Default: `0.0.0.0:9109`. -### ocis-reva storage-home +### storage storage-eos-data -Start reva storage-home service +Start storage-eos-data service -Usage: `ocis-reva storage-home [command options] [arguments...]` +Usage: `storage storage-eos-data [command options] [arguments...]` ---debug-addr | $REVA_STORAGE_HOME_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9155`. - ---network | $REVA_STORAGE_HOME_NETWORK -: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---protocol | $REVA_STORAGE_HOME_PROTOCOL -: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`. - ---addr | $REVA_STORAGE_HOME_ADDR -: Address to bind reva service. Default: `0.0.0.0:9154`. - ---url | $REVA_STORAGE_HOME_URL -: URL to use for the reva service. Default: `localhost:9154`. - ---driver | $REVA_STORAGE_HOME_DRIVER -: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. - ---mount-path | $REVA_STORAGE_HOME_MOUNT_PATH -: mount path. Default: `/home`. - ---mount-id | $REVA_STORAGE_HOME_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. - ---expose-data-server | $REVA_STORAGE_HOME_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. - ---data-server-url | $REVA_STORAGE_HOME_DATA_SERVER_URL -: data server url. Default: `http://localhost:9156/data`. - ---enable-home | $REVA_STORAGE_HOME_ENABLE_HOME -: enable the creation of home directories. Default: `true`. - ---users-url | $REVA_USERS_URL -: URL to use for the reva service. Default: `localhost:9144`. - -### ocis-reva storage-eos-data - -Start reva storage-eos-data service - -Usage: `ocis-reva storage-eos-data [command options] [arguments...]` - ---debug-addr | $REVA_STORAGE_OC_DATA_DEBUG_ADDR +--debug-addr | $STORAGE_STORAGE_OC_DATA_DEBUG_ADDR : Address to bind debug server. Default: `0.0.0.0:9161`. ---network | $REVA_STORAGE_EOS_DATA_NETWORK -: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--network | $STORAGE_STORAGE_EOS_DATA_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $REVA_STORAGE_EOS_DATA_PROTOCOL -: protocol for reva service, can be 'http' or 'grpc'. Default: `http`. +--protocol | $STORAGE_STORAGE_EOS_DATA_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `http`. ---addr | $REVA_STORAGE_EOS_DATA_ADDR -: Address to bind reva service. Default: `0.0.0.0:9160`. +--addr | $STORAGE_STORAGE_EOS_DATA_ADDR +: Address to bind storage service. Default: `0.0.0.0:9160`. ---url | $REVA_STORAGE_EOS_DATA_URL -: URL to use for the reva service. Default: `localhost:9160`. +--url | $STORAGE_STORAGE_EOS_DATA_URL +: URL to use for the storage service. Default: `localhost:9160`. ---driver | $REVA_STORAGE_EOS_DATA_DRIVER +--driver | $STORAGE_STORAGE_EOS_DATA_DRIVER : storage driver for eos data mount: eg. local, eos, owncloud, ocis or s3. Default: `eos`. ---prefix | $REVA_STORAGE_EOS_DATA_PREFIX +--prefix | $STORAGE_STORAGE_EOS_DATA_PREFIX : prefix for the http endpoint, without leading slash. Default: `data`. ---temp-folder | $REVA_STORAGE_EOS_DATA_TEMP_FOLDER +--temp-folder | $STORAGE_STORAGE_EOS_DATA_TEMP_FOLDER : temp folder. Default: `/var/tmp/`. ---gateway-url | $REVA_GATEWAY_URL -: URL to use for the reva gateway service. Default: `localhost:9142`. +--gateway-url | $STORAGE_GATEWAY_URL +: URL to use for the storage gateway service. Default: `localhost:9142`. ---users-url | $REVA_USERS_URL -: URL to use for the reva service. Default: `localhost:9144`. +--users-url | $STORAGE_USERS_URL +: URL to use for the storage service. Default: `localhost:9144`. -### ocis-reva reva-storage-public-link +### storage storage-home-data -Start reva storage-public-link service +Start storage-home-data service -Usage: `ocis-reva reva-storage-public-link [command options] [arguments...]` +Usage: `storage storage-home-data [command options] [arguments...]` ---debug-addr | $REVA_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 | $REVA_STORAGE_PUBLIC_LINK_NETWORK -: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--network | $STORAGE_STORAGE_HOME_DATA_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $REVA_STORAGE_PUBLIC_LINK_PROTOCOL -: protocol for reva 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 | $REVA_STORAGE_PUBLIC_LINK_ADDR -: Address to bind reva 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 | $REVA_STORAGE_PUBLIC_LINK_URL -: Address to bind reva service. Default: `localhost:9178`. +--url | $STORAGE_STORAGE_HOME_DATA_URL +: URL to use for the storage service. Default: `localhost:9156`. ---mount-path | $REVA_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`. ---gateway-url | $REVA_GATEWAY_URL -: URL to use for the reva gateway service. Default: `localhost:9142`. - -### ocis-reva users - -Start reva users service - -Usage: `ocis-reva users [command options] [arguments...]` - ---debug-addr | $REVA_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9145`. - ---network | $REVA_USERS_NETWORK -: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---protocol | $REVA_USERS_PROTOCOL -: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`. - ---addr | $REVA_USERS_ADDR -: Address to bind reva service. Default: `0.0.0.0:9144`. - ---url | $REVA_USERS_URL -: URL to use for the reva service. Default: `localhost:9144`. - ---driver | $REVA_USERS_DRIVER -: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. - ---json-config | $REVA_USERS_JSON -: Path to users.json file. - ---rest-client-id | $REVA_REST_CLIENT_ID -: User rest driver Client ID. - ---rest-client-secret | $REVA_REST_CLIENT_SECRET -: User rest driver Client Secret. - ---rest-redis-address | $REVA_REST_REDIS_ADDRESS -: Address for redis server. Default: `localhost:6379`. - ---rest-redis-username | $REVA_REST_REDIS_USERNAME -: Username for redis server. - ---rest-redis-password | $REVA_REST_REDIS_PASSWORD -: Password for redis server. - ---rest-id-provider | $REVA_REST_ID_PROVIDER -: The OIDC Provider. - ---rest-api-base-url | $REVA_REST_API_BASE_URL -: Base API Endpoint. - ---rest-oidc-token-endpoint | $REVA_REST_OIDC_TOKEN_ENDPOINT -: Endpoint to generate token to access the API. - ---rest-target-api | $REVA_REST_TARGET_API -: The target application. - -### ocis-reva auth-bearer - -Start reva authprovider for bearer auth - -Usage: `ocis-reva auth-bearer [command options] [arguments...]` - ---debug-addr | $REVA_AUTH_BEARER_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9149`. - ---oidc-issuer | $REVA_OIDC_ISSUER -: OIDC issuer. Default: `https://localhost:9200`. - ---oidc-insecure | $REVA_OIDC_INSECURE -: OIDC allow insecure communication. Default: `true`. - ---oidc-id-claim | $REVA_OIDC_ID_CLAIM -: OIDC id claim. Default: `preferred_username`. - ---oidc-uid-claim | $REVA_OIDC_UID_CLAIM -: OIDC uid claim. - ---oidc-gid-claim | $REVA_OIDC_GID_CLAIM -: OIDC gid claim. - ---network | $REVA_AUTH_BEARER_NETWORK -: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---protocol | $REVA_AUTH_BEARER_PROTOCOL -: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`. - ---addr | $REVA_AUTH_BEARER_ADDR -: Address to bind reva service. Default: `0.0.0.0:9148`. - ---url | $REVA_AUTH_BEARER_URL -: URL to use for the reva service. Default: `localhost:9148`. - -### ocis-reva storage-eos - -Start reva storage-eos service - -Usage: `ocis-reva storage-eos [command options] [arguments...]` - ---debug-addr | $REVA_STORAGE_EOS_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9159`. - ---network | $REVA_STORAGE_EOS_NETWORK -: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---protocol | $REVA_STORAGE_EOS_PROTOCOL -: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`. - ---addr | $REVA_STORAGE_EOS_ADDR -: Address to bind reva service. Default: `0.0.0.0:9158`. - ---url | $REVA_STORAGE_EOS_URL -: URL to use for the reva service. Default: `localhost:9158`. - ---driver | $REVA_STORAGE_EOS_DRIVER -: storage driver for eos mount: eg. local, eos, owncloud, ocis or s3. Default: `eos`. - ---mount-path | $REVA_STORAGE_EOS_MOUNT_PATH -: mount path. Default: `/eos`. - ---mount-id | $REVA_STORAGE_EOS_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009158`. - ---expose-data-server | $REVA_STORAGE_EOS_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. - ---data-server-url | $REVA_STORAGE_EOS_DATA_SERVER_URL -: data server url. Default: `http://localhost:9160/data`. - -### ocis-reva storage-oc - -Start reva storage-oc service - -Usage: `ocis-reva storage-oc [command options] [arguments...]` - ---debug-addr | $REVA_STORAGE_OC_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9163`. - ---network | $REVA_STORAGE_OC_NETWORK -: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---protocol | $REVA_STORAGE_OC_PROTOCOL -: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`. - ---addr | $REVA_STORAGE_OC_ADDR -: Address to bind reva service. Default: `0.0.0.0:9162`. - ---url | $REVA_STORAGE_OC_URL -: URL to use for the reva service. Default: `localhost:9162`. - ---driver | $REVA_STORAGE_OC_DRIVER -: storage driver for oc mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. - ---mount-path | $REVA_STORAGE_OC_MOUNT_PATH -: mount path. Default: `/oc`. - ---mount-id | $REVA_STORAGE_OC_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. - ---expose-data-server | $REVA_STORAGE_OC_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. - ---data-server-url | $REVA_STORAGE_OC_DATA_SERVER_URL -: data server url. Default: `http://localhost:9164/data`. - ---users-url | $REVA_USERS_URL -: URL to use for the reva service. Default: `localhost:9144`. - -### ocis-reva storage-oc-data - -Start reva storage-oc-data service - -Usage: `ocis-reva storage-oc-data [command options] [arguments...]` - ---debug-addr | $REVA_STORAGE_OC_DATA_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9165`. - ---network | $REVA_STORAGE_OC_DATA_NETWORK -: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---protocol | $REVA_STORAGE_OC_DATA_PROTOCOL -: protocol for reva service, can be 'http' or 'grpc'. Default: `http`. - ---addr | $REVA_STORAGE_OC_DATA_ADDR -: Address to bind reva service. Default: `0.0.0.0:9164`. - ---url | $REVA_STORAGE_OC_DATA_URL -: URL to use for the reva service. Default: `localhost:9164`. - ---driver | $REVA_STORAGE_OC_DATA_DRIVER -: storage driver for oc data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. - ---prefix | $REVA_STORAGE_OC_DATA_PREFIX +--prefix | $STORAGE_STORAGE_HOME_DATA_PREFIX : prefix for the http endpoint, without leading slash. Default: `data`. ---temp-folder | $REVA_STORAGE_OC_DATA_TEMP_FOLDER +--temp-folder | $STORAGE_STORAGE_HOME_DATA_TEMP_FOLDER : temp folder. Default: `/var/tmp/`. ---gateway-url | $REVA_GATEWAY_URL -: URL to use for the reva gateway service. Default: `localhost:9142`. +--enable-home | $STORAGE_STORAGE_HOME_ENABLE_HOME +: enable the creation of home directories. Default: `true`. ---users-url | $REVA_USERS_URL -: URL to use for the reva service. Default: `localhost:9144`. +--gateway-url | $STORAGE_GATEWAY_URL +: URL to use for the storage gateway service. Default: `localhost:9142`. -### ocis-reva storage-root +--users-url | $STORAGE_USERS_URL +: URL to use for the storage service. Default: `localhost:9144`. -Start reva storage-root service +### storage storage-root -Usage: `ocis-reva storage-root [command options] [arguments...]` +Start storage-root service ---debug-addr | $REVA_STORAGE_ROOT_DEBUG_ADDR +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 | $REVA_STORAGE_ROOT_NETWORK -: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--network | $STORAGE_STORAGE_ROOT_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $REVA_STORAGE_ROOT_PROTOCOL -: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`. +--protocol | $STORAGE_STORAGE_ROOT_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. ---addr | $REVA_STORAGE_ROOT_ADDR -: Address to bind reva service. Default: `0.0.0.0:9152`. +--addr | $STORAGE_STORAGE_ROOT_ADDR +: Address to bind storage service. Default: `0.0.0.0:9152`. ---url | $REVA_STORAGE_ROOT_URL -: URL to use for the reva service. Default: `localhost:9152`. +--url | $STORAGE_STORAGE_ROOT_URL +: URL to use for the storage service. Default: `localhost:9152`. ---driver | $REVA_STORAGE_ROOT_DRIVER +--driver | $STORAGE_STORAGE_ROOT_DRIVER : storage driver for root mount: eg. local, eos, owncloud, ocis or s3. Default: `local`. ---mount-path | $REVA_STORAGE_ROOT_MOUNT_PATH +--mount-path | $STORAGE_STORAGE_ROOT_MOUNT_PATH : mount path. Default: `/`. ---mount-id | $REVA_STORAGE_ROOT_MOUNT_ID +--mount-id | $STORAGE_STORAGE_ROOT_MOUNT_ID : mount id. Default: `123e4567-e89b-12d3-a456-426655440001`. ---expose-data-server | $REVA_STORAGE_ROOT_EXPOSE_DATA_SERVER +--expose-data-server | $STORAGE_STORAGE_ROOT_EXPOSE_DATA_SERVER : exposes a dedicated data server. ---data-server-url | $REVA_STORAGE_ROOT_DATA_SERVER_URL +--data-server-url | $STORAGE_STORAGE_ROOT_DATA_SERVER_URL : data server url. diff --git a/storage/templates/CONFIGURATION.tmpl b/storage/templates/CONFIGURATION.tmpl index 060c8024fe..26272fc212 100644 --- a/storage/templates/CONFIGURATION.tmpl +++ b/storage/templates/CONFIGURATION.tmpl @@ -2,8 +2,8 @@ title: "Configuration" date: "{{ date "2006-01-02T15:04:05-0700" now }}" weight: 20 -geekdocRepo: https://github.com/owncloud/ocis-reva -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/storage geekdocFilePath: configuration.md --- {{- define "options"}} @@ -11,7 +11,7 @@ geekdocFilePath: configuration.md {{ range $opt := first . }}{{ with list $fnName $opt -}} {{ $o := last . -}} {{ if eq $o.FnName $fnName -}} ---{{ $o.Name }} | ${{ index $o.Env 0 }} +--{{ $o.Name }} | ${{ index $o.Env 0 }} : {{ $o.Usage }}. {{- if $o.Default }} Default: `{{ $o.Default }}`.{{ end }} {{ end -}} @@ -52,12 +52,12 @@ If you prefer to configure the service with commandline flags you can see the av {{ $options := .Options -}} {{ range $com := .Commands }}{{ with (list $options $com) -}} {{ $c := last . -}} -{{ if eq $c.Name "ocis-reva" -}} +{{ if eq $c.Name "storage" -}} ## Root Command {{ $c.Usage }} -Usage: `ocis-reva [global options] command [command options] [arguments...]` +Usage: `storage [global options] command [command options] [arguments...]` {{ template "options" . -}} ## Sub Commands @@ -67,12 +67,12 @@ Usage: `ocis-reva [global options] command [command options] [arguments...]` {{- range $com := .Commands }}{{ with (list $options $com) -}} {{- $c := last . }} {{- if ne $c.Name "ocis-reva" -}} -### ocis-reva {{ $c.Name }} +### storage {{ $c.Name }} {{ $c.Usage }} -Usage: `ocis-reva {{ $c.Name }} [command options] [arguments...]` +Usage: `storage {{ $c.Name }} [command options] [arguments...]` {{ template "options" . }} {{- end -}} {{- end -}} -{{- end -}} \ No newline at end of file +{{- end -}}