From 8947021e30b4cecca54812c16d70a616afc9b88d Mon Sep 17 00:00:00 2001 From: David Christofas Date: Tue, 23 Feb 2021 13:29:42 +0000 Subject: [PATCH] commit 1ed27939cc2f56ac1f5b997cb4e74ec4d70286f1 Merge: 52ebb7c6 3a46bd2f Author: David Christofas Date: Tue Feb 23 14:26:42 2021 +0100 Merge pull request #1684 from owncloud/update-reva update reva to v1.6.1-0.20210218130854-a954e7242e7a --- extensions/accounts/configuration.md | 80 ++--- extensions/glauth/configuration.md | 50 +-- extensions/graph-explorer/configuration.md | 2 +- extensions/graph/configuration.md | 2 +- extensions/idp/configuration.md | 2 +- extensions/ocs/configuration.md | 26 +- extensions/onlyoffice/configuration.md | 2 +- extensions/proxy/configuration.md | 20 +- extensions/settings/configuration.md | 2 +- extensions/storage/configuration.md | 398 ++++++++++----------- extensions/store/configuration.md | 20 +- extensions/thumbnails/configuration.md | 2 +- extensions/web/configuration.md | 20 +- extensions/webdav/configuration.md | 2 +- ocis/configuration.md | 116 +++--- 15 files changed, 372 insertions(+), 372 deletions(-) diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 4d27dc5153e..f2ae56f8d5d 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-02-23T08:56:38+0000" +date: "2021-02-23T13:27:24+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -35,11 +35,44 @@ 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. -### accounts list +### accounts ocis-accounts -List existing accounts +Provide accounts and groups for oCIS -Usage: `accounts list [command options] [arguments...]` +Usage: `accounts ocis-accounts [command options] [arguments...]` + +-log-level | $ACCOUNTS_LOG_LEVEL +: Set logging level. Default: `info`. + +-log-pretty | $ACCOUNTS_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +-log-color | $ACCOUNTS_LOG_COLOR +: Enable colored logging. Default: `true`. + +### 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 rebuildIndex + +Rebuilds the service's index, i.e. deleting and then re-adding all existing documents + +Usage: `accounts rebuildIndex [command options] [arguments...]` + +### accounts remove + +Removes an existing account + +Usage: `accounts remove [command options] [arguments...]` -grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. @@ -119,18 +152,6 @@ Make changes to an existing account 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 add Create a new account @@ -149,32 +170,11 @@ Usage: `accounts inspect [command options] [arguments...]` -name | $ACCOUNTS_NAME : service name. Default: `accounts`. -### accounts ocis-accounts - -Provide accounts and groups for oCIS - -Usage: `accounts ocis-accounts [command options] [arguments...]` - --log-level | $ACCOUNTS_LOG_LEVEL -: Set logging level. Default: `info`. - --log-pretty | $ACCOUNTS_LOG_PRETTY -: Enable pretty logging. Default: `true`. - --log-color | $ACCOUNTS_LOG_COLOR -: Enable colored logging. Default: `true`. - -### accounts rebuildIndex - -Rebuilds the service's index, i.e. deleting and then re-adding all existing documents - -Usage: `accounts rebuildIndex [command options] [arguments...]` - -### accounts remove +### accounts list -Removes an existing account +List existing accounts -Usage: `accounts remove [command options] [arguments...]` +Usage: `accounts list [command options] [arguments...]` -grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index 09d23cfef37..cd48d7ecd43 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-02-23T08:57:47+0000" +date: "2021-02-23T13:29:00+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/glauth/templates @@ -35,6 +35,30 @@ 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. +### glauth health + +Check health status + +Usage: `glauth health [command options] [arguments...]` + +-debug-addr | $GLAUTH_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9129`. + +### glauth ocis-glauth + +Serve GLAuth API for oCIS + +Usage: `glauth ocis-glauth [command options] [arguments...]` + +-log-level | $GLAUTH_LOG_LEVEL +: Set logging level. Default: `info`. + +-log-pretty | $GLAUTH_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +-log-color | $GLAUTH_LOG_COLOR +: Enable colored logging. Default: `true`. + ### glauth server Start integrated server @@ -134,27 +158,3 @@ Usage: `glauth server [command options] [arguments...]` -fallback-use-graphapi | $GLAUTH_FALLBACK_USE_GRAPHAPI : use Graph API, only for owncloud datastore. Default: `true`. -### glauth health - -Check health status - -Usage: `glauth health [command options] [arguments...]` - --debug-addr | $GLAUTH_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9129`. - -### glauth ocis-glauth - -Serve GLAuth API for oCIS - -Usage: `glauth ocis-glauth [command options] [arguments...]` - --log-level | $GLAUTH_LOG_LEVEL -: Set logging level. Default: `info`. - --log-pretty | $GLAUTH_LOG_PRETTY -: Enable pretty logging. Default: `true`. - --log-color | $GLAUTH_LOG_COLOR -: Enable colored logging. Default: `true`. - diff --git a/extensions/graph-explorer/configuration.md b/extensions/graph-explorer/configuration.md index 51ae7262364..b46421fb19c 100644 --- a/extensions/graph-explorer/configuration.md +++ b/extensions/graph-explorer/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-02-23T08:57:49+0000" +date: "2021-02-23T13:29:02+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph-explorer/templates diff --git a/extensions/graph/configuration.md b/extensions/graph/configuration.md index d180ac8c9ab..2169d4e59ff 100644 --- a/extensions/graph/configuration.md +++ b/extensions/graph/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-02-23T08:57:50+0000" +date: "2021-02-23T13:29:03+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 1a32179ed1b..79cf93695da 100644 --- a/extensions/idp/configuration.md +++ b/extensions/idp/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-02-23T08:57:51+0000" +date: "2021-02-23T13:29:04+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 ff7b6a4bac8..7df8da16920 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-02-23T08:57:53+0000" +date: "2021-02-23T13:29:07+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/templates @@ -35,18 +35,6 @@ 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. -### ocs version - -Print the versions of the running instances - -Usage: `ocs version [command options] [arguments...]` - --http-namespace | $OCS_NAMESPACE -: Set the base namespace for the http namespace. Default: `com.owncloud.web`. - --name | $OCS_NAME -: Service name. Default: `ocs`. - ### ocs health Check health status @@ -122,3 +110,15 @@ Usage: `ocs server [command options] [arguments...]` -jwt-secret | $OCS_JWT_SECRET , $OCIS_JWT_SECRET : Used to dismantle the access token, should equal reva's jwt-secret. Default: `Pive-Fumkiu4`. +### ocs version + +Print the versions of the running instances + +Usage: `ocs version [command options] [arguments...]` + +-http-namespace | $OCS_NAMESPACE +: Set the base namespace for the http namespace. Default: `com.owncloud.web`. + +-name | $OCS_NAME +: Service name. Default: `ocs`. + diff --git a/extensions/onlyoffice/configuration.md b/extensions/onlyoffice/configuration.md index d21e4425ccf..7c020e8479d 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-02-23T08:57:54+0000" +date: "2021-02-23T13:29:08+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/onlyoffice/templates diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index c6bdf28b27f..b27b7e170d6 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-02-23T08:57:55+0000" +date: "2021-02-23T13:29:09+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/proxy/templates @@ -35,6 +35,15 @@ 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. +### proxy health + +Check health status + +Usage: `proxy health [command options] [arguments...]` + +--debug-addr | $PROXY_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9109`. + ### proxy ocis-proxy proxy for oCIS @@ -149,12 +158,3 @@ Usage: `proxy version [command options] [arguments...]` --service-name | $PROXY_SERVICE_NAME : Service name. Default: `proxy`. -### proxy health - -Check health status - -Usage: `proxy health [command options] [arguments...]` - ---debug-addr | $PROXY_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9109`. - diff --git a/extensions/settings/configuration.md b/extensions/settings/configuration.md index 97b9a71e2e9..6b3799b3c69 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-02-23T08:57:55+0000" +date: "2021-02-23T13:29:10+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/settings/templates diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index 4e1715e72e9..f85552b3c44 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-02-23T08:57:56+0000" +date: "2021-02-23T13:29:11+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -55,59 +55,29 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage frontend - -Start frontend service - -Usage: `storage frontend [command options] [arguments...]` - --debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9141`. - --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. +### storage groups --chunk-folder | $STORAGE_CHUNK_FOLDER -: temp directory for chunked uploads. Default: `/var/tmp/ocis/tmp/chunks`. +Start groups service --webdav-namespace | $STORAGE_WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `/home/`. +Usage: `storage groups [command options] [arguments...]` --dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `/users/`. +-debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9161`. --network | $STORAGE_FRONTEND_HTTP_NETWORK +-network | $STORAGE_GROUPPROVIDER_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`. - --datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `data`. - --ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. - --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`. - --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `localhost:9142`. +-addr | $STORAGE_GROUPPROVIDER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9160`. --default-upload-protocol | $STORAGE_FRONTEND_DEFAULT_UPLOAD_PROTOCOL -: Default upload chunking protocol to be used out of tus/v1/ng. Default: `tus`. +-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `localhost:9160`. --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. +-driver | $STORAGE_GROUPPROVIDER_DRIVER +: group driver: 'json', 'ldap', or 'rest'. Default: `ldap`. --checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE -: Specify the preferred checksum algorithm used for uploads. +-json-config | $STORAGE_GROUPPROVIDER_JSON +: Path to groups.json file. ### storage storage @@ -127,6 +97,45 @@ Usage: `storage storage [command options] [arguments...]` -log-color | $STORAGE_LOG_COLOR : Enable colored logging. +### storage storage-metadata + +Start storage-metadata service + +Usage: `storage storage-metadata [command options] [arguments...]` + +-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`. + ### storage storage-users Start storage-users service @@ -175,6 +184,135 @@ Usage: `storage storage-users [command options] [arguments...]` -users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT : endpoint to use for the storage service. Default: `localhost:9144`. +### storage auth-basic + +Start authprovider for basic auth + +Usage: `storage auth-basic [command options] [arguments...]` + +-debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9147`. + +-auth-driver | $STORAGE_AUTH_DRIVER +: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. + +-auth-json | $STORAGE_AUTH_JSON +: Path to users.json file. + +-network | $STORAGE_AUTH_BASIC_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`. + +### storage storage-public-link + +Start storage-public-link service + +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`. + +### storage users + +Start users service + +Usage: `storage users [command options] [arguments...]` + +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9145`. + +-network | $STORAGE_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`. + +-driver | $STORAGE_USERPROVIDER_DRIVER +: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. + +-json-config | $STORAGE_USERPROVIDER_JSON +: Path to users.json file. + +### storage frontend + +Start frontend service + +Usage: `storage frontend [command options] [arguments...]` + +-debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9141`. + +-transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. + +-chunk-folder | $STORAGE_CHUNK_FOLDER +: temp directory for chunked uploads. Default: `/var/tmp/ocis/tmp/chunks`. + +-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`. + +-datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX +: datagateway prefix. Default: `data`. + +-ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX +: owncloud webdav endpoint prefix. + +-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`. + +-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-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. + +-checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE +: Specify the preferred checksum algorithm used for uploads. + +### storage health + +Check health status + +Usage: `storage health [command options] [arguments...]` + +-debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9109`. + ### storage storage-home Start storage-home service @@ -226,62 +364,32 @@ Usage: `storage storage-home [command options] [arguments...]` -users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT : endpoint to use for the storage service. Default: `localhost:9144`. -### storage groups - -Start groups service - -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`. - --driver | $STORAGE_GROUPPROVIDER_DRIVER -: group driver: 'json', 'ldap', or 'rest'. Default: `ldap`. - --json-config | $STORAGE_GROUPPROVIDER_JSON -: Path to groups.json file. - -### storage health - -Check health status - -Usage: `storage health [command options] [arguments...]` - --debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9109`. - -### storage users +### storage sharing -Start users service +Start sharing service -Usage: `storage users [command options] [arguments...]` +Usage: `storage sharing [command options] [arguments...]` -debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9145`. +: Address to bind debug server. Default: `0.0.0.0:9151`. --network | $STORAGE_USERPROVIDER_NETWORK +-network | $STORAGE_SHARING_GRPC_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`. +-addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9150`. --endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `localhost:9144`. +-user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `json`. --driver | $STORAGE_USERPROVIDER_DRIVER -: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. +-user-json-file | $STORAGE_SHARING_USER_JSON_FILE +: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/storage/shares.json`. --json-config | $STORAGE_USERPROVIDER_JSON -: Path to users.json file. +-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`. ### storage auth-bearer @@ -400,114 +508,6 @@ Usage: `storage gateway [command options] [arguments...]` -storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH : mount path. Default: `/public`. -### storage storage-public-link - -Start storage-public-link service - -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`. - -### storage auth-basic - -Start authprovider for basic auth - -Usage: `storage auth-basic [command options] [arguments...]` - --debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9147`. - --auth-driver | $STORAGE_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. - --auth-json | $STORAGE_AUTH_JSON -: Path to users.json file. - --network | $STORAGE_AUTH_BASIC_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`. - -### storage sharing - -Start sharing service - -Usage: `storage sharing [command options] [arguments...]` - --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0: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`. - --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`. - -### storage storage-metadata - -Start storage-metadata service - -Usage: `storage storage-metadata [command options] [arguments...]` - --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`. - ## Config for the different Storage Drivers You can set different storage drivers for the Storage Providers. Please check the storage provider configuration. diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index 8d28ff20a8f..8befd9dd12c 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-02-23T08:57:57+0000" +date: "2021-02-23T13:29:12+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates @@ -35,15 +35,6 @@ 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 - -Check health status - -Usage: `store health [command options] [arguments...]` - --debug-addr | $STORE_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9460`. - ### store ocis-store Service to store values for ocis extensions @@ -116,3 +107,12 @@ Usage: `store version [command options] [arguments...]` -name | $STORE_NAME : Service name. Default: `store`. +### store health + +Check health status + +Usage: `store health [command options] [arguments...]` + +-debug-addr | $STORE_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9460`. + diff --git a/extensions/thumbnails/configuration.md b/extensions/thumbnails/configuration.md index 622481c31e7..54d703a24d3 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-02-23T08:57:58+0000" +date: "2021-02-23T13:29:13+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates diff --git a/extensions/web/configuration.md b/extensions/web/configuration.md index 9f1539747a7..55fc0c28af8 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-02-23T08:57:59+0000" +date: "2021-02-23T13:29:14+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/web/templates @@ -52,15 +52,6 @@ Usage: `web [global options] command [command options] [arguments...]` ## Sub Commands -### web health - -Check health status - -Usage: `web health [command options] [arguments...]` - --debug-addr | $WEB_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9104`. - ### web server Start integrated server @@ -136,3 +127,12 @@ Usage: `web server [command options] [arguments...]` -oidc-scope | $WEB_OIDC_SCOPE : OpenID Connect scope. Default: `openid profile email`. +### web health + +Check health status + +Usage: `web health [command options] [arguments...]` + +-debug-addr | $WEB_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9104`. + diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index e5cc8fc66a0..1ede273117e 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-02-23T08:58:00+0000" +date: "2021-02-23T13:29:15+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates diff --git a/ocis/configuration.md b/ocis/configuration.md index 758db8f878a..c748e31f548 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-02-23T08:57:52+0000" +date: "2021-02-23T13:29:06+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -74,11 +74,17 @@ Usage: `ocis [global options] command [command options] [arguments...]` ## Sub Commands -### ocis run +### ocis kill -Runs an extension +Kill an extension by name -Usage: `ocis run [command options] [arguments...]` +Usage: `ocis kill [command options] [arguments...]` + +### ocis list + +Lists running ocis extensions + +Usage: `ocis list [command options] [arguments...]` ### ocis server @@ -107,6 +113,12 @@ Usage: `ocis server [command options] [arguments...]` -grpc-addr | $OCIS_GRPC_ADDR : Address to bind grpc server. Default: `0.0.0.0:9001`. +### ocis run + +Runs an extension + +Usage: `ocis run [command options] [arguments...]` + ### ocis health Check health status @@ -116,111 +128,99 @@ Usage: `ocis health [command options] [arguments...]` -debug-addr | $OCIS_DEBUG_ADDR : Address to debug endpoint. Default: `0.0.0.0:9010`. -### ocis kill +### List of available Extension subcommands -Kill an extension by name +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. -Usage: `ocis kill [command options] [arguments...]` +#### ocis onlyoffice -### ocis list +Start onlyoffice server -Lists running ocis extensions +#### ocis settings -Usage: `ocis list [command options] [arguments...]` +Start settings server -### List of available Extension subcommands +#### ocis web -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. +Start web server -#### ocis storage-auth-basic +#### ocis idp -Start storage auth-basic service +Start idp server -#### ocis storage-users +#### ocis proxy -Start storage and data provider for /users mount +Start proxy server -#### ocis version +#### ocis storage-auth-basic -Lists running services with version +Start storage auth-basic service -#### ocis storage-gateway +#### ocis storage-auth-bearer -Start storage gateway +Start storage auth-bearer service -#### ocis storage-public-link +#### ocis storage-groupprovider -Start storage public link storage +Start storage groupprovider service -#### ocis storage-userprovider +#### ocis storage-home -Start storage userprovider service +Start storage and data provider for /home mount -#### ocis store +#### ocis storage-sharing -Start a go-micro store +Start storage sharing service -#### ocis webdav +#### ocis storage-users -Start webdav server +Start storage and data provider for /users mount -#### ocis onlyoffice +#### ocis webdav -Start onlyoffice server +Start webdav server -#### ocis proxy +#### ocis accounts -Start proxy server +Start accounts server -#### ocis storage-home +#### ocis storage-gateway -Start storage and data provider for /home mount +Start storage gateway #### ocis storage-metadata Start storage and data service for metadata -#### ocis web +#### ocis storage-userprovider -Start web server +Start storage userprovider service -#### ocis idp +#### ocis version -Start idp server +Lists running services with version -#### ocis ocs +#### ocis glauth -Start ocs server +Start glauth server -#### ocis settings +#### ocis ocs -Start settings server +Start ocs server #### ocis storage-frontend Start storage frontend -#### ocis accounts +#### ocis storage-public-link -Start accounts server +Start storage public link storage -#### ocis glauth +#### ocis store -Start glauth server +Start a go-micro store #### ocis thumbnails Start thumbnails server -#### ocis storage-sharing - -Start storage sharing service - -#### ocis storage-auth-bearer - -Start storage auth-bearer service - -#### ocis storage-groupprovider - -Start storage groupprovider service -