From 77d653bd8868ac26c24cc9fa9e79cc1b60ec0c87 Mon Sep 17 00:00:00 2001 From: Benedikt Kulmann Date: Wed, 23 Jun 2021 14:57:40 +0000 Subject: [PATCH] commit 216be05ffa7f60e615295b0607599a66b9d77ffa Merge: d3a7c3fc 8650a3c9 Author: Benedikt Kulmann Date: Wed Jun 23 16:52:52 2021 +0200 Merge pull request #2187 from owncloud/update-web-v3.3.0 [full-ci] Update web to v3.3.0 --- extensions/accounts/configuration.md | 86 ++++---- extensions/glauth/configuration.md | 2 +- extensions/graph-explorer/configuration.md | 2 +- extensions/graph/configuration.md | 56 ++--- extensions/idp/configuration.md | 20 +- extensions/ocs/configuration.md | 32 +-- extensions/onlyoffice/configuration.md | 20 +- extensions/proxy/configuration.md | 2 +- extensions/settings/configuration.md | 2 +- extensions/storage/configuration.md | 238 ++++++++++----------- extensions/store/configuration.md | 26 +-- extensions/thumbnails/configuration.md | 44 ++-- extensions/web/configuration.md | 14 +- extensions/webdav/configuration.md | 2 +- ocis/configuration.md | 116 +++++----- 15 files changed, 331 insertions(+), 331 deletions(-) diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 736e0a4b90e..238962e20bb 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T12:44:25+0000" +date: "2021-06-23T14:53:10+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -35,6 +35,12 @@ 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 @@ -59,44 +65,11 @@ Usage: `accounts list [command options] [arguments...]` -name | $ACCOUNTS_NAME : service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. -### 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 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 add +### accounts rebuildIndex -Create a new account +Rebuilds the service's index, i.e. deleting and then re-adding all existing documents -Usage: `accounts add [command options] [arguments...]` +Usage: `accounts rebuildIndex [command options] [arguments...]` ### accounts server @@ -167,11 +140,11 @@ 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 version +### accounts remove -Print the versions of the running instances +Removes an existing account -Usage: `accounts version [command options] [arguments...]` +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")`. @@ -179,9 +152,36 @@ Usage: `accounts version [command options] [arguments...]` -name | $ACCOUNTS_NAME : service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. -### accounts rebuildIndex +### accounts ocis-accounts -Rebuilds the service's index, i.e. deleting and then re-adding all existing documents +Provide accounts and groups for oCIS -Usage: `accounts rebuildIndex [command options] [arguments...]` +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 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: `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 6c2e5e5e554..5e08a10f881 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T12:46:25+0000" +date: "2021-06-23T14:53:53+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 1227a4f1e54..b07cf2b7e84 100644 --- a/extensions/graph-explorer/configuration.md +++ b/extensions/graph-explorer/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T12:46:25+0000" +date: "2021-06-23T14:53:53+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 0bce3334915..ffa7f2d589f 100644 --- a/extensions/graph/configuration.md +++ b/extensions/graph/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T12:46:25+0000" +date: "2021-06-23T14:53:53+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph/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. +### graph health + +Check health status + +Usage: `graph health [command options] [arguments...]` + +-debug-addr | $GRAPH_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9124")`. + +### graph ocis-graph + +Serve Graph API for oCIS + +Usage: `graph ocis-graph [command options] [arguments...]` + +-config-file | $GRAPH_CONFIG_FILE +: Path to config file. Default: `flags.OverrideDefaultString(cfg.File, "")`. + +-log-level | $GRAPH_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. + +-log-pretty | $GRAPH_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. + +-log-color | $GRAPH_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. + ### graph server Start integrated server @@ -110,30 +137,3 @@ Usage: `graph server [command options] [arguments...]` -reva-gateway-addr | $REVA_GATEWAY_ADDR : REVA Gateway Endpoint. Default: `flags.OverrideDefaultString(cfg.Reva.Address, "127.0.0.1:9142")`. -### graph health - -Check health status - -Usage: `graph health [command options] [arguments...]` - --debug-addr | $GRAPH_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9124")`. - -### graph ocis-graph - -Serve Graph API for oCIS - -Usage: `graph ocis-graph [command options] [arguments...]` - --config-file | $GRAPH_CONFIG_FILE -: Path to config file. Default: `flags.OverrideDefaultString(cfg.File, "")`. - --log-level | $GRAPH_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. - --log-pretty | $GRAPH_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. - --log-color | $GRAPH_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. - diff --git a/extensions/idp/configuration.md b/extensions/idp/configuration.md index dd34a2707f2..5651c75d504 100644 --- a/extensions/idp/configuration.md +++ b/extensions/idp/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T12:46:25+0000" +date: "2021-06-23T14:53:53+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/idp/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. +### idp health + +Check health status + +Usage: `idp health [command options] [arguments...]` + +-debug-addr | $IDP_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9134")`. + ### idp ocis-idp Serve IDP API for oCIS @@ -212,12 +221,3 @@ Usage: `idp version [command options] [arguments...]` -name | $IDP_NAME : Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "idp")`. -### idp health - -Check health status - -Usage: `idp health [command options] [arguments...]` - --debug-addr | $IDP_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9134")`. - diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index c3d2ccc84f3..4e6f1ebb470 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T12:46:25+0000" +date: "2021-06-23T14:53:53+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 @@ -122,18 +137,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 5a3514e381e..3b3a4c724a4 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T12:46:25+0000" +date: "2021-06-23T14:53:53+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/onlyoffice/templates @@ -59,15 +59,6 @@ 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: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9224")`. - ### onlyoffice server Start integrated server @@ -116,3 +107,12 @@ Usage: `onlyoffice server [command options] [arguments...]` -asset-path | $ONLYOFFICE_ASSET_PATH : Path to custom assets. Default: `flags.OverrideDefaultString(cfg.Asset.Path, "")`. +### onlyoffice health + +Check health status + +Usage: `onlyoffice health [command options] [arguments...]` + +-debug-addr | $ONLYOFFICE_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9224")`. + diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index bd0bdb53c95..f84ea1fe59a 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T12:46:25+0000" +date: "2021-06-23T14:53:53+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 c3edc188c3c..2bac4909e39 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T12:46:25+0000" +date: "2021-06-23T14:53:53+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 ccf170dd7f6..5bfbb12602a 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T12:46:26+0000" +date: "2021-06-23T14:53:54+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -55,30 +55,6 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### 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: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.DebugAddr, "0.0.0.0:9147")`. - --auth-driver | $STORAGE_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthProvider.Driver, "ldap")`. - --auth-json | $STORAGE_AUTH_JSON -: Path to users.json file. Default: `flags.OverrideDefaultString(cfg.Reva.AuthProvider.JSON, "")`. - --network | $STORAGE_AUTH_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.GRPCNetwork, "tcp")`. - --addr | $STORAGE_AUTH_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.GRPCAddr, "0.0.0.0:9146")`. - --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. - ### storage groups Start groups service @@ -154,6 +130,27 @@ 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-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: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.DebugAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.GRPCNetwork, "tcp")`. + +-addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.GRPCAddr, "0.0.0.0:9178")`. + +-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.MountPath, "/public")`. + +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. + ### storage gateway Start gateway @@ -244,47 +241,65 @@ 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 health +### storage sharing -Check health status +Start sharing service -Usage: `storage health [command options] [arguments...]` +Usage: `storage sharing [command options] [arguments...]` --debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9109")`. +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.DebugAddr, "0.0.0.0:9151")`. -### storage auth-bearer +-network | $STORAGE_SHARING_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.GRPCNetwork, "tcp")`. -Start authprovider for bearer auth +-addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.GRPCAddr, "0.0.0.0:9150")`. -Usage: `storage auth-bearer [command options] [arguments...]` +-user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.UserDriver, "json")`. --debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.DebugAddr, "0.0.0.0:9149")`. +-user-json-file | $STORAGE_SHARING_USER_JSON_FILE +: file used to persist shares for the UserShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.UserJSONFile, "/var/tmp/ocis/storage/shares.json")`. --oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL -: OIDC issuer. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.Issuer, "https://localhost:9200")`. +-public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.PublicDriver, "json")`. --oidc-insecure | $STORAGE_OIDC_INSECURE -: OIDC allow insecure communication. Default: `flags.OverrideDefaultBool(cfg.Reva.OIDC.Insecure, true)`. +-public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE +: file used to persist shares for the PublicShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.PublicJSONFile, "/var/tmp/ocis/storage/publicshares.json")`. --oidc-id-claim | $STORAGE_OIDC_ID_CLAIM -: OIDC id claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.IDClaim, "preferred_username")`. +-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)`. --oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM -: OIDC uid claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.UIDClaim, "")`. +### storage storage-metadata --oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM -: OIDC gid claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.GIDClaim, "")`. +Start storage-metadata service --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")`. +Usage: `storage storage-metadata [command options] [arguments...]` --addr | $STORAGE_AUTH_BEARER_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.GRPCAddr, "0.0.0.0:9148")`. +### storage users --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. +Start users service + +Usage: `storage users [command options] [arguments...]` + +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Users.DebugAddr, "0.0.0.0:9145")`. + +-network | $STORAGE_USERPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Users.GRPCNetwork, "tcp")`. + +-addr | $STORAGE_USERPROVIDER_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.GRPCAddr, "0.0.0.0:9144")`. + +-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. + +-driver | $STORAGE_USERPROVIDER_DRIVER +: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Driver, "ldap")`. + +-json-config | $STORAGE_USERPROVIDER_JSON +: Path to users.json file. Default: `flags.OverrideDefaultString(cfg.Reva.Users.JSON, "")`. ### storage frontend @@ -340,62 +355,38 @@ Usage: `storage frontend [command options] [arguments...]` -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 sharing - -Start sharing service - -Usage: `storage sharing [command options] [arguments...]` - --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.DebugAddr, "0.0.0.0:9151")`. - --network | $STORAGE_SHARING_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.GRPCNetwork, "tcp")`. - --addr | $STORAGE_SHARING_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.GRPCAddr, "0.0.0.0:9150")`. - --user-driver | $STORAGE_SHARING_USER_DRIVER -: driver to use for the UserShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.UserDriver, "json")`. - --user-json-file | $STORAGE_SHARING_USER_JSON_FILE -: file used to persist shares for the UserShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.UserJSONFile, "/var/tmp/ocis/storage/shares.json")`. - --public-driver | $STORAGE_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.PublicDriver, "json")`. - --public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE -: file used to persist shares for the PublicShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.PublicJSONFile, "/var/tmp/ocis/storage/publicshares.json")`. +### storage health --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)`. +Check health status -### storage storage-metadata +Usage: `storage health [command options] [arguments...]` -Start storage-metadata service +-debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9109")`. -Usage: `storage storage-metadata [command options] [arguments...]` +### storage auth-basic -### storage storage-public-link +Start authprovider for basic auth -Start storage-public-link service +Usage: `storage auth-basic [command options] [arguments...]` -Usage: `storage storage-public-link [command options] [arguments...]` +-debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.DebugAddr, "0.0.0.0:9147")`. --debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.DebugAddr, "0.0.0.0:9179")`. +-auth-driver | $STORAGE_AUTH_DRIVER +: auth driver: 'demo', 'json' or 'ldap'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthProvider.Driver, "ldap")`. --network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.GRPCNetwork, "tcp")`. +-auth-json | $STORAGE_AUTH_JSON +: Path to users.json file. Default: `flags.OverrideDefaultString(cfg.Reva.AuthProvider.JSON, "")`. --addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.GRPCAddr, "0.0.0.0:9178")`. +-network | $STORAGE_AUTH_BASIC_GRPC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.GRPCNetwork, "tcp")`. --mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.MountPath, "/public")`. +-addr | $STORAGE_AUTH_BASIC_GRPC_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.GRPCAddr, "0.0.0.0:9146")`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. ### storage storage-users @@ -445,6 +436,39 @@ Usage: `storage storage-users [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 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 storage Storage service for oCIS @@ -463,30 +487,6 @@ Usage: `storage storage [command options] [arguments...]` -log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR : Enable colored logging. -### storage users - -Start users service - -Usage: `storage users [command options] [arguments...]` - --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Users.DebugAddr, "0.0.0.0:9145")`. - --network | $STORAGE_USERPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Users.GRPCNetwork, "tcp")`. - --addr | $STORAGE_USERPROVIDER_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.GRPCAddr, "0.0.0.0:9144")`. - --endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. - --driver | $STORAGE_USERPROVIDER_DRIVER -: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Driver, "ldap")`. - --json-config | $STORAGE_USERPROVIDER_JSON -: Path to users.json file. Default: `flags.OverrideDefaultString(cfg.Reva.Users.JSON, "")`. - ## 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 16f4ca944db..4dc822fbf62 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T12:46:26+0000" +date: "2021-06-23T14:53:54+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates @@ -35,6 +35,18 @@ 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 version + +Print the versions of the running instances + +Usage: `store version [command options] [arguments...]` + +-grpc-namespace | $STORE_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.Service.Namespace, "com.owncloud.api")`. + +-name | $STORE_NAME +: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "store")`. + ### store health Check health status @@ -107,15 +119,3 @@ Usage: `store server [command options] [arguments...]` -data-path | $STORE_DATA_PATH : location of the store data path. Default: `flags.OverrideDefaultString(cfg.Datapath, "/var/tmp/ocis/store")`. -### store version - -Print the versions of the running instances - -Usage: `store version [command options] [arguments...]` - --grpc-namespace | $STORE_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.Service.Namespace, "com.owncloud.api")`. - --name | $STORE_NAME -: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "store")`. - diff --git a/extensions/thumbnails/configuration.md b/extensions/thumbnails/configuration.md index a541ee369b4..edb6bfb0560 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T12:46:26+0000" +date: "2021-06-23T14:53:54+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates @@ -35,27 +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. -### 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 @@ -128,3 +107,24 @@ Usage: `thumbnails server [command options] [arguments...]` -webdavsource-insecure | $THUMBNAILS_WEBDAVSOURCE_INSECURE : Whether to skip certificate checks. Default: `flags.OverrideDefaultBool(cfg.Thumbnail.WebdavAllowInsecure, 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")`. + diff --git a/extensions/web/configuration.md b/extensions/web/configuration.md index 9e2cb879f74..ccd55fd70a4 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T12:46:26+0000" +date: "2021-06-23T14:53:55+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/web/templates @@ -43,6 +43,12 @@ 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 @@ -52,9 +58,3 @@ 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 987c8cb230c..75ddedd3afe 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T12:46:26+0000" +date: "2021-06-23T14:53:55+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 9c4de53349b..0d82812a79e 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T12:46:25+0000" +date: "2021-06-23T14:53:53+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -86,6 +86,18 @@ Usage: `ocis [global options] command [command options] [arguments...]` ## Sub Commands +### ocis kill + +Kill an extension by name + +Usage: `ocis kill [command options] [arguments...]` + +### ocis run + +Runs an extension + +Usage: `ocis run [command options] [arguments...]` + ### ocis server Start fullstack server @@ -113,12 +125,6 @@ Usage: `ocis server [command options] [arguments...]` -grpc-addr | $OCIS_GRPC_ADDR : Address to bind grpc server. Default: `0.0.0.0:9001`. -### ocis list - -Lists running ocis extensions - -Usage: `ocis list [command options] [arguments...]` - ### ocis health Check health status @@ -128,89 +134,67 @@ Usage: `ocis health [command options] [arguments...]` -debug-addr | $OCIS_DEBUG_ADDR : Address to debug endpoint. Default: `0.0.0.0:9010`. -### ocis run - -Runs an extension - -Usage: `ocis run [command options] [arguments...]` - -### ocis kill +### ocis list -Kill an extension by name +Lists running ocis extensions -Usage: `ocis kill [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 idp - -Start idp server - -#### ocis onlyoffice - -Start onlyoffice server - -#### ocis storage-public-link - -Start storage public link storage - -#### ocis storage-users - -Start storage and data provider for /users mount - -#### ocis storage-gateway +#### ocis ocs -Start storage gateway +Start ocs server #### ocis storage-auth-bearer Start storage auth-bearer service -#### ocis accounts +#### ocis storage-groupprovider -Start accounts server +Start storage groupprovider service -#### ocis storage-auth-basic +#### ocis storage-metadata -Start storage auth-basic service +Start storage and data service for metadata #### ocis web Start web server -#### ocis webdav - -Start webdav server - -#### ocis glauth - -Start glauth server - -#### ocis ocs - -Start ocs server - #### ocis thumbnails Start thumbnails server -#### ocis storage-userprovider +#### ocis storage-public-link -Start storage userprovider service +Start storage public link storage #### ocis version Lists running services with version +#### ocis glauth + +Start glauth server + #### ocis settings Start settings server -#### ocis storage-groupprovider +#### ocis storage-userprovider -Start storage groupprovider service +Start storage userprovider service + +#### ocis storage-users + +Start storage and data provider for /users mount + +#### ocis storage-auth-basic + +Start storage auth-basic service #### ocis storage-sharing @@ -220,19 +204,35 @@ Start storage sharing service Start a go-micro store +#### ocis accounts + +Start accounts server + #### ocis proxy Start proxy server -#### ocis storage-frontend +#### ocis storage-gateway -Start storage frontend +Start storage gateway #### ocis storage-home Start storage and data provider for /home mount -#### ocis storage-metadata +#### ocis webdav -Start storage and data service for metadata +Start webdav server + +#### ocis idp + +Start idp server + +#### ocis onlyoffice + +Start onlyoffice server + +#### ocis storage-frontend + +Start storage frontend