diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 14b6420cf16..708fd7b2942 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-30T13:42:53+0000" +date: "2021-08-02T06:58:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -236,13 +236,11 @@ Usage: `accounts list [command options] [arguments...]` -### accounts remove - -Removes an existing account - -Usage: `accounts remove [command options] [arguments...]` +### accounts rebuildIndex +Rebuilds the service's index, i.e. deleting and then re-adding all existing documents +Usage: `accounts rebuildIndex [command options] [arguments...]` @@ -308,12 +306,8 @@ Usage: `accounts remove [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. @@ -432,6 +426,87 @@ Usage: `accounts update [command options] [arguments...]` + + +### accounts version + +Print the versions of the running instances + +Usage: `accounts version [command options] [arguments...]` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. + + +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. + + + ### accounts inspect @@ -515,11 +590,11 @@ Usage: `accounts inspect [command options] [arguments...]` -name | $ACCOUNTS_NAME : service name. Default: `"accounts"`. -### accounts rebuildIndex +### accounts remove -Rebuilds the service's index, i.e. deleting and then re-adding all existing documents +Removes an existing account -Usage: `accounts rebuildIndex [command options] [arguments...]` +Usage: `accounts remove [command options] [arguments...]` @@ -587,6 +662,12 @@ Usage: `accounts rebuildIndex [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. + + +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. @@ -837,87 +918,6 @@ Usage: `accounts server [command options] [arguments...]` - - - - - -### accounts version - -Print the versions of the running instances - -Usage: `accounts version [command options] [arguments...]` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. - - --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index d8656242f3f..606a319b7c9 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-30T13:43:46+0000" +date: "2021-08-02T06:59:50+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/glauth/templates @@ -34,6 +34,60 @@ If multiple variables are listed for one option, they are in order of precedence ### Commandline flags If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. + +### glauth ocis-glauth + +Serve GLAuth API for oCIS + +Usage: `glauth ocis-glauth [command options] [arguments...]` + + +-log-level | $GLAUTH_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. + + +-log-pretty | $GLAUTH_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. + + +-log-color | $GLAUTH_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ### glauth server @@ -216,60 +270,6 @@ Usage: `glauth health [command options] [arguments...]` - - - - - - - - - - - - - - - - - -### glauth ocis-glauth - -Serve GLAuth API for oCIS - -Usage: `glauth ocis-glauth [command options] [arguments...]` - - --log-level | $GLAUTH_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. - - --log-pretty | $GLAUTH_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. - - --log-color | $GLAUTH_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. - - - - - - - - - - - - - - - - - - - - diff --git a/extensions/graph-explorer/configuration.md b/extensions/graph-explorer/configuration.md index 4de5d03ff85..5b26c509867 100644 --- a/extensions/graph-explorer/configuration.md +++ b/extensions/graph-explorer/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-30T13:43:47+0000" +date: "2021-08-02T06:59:50+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph-explorer/templates @@ -73,6 +73,36 @@ Usage: `graph-explorer [global options] command [command options] [arguments...] ## Sub Commands +### graph-explorer health + +Check health status + +Usage: `graph-explorer health [command options] [arguments...]` + + + + + +-debug-addr | $GRAPH_EXPLORER_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9136"`. + + + + + + + + + + + + + + + + + + ### graph-explorer server Start integrated server @@ -151,33 +181,3 @@ Usage: `graph-explorer server [command options] [arguments...]` -extensions | : Run specific extensions during supervised mode. This flag is set by the runtime. -### graph-explorer health - -Check health status - -Usage: `graph-explorer health [command options] [arguments...]` - - - - - --debug-addr | $GRAPH_EXPLORER_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9136"`. - - - - - - - - - - - - - - - - - - diff --git a/extensions/graph/configuration.md b/extensions/graph/configuration.md index 14939b52df0..fd5a9a01fe3 100644 --- a/extensions/graph/configuration.md +++ b/extensions/graph/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-30T13:43:47+0000" +date: "2021-08-02T06:59:50+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph/templates diff --git a/extensions/idp/configuration.md b/extensions/idp/configuration.md index 6e671760a27..91f0a02701d 100644 --- a/extensions/idp/configuration.md +++ b/extensions/idp/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-30T13:43:47+0000" +date: "2021-08-02T06:59:50+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/idp/templates diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index 746677414f7..d0d6f13cf4b 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-30T13:43:47+0000" +date: "2021-08-02T06:59:50+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/templates @@ -34,6 +34,42 @@ If multiple variables are listed for one option, they are in order of precedence ### Commandline flags If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. + +### ocs health + +Check health status + +Usage: `ocs health [command options] [arguments...]` + + +-debug-addr | $OCS_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9114"`. + + + + + + + + + + + + + + + + + + + + + + + + + + ### ocs ocis-ocs @@ -211,40 +247,4 @@ Usage: `ocs version [command options] [arguments...]` -name | $OCS_NAME : Service name. Default: `"ocs"`. - -### ocs health - -Check health status - -Usage: `ocs health [command options] [arguments...]` - - --debug-addr | $OCS_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9114"`. - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/extensions/onlyoffice/configuration.md b/extensions/onlyoffice/configuration.md index ff512c0b32b..96f83d3f9db 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-30T13:43:47+0000" +date: "2021-08-02T06:59:50+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/onlyoffice/templates @@ -80,6 +80,36 @@ Usage: `onlyoffice [global options] command [command options] [arguments...]` ## Sub Commands +### onlyoffice health + +Check health status + +Usage: `onlyoffice health [command options] [arguments...]` + + + + + + +-debug-addr | $ONLYOFFICE_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9224"`. + + + + + + + + + + + + + + + + + ### onlyoffice server Start integrated server @@ -155,33 +185,3 @@ Usage: `onlyoffice server [command options] [arguments...]` -extensions | : Run specific extensions during supervised mode. This flag is set by the runtime. -### onlyoffice health - -Check health status - -Usage: `onlyoffice health [command options] [arguments...]` - - - - - - --debug-addr | $ONLYOFFICE_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9224"`. - - - - - - - - - - - - - - - - - diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index 4c8f88644f5..e10009e4660 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-30T13:43:47+0000" +date: "2021-08-02T06:59:50+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/proxy/templates diff --git a/extensions/settings/configuration.md b/extensions/settings/configuration.md index bcb5b312609..836e434b55b 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-30T13:43:47+0000" +date: "2021-08-02T06:59:50+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/settings/templates @@ -34,42 +34,6 @@ If multiple variables are listed for one option, they are in order of precedence ### Commandline flags If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -### settings health - -Check health status - -Usage: `settings health [command options] [arguments...]` - - - - - --debug-addr | $SETTINGS_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9194"`. - - - - - - - - - - - - - - - - - - - - - - - ### settings ocis-settings @@ -247,4 +211,40 @@ Usage: `settings version [command options] [arguments...]` -name | $SETTINGS_NAME : service name. Default: `"settings"`. + +### settings health + +Check health status + +Usage: `settings health [command options] [arguments...]` + + + + + +-debug-addr | $SETTINGS_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9194"`. + + + + + + + + + + + + + + + + + + + + + + + diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index f94baa6ada1..cee70592076 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-30T13:43:47+0000" +date: "2021-08-02T06:59:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -99,10 +99,20 @@ Usage: `storage [global options] command [command options] [arguments...]` +-config-file | $STORAGE_CONFIG_FILE +: Path to config file. +-log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. + + +-log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. @@ -186,20 +196,12 @@ Usage: `storage [global options] command [command options] [arguments...]` --config-file | $STORAGE_CONFIG_FILE -: Path to config file. --log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. --log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. @@ -300,11 +302,11 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage gateway +### storage frontend -Start gateway +Start frontend service -Usage: `storage gateway [command options] [arguments...]` +Usage: `storage frontend [command options] [arguments...]` @@ -407,48 +409,92 @@ Usage: `storage gateway [command options] [arguments...]` +-debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9141"`. +-transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. +-webdav-namespace | $STORAGE_WEBDAV_NAMESPACE +: Namespace prefix for the /webdav endpoint. Default: `"/home/"`. +-dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE +: Namespace prefix for the webdav /dav/files endpoint. Default: `"/users/"`. +-network | $STORAGE_FRONTEND_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_FRONTEND_HTTP_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9140"`. +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `"https://localhost:9200"`. +-service | $STORAGE_FRONTEND_SERVICES +: --service ocdav [--service ocs]. Default: `cli.NewStringSlice("datagateway", "ocdav", "ocs")`. +-datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX +: datagateway prefix. Default: `"data"`. +-ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX +: owncloud webdav endpoint prefix. Default: `""`. +-ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX +: open collaboration services endpoint prefix. Default: `"ocs"`. +-ocs-share-prefix | $STORAGE_FRONTEND_OCS_SHARE_PREFIX +: the prefix prepended to the path of shared files. Default: `"/Shares"`. +-ocs-home-namespace | $STORAGE_FRONTEND_OCS_HOME_NAMESPACE +: the prefix prepended to the incoming requests in OCS. Default: `"/home"`. +-ocs-resource-info-cache-ttl | $STORAGE_FRONTEND_OCS_RESOURCE_INFO_CACHE_TTL +: the TTL for statted resources in the share cache. Default: `0`. +-ocs-cache-warmup-driver | $STORAGE_FRONTEND_OCS_CACHE_WARMUP_DRIVER +: the driver to be used for warming up the share cache. Default: `""`. +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `"localhost:9142"`. +-default-upload-protocol | $STORAGE_FRONTEND_DEFAULT_UPLOAD_PROTOCOL +: Default upload chunking protocol to be used out of tus/v1/ng. Default: `"tus"`. +-upload-max-chunk-size | $STORAGE_FRONTEND_UPLOAD_MAX_CHUNK_SIZE +: Max chunk size in bytes to advertise to clients through capabilities, or 0 for unlimited. Default: `0`. +-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. Default: `""`. +-checksum-suppored-type | $STORAGE_FRONTEND_CHECKSUM_SUPPORTED_TYPES +: --checksum-suppored-type sha1 [--checksum-suppored-type adler32]. Default: `cli.NewStringSlice("sha1", "md5", "adler32")`. +-checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE +: Specify the preferred checksum algorithm used for uploads. Default: `""`. +-user-agent-whitelist-lock-in | $STORAGE_FRONTEND_MIDDLEWARE_AUTH_CREDENTIALS_BY_USER_AGENT +: --user-agent-whitelist-lock-in=mirall:basic,foo:bearer Given a tuple of comma separated [UserAgent:challenge] values, it locks a given user agent to the authentication challenge. Particularly useful for old clients whose USer-Agent is known and only support one authentication challenge. When this flag is set in the storage-frontend it configures Reva.. @@ -519,199 +565,105 @@ 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"`. --transfer-expires | $STORAGE_TRANSFER_EXPIRES -: Transfer token ttl in seconds. Default: `24 * 60 * 60`. --network | $STORAGE_GATEWAY_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_GATEWAY_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9142"`. --endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9142"`. --service | $STORAGE_GATEWAY_SERVICES -: --service gateway [--service authregistry]. Default: `cli.NewStringSlice("gateway", "authregistry", "storageregistry")`. --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-home-mapping | $STORAGE_GATEWAY_HOME_MAPPING -: mapping template for user home paths to user-specific mount points, e.g. /home/{{substr 0 1 .Username}}. Default: `""`. --etag-cache-ttl | $STORAGE_GATEWAY_ETAG_CACHE_TTL -: TTL for the home and shares directory etags cache. Default: `0`. --auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT -: endpoint to use for the basic auth provider. Default: `"localhost:9146"`. --auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT -: endpoint to use for the bearer auth provider. Default: `"localhost:9148"`. --storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER -: driver of the storage registry. Default: `"static"`. --storage-registry-rule | $STORAGE_STORAGE_REGISTRY_RULES -: `Replaces the generated storage registry rules with this set: --storage-registry-rule "/eos=localhost:9158" [--storage-registry-rule "1284d238-aa92-42ce-bdc4-0b0000009162=localhost:9162"]`. Default: `cli.NewStringSlice()`. --storage-home-provider | $STORAGE_STORAGE_REGISTRY_HOME_PROVIDER -: mount point of the storage provider for user homes in the global namespace. Default: `"/home"`. --storage-registry-json | $STORAGE_STORAGE_REGISTRY_JSON -: JSON file containing the storage registry rules. Default: `""`. --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `"https://localhost:9200"`. --datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL -: URL to use for the storage datagateway, defaults to /data. Default: `""`. --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider. Default: `"localhost:9144"`. --groupprovider-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: endpoint to use for the groupprovider. Default: `"localhost:9160"`. --sharing-endpoint | $STORAGE_SHARING_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9150"`. --storage-home-endpoint | $STORAGE_HOME_ENDPOINT -: endpoint to use for the home storage. Default: `"localhost:9154"`. --storage-home-mount-path | $STORAGE_HOME_MOUNT_PATH -: mount path. Default: `"/home"`. --storage-home-mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009154"`. --storage-users-endpoint | $STORAGE_USERS_ENDPOINT -: endpoint to use for the users storage. Default: `"localhost:9157"`. --storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH -: mount path. Default: `"/users"`. +### storage storage-metadata +Start storage-metadata service --storage-users-mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. +Usage: `storage storage-metadata [command options] [arguments...]` --public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT -: endpoint to use for the public links service. Default: `"localhost:9178"`. --storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `"/public"`. -### storage storage-users -Start storage-users service -Usage: `storage storage-users [command options] [arguments...]` --debug-addr | $STORAGE_USERS_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9159"`. --grpc-network | $STORAGE_USERS_GRPC_NETWORK -: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --grpc-addr | $STORAGE_USERS_GRPC_ADDR -: GRPC Address to bind users storage. Default: `"0.0.0.0:9157"`. --http-network | $STORAGE_USERS_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --http-addr | $STORAGE_USERS_HTTP_ADDR -: HTTP Address to bind users storage. Default: `"0.0.0.0:9158"`. --driver | $STORAGE_USERS_DRIVER -: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. --read-only | $STORAGE_USERS_READ_ONLY , $OCIS_STORAGE_READ_ONLY -: use storage driver in read-only mode. Default: `false`. --mount-path | $STORAGE_USERS_MOUNT_PATH -: mount path. Default: `"/users"`. --mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. --expose-data-server | $STORAGE_USERS_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. --data-server-url | $STORAGE_USERS_DATA_SERVER_URL -: data server url. Default: `"http://localhost:9158/data"`. --http-prefix | $STORAGE_USERS_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `"data"`. --tmp-folder | $STORAGE_USERS_TMP_FOLDER -: path to tmp folder. Default: `"/var/tmp/ocis/tmp/users"`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `"localhost:9142"`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9144"`. @@ -733,34 +685,64 @@ Usage: `storage storage-users [command options] [arguments...]` +-config-file | $STORAGE_CONFIG_FILE +: Path to config file. +-log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. +-debug-addr | $STORAGE_METADATA_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9217"`. +-grpc-network | $STORAGE_METADATA_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9215"`. +-data-server-url | $STORAGE_METADATA_DATA_SERVER_URL +: URL of the data-provider the storage-provider uses. Default: `"http://localhost:9216"`. +-http-network | $STORAGE_METADATA_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-http-addr | $STORAGE_METADATA_HTTP_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9216"`. +-tmp-folder | $STORAGE_METADATA_TMP_FOLDER +: path to tmp folder. Default: `"/var/tmp/ocis/tmp/metadata"`. +-driver | $STORAGE_METADATA_DRIVER +: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the gateway service. Default: `"localhost:9142"`. +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider service. Default: `"localhost:9144"`. +-storage-root | $STORAGE_METADATA_ROOT +: the path to the metadata storage root. Default: `"/var/tmp/ocis/storage/metadata"`. @@ -937,17 +919,17 @@ Usage: `storage storage-users [command options] [arguments...]` +### storage storage-public-link +Start storage-public-link service +Usage: `storage storage-public-link [command options] [arguments...]` -### storage frontend -Start frontend service -Usage: `storage frontend [command options] [arguments...]` @@ -995,84 +977,44 @@ 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 | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. --webdav-namespace | $STORAGE_WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `"/home/"`. --dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `"/users/"`. --network | $STORAGE_FRONTEND_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_FRONTEND_HTTP_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9140"`. --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `"https://localhost:9200"`. --service | $STORAGE_FRONTEND_SERVICES -: --service ocdav [--service ocs]. Default: `cli.NewStringSlice("datagateway", "ocdav", "ocs")`. --datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `"data"`. --ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. Default: `""`. --ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX -: open collaboration services endpoint prefix. Default: `"ocs"`. --ocs-share-prefix | $STORAGE_FRONTEND_OCS_SHARE_PREFIX -: the prefix prepended to the path of shared files. Default: `"/Shares"`. --ocs-home-namespace | $STORAGE_FRONTEND_OCS_HOME_NAMESPACE -: the prefix prepended to the incoming requests in OCS. Default: `"/home"`. --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `"localhost:9142"`. --default-upload-protocol | $STORAGE_FRONTEND_DEFAULT_UPLOAD_PROTOCOL -: Default upload chunking protocol to be used out of tus/v1/ng. Default: `"tus"`. --upload-max-chunk-size | $STORAGE_FRONTEND_UPLOAD_MAX_CHUNK_SIZE -: Max chunk size in bytes to advertise to clients through capabilities, or 0 for unlimited. Default: `0`. --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. Default: `""`. --checksum-suppored-type | $STORAGE_FRONTEND_CHECKSUM_SUPPORTED_TYPES -: --checksum-suppored-type sha1 [--checksum-suppored-type adler32]. Default: `cli.NewStringSlice("sha1", "md5", "adler32")`. --checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE -: Specify the preferred checksum algorithm used for uploads. Default: `""`. --user-agent-whitelist-lock-in | $STORAGE_FRONTEND_MIDDLEWARE_AUTH_CREDENTIALS_BY_USER_AGENT -: --user-agent-whitelist-lock-in=mirall:basic,foo:bearer Given a tuple of comma separated [UserAgent:challenge] values, it locks a given user agent to the authentication challenge. Particularly useful for old clients whose USer-Agent is known and only support one authentication challenge. When this flag is set in the storage-frontend it configures Reva.. @@ -1226,17 +1168,30 @@ Usage: `storage frontend [command options] [arguments...]` +-debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9179"`. +-network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9178"`. +-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `"/public"`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `"localhost:9142"`. +### storage users +Start users service +Usage: `storage users [command options] [arguments...]` @@ -1249,23 +1204,36 @@ Usage: `storage frontend [command options] [arguments...]` +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9145"`. +-network | $STORAGE_USERPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_USERPROVIDER_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9144"`. -### storage groups -Start groups service +-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `"localhost:9144"`. -Usage: `storage groups [command options] [arguments...]` +-service | $STORAGE_USERPROVIDER_SERVICES +: --service userprovider [--service otherservice]. Default: `cli.NewStringSlice("userprovider")`. +-driver | $STORAGE_USERPROVIDER_DRIVER +: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `"ldap"`. +-json-config | $STORAGE_USERPROVIDER_JSON +: Path to users.json file. Default: `""`. +-user-groups-cache-expiration | $STORAGE_USER_CACHE_EXPIRATION +: Time in minutes for redis cache expiration.. Default: `5`. @@ -1326,36 +1294,20 @@ Usage: `storage groups [command options] [arguments...]` --debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9161"`. --network | $STORAGE_GROUPPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_GROUPPROVIDER_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9160"`. --endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `"localhost:9160"`. --service | $STORAGE_GROUPPROVIDER_SERVICES -: --service groupprovider [--service otherservice]. Default: `cli.NewStringSlice("groupprovider")`. --driver | $STORAGE_GROUPPROVIDER_DRIVER -: group driver: 'json', 'ldap', or 'rest'. Default: `"ldap"`. --json-config | $STORAGE_GROUPPROVIDER_JSON -: Path to groups.json file. Default: `""`. --group-members-cache-expiration | $STORAGE_GROUP_CACHE_EXPIRATION -: Time in minutes for redis cache expiration.. Default: `5`. @@ -1512,8 +1464,11 @@ Usage: `storage groups [command options] [arguments...]` +### storage auth-bearer +Start authprovider for bearer auth +Usage: `storage auth-bearer [command options] [arguments...]` @@ -1529,11 +1484,8 @@ Usage: `storage groups [command options] [arguments...]` -### storage storage -Storage service for oCIS -Usage: `storage storage [command options] [arguments...]` @@ -1656,44 +1608,56 @@ Usage: `storage storage [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 , $OCIS_URL +: 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. Default: `""`. +-oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM +: OIDC gid claim. Default: `""`. +-network | $STORAGE_AUTH_BEARER_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_AUTH_BEARER_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9148"`. +-service | $STORAGE_AUTH_BEARER_SERVICES +: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `"localhost:9142"`. --config-file | $STORAGE_CONFIG_FILE -: Path to config file. --log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. --log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. @@ -1783,8 +1747,11 @@ Usage: `storage storage [command options] [arguments...]` +### storage health +Check health status +Usage: `storage health [command options] [arguments...]` @@ -1792,11 +1759,8 @@ Usage: `storage storage [command options] [arguments...]` -### storage sharing -Start sharing service -Usage: `storage sharing [command options] [arguments...]` @@ -1920,6 +1884,8 @@ Usage: `storage sharing [command options] [arguments...]` +-debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9109"`. @@ -1985,48 +1951,26 @@ Usage: `storage sharing [command options] [arguments...]` --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9151"`. --network | $STORAGE_SHARING_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_SHARING_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9150"`. --service | $STORAGE_SHARING_SERVICES -: --service usershareprovider [--service publicshareprovider]. Default: `cli.NewStringSlice("usershareprovider", "publicshareprovider")`. --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/storage/shares.json"`. --public-driver | $STORAGE_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `"json"`. --public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE -: file used to persist shares for the PublicShareProvider. Default: `"/var/tmp/ocis/storage/publicshares.json"`. --public-password-hash-cost | $STORAGE_SHARING_PUBLIC_PASSWORD_HASH_COST -: the cost of hashing the public shares passwords. Default: `11`. --public-enable-expired-shares-cleanup | $STORAGE_SHARING_PUBLIC_ENABLE_EXPIRED_SHARES_CLEANUP -: whether to periodically delete expired public shares. Default: `true`. --public-janitor-run-interval | $STORAGE_SHARING_PUBLIC_JANITOR_RUN_INTERVAL -: the time period in seconds after which to start a janitor run. Default: `60`. @@ -2059,8 +2003,11 @@ Usage: `storage sharing [command options] [arguments...]` +### storage storage +Storage service for oCIS +Usage: `storage storage [command options] [arguments...]` @@ -2076,11 +2023,8 @@ Usage: `storage sharing [command options] [arguments...]` -### storage storage-home -Start storage-home service -Usage: `storage storage-home [command options] [arguments...]` @@ -2123,12 +2067,20 @@ Usage: `storage storage-home [command options] [arguments...]` +-config-file | $STORAGE_CONFIG_FILE +: Path to config file. +-log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. @@ -2202,68 +2154,36 @@ Usage: `storage storage-home [command options] [arguments...]` --debug-addr | $STORAGE_HOME_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9156"`. --grpc-network | $STORAGE_HOME_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --grpc-addr | $STORAGE_HOME_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9154"`. --http-network | $STORAGE_HOME_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --http-addr | $STORAGE_HOME_HTTP_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9155"`. --driver | $STORAGE_HOME_DRIVER -: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. --read-only | $STORAGE_HOME_READ_ONLY , $OCIS_STORAGE_READ_ONLY -: use storage driver in read-only mode. Default: `false`. --mount-path | $STORAGE_HOME_MOUNT_PATH -: mount path. Default: `"/home"`. --mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. --expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. --data-server-url | $STORAGE_HOME_DATA_SERVER_URL -: data server url. Default: `"http://localhost:9155/data"`. --http-prefix | $STORAGE_HOME_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `"data"`. --tmp-folder | $STORAGE_HOME_TMP_FOLDER -: path to tmp folder. Default: `"/var/tmp/ocis/tmp/home"`. --enable-home | $STORAGE_HOME_ENABLE_HOME -: enable the creation of home directories. Default: `true`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `"localhost:9142"`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9144"`. @@ -2348,8 +2268,11 @@ Usage: `storage storage-home [command options] [arguments...]` +### storage auth-basic +Start authprovider for basic auth +Usage: `storage auth-basic [command options] [arguments...]` @@ -2370,16 +2293,55 @@ Usage: `storage storage-home [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. Default: `""`. + + +-network | $STORAGE_AUTH_BASIC_GRPC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. + + +-addr | $STORAGE_AUTH_BASIC_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9146"`. + + +-service | $STORAGE_AUTH_BASIC_SERVICES +: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. + + +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `"localhost:9142"`. + + + + + + + + + + + + + + + + -### storage storage-metadata -Start storage-metadata service -Usage: `storage storage-metadata [command options] [arguments...]` @@ -2526,65 +2488,35 @@ Usage: `storage storage-metadata [command options] [arguments...]` --config-file | $STORAGE_CONFIG_FILE -: Path to config file. --log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. --log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. --debug-addr | $STORAGE_METADATA_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9217"`. --grpc-network | $STORAGE_METADATA_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9215"`. --data-server-url | $STORAGE_METADATA_DATA_SERVER_URL -: URL of the data-provider the storage-provider uses. Default: `"http://localhost:9216"`. --http-network | $STORAGE_METADATA_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --http-addr | $STORAGE_METADATA_HTTP_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9216"`. --tmp-folder | $STORAGE_METADATA_TMP_FOLDER -: path to tmp folder. Default: `"/var/tmp/ocis/tmp/metadata"`. --driver | $STORAGE_METADATA_DRIVER -: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the gateway service. Default: `"localhost:9142"`. --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider service. Default: `"localhost:9144"`. --storage-root | $STORAGE_METADATA_ROOT -: the path to the metadata storage root. Default: `"/var/tmp/ocis/storage/metadata"`. @@ -2610,8 +2542,11 @@ Usage: `storage storage-metadata [command options] [arguments...]` +### storage gateway +Start gateway +Usage: `storage gateway [command options] [arguments...]` @@ -2671,11 +2606,8 @@ Usage: `storage storage-metadata [command options] [arguments...]` -### storage storage-public-link -Start storage-public-link service -Usage: `storage storage-public-link [command options] [arguments...]` @@ -2751,92 +2683,146 @@ Usage: `storage storage-public-link [command options] [arguments...]` --debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9179"`. --network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9178"`. --mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `"/public"`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `"localhost:9142"`. +-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"`. +-transfer-expires | $STORAGE_TRANSFER_EXPIRES +: Transfer token ttl in seconds. Default: `24 * 60 * 60`. +-network | $STORAGE_GATEWAY_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_GATEWAY_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9142"`. +-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9142"`. +-service | $STORAGE_GATEWAY_SERVICES +: --service gateway [--service authregistry]. Default: `cli.NewStringSlice("gateway", "authregistry", "storageregistry")`. +-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-home-mapping | $STORAGE_GATEWAY_HOME_MAPPING +: mapping template for user home paths to user-specific mount points, e.g. /home/{{substr 0 1 .Username}}. Default: `""`. +-etag-cache-ttl | $STORAGE_GATEWAY_ETAG_CACHE_TTL +: TTL for the home and shares directory etags cache. Default: `0`. +-auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT +: endpoint to use for the basic auth provider. Default: `"localhost:9146"`. +-auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT +: endpoint to use for the bearer auth provider. Default: `"localhost:9148"`. +-storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER +: driver of the storage registry. Default: `"static"`. +-storage-registry-rule | $STORAGE_STORAGE_REGISTRY_RULES +: `Replaces the generated storage registry rules with this set: --storage-registry-rule "/eos=localhost:9158" [--storage-registry-rule "1284d238-aa92-42ce-bdc4-0b0000009162=localhost:9162"]`. Default: `cli.NewStringSlice()`. +-storage-home-provider | $STORAGE_STORAGE_REGISTRY_HOME_PROVIDER +: mount point of the storage provider for user homes in the global namespace. Default: `"/home"`. +-storage-registry-json | $STORAGE_STORAGE_REGISTRY_JSON +: JSON file containing the storage registry rules. Default: `""`. +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `"https://localhost:9200"`. +-datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL +: URL to use for the storage datagateway, defaults to /data. Default: `""`. +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider. Default: `"localhost:9144"`. +-groupprovider-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: endpoint to use for the groupprovider. Default: `"localhost:9160"`. +-sharing-endpoint | $STORAGE_SHARING_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9150"`. +-storage-home-endpoint | $STORAGE_HOME_ENDPOINT +: endpoint to use for the home storage. Default: `"localhost:9154"`. +-storage-home-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `"/home"`. +-storage-home-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009154"`. +-storage-users-endpoint | $STORAGE_USERS_ENDPOINT +: endpoint to use for the users storage. Default: `"localhost:9157"`. +-storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH +: mount path. Default: `"/users"`. +-storage-users-mount-id | $STORAGE_USERS_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. +-public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT +: endpoint to use for the public links service. Default: `"localhost:9178"`. +-storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `"/public"`. @@ -2905,8 +2891,11 @@ Usage: `storage storage-public-link [command options] [arguments...]` +### storage groups +Start groups service +Usage: `storage groups [command options] [arguments...]` @@ -2937,11 +2926,8 @@ Usage: `storage storage-public-link [command options] [arguments...]` -### storage users -Start users service -Usage: `storage users [command options] [arguments...]` @@ -3022,48 +3008,48 @@ 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_USERPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_USERPROVIDER_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9144"`. --endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `"localhost:9144"`. --service | $STORAGE_USERPROVIDER_SERVICES -: --service userprovider [--service otherservice]. Default: `cli.NewStringSlice("userprovider")`. --driver | $STORAGE_USERPROVIDER_DRIVER -: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `"ldap"`. --json-config | $STORAGE_USERPROVIDER_JSON -: Path to users.json file. Default: `""`. +-debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9161"`. --user-groups-cache-expiration | $STORAGE_USER_CACHE_EXPIRATION -: Time in minutes for redis cache expiration.. Default: `5`. +-network | $STORAGE_GROUPPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_GROUPPROVIDER_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9160"`. +-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `"localhost:9160"`. +-service | $STORAGE_GROUPPROVIDER_SERVICES +: --service groupprovider [--service otherservice]. Default: `cli.NewStringSlice("groupprovider")`. +-driver | $STORAGE_GROUPPROVIDER_DRIVER +: group driver: 'json', 'ldap', or 'rest'. Default: `"ldap"`. +-json-config | $STORAGE_GROUPPROVIDER_JSON +: Path to groups.json file. Default: `""`. +-group-members-cache-expiration | $STORAGE_GROUP_CACHE_EXPIRATION +: Time in minutes for redis cache expiration.. Default: `5`. @@ -3182,8 +3168,11 @@ Usage: `storage users [command options] [arguments...]` +### storage sharing +Start sharing service +Usage: `storage sharing [command options] [arguments...]` @@ -3212,11 +3201,8 @@ Usage: `storage users [command options] [arguments...]` -### storage auth-basic -Start authprovider for basic auth -Usage: `storage auth-basic [command options] [arguments...]` @@ -3239,32 +3225,18 @@ 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. Default: `""`. --network | $STORAGE_AUTH_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_AUTH_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9146"`. --service | $STORAGE_AUTH_BASIC_SERVICES -: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `"localhost:9142"`. @@ -3418,26 +3390,48 @@ Usage: `storage auth-basic [command options] [arguments...]` +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9151"`. +-network | $STORAGE_SHARING_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9150"`. +-service | $STORAGE_SHARING_SERVICES +: --service usershareprovider [--service publicshareprovider]. Default: `cli.NewStringSlice("usershareprovider", "publicshareprovider")`. +-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/storage/shares.json"`. +-public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `"json"`. +-public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE +: file used to persist shares for the PublicShareProvider. Default: `"/var/tmp/ocis/storage/publicshares.json"`. +-public-password-hash-cost | $STORAGE_SHARING_PUBLIC_PASSWORD_HASH_COST +: the cost of hashing the public shares passwords. Default: `11`. +-public-enable-expired-shares-cleanup | $STORAGE_SHARING_PUBLIC_ENABLE_EXPIRED_SHARES_CLEANUP +: whether to periodically delete expired public shares. Default: `true`. +-public-janitor-run-interval | $STORAGE_SHARING_PUBLIC_JANITOR_RUN_INTERVAL +: the time period in seconds after which to start a janitor run. Default: `60`. @@ -3460,8 +3454,11 @@ Usage: `storage auth-basic [command options] [arguments...]` +### storage storage-home +Start storage-home service +Usage: `storage storage-home [command options] [arguments...]` @@ -3484,11 +3481,8 @@ Usage: `storage auth-basic [command options] [arguments...]` -### storage health -Check health status -Usage: `storage health [command options] [arguments...]` @@ -3693,56 +3687,86 @@ Usage: `storage health [command options] [arguments...]` +-debug-addr | $STORAGE_HOME_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9156"`. +-grpc-network | $STORAGE_HOME_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-grpc-addr | $STORAGE_HOME_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9154"`. +-http-network | $STORAGE_HOME_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-http-addr | $STORAGE_HOME_HTTP_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9155"`. +-driver | $STORAGE_HOME_DRIVER +: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. +-read-only | $STORAGE_HOME_READ_ONLY , $OCIS_STORAGE_READ_ONLY +: use storage driver in read-only mode. Default: `false`. +-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `"/home"`. +-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. +-expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. +-data-server-url | $STORAGE_HOME_DATA_SERVER_URL +: data server url. Default: `"http://localhost:9155/data"`. +-http-prefix | $STORAGE_HOME_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `"data"`. +-tmp-folder | $STORAGE_HOME_TMP_FOLDER +: path to tmp folder. Default: `"/var/tmp/ocis/tmp/home"`. +-enable-home | $STORAGE_HOME_ENABLE_HOME +: enable the creation of home directories. Default: `true`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `"localhost:9142"`. +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9144"`. +### storage storage-users +Start storage-users service +Usage: `storage storage-users [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...]` @@ -3810,34 +3834,64 @@ Usage: `storage auth-bearer [command options] [arguments...]` +-debug-addr | $STORAGE_USERS_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9159"`. +-grpc-network | $STORAGE_USERS_GRPC_NETWORK +: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-grpc-addr | $STORAGE_USERS_GRPC_ADDR +: GRPC Address to bind users storage. Default: `"0.0.0.0:9157"`. +-http-network | $STORAGE_USERS_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-http-addr | $STORAGE_USERS_HTTP_ADDR +: HTTP Address to bind users storage. Default: `"0.0.0.0:9158"`. +-driver | $STORAGE_USERS_DRIVER +: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. +-read-only | $STORAGE_USERS_READ_ONLY , $OCIS_STORAGE_READ_ONLY +: use storage driver in read-only mode. Default: `false`. +-mount-path | $STORAGE_USERS_MOUNT_PATH +: mount path. Default: `"/users"`. +-mount-id | $STORAGE_USERS_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. +-expose-data-server | $STORAGE_USERS_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. +-data-server-url | $STORAGE_USERS_DATA_SERVER_URL +: data server url. Default: `"http://localhost:9158/data"`. +-http-prefix | $STORAGE_USERS_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `"data"`. +-tmp-folder | $STORAGE_USERS_TMP_FOLDER +: path to tmp folder. Default: `"/var/tmp/ocis/tmp/users"`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `"localhost:9142"`. +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9144"`. @@ -3942,44 +3996,24 @@ 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 , $OCIS_URL -: 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. Default: `""`. --oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM -: OIDC gid claim. Default: `""`. --network | $STORAGE_AUTH_BEARER_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_AUTH_BEARER_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9148"`. --service | $STORAGE_AUTH_BEARER_SERVICES -: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `"localhost:9142"`. diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index 30f2a112dbf..b05cb1e1d45 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-30T13:43:47+0000" +date: "2021-08-02T06:59:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates @@ -35,62 +35,80 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### store health +### store server -Check health status +Start integrated server -Usage: `store health [command options] [arguments...]` +Usage: `store server [command options] [arguments...]` --debug-addr | $STORE_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9460"`. +-log-file | $STORE_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. +-tracing-enabled | $STORE_TRACING_ENABLED +: Enable sending traces. +-tracing-type | $STORE_TRACING_TYPE +: Tracing backend type. Default: `"jaeger"`. +-tracing-endpoint | $STORE_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. +-tracing-collector | $STORE_TRACING_COLLECTOR +: Endpoint for the collector. Default: `""`. +-tracing-service | $STORE_TRACING_SERVICE +: Service name for tracing. Default: `"store"`. +-debug-addr | $STORE_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9460"`. +-debug-token | $STORE_DEBUG_TOKEN +: Token to grant metrics access. Default: `""`. -### store ocis-store +-debug-pprof | $STORE_DEBUG_PPROF +: Enable pprof debugging. -Service to store values for ocis extensions -Usage: `store ocis-store [command options] [arguments...]` +-debug-zpages | $STORE_DEBUG_ZPAGES +: Enable zpages debugging. --config-file | $STORE_CONFIG_FILE -: Path to config file. +-grpc-namespace | $STORE_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --log-level | $STORE_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. +-name | $STORE_NAME +: Service name. Default: `"store"`. --log-pretty | $STORE_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. +-data-path | $STORE_DATA_PATH +: location of the store data path. Default: `"/var/tmp/ocis/store"`. --log-color | $STORE_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. +-extensions | +: Run specific extensions during supervised mode. This flag is set by the runtime. +### store version +Print the versions of the running instances +Usage: `store version [command options] [arguments...]` @@ -104,86 +122,72 @@ Usage: `store ocis-store [command options] [arguments...]` -### store server -Start integrated server -Usage: `store server [command options] [arguments...]` +-grpc-namespace | $STORE_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --log-file | $STORE_LOG_FILE , $OCIS_LOG_FILE -: Enable log to file. +-name | $STORE_NAME +: Service name. Default: `"store"`. --tracing-enabled | $STORE_TRACING_ENABLED -: Enable sending traces. +### store health +Check health status --tracing-type | $STORE_TRACING_TYPE -: Tracing backend type. Default: `"jaeger"`. +Usage: `store health [command options] [arguments...]` --tracing-endpoint | $STORE_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. --tracing-collector | $STORE_TRACING_COLLECTOR -: Endpoint for the collector. Default: `""`. --tracing-service | $STORE_TRACING_SERVICE -: Service name for tracing. Default: `"store"`. +-debug-addr | $STORE_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9460"`. --debug-addr | $STORE_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9460"`. --debug-token | $STORE_DEBUG_TOKEN -: Token to grant metrics access. Default: `""`. --debug-pprof | $STORE_DEBUG_PPROF -: Enable pprof debugging. --debug-zpages | $STORE_DEBUG_ZPAGES -: Enable zpages debugging. --grpc-namespace | $STORE_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $STORE_NAME -: Service name. Default: `"store"`. --data-path | $STORE_DATA_PATH -: location of the store data path. Default: `"/var/tmp/ocis/store"`. --extensions | -: Run specific extensions during supervised mode. This flag is set by the runtime. +### store ocis-store +Service to store values for ocis extensions -### store version +Usage: `store ocis-store [command options] [arguments...]` -Print the versions of the running instances -Usage: `store version [command options] [arguments...]` +-config-file | $STORE_CONFIG_FILE +: Path to config file. +-log-level | $STORE_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $STORE_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $STORE_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. @@ -199,10 +203,6 @@ Usage: `store version [command options] [arguments...]` --grpc-namespace | $STORE_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $STORE_NAME -: Service name. Default: `"store"`. diff --git a/extensions/thumbnails/configuration.md b/extensions/thumbnails/configuration.md index a4beaacdff5..6485987eb66 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-30T13:43:48+0000" +date: "2021-08-02T06:59:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates @@ -35,181 +35,185 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### thumbnails health +### thumbnails server -Check health status +Start integrated server -Usage: `thumbnails health [command options] [arguments...]` +Usage: `thumbnails server [command options] [arguments...]` --debug-addr | $THUMBNAILS_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9189"`. +-log-file | $THUMBNAILS_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. +-log-level | $THUMBNAILS_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $THUMBNAILS_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $THUMBNAILS_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. +-config-file | $THUMBNAILS_CONFIG_FILE +: Path to config file. +-tracing-enabled | $THUMBNAILS_TRACING_ENABLED +: Enable sending traces. +-tracing-type | $THUMBNAILS_TRACING_TYPE +: Tracing backend type. Default: `"jaeger"`. +-tracing-endpoint | $THUMBNAILS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. +-tracing-collector | $THUMBNAILS_TRACING_COLLECTOR +: Endpoint for the collector. Default: `""`. +-tracing-service | $THUMBNAILS_TRACING_SERVICE +: Service name for tracing. Default: `"thumbnails"`. +-debug-addr | $THUMBNAILS_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9189"`. +-debug-token | $THUMBNAILS_DEBUG_TOKEN +: Token to grant metrics access. Default: `""`. +-debug-pprof | $THUMBNAILS_DEBUG_PPROF +: Enable pprof debugging. -### thumbnails ocis-thumbnails -Example usage +-debug-zpages | $THUMBNAILS_DEBUG_ZPAGES +: Enable zpages debugging. -Usage: `thumbnails ocis-thumbnails [command options] [arguments...]` +-grpc-name | $THUMBNAILS_GRPC_NAME +: Name of the service. Default: `"thumbnails"`. +-grpc-addr | $THUMBNAILS_GRPC_ADDR +: Address to bind grpc server. Default: `"0.0.0.0:9185"`. +-grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-filesystemstorage-root | $THUMBNAILS_FILESYSTEMSTORAGE_ROOT +: Root path of the filesystem storage directory. Default: `/var/tmp/ocis/thumbnails`. +-reva-gateway-addr | $THUMBNAILS_REVA_GATEWAY , $PROXY_REVA_GATEWAY_ADDR +: Reva gateway address. Default: `"127.0.0.1:9142"`. +-webdavsource-insecure | $THUMBNAILS_WEBDAVSOURCE_INSECURE +: Whether to skip certificate checks. Default: `true`. +-thumbnail-resolution | $THUMBNAILS_RESOLUTIONS +: --thumbnail-resolution 16x16 [--thumbnail-resolution 32x32]. Default: `cli.NewStringSlice("16x16", "32x32", "64x64", "128x128", "1920x1080", "3840x2160", "7680x4320")`. +-webdav-namespace | $STORAGE_WEBDAV_NAMESPACE +: Namespace prefix for the webdav endpoint. Default: `"/home"`. +-extensions | +: Run specific extensions during supervised mode. +### thumbnails version +Print the versions of the running instances +Usage: `thumbnails version [command options] [arguments...]` -### thumbnails server -Start integrated server -Usage: `thumbnails server [command options] [arguments...]` --log-file | $THUMBNAILS_LOG_FILE , $OCIS_LOG_FILE -: Enable log to file. --log-level | $THUMBNAILS_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. --log-pretty | $THUMBNAILS_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $THUMBNAILS_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. --config-file | $THUMBNAILS_CONFIG_FILE -: Path to config file. --tracing-enabled | $THUMBNAILS_TRACING_ENABLED -: Enable sending traces. --tracing-type | $THUMBNAILS_TRACING_TYPE -: Tracing backend type. Default: `"jaeger"`. --tracing-endpoint | $THUMBNAILS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. --tracing-collector | $THUMBNAILS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `""`. +-grpc-name | $THUMBNAILS_GRPC_NAME +: Name of the service. Default: `"thumbnails"`. --tracing-service | $THUMBNAILS_TRACING_SERVICE -: Service name for tracing. Default: `"thumbnails"`. +-grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +### thumbnails health --debug-addr | $THUMBNAILS_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9189"`. +Check health status +Usage: `thumbnails health [command options] [arguments...]` --debug-token | $THUMBNAILS_DEBUG_TOKEN -: Token to grant metrics access. Default: `""`. +-debug-addr | $THUMBNAILS_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9189"`. --debug-pprof | $THUMBNAILS_DEBUG_PPROF -: Enable pprof debugging. --debug-zpages | $THUMBNAILS_DEBUG_ZPAGES -: Enable zpages debugging. --grpc-name | $THUMBNAILS_GRPC_NAME -: Name of the service. Default: `"thumbnails"`. --grpc-addr | $THUMBNAILS_GRPC_ADDR -: Address to bind grpc server. Default: `"0.0.0.0:9185"`. --grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --filesystemstorage-root | $THUMBNAILS_FILESYSTEMSTORAGE_ROOT -: Root path of the filesystem storage directory. Default: `/var/tmp/ocis/thumbnails`. --reva-gateway-addr | $THUMBNAILS_REVA_GATEWAY , $PROXY_REVA_GATEWAY_ADDR -: Reva gateway address. Default: `"127.0.0.1:9142"`. --webdavsource-insecure | $THUMBNAILS_WEBDAVSOURCE_INSECURE -: Whether to skip certificate checks. Default: `true`. --thumbnail-resolution | $THUMBNAILS_RESOLUTIONS -: --thumbnail-resolution 16x16 [--thumbnail-resolution 32x32]. Default: `cli.NewStringSlice("16x16", "32x32", "64x64", "128x128", "1920x1080", "3840x2160", "7680x4320")`. --webdav-namespace | $STORAGE_WEBDAV_NAMESPACE -: Namespace prefix for the webdav endpoint. Default: `"/home"`. --extensions | -: Run specific extensions during supervised mode. -### thumbnails version -Print the versions of the running instances -Usage: `thumbnails version [command options] [arguments...]` +### thumbnails ocis-thumbnails +Example usage +Usage: `thumbnails ocis-thumbnails [command options] [arguments...]` @@ -234,10 +238,6 @@ Usage: `thumbnails version [command options] [arguments...]` --grpc-name | $THUMBNAILS_GRPC_NAME -: Name of the service. Default: `"thumbnails"`. --grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. diff --git a/extensions/web/configuration.md b/extensions/web/configuration.md index 7cccaf9c5e0..5822df945cd 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-30T13:43:48+0000" +date: "2021-08-02T06:59:52+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/web/templates diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index 3359a0b3ca8..598987255e8 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-30T13:43:48+0000" +date: "2021-08-02T06:59:52+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates @@ -66,39 +66,6 @@ Usage: `webdav [global options] command [command options] [arguments...]` ## Sub Commands - -### webdav health - -Check health status - -Usage: `webdav health [command options] [arguments...]` - - --debug-addr | $WEBDAV_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9119"`. - - - - - - - - - - - - - - - - - - - - - - - ### webdav server @@ -228,4 +195,37 @@ Usage: `webdav version [command options] [arguments...]` -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"`. + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ocis/configuration.md b/ocis/configuration.md index 8698b6cfab1..6f2855ecaae 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-07-30T13:43:47+0000" +date: "2021-08-02T06:59:50+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -108,11 +108,11 @@ Usage: `ocis [global options] command [command options] [arguments...]` ## Sub Commands -### ocis kill +### ocis run -Kill an extension by name +Runs an extension -Usage: `ocis kill [command options] [arguments...]` +Usage: `ocis run [command options] [arguments...]` @@ -136,11 +136,11 @@ Usage: `ocis kill [command options] [arguments...]` -### ocis server +### ocis list -Start fullstack server +Lists running ocis extensions -Usage: `ocis server [command options] [arguments...]` +Usage: `ocis list [command options] [arguments...]` @@ -157,42 +157,26 @@ Usage: `ocis server [command options] [arguments...]` --debug-addr | $OCIS_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9010`. --debug-token | $OCIS_DEBUG_TOKEN -: Token to grant metrics access. --debug-pprof | $OCIS_DEBUG_PPROF -: Enable pprof debugging. --debug-zpages | $OCIS_DEBUG_ZPAGES -: Enable zpages debugging. +### ocis health --http-addr | $OCIS_HTTP_ADDR -: Address to bind http server. Default: `0.0.0.0:9000`. +Check health status +Usage: `ocis health [command options] [arguments...]` --http-root | $OCIS_HTTP_ROOT -: Root path of http server. Default: `/`. --grpc-addr | $OCIS_GRPC_ADDR -: Address to bind grpc server. Default: `0.0.0.0:9001`. --extensions | $OCIS_RUN_EXTENSIONS -: Run specific extensions during supervised mode. -### ocis health -Check health status -Usage: `ocis health [command options] [arguments...]` @@ -200,6 +184,8 @@ Usage: `ocis health [command options] [arguments...]` +-debug-addr | $OCIS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9010`. @@ -208,22 +194,20 @@ Usage: `ocis health [command options] [arguments...]` --debug-addr | $OCIS_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9010`. +### ocis kill +Kill an extension by name +Usage: `ocis kill [command options] [arguments...]` -### ocis run -Runs an extension -Usage: `ocis run [command options] [arguments...]` @@ -239,19 +223,19 @@ Usage: `ocis run [command options] [arguments...]` +### ocis server +Start fullstack server +Usage: `ocis server [command options] [arguments...]` -### ocis list -Lists running ocis extensions -Usage: `ocis list [command options] [arguments...]` @@ -260,45 +244,73 @@ Usage: `ocis list [command options] [arguments...]` +-debug-addr | $OCIS_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9010`. +-debug-token | $OCIS_DEBUG_TOKEN +: Token to grant metrics access. +-debug-pprof | $OCIS_DEBUG_PPROF +: Enable pprof debugging. +-debug-zpages | $OCIS_DEBUG_ZPAGES +: Enable zpages debugging. +-http-addr | $OCIS_HTTP_ADDR +: Address to bind http server. Default: `0.0.0.0:9000`. +-http-root | $OCIS_HTTP_ROOT +: Root path of http server. Default: `/`. +-grpc-addr | $OCIS_GRPC_ADDR +: Address to bind grpc server. Default: `0.0.0.0:9001`. +-extensions | $OCIS_RUN_EXTENSIONS +: Run specific extensions during supervised mode. ### List of available Extension subcommands There are more subcommands to start the individual extensions. Please check the documentation about their usage and options in the dedicated section of the documentation. -#### ocis idp +#### ocis glauth -Start idp server +Start glauth server #### ocis onlyoffice Start onlyoffice server -#### ocis settings - -Start settings server - -#### ocis storage-gateway +#### ocis storage-home -Start storage gateway +Start storage and data provider for /home mount #### ocis storage-userprovider Start storage userprovider service +#### ocis idp + +Start idp server + +#### ocis storage-sharing + +Start storage sharing service + +#### ocis storage-users + +Start storage and data provider for /users mount + +#### ocis ocs + +Start ocs server + #### ocis web Start web server @@ -307,67 +319,55 @@ Start web server Start webdav server -#### ocis proxy +#### ocis storage-auth-basic -Start proxy server +Start storage auth-basic service #### ocis thumbnails Start thumbnails server -#### ocis glauth +#### ocis settings -Start glauth server +Start settings server -#### ocis storage-metadata +#### ocis storage-gateway -Start storage and data service for metadata +Start storage gateway -#### ocis storage-sharing +#### ocis storage-groupprovider -Start storage sharing service +Start storage groupprovider service -#### ocis accounts +#### ocis store -Start accounts server +Start a go-micro store -#### ocis storage-public-link +#### ocis proxy -Start storage public link storage +Start proxy server #### ocis storage-frontend Start storage frontend -#### ocis storage-auth-basic - -Start storage auth-basic service - -#### ocis storage-auth-bearer - -Start storage auth-bearer service - -#### ocis storage-home +#### ocis storage-public-link -Start storage and data provider for /home mount +Start storage public link storage -#### ocis ocs +#### ocis accounts -Start ocs server +Start accounts server -#### ocis store +#### ocis storage-auth-bearer -Start a go-micro store +Start storage auth-bearer service -#### ocis storage-users +#### ocis storage-metadata -Start storage and data provider for /users mount +Start storage and data service for metadata #### ocis version Lists running services with version -#### ocis storage-groupprovider - -Start storage groupprovider service -