From d462e3212c3401452112ebb1a4d208ad5cb1a0ea Mon Sep 17 00:00:00 2001 From: Vincent Petry Date: Wed, 9 Sep 2020 12:37:32 +0200 Subject: [PATCH] Add ocis to driver list in help Also added slight hint about them being mounts with specific drivers. --- docs/configuration.md | 542 ++++++++++++++++----------------- pkg/flagset/storageeos.go | 2 +- pkg/flagset/storageeosdata.go | 2 +- pkg/flagset/storagehome.go | 2 +- pkg/flagset/storagehomedata.go | 2 +- pkg/flagset/storageoc.go | 2 +- pkg/flagset/storageocdata.go | 2 +- pkg/flagset/storageroot.go | 2 +- 8 files changed, 278 insertions(+), 278 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index b57b1ab3e..792b5a530 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-09-08T14:35:15+0200" +date: "2020-09-09T12:38:00+0200" weight: 20 geekdocRepo: https://github.com/owncloud/ocis-reva geekdocEditPath: edit/master/docs @@ -57,77 +57,167 @@ Usage: `ocis-reva [global options] command [command options] [arguments...]` ## Sub Commands -### ocis-reva storage-root +### ocis-reva frontend -Start reva storage-root service +Start reva frontend service -Usage: `ocis-reva storage-root [command options] [arguments...]` +Usage: `ocis-reva frontend [command options] [arguments...]` ---debug-addr | $REVA_STORAGE_ROOT_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9153`. +--debug-addr | $REVA_FRONTEND_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9141`. ---network | $REVA_STORAGE_ROOT_NETWORK +--transfer-secret | $REVA_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. + +--webdav-namespace | $WEBDAV_NAMESPACE +: Namespace prefix for the /webdav endpoint. Default: `/home/`. + +--dav-files-namespace | $DAV_FILES_NAMESPACE +: Namespace prefix for the webdav /dav/files endpoint. Default: `/oc/`. + +--network | $REVA_FRONTEND_NETWORK : Network to use for the reva 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 | $REVA_FRONTEND_PROTOCOL +: protocol for reva service, can be 'http' or 'grpc'. Default: `http`. ---addr | $REVA_STORAGE_ROOT_ADDR -: Address to bind reva service. Default: `0.0.0.0:9152`. +--addr | $REVA_FRONTEND_ADDR +: Address to bind reva service. Default: `0.0.0.0:9140`. ---url | $REVA_STORAGE_ROOT_URL -: URL to use for the reva service. Default: `localhost:9152`. +--url | $REVA_FRONTEND_URL +: URL to use for the reva service. Default: `https://localhost:9200`. ---driver | $REVA_STORAGE_ROOT_DRIVER -: storage driver, eg. local, eos, owncloud or s3. Default: `local`. +--datagateway-prefix | $REVA_FRONTEND_DATAGATEWAY_PREFIX +: datagateway prefix. Default: `data`. ---mount-path | $REVA_STORAGE_ROOT_MOUNT_PATH -: mount path. Default: `/`. +--ocdav-prefix | $REVA_FRONTEND_OCDAV_PREFIX +: owncloud webdav endpoint prefix. ---mount-id | $REVA_STORAGE_ROOT_MOUNT_ID -: mount id. Default: `123e4567-e89b-12d3-a456-426655440001`. +--ocs-prefix | $REVA_FRONTEND_OCS_PREFIX +: open collaboration services endpoint prefix. Default: `ocs`. ---expose-data-server | $REVA_STORAGE_ROOT_EXPOSE_DATA_SERVER -: exposes a dedicated data server. +--gateway-url | $REVA_GATEWAY_URL +: URL to use for the reva gateway service. Default: `localhost:9142`. ---data-server-url | $REVA_STORAGE_ROOT_DATA_SERVER_URL -: data server url. +--upload-disable-tus | $REVA_FRONTEND_UPLOAD_DISABLE_TUS +: Disables TUS upload mechanism. Default: `false`. -### ocis-reva auth-bearer +--upload-http-method-override | $REVA_FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE +: Specify an HTTP method (ex: POST) that clients should to use when uploading instead of PATCH. -Start reva authprovider for bearer auth +### ocis-reva health -Usage: `ocis-reva auth-bearer [command options] [arguments...]` +Check health status ---debug-addr | $REVA_AUTH_BEARER_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9149`. +Usage: `ocis-reva health [command options] [arguments...]` ---oidc-issuer | $REVA_OIDC_ISSUER -: OIDC issuer. Default: `https://localhost:9200`. +--debug-addr | $REVA_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9109`. ---oidc-insecure | $REVA_OIDC_INSECURE -: OIDC allow insecure communication. Default: `true`. +### ocis-reva storage-home-data ---oidc-id-claim | $REVA_OIDC_ID_CLAIM -: OIDC id claim. Default: `preferred_username`. +Start reva storage-home-data service ---oidc-uid-claim | $REVA_OIDC_UID_CLAIM -: OIDC uid claim. +Usage: `ocis-reva storage-home-data [command options] [arguments...]` ---oidc-gid-claim | $REVA_OIDC_GID_CLAIM -: OIDC gid claim. +--debug-addr | $REVA_STORAGE_HOME_DATA_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9157`. ---network | $REVA_AUTH_BEARER_NETWORK +--network | $REVA_STORAGE_HOME_DATA_NETWORK : Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $REVA_AUTH_BEARER_PROTOCOL +--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 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_AUTH_BEARER_ADDR -: Address to bind reva service. Default: `0.0.0.0:9148`. +--addr | $REVA_STORAGE_OC_ADDR +: Address to bind reva service. Default: `0.0.0.0:9162`. ---url | $REVA_AUTH_BEARER_URL -: URL to use for the reva service. Default: `localhost:9148`. +--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 auth-basic + +Start reva authprovider for basic auth + +Usage: `ocis-reva auth-basic [command options] [arguments...]` + +--debug-addr | $REVA_AUTH_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9147`. + +--auth-driver | $REVA_AUTH_DRIVER +: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. + +--auth-json | $REVA_AUTH_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`. + +--protocol | $REVA_AUTH_BASIC_PROTOCOL +: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`. + +--addr | $REVA_AUTH_BASIC_ADDR +: Address to bind reva service. Default: `0.0.0.0:9146`. + +--url | $REVA_AUTH_BASIC_URL +: URL to use for the reva service. Default: `localhost:9146`. ### ocis-reva gateway @@ -231,6 +321,36 @@ Usage: `ocis-reva gateway [command options] [arguments...]` --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-eos-data Start reva storage-eos-data service @@ -253,7 +373,7 @@ Usage: `ocis-reva storage-eos-data [command options] [arguments...]` : URL to use for the reva service. Default: `localhost:9160`. --driver | $REVA_STORAGE_EOS_DATA_DRIVER -: storage driver, eg. local, eos, owncloud or s3. Default: `eos`. +: storage driver for eos data mount: eg. local, eos, owncloud, ocis or s3. Default: `eos`. --prefix | $REVA_STORAGE_EOS_DATA_PREFIX : prefix for the http endpoint, without leading slash. Default: `data`. @@ -267,149 +387,41 @@ Usage: `ocis-reva storage-eos-data [command options] [arguments...]` --users-url | $REVA_USERS_URL : URL to use for the reva service. Default: `localhost:9144`. -### ocis-reva storage-home +### ocis-reva auth-bearer -Start reva storage-home service +Start reva authprovider for bearer auth -Usage: `ocis-reva storage-home [command options] [arguments...]` +Usage: `ocis-reva auth-bearer [command options] [arguments...]` ---debug-addr | $REVA_STORAGE_HOME_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9155`. +--debug-addr | $REVA_AUTH_BEARER_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9149`. ---network | $REVA_STORAGE_HOME_NETWORK +--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_STORAGE_HOME_PROTOCOL +--protocol | $REVA_AUTH_BEARER_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`. +--addr | $REVA_AUTH_BEARER_ADDR +: Address to bind reva service. Default: `0.0.0.0:9148`. ---url | $REVA_STORAGE_HOME_URL -: URL to use for the reva service. Default: `localhost:9154`. - ---driver | $REVA_STORAGE_HOME_DRIVER -: storage driver, eg. local, eos, owncloud 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 reva-storage-public-link - -Start reva storage-public-link service - -Usage: `ocis-reva reva-storage-public-link [command options] [arguments...]` - ---debug-addr | $REVA_STORAGE_PUBLIC_LINK_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9179`. - ---network | $REVA_STORAGE_PUBLIC_LINK_NETWORK -: Network to use for the reva 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`. - ---addr | $REVA_STORAGE_PUBLIC_LINK_ADDR -: Address to bind reva service. Default: `0.0.0.0:9178`. - ---url | $REVA_STORAGE_PUBLIC_LINK_URL -: Address to bind reva service. Default: `localhost:9178`. - ---mount-path | $REVA_STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `/public/`. - ---gateway-url | $REVA_GATEWAY_URL -: URL to use for the reva gateway service. Default: `localhost:9142`. - -### ocis-reva auth-basic - -Start reva authprovider for basic auth - -Usage: `ocis-reva auth-basic [command options] [arguments...]` - ---debug-addr | $REVA_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9147`. - ---auth-driver | $REVA_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. - ---auth-json | $REVA_AUTH_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`. - ---protocol | $REVA_AUTH_BASIC_PROTOCOL -: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`. - ---addr | $REVA_AUTH_BASIC_ADDR -: Address to bind reva service. Default: `0.0.0.0:9146`. - ---url | $REVA_AUTH_BASIC_URL -: URL to use for the reva service. Default: `localhost:9146`. - -### ocis-reva frontend - -Start reva frontend service - -Usage: `ocis-reva frontend [command options] [arguments...]` - ---debug-addr | $REVA_FRONTEND_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9141`. - ---transfer-secret | $REVA_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. - ---webdav-namespace | $WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `/home/`. - ---dav-files-namespace | $DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `/oc/`. - ---network | $REVA_FRONTEND_NETWORK -: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---protocol | $REVA_FRONTEND_PROTOCOL -: protocol for reva service, can be 'http' or 'grpc'. Default: `http`. - ---addr | $REVA_FRONTEND_ADDR -: Address to bind reva service. Default: `0.0.0.0:9140`. - ---url | $REVA_FRONTEND_URL -: URL to use for the reva service. Default: `https://localhost:9200`. - ---datagateway-prefix | $REVA_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `data`. - ---ocdav-prefix | $REVA_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. - ---ocs-prefix | $REVA_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`. - ---upload-disable-tus | $REVA_FRONTEND_UPLOAD_DISABLE_TUS -: Disables TUS upload mechanism. Default: `false`. - ---upload-http-method-override | $REVA_FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE -: Specify an HTTP method (ex: POST) that clients should to use when uploading instead of PATCH. +--url | $REVA_AUTH_BEARER_URL +: URL to use for the reva service. Default: `localhost:9148`. ### ocis-reva storage-eos @@ -433,7 +445,7 @@ Usage: `ocis-reva storage-eos [command options] [arguments...]` : URL to use for the reva service. Default: `localhost:9158`. --driver | $REVA_STORAGE_EOS_DRIVER -: storage driver, eg. local, eos, owncloud or s3. Default: `eos`. +: 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`. @@ -447,6 +459,48 @@ Usage: `ocis-reva storage-eos [command options] [arguments...]` --data-server-url | $REVA_STORAGE_EOS_DATA_SERVER_URL : data server url. Default: `http://localhost:9160/data`. +### ocis-reva storage-home + +Start reva storage-home service + +Usage: `ocis-reva storage-home [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-oc-data Start reva storage-oc-data service @@ -469,7 +523,7 @@ Usage: `ocis-reva storage-oc-data [command options] [arguments...]` : URL to use for the reva service. Default: `localhost:9164`. --driver | $REVA_STORAGE_OC_DATA_DRIVER -: storage driver, eg. local, eos, owncloud or s3. Default: `owncloud`. +: storage driver for oc data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. --prefix | $REVA_STORAGE_OC_DATA_PREFIX : prefix for the http endpoint, without leading slash. Default: `data`. @@ -483,92 +537,41 @@ Usage: `ocis-reva storage-oc-data [command options] [arguments...]` --users-url | $REVA_USERS_URL : URL to use for the reva service. Default: `localhost:9144`. -### ocis-reva health +### ocis-reva storage-root -Check health status +Start reva storage-root service -Usage: `ocis-reva health [command options] [arguments...]` +Usage: `ocis-reva storage-root [command options] [arguments...]` ---debug-addr | $REVA_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9109`. +--debug-addr | $REVA_STORAGE_ROOT_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9153`. -### 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 | $REVA_STORAGE_ROOT_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, eg. local, eos, owncloud 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 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 | $REVA_STORAGE_ROOT_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`. +--addr | $REVA_STORAGE_ROOT_ADDR +: Address to bind reva service. Default: `0.0.0.0:9152`. ---url | $REVA_STORAGE_OC_URL -: URL to use for the reva service. Default: `localhost:9162`. +--url | $REVA_STORAGE_ROOT_URL +: URL to use for the reva service. Default: `localhost:9152`. ---driver | $REVA_STORAGE_OC_DRIVER -: storage driver, eg. local, eos, owncloud or s3. Default: `owncloud`. +--driver | $REVA_STORAGE_ROOT_DRIVER +: storage driver for root mount: eg. local, eos, owncloud, ocis or s3. Default: `local`. ---mount-path | $REVA_STORAGE_OC_MOUNT_PATH -: mount path. Default: `/oc`. +--mount-path | $REVA_STORAGE_ROOT_MOUNT_PATH +: mount path. Default: `/`. ---mount-id | $REVA_STORAGE_OC_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. +--mount-id | $REVA_STORAGE_ROOT_MOUNT_ID +: mount id. Default: `123e4567-e89b-12d3-a456-426655440001`. ---expose-data-server | $REVA_STORAGE_OC_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. +--expose-data-server | $REVA_STORAGE_ROOT_EXPOSE_DATA_SERVER +: exposes a dedicated data server. ---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`. +--data-server-url | $REVA_STORAGE_ROOT_DATA_SERVER_URL +: data server url. ### ocis-reva users @@ -624,33 +627,30 @@ Usage: `ocis-reva users [command options] [arguments...]` --rest-target-api | $REVA_REST_TARGET_API : The target application. -### ocis-reva sharing +### ocis-reva reva-storage-public-link -Start reva sharing service +Start reva storage-public-link service -Usage: `ocis-reva sharing [command options] [arguments...]` +Usage: `ocis-reva reva-storage-public-link [command options] [arguments...]` ---debug-addr | $REVA_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9151`. +--debug-addr | $REVA_STORAGE_PUBLIC_LINK_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9179`. ---network | $REVA_SHARING_NETWORK +--network | $REVA_STORAGE_PUBLIC_LINK_NETWORK : Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $REVA_SHARING_PROTOCOL +--protocol | $REVA_STORAGE_PUBLIC_LINK_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`. +--addr | $REVA_STORAGE_PUBLIC_LINK_ADDR +: Address to bind reva service. Default: `0.0.0.0:9178`. ---url | $REVA_SHARING_URL -: URL to use for the reva service. Default: `localhost:9150`. +--url | $REVA_STORAGE_PUBLIC_LINK_URL +: Address to bind reva service. Default: `localhost:9178`. ---user-driver | $REVA_SHARING_USER_DRIVER -: driver to use for the UserShareProvider. Default: `json`. +--mount-path | $REVA_STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `/public/`. ---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`. +--gateway-url | $REVA_GATEWAY_URL +: URL to use for the reva gateway service. Default: `localhost:9142`. diff --git a/pkg/flagset/storageeos.go b/pkg/flagset/storageeos.go index c52b71d32..a11a18e75 100644 --- a/pkg/flagset/storageeos.go +++ b/pkg/flagset/storageeos.go @@ -58,7 +58,7 @@ func StorageEOSWithConfig(cfg *config.Config) []cli.Flag { &cli.StringFlag{ Name: "driver", Value: "eos", - Usage: "storage driver, eg. local, eos, owncloud or s3", + Usage: "storage driver for eos mount: eg. local, eos, owncloud, ocis or s3", EnvVars: []string{"REVA_STORAGE_EOS_DRIVER"}, Destination: &cfg.Reva.StorageEOS.Driver, }, diff --git a/pkg/flagset/storageeosdata.go b/pkg/flagset/storageeosdata.go index 227a07847..1ba2a46a4 100644 --- a/pkg/flagset/storageeosdata.go +++ b/pkg/flagset/storageeosdata.go @@ -59,7 +59,7 @@ func StorageEOSDataWithConfig(cfg *config.Config) []cli.Flag { &cli.StringFlag{ Name: "driver", Value: "eos", - Usage: "storage driver, eg. local, eos, owncloud or s3", + Usage: "storage driver for eos data mount: eg. local, eos, owncloud, ocis or s3", EnvVars: []string{"REVA_STORAGE_EOS_DATA_DRIVER"}, Destination: &cfg.Reva.StorageEOSData.Driver, }, diff --git a/pkg/flagset/storagehome.go b/pkg/flagset/storagehome.go index 467417f34..49fd4bed0 100644 --- a/pkg/flagset/storagehome.go +++ b/pkg/flagset/storagehome.go @@ -60,7 +60,7 @@ func StorageHomeWithConfig(cfg *config.Config) []cli.Flag { &cli.StringFlag{ Name: "driver", Value: "owncloud", - Usage: "storage driver, eg. local, eos, owncloud or s3", + Usage: "storage driver for home mount: eg. local, eos, owncloud, ocis or s3", EnvVars: []string{"REVA_STORAGE_HOME_DRIVER"}, Destination: &cfg.Reva.StorageHome.Driver, }, diff --git a/pkg/flagset/storagehomedata.go b/pkg/flagset/storagehomedata.go index 4dc9ccf04..d6672bef2 100644 --- a/pkg/flagset/storagehomedata.go +++ b/pkg/flagset/storagehomedata.go @@ -59,7 +59,7 @@ func StorageHomeDataWithConfig(cfg *config.Config) []cli.Flag { &cli.StringFlag{ Name: "driver", Value: "owncloud", - Usage: "storage driver, eg. local, eos, owncloud or s3", + Usage: "storage driver for home data mount: eg. local, eos, owncloud, ocis or s3", EnvVars: []string{"REVA_STORAGE_HOME_DATA_DRIVER"}, Destination: &cfg.Reva.StorageHomeData.Driver, }, diff --git a/pkg/flagset/storageoc.go b/pkg/flagset/storageoc.go index 0b6d7f8b9..718970a22 100644 --- a/pkg/flagset/storageoc.go +++ b/pkg/flagset/storageoc.go @@ -60,7 +60,7 @@ func StorageOCWithConfig(cfg *config.Config) []cli.Flag { &cli.StringFlag{ Name: "driver", Value: "owncloud", - Usage: "storage driver, eg. local, eos, owncloud or s3", + Usage: "storage driver for oc mount: eg. local, eos, owncloud, ocis or s3", EnvVars: []string{"REVA_STORAGE_OC_DRIVER"}, Destination: &cfg.Reva.StorageOC.Driver, }, diff --git a/pkg/flagset/storageocdata.go b/pkg/flagset/storageocdata.go index f984623a7..ebf3ae02b 100644 --- a/pkg/flagset/storageocdata.go +++ b/pkg/flagset/storageocdata.go @@ -59,7 +59,7 @@ func StorageOCDataWithConfig(cfg *config.Config) []cli.Flag { &cli.StringFlag{ Name: "driver", Value: "owncloud", - Usage: "storage driver, eg. local, eos, owncloud or s3", + Usage: "storage driver for oc data mount: eg. local, eos, owncloud, ocis or s3", EnvVars: []string{"REVA_STORAGE_OC_DATA_DRIVER"}, Destination: &cfg.Reva.StorageOCData.Driver, }, diff --git a/pkg/flagset/storageroot.go b/pkg/flagset/storageroot.go index b02602f2f..55cda67bd 100644 --- a/pkg/flagset/storageroot.go +++ b/pkg/flagset/storageroot.go @@ -60,7 +60,7 @@ func StorageRootWithConfig(cfg *config.Config) []cli.Flag { &cli.StringFlag{ Name: "driver", Value: "local", - Usage: "storage driver, eg. local, eos, owncloud or s3", + Usage: "storage driver for root mount: eg. local, eos, owncloud, ocis or s3", EnvVars: []string{"REVA_STORAGE_ROOT_DRIVER"}, Destination: &cfg.Reva.StorageRoot.Driver, },