From 2c6ce3059afe1e7477cf7b71a6ebba11bee05ac3 Mon Sep 17 00:00:00 2001 From: Alex Unger <6905948+refs@users.noreply.github.com> Date: Wed, 21 Apr 2021 09:42:02 +0000 Subject: [PATCH] commit a95cf437de75236700a1ddce1b16e16fa4f6dc2e Merge: dff3f0af 0e36f04a Author: Alex Unger <6905948+refs@users.noreply.github.com> Date: Wed Apr 21 11:40:05 2021 +0200 Merge pull request #1941 from owncloud/fix_arm64_builds_docker use binaries from make release for docker builds --- extensions/accounts/configuration.md | 140 ++++++------- extensions/glauth/configuration.md | 2 +- extensions/graph-explorer/configuration.md | 2 +- extensions/graph/configuration.md | 2 +- extensions/idp/configuration.md | 2 +- extensions/ocs/configuration.md | 32 +-- extensions/onlyoffice/configuration.md | 2 +- extensions/proxy/configuration.md | 2 +- extensions/settings/configuration.md | 2 +- extensions/storage/configuration.md | 230 ++++++++++----------- extensions/store/configuration.md | 2 +- extensions/thumbnails/configuration.md | 56 ++--- extensions/web/configuration.md | 14 +- extensions/webdav/configuration.md | 26 +-- ocis/configuration.md | 108 +++++----- 15 files changed, 311 insertions(+), 311 deletions(-) diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 893ca7e5e8d..15088478c7f 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-04-20T14:11:17+0000" +date: "2021-04-21T09:40:24+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -35,6 +35,75 @@ 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 add + +Create a new account + +Usage: `accounts add [command options] [arguments...]` + +### accounts inspect + +Show detailed data on an existing account + +Usage: `accounts inspect [command options] [arguments...]` + +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. + +-name | $ACCOUNTS_NAME +: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. + +### accounts list + +List existing accounts + +Usage: `accounts list [command options] [arguments...]` + +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. + +-name | $ACCOUNTS_NAME +: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. + +### accounts ocis-accounts + +Provide accounts and groups for oCIS + +Usage: `accounts ocis-accounts [command options] [arguments...]` + +-log-level | $ACCOUNTS_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. + +-log-pretty | $ACCOUNTS_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. + +-log-color | $ACCOUNTS_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. + +### accounts update + +Make changes to an existing account + +Usage: `accounts update [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...]` + +### 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: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. + +-name | $ACCOUNTS_NAME +: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. + ### accounts server Start ocis accounts service @@ -104,12 +173,6 @@ Usage: `accounts server [command options] [arguments...]` -service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME : username of the internal service user (required on EOS). Default: `flags.OverrideDefaultString(cfg.ServiceUser.Username, "")`. -### accounts update - -Make changes to an existing account - -Usage: `accounts update [command options] [arguments...]` - ### accounts version Print the versions of the running instances @@ -122,66 +185,3 @@ Usage: `accounts version [command options] [arguments...]` -name | $ACCOUNTS_NAME : service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. -### accounts add - -Create a new account - -Usage: `accounts add [command options] [arguments...]` - -### accounts inspect - -Show detailed data on an existing account - -Usage: `accounts inspect [command options] [arguments...]` - --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. - --name | $ACCOUNTS_NAME -: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. - -### accounts ocis-accounts - -Provide accounts and groups for oCIS - -Usage: `accounts ocis-accounts [command options] [arguments...]` - --log-level | $ACCOUNTS_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. - --log-pretty | $ACCOUNTS_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. - --log-color | $ACCOUNTS_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. - -### accounts list - -List existing accounts - -Usage: `accounts list [command options] [arguments...]` - --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. - --name | $ACCOUNTS_NAME -: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "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: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. - --name | $ACCOUNTS_NAME -: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. - diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index 573b8a3fd5a..87bd9e51bc9 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-04-20T14:12:09+0000" +date: "2021-04-21T09:41:09+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/glauth/templates diff --git a/extensions/graph-explorer/configuration.md b/extensions/graph-explorer/configuration.md index 90dc18d4271..0c9b5119a20 100644 --- a/extensions/graph-explorer/configuration.md +++ b/extensions/graph-explorer/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-04-20T14:12:09+0000" +date: "2021-04-21T09:41:09+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 e15feb33741..5d13c0eec54 100644 --- a/extensions/graph/configuration.md +++ b/extensions/graph/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-04-20T14:12:09+0000" +date: "2021-04-21T09:41:09+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 757d1eb5a5b..68dcdd5e07e 100644 --- a/extensions/idp/configuration.md +++ b/extensions/idp/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-04-20T14:12:09+0000" +date: "2021-04-21T09:41:09+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 294144abd7a..d4b9d9c497d 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-04-20T14:12:09+0000" +date: "2021-04-21T09:41:09+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/templates @@ -35,6 +35,21 @@ 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 health + +Check health status + +Usage: `ocs health [command options] [arguments...]` + +-debug-addr | $OCS_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9114")`. + +### ocs ocis-ocs + +Serve OCS API for oCIS + +Usage: `ocs ocis-ocs [command options] [arguments...]` + ### ocs server Start integrated server @@ -116,18 +131,3 @@ Usage: `ocs version [command options] [arguments...]` -name | $OCS_NAME : Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "ocs")`. -### ocs health - -Check health status - -Usage: `ocs health [command options] [arguments...]` - --debug-addr | $OCS_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9114")`. - -### ocs ocis-ocs - -Serve OCS API for oCIS - -Usage: `ocs ocis-ocs [command options] [arguments...]` - diff --git a/extensions/onlyoffice/configuration.md b/extensions/onlyoffice/configuration.md index 9863f0c4f83..5a9152a1b05 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-04-20T14:12:09+0000" +date: "2021-04-21T09:41:09+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 bf6a1e8405f..6a5b853c3f6 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-04-20T14:12:10+0000" +date: "2021-04-21T09:41:09+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 f3e1c686d8e..9e9a6ae4275 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-04-20T14:12:10+0000" +date: "2021-04-21T09:41:09+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 764cad2524b..dbcdb4db83a 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-04-20T14:12:10+0000" +date: "2021-04-21T09:41:09+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -55,6 +55,60 @@ 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: `flags.OverrideDefaultString(cfg.Reva.Frontend.DebugAddr, "0.0.0.0:9141")`. + +-transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `flags.OverrideDefaultString(cfg.Reva.TransferSecret, "replace-me-with-a-transfer-secret")`. + +-webdav-namespace | $STORAGE_WEBDAV_NAMESPACE +: Namespace prefix for the /webdav endpoint. Default: `flags.OverrideDefaultString(cfg.Reva.OCDav.WebdavNamespace, "/home/")`. + +-dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE +: Namespace prefix for the webdav /dav/files endpoint. Default: `flags.OverrideDefaultString(cfg.Reva.OCDav.DavFilesNamespace, "/users/")`. + +-network | $STORAGE_FRONTEND_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.HTTPNetwork, "tcp")`. + +-addr | $STORAGE_FRONTEND_HTTP_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.HTTPAddr, "0.0.0.0:9140")`. + +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.PublicURL, "https://localhost:9200")`. + +-datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX +: datagateway prefix. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.DatagatewayPrefix, "data")`. + +-ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX +: owncloud webdav endpoint prefix. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCDavPrefix, "")`. + +-ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX +: open collaboration services endpoint prefix. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCSPrefix, "ocs")`. + +-ocs-share-prefix | $STORAGE_FRONTEND_OCS_SHARE_PREFIX +: the prefix prepended to the path of shared files. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCSSharePrefix, "/Shares")`. + +-ocs-home-namespace | $STORAGE_FRONTEND_OCS_HOME_NAMESPACE +: the prefix prepended to the incoming requests in OCS. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCSHomeNamespace, "/home")`. + +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. + +-default-upload-protocol | $STORAGE_FRONTEND_DEFAULT_UPLOAD_PROTOCOL +: Default upload chunking protocol to be used out of tus/v1/ng. Default: `flags.OverrideDefaultString(cfg.Reva.DefaultUploadProtocol, "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. Default: `flags.OverrideDefaultString(cfg.Reva.UploadHTTPMethodOverride, "")`. + +-checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE +: Specify the preferred checksum algorithm used for uploads. Default: `flags.OverrideDefaultString(cfg.Reva.ChecksumPreferredUploadType, "")`. + ### storage gateway Start gateway @@ -145,6 +199,30 @@ Usage: `storage gateway [command options] [arguments...]` -storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH : mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.MountPath, "/public")`. +### storage groups + +Start groups service + +Usage: `storage groups [command options] [arguments...]` + +-debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.DebugAddr, "0.0.0.0:9161")`. + +-network | $STORAGE_GROUPPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.GRPCNetwork, "tcp")`. + +-addr | $STORAGE_GROUPPROVIDER_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.GRPCAddr, "0.0.0.0:9160")`. + +-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Endpoint, "localhost:9160")`. + +-driver | $STORAGE_GROUPPROVIDER_DRIVER +: group driver: 'json', 'ldap', or 'rest'. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Driver, "ldap")`. + +-json-config | $STORAGE_GROUPPROVIDER_JSON +: Path to groups.json file. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.JSON, "")`. + ### storage sharing Start sharing service @@ -175,39 +253,6 @@ Usage: `storage sharing [command options] [arguments...]` -public-enable-expired-shares-cleanup | $STORAGE_SHARING_PUBLIC_ENABLE_EXPIRED_SHARES_CLEANUP : whether to periodically delete expired public shares. Default: `flags.OverrideDefaultBool(cfg.Reva.Sharing.PublicEnableExpiredSharesCleanup, true)`. -### storage auth-bearer - -Start authprovider for bearer auth - -Usage: `storage auth-bearer [command options] [arguments...]` - --debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.DebugAddr, "0.0.0.0:9149")`. - --oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL -: OIDC issuer. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.Issuer, "https://localhost:9200")`. - --oidc-insecure | $STORAGE_OIDC_INSECURE -: OIDC allow insecure communication. Default: `flags.OverrideDefaultBool(cfg.Reva.OIDC.Insecure, true)`. - --oidc-id-claim | $STORAGE_OIDC_ID_CLAIM -: OIDC id claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.IDClaim, "preferred_username")`. - --oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM -: OIDC uid claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.UIDClaim, "")`. - --oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM -: OIDC gid claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.GIDClaim, "")`. - --network | $STORAGE_AUTH_BEARER_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.GRPCNetwork, "tcp")`. - --addr | $STORAGE_AUTH_BEARER_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.GRPCAddr, "0.0.0.0:9148")`. - --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. - ### storage health Check health status @@ -217,30 +262,6 @@ Usage: `storage health [command options] [arguments...]` -debug-addr | $STORAGE_DEBUG_ADDR : Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9109")`. -### storage storage - -Storage service for oCIS - -Usage: `storage storage [command options] [arguments...]` - --config-file | $STORAGE_CONFIG_FILE -: Path to config file. - --log-level | $STORAGE_LOG_LEVEL , $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. - -### storage storage-metadata - -Start storage-metadata service - -Usage: `storage storage-metadata [command options] [arguments...]` - ### storage storage-public-link Start storage-public-link service @@ -334,83 +355,56 @@ Usage: `storage auth-basic [command options] [arguments...]` -gateway-url | $STORAGE_GATEWAY_ENDPOINT : URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. -### storage frontend - -Start frontend service - -Usage: `storage frontend [command options] [arguments...]` - --debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.DebugAddr, "0.0.0.0:9141")`. - --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `flags.OverrideDefaultString(cfg.Reva.TransferSecret, "replace-me-with-a-transfer-secret")`. +### storage auth-bearer --webdav-namespace | $STORAGE_WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `flags.OverrideDefaultString(cfg.Reva.OCDav.WebdavNamespace, "/home/")`. +Start authprovider for bearer auth --dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `flags.OverrideDefaultString(cfg.Reva.OCDav.DavFilesNamespace, "/users/")`. +Usage: `storage auth-bearer [command options] [arguments...]` --network | $STORAGE_FRONTEND_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.HTTPNetwork, "tcp")`. +-debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.DebugAddr, "0.0.0.0:9149")`. --addr | $STORAGE_FRONTEND_HTTP_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.HTTPAddr, "0.0.0.0:9140")`. +-oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL +: OIDC issuer. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.Issuer, "https://localhost:9200")`. --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.PublicURL, "https://localhost:9200")`. +-oidc-insecure | $STORAGE_OIDC_INSECURE +: OIDC allow insecure communication. Default: `flags.OverrideDefaultBool(cfg.Reva.OIDC.Insecure, true)`. --datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.DatagatewayPrefix, "data")`. +-oidc-id-claim | $STORAGE_OIDC_ID_CLAIM +: OIDC id claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.IDClaim, "preferred_username")`. --ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCDavPrefix, "")`. +-oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM +: OIDC uid claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.UIDClaim, "")`. --ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX -: open collaboration services endpoint prefix. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCSPrefix, "ocs")`. +-oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM +: OIDC gid claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.GIDClaim, "")`. --ocs-share-prefix | $STORAGE_FRONTEND_OCS_SHARE_PREFIX -: the prefix prepended to the path of shared files. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCSSharePrefix, "/Shares")`. +-network | $STORAGE_AUTH_BEARER_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.GRPCNetwork, "tcp")`. --ocs-home-namespace | $STORAGE_FRONTEND_OCS_HOME_NAMESPACE -: the prefix prepended to the incoming requests in OCS. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCSHomeNamespace, "/home")`. +-addr | $STORAGE_AUTH_BEARER_GRPC_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.GRPCAddr, "0.0.0.0:9148")`. -gateway-url | $STORAGE_GATEWAY_ENDPOINT : URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. --default-upload-protocol | $STORAGE_FRONTEND_DEFAULT_UPLOAD_PROTOCOL -: Default upload chunking protocol to be used out of tus/v1/ng. Default: `flags.OverrideDefaultString(cfg.Reva.DefaultUploadProtocol, "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. Default: `flags.OverrideDefaultString(cfg.Reva.UploadHTTPMethodOverride, "")`. - --checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE -: Specify the preferred checksum algorithm used for uploads. Default: `flags.OverrideDefaultString(cfg.Reva.ChecksumPreferredUploadType, "")`. - -### storage groups - -Start groups service - -Usage: `storage groups [command options] [arguments...]` +### storage storage --debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.DebugAddr, "0.0.0.0:9161")`. +Storage service for oCIS --network | $STORAGE_GROUPPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.GRPCNetwork, "tcp")`. +Usage: `storage storage [command options] [arguments...]` --addr | $STORAGE_GROUPPROVIDER_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.GRPCAddr, "0.0.0.0:9160")`. +-config-file | $STORAGE_CONFIG_FILE +: Path to config file. --endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Endpoint, "localhost:9160")`. +-log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. --driver | $STORAGE_GROUPPROVIDER_DRIVER -: group driver: 'json', 'ldap', or 'rest'. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Driver, "ldap")`. +-log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. --json-config | $STORAGE_GROUPPROVIDER_JSON -: Path to groups.json file. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.JSON, "")`. +-log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. ### storage storage-home @@ -463,6 +457,12 @@ Usage: `storage storage-home [command options] [arguments...]` -users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT : endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. +### storage storage-metadata + +Start storage-metadata service + +Usage: `storage storage-metadata [command options] [arguments...]` + ### storage users Start users service diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index d470dac0a5c..99be5fc0aad 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-04-20T14:12:10+0000" +date: "2021-04-21T09:41:10+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates diff --git a/extensions/thumbnails/configuration.md b/extensions/thumbnails/configuration.md index 59c4f5e5ab8..db80a7a2eec 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-04-20T14:12:11+0000" +date: "2021-04-21T09:41:10+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates @@ -35,6 +35,33 @@ 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 version + +Print the versions of the running instances + +Usage: `thumbnails version [command options] [arguments...]` + +-grpc-name | $THUMBNAILS_GRPC_NAME +: Name of the service. Default: `flags.OverrideDefaultString(cfg.Server.Name, "thumbnails")`. + +-grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.Server.Namespace, "com.owncloud.api")`. + +### thumbnails health + +Check health status + +Usage: `thumbnails health [command options] [arguments...]` + +-debug-addr | $THUMBNAILS_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9189")`. + +### thumbnails ocis-thumbnails + +Example usage + +Usage: `thumbnails ocis-thumbnails [command options] [arguments...]` + ### thumbnails server Start integrated server @@ -101,30 +128,3 @@ Usage: `thumbnails server [command options] [arguments...]` -webdavsource-insecure | $THUMBNAILS_WEBDAVSOURCE_INSECURE : Whether to skip certificate checks. Default: `flags.OverrideDefaultBool(cfg.Thumbnail.WebDavSource.Insecure, true)`. -### thumbnails version - -Print the versions of the running instances - -Usage: `thumbnails version [command options] [arguments...]` - --grpc-name | $THUMBNAILS_GRPC_NAME -: Name of the service. Default: `flags.OverrideDefaultString(cfg.Server.Name, "thumbnails")`. - --grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.Server.Namespace, "com.owncloud.api")`. - -### thumbnails health - -Check health status - -Usage: `thumbnails health [command options] [arguments...]` - --debug-addr | $THUMBNAILS_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9189")`. - -### thumbnails ocis-thumbnails - -Example usage - -Usage: `thumbnails ocis-thumbnails [command options] [arguments...]` - diff --git a/extensions/web/configuration.md b/extensions/web/configuration.md index 8a2ebd86543..f28dde5b69a 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-04-20T14:12:11+0000" +date: "2021-04-21T09:41:10+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/web/templates @@ -43,12 +43,6 @@ Usage: `web [global options] command [command options] [arguments...]` ## Sub Commands -### web server - -Start integrated server - -Usage: `web server [command options] [arguments...]` - ### web health Check health status @@ -58,3 +52,9 @@ Usage: `web health [command options] [arguments...]` -debug-addr | $WEB_DEBUG_ADDR : Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9104")`. +### web server + +Start integrated server + +Usage: `web server [command options] [arguments...]` + diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index 5aa5725748c..764e8e1b4a8 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-04-20T14:12:11+0000" +date: "2021-04-21T09:41:11+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates @@ -43,6 +43,18 @@ Usage: `webdav [global options] command [command options] [arguments...]` ## Sub Commands +### webdav version + +Print the versions of the running instances + +Usage: `webdav version [command options] [arguments...]` + +-http-namespace | $WEBDAV_HTTP_NAMESPACE +: Set the base namespace for service discovery. Default: `flags.OverrideDefaultString(cfg.Service.Namespace, "com.owncloud.web")`. + +-service-name | $WEBDAV_SERVICE_NAME +: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "webdav")`. + ### webdav health Check health status @@ -112,15 +124,3 @@ Usage: `webdav server [command options] [arguments...]` -http-root | $WEBDAV_HTTP_ROOT : Root path of http server. Default: `flags.OverrideDefaultString(cfg.HTTP.Root, "/")`. -### webdav version - -Print the versions of the running instances - -Usage: `webdav version [command options] [arguments...]` - --http-namespace | $WEBDAV_HTTP_NAMESPACE -: Set the base namespace for service discovery. Default: `flags.OverrideDefaultString(cfg.Service.Namespace, "com.owncloud.web")`. - --service-name | $WEBDAV_SERVICE_NAME -: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "webdav")`. - diff --git a/ocis/configuration.md b/ocis/configuration.md index de02316ac75..896166fef43 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-04-20T14:12:09+0000" +date: "2021-04-21T09:41:09+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -86,6 +86,12 @@ Usage: `ocis [global options] command [command options] [arguments...]` ## Sub Commands +### ocis run + +Runs an extension + +Usage: `ocis run [command options] [arguments...]` + ### ocis server Start fullstack server @@ -122,117 +128,111 @@ Usage: `ocis health [command options] [arguments...]` -debug-addr | $OCIS_DEBUG_ADDR : Address to debug endpoint. Default: `0.0.0.0:9010`. -### ocis list - -Lists running ocis extensions - -Usage: `ocis list [command options] [arguments...]` - ### ocis kill Kill an extension by name Usage: `ocis kill [command options] [arguments...]` -### ocis run +### ocis list -Runs an extension +Lists running ocis extensions -Usage: `ocis run [command options] [arguments...]` +Usage: `ocis list [command options] [arguments...]` ### 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 thumbnails - -Start thumbnails server - -#### ocis glauth +#### ocis storage-gateway -Start glauth server +Start storage gateway -#### ocis onlyoffice +#### ocis storage-groupprovider -Start onlyoffice server +Start storage groupprovider service -#### ocis storage-auth-basic +#### ocis thumbnails -Start storage auth-basic service +Start thumbnails server -#### ocis storage-auth-bearer +#### ocis onlyoffice -Start storage auth-bearer service +Start onlyoffice server -#### ocis storage-gateway +#### ocis settings -Start storage gateway +Start settings server -#### ocis storage-userprovider +#### ocis idp -Start storage userprovider service +Start idp server -#### ocis proxy +#### ocis web -Start proxy server +Start web server -#### ocis settings +#### ocis storage-metadata -Start settings server +Start storage and data service for metadata #### ocis version Lists running services with version +#### ocis proxy + +Start proxy server + #### ocis storage-users Start storage and data provider for /users mount -#### ocis webdav +#### ocis store -Start webdav server +Start a go-micro store -#### ocis storage-home +#### ocis storage-sharing -Start storage and data provider for /home mount +Start storage sharing service -#### ocis storage-public-link +#### ocis storage-userprovider -Start storage public link storage +Start storage userprovider service -#### ocis storage-sharing +#### ocis storage-frontend -Start storage sharing service +Start storage frontend -#### ocis idp +#### ocis accounts -Start idp server +Start accounts server -#### ocis ocs +#### ocis glauth -Start ocs server +Start glauth server -#### ocis storage-groupprovider +#### ocis ocs -Start storage groupprovider service +Start ocs server -#### ocis storage-metadata +#### ocis storage-public-link -Start storage and data service for metadata +Start storage public link storage -#### ocis accounts +#### ocis webdav -Start accounts server +Start webdav server -#### ocis storage-frontend +#### ocis storage-auth-bearer -Start storage frontend +Start storage auth-bearer service -#### ocis web +#### ocis storage-home -Start web server +Start storage and data provider for /home mount -#### ocis store +#### ocis storage-auth-basic -Start a go-micro store +Start storage auth-basic service