From 850eee0acc67edb9c3e5152a4b0b45873695475e Mon Sep 17 00:00:00 2001 From: Willy Kloucek <34452982+wkloucek@users.noreply.github.com> Date: Wed, 13 Oct 2021 11:33:38 +0000 Subject: [PATCH] commit 5703a18f17d0aabec6b58de23929a36aedeb57b1 Merge: 719e1cfb e303f5fa Author: Willy Kloucek <34452982+wkloucek@users.noreply.github.com> Date: Wed Oct 13 13:31:55 2021 +0200 Merge pull request #2585 from owncloud/1.13_release_notes [docs-only] 1.13.0 Release Notes --- extensions/accounts/configuration.md | 314 ++++---- extensions/glauth/configuration.md | 2 +- extensions/graph-explorer/configuration.md | 62 +- extensions/graph/configuration.md | 2 +- extensions/idp/configuration.md | 270 +++---- extensions/ocs/configuration.md | 2 +- extensions/proxy/configuration.md | 2 +- extensions/settings/configuration.md | 2 +- extensions/storage/configuration.md | 878 ++++++++++----------- extensions/store/configuration.md | 2 +- extensions/thumbnails/configuration.md | 66 +- extensions/web/configuration.md | 84 +- extensions/webdav/configuration.md | 2 +- ocis/configuration.md | 152 ++-- ocis/release_notes.md | 19 + 15 files changed, 939 insertions(+), 920 deletions(-) diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 7f5130fd2ef..2f26b92eeec 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-13T08:59:44+0000" +date: "2021-10-13T11:32:14+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -35,148 +35,93 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### accounts server +### accounts version -Start ocis accounts service +Print the versions of the running instances -Usage: `accounts server [command options] [arguments...]` +Usage: `accounts version [command options] [arguments...]` --log-file | $ACCOUNTS_LOG_FILE , $OCIS_LOG_FILE -: Enable log to file. --tracing-enabled | $ACCOUNTS_TRACING_ENABLED , $OCIS_TRACING_ENABLED -: Enable sending traces. --tracing-type | $ACCOUNTS_TRACING_TYPE , $OCIS_TRACING_TYPE -: Tracing backend type. Default: `"jaeger"`. --tracing-endpoint | $ACCOUNTS_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. --tracing-collector | $ACCOUNTS_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `""`. --tracing-service | $ACCOUNTS_TRACING_SERVICE -: Service name for tracing. Default: `"accounts"`. --http-namespace | $ACCOUNTS_HTTP_NAMESPACE -: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. --http-addr | $ACCOUNTS_HTTP_ADDR -: Address to bind http server. Default: `"0.0.0.0:9181"`. --http-root | $ACCOUNTS_HTTP_ROOT -: Root path of http server. Default: `"/"`. --http-cache-ttl | $ACCOUNTS_CACHE_TTL -: Set the static assets caching duration in seconds. Default: `604800`. --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --grpc-addr | $ACCOUNTS_GRPC_ADDR -: Address to bind grpc server. Default: `"0.0.0.0:9180"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. --accounts-hash-difficulty | $ACCOUNTS_HASH_DIFFICULTY -: accounts password hash difficulty. Default: `11`. --demo-users-and-groups | $ACCOUNTS_DEMO_USERS_AND_GROUPS -: Enable demo users and groups. Default: `true`. --asset-path | $ACCOUNTS_ASSET_PATH -: Path to custom assets. Default: `""`. --jwt-secret | $ACCOUNTS_JWT_SECRET , $OCIS_JWT_SECRET -: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. --storage-disk-path | $ACCOUNTS_STORAGE_DISK_PATH -: Path on the local disk, e.g. /var/tmp/ocis/accounts. Default: `""`. --storage-cs3-provider-addr | $ACCOUNTS_STORAGE_CS3_PROVIDER_ADDR -: bind address for the metadata storage provider. Default: `"localhost:9215"`. --storage-cs3-data-url | $ACCOUNTS_STORAGE_CS3_DATA_URL -: http endpoint of the metadata storage. Default: `"http://localhost:9216"`. --storage-cs3-data-prefix | $ACCOUNTS_STORAGE_CS3_DATA_PREFIX -: path prefix for the http endpoint of the metadata storage, without leading slash. Default: `"data"`. --storage-cs3-jwt-secret | $ACCOUNTS_STORAGE_CS3_JWT_SECRET , $OCIS_JWT_SECRET -: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. --service-user-uuid | $ACCOUNTS_SERVICE_USER_UUID -: uuid of the internal service user (required on EOS). Default: `"95cb8724-03b2-11eb-a0a6-c33ef8ef53ad"`. --service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME -: username of the internal service user (required on EOS). Default: `""`. --service-user-uid | $ACCOUNTS_SERVICE_USER_UID -: uid of the internal service user (required on EOS). Default: `0`. --service-user-gid | $ACCOUNTS_SERVICE_USER_GID -: gid of the internal service user (required on EOS). Default: `0`. --uid-index-lower-bound | $ACCOUNTS_UID_INDEX_LOWER_BOUND -: define a starting point for the account UID. Default: `0`. --gid-index-lower-bound | $ACCOUNTS_GID_INDEX_LOWER_BOUND -: define a starting point for the account GID. Default: `1000`. --uid-index-upper-bound | $ACCOUNTS_UID_INDEX_UPPER_BOUND -: define an ending point for the account UID. Default: `0`. --gid-index-upper-bound | $ACCOUNTS_GID_INDEX_UPPER_BOUND -: define an ending point for the account GID. Default: `1000`. --extensions | -: Run specific extensions during supervised mode. +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +### accounts inspect +Show detailed data on an existing account +Usage: `accounts inspect [command options] [arguments...]` @@ -204,11 +149,8 @@ Usage: `accounts server [command options] [arguments...]` -### accounts add -Create a new account -Usage: `accounts add [command options] [arguments...]` @@ -250,74 +192,51 @@ Usage: `accounts add [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 list +List existing accounts +Usage: `accounts list [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"`. --enabled | -: Enable the account. --displayname | -: Set the displayname for the account. --username | -: Username will be written to preferred-name and on_premises_sam_account_name. --preferred-name | -: Set the preferred-name for the account. --on-premises-sam-account-name | -: Set the on-premises-sam-account-name. --uidnumber | -: Set the uidnumber for the account. --gidnumber | -: Set the gidnumber for the account. --mail | -: Set the mail for the account. --description | -: Set the description for the account. --password | -: Set the password for the account. --password-policies | -: Possible policies: DisableStrongPassword, DisablePasswordExpiration. --force-password-change | -: Force password change on next sign-in. --force-password-change-mfa | -: Force password change on next sign-in with mfa. @@ -325,11 +244,8 @@ Usage: `accounts add [command options] [arguments...]` -### accounts inspect -Show detailed data on an existing account -Usage: `accounts inspect [command options] [arguments...]` @@ -354,15 +270,22 @@ Usage: `accounts inspect [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...]` @@ -400,18 +323,11 @@ Usage: `accounts inspect [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...]` @@ -441,6 +357,19 @@ Usage: `accounts rebuildIndex [command options] [arguments...]` +### accounts remove + +Removes an existing account + +Usage: `accounts remove [command options] [arguments...]` + + + + + + + + @@ -483,27 +412,16 @@ Usage: `accounts rebuildIndex [command options] [arguments...]` -### 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. --extensions | -: Run specific extensions during supervised mode. @@ -512,82 +430,148 @@ Usage: `accounts ocis-accounts [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 server +Start ocis accounts service +Usage: `accounts server [command options] [arguments...]` +-log-file | $ACCOUNTS_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. +-tracing-enabled | $ACCOUNTS_TRACING_ENABLED , $OCIS_TRACING_ENABLED +: Enable sending traces. +-tracing-type | $ACCOUNTS_TRACING_TYPE , $OCIS_TRACING_TYPE +: Tracing backend type. Default: `"jaeger"`. +-tracing-endpoint | $ACCOUNTS_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. +-tracing-collector | $ACCOUNTS_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR +: Endpoint for the collector. Default: `""`. +-tracing-service | $ACCOUNTS_TRACING_SERVICE +: Service name for tracing. Default: `"accounts"`. +-http-namespace | $ACCOUNTS_HTTP_NAMESPACE +: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. +-http-addr | $ACCOUNTS_HTTP_ADDR +: Address to bind http server. Default: `"0.0.0.0:9181"`. +-http-root | $ACCOUNTS_HTTP_ROOT +: Root path of http server. Default: `"/"`. +-http-cache-ttl | $ACCOUNTS_CACHE_TTL +: Set the static assets caching duration in seconds. Default: `604800`. +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-grpc-addr | $ACCOUNTS_GRPC_ADDR +: Address to bind grpc server. Default: `"0.0.0.0:9180"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +-accounts-hash-difficulty | $ACCOUNTS_HASH_DIFFICULTY +: accounts password hash difficulty. Default: `11`. +-demo-users-and-groups | $ACCOUNTS_DEMO_USERS_AND_GROUPS +: Enable demo users and groups. Default: `true`. +-asset-path | $ACCOUNTS_ASSET_PATH +: Path to custom assets. Default: `""`. +-jwt-secret | $ACCOUNTS_JWT_SECRET , $OCIS_JWT_SECRET +: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. +-storage-disk-path | $ACCOUNTS_STORAGE_DISK_PATH +: Path on the local disk, e.g. /var/tmp/ocis/accounts. Default: `""`. +-storage-cs3-provider-addr | $ACCOUNTS_STORAGE_CS3_PROVIDER_ADDR +: bind address for the metadata storage provider. Default: `"localhost:9215"`. +-storage-cs3-data-url | $ACCOUNTS_STORAGE_CS3_DATA_URL +: http endpoint of the metadata storage. Default: `"http://localhost:9216"`. +-storage-cs3-data-prefix | $ACCOUNTS_STORAGE_CS3_DATA_PREFIX +: path prefix for the http endpoint of the metadata storage, without leading slash. Default: `"data"`. +-storage-cs3-jwt-secret | $ACCOUNTS_STORAGE_CS3_JWT_SECRET , $OCIS_JWT_SECRET +: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. +-service-user-uuid | $ACCOUNTS_SERVICE_USER_UUID +: uuid of the internal service user (required on EOS). Default: `"95cb8724-03b2-11eb-a0a6-c33ef8ef53ad"`. -### accounts list +-service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME +: username of the internal service user (required on EOS). Default: `""`. -List existing accounts -Usage: `accounts list [command options] [arguments...]` +-service-user-uid | $ACCOUNTS_SERVICE_USER_UID +: uid of the internal service user (required on EOS). Default: `0`. +-service-user-gid | $ACCOUNTS_SERVICE_USER_GID +: gid of the internal service user (required on EOS). Default: `0`. +-uid-index-lower-bound | $ACCOUNTS_UID_INDEX_LOWER_BOUND +: define a starting point for the account UID. Default: `0`. +-gid-index-lower-bound | $ACCOUNTS_GID_INDEX_LOWER_BOUND +: define a starting point for the account GID. Default: `1000`. +-uid-index-upper-bound | $ACCOUNTS_UID_INDEX_UPPER_BOUND +: define an ending point for the account UID. Default: `0`. +-gid-index-upper-bound | $ACCOUNTS_GID_INDEX_UPPER_BOUND +: define an ending point for the account GID. Default: `1000`. +-extensions | +: Run specific extensions during supervised mode. @@ -624,8 +608,11 @@ Usage: `accounts list [command options] [arguments...]` +### accounts update +Make changes to an existing account +Usage: `accounts update [command options] [arguments...]` @@ -642,22 +629,15 @@ Usage: `accounts list [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 remove -Removes an existing account -Usage: `accounts remove [command options] [arguments...]` @@ -670,32 +650,60 @@ Usage: `accounts remove [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +-enabled | +: Enable the account. +-displayname | +: Set the displayname for the account. +-preferred-name | +: Set the preferred-name for the account. +-on-premises-sam-account-name | +: Set the on-premises-sam-account-name. +-uidnumber | +: Set the uidnumber for the account. +-gidnumber | +: Set the gidnumber for the account. +-mail | +: Set the mail for the account. +-description | +: Set the description for the account. +-password | +: Set the password for the account. +-password-policies | +: Possible policies: DisableStrongPassword, DisablePasswordExpiration. +-force-password-change | +: Force password change on next sign-in. +-force-password-change-mfa | +: Force password change on next sign-in with mfa. @@ -718,7 +726,11 @@ Usage: `accounts remove [command options] [arguments...]` +### accounts add +Create a new account + +Usage: `accounts add [command options] [arguments...]` @@ -726,20 +738,13 @@ Usage: `accounts remove [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. -### accounts update -Make changes to an existing account -Usage: `accounts update [command options] [arguments...]` @@ -793,6 +798,10 @@ Usage: `accounts update [command options] [arguments...]` : Set the displayname for the account. +-username | +: Username will be written to preferred-name and on_premises_sam_account_name. + + -preferred-name | : Set the preferred-name for the account. @@ -838,32 +847,27 @@ Usage: `accounts update [command options] [arguments...]` +### 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 version - -Print the versions of the running instances - -Usage: `accounts version [command options] [arguments...]` - - - - - - +-extensions | +: Run specific extensions during supervised mode. @@ -924,12 +928,8 @@ Usage: `accounts version [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index af05f42648a..6f2dd28e660 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-13T09:00:37+0000" +date: "2021-10-13T11:32:51+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 d91ba8ae1ef..ad0d3a98de3 100644 --- a/extensions/graph-explorer/configuration.md +++ b/extensions/graph-explorer/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-13T09:00:37+0000" +date: "2021-10-13T11:32:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph-explorer/templates @@ -73,36 +73,6 @@ Usage: `graph-explorer [global options] command [command options] [arguments...] ## Sub Commands -### graph-explorer health - -Check health status - -Usage: `graph-explorer health [command options] [arguments...]` - - - - - --debug-addr | $GRAPH_EXPLORER_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9136"`. - - - - - - - - - - - - - - - - - - ### graph-explorer server Start integrated server @@ -181,3 +151,33 @@ Usage: `graph-explorer server [command options] [arguments...]` -extensions | : Run specific extensions during supervised mode. This flag is set by the runtime. +### graph-explorer health + +Check health status + +Usage: `graph-explorer health [command options] [arguments...]` + + + + + +-debug-addr | $GRAPH_EXPLORER_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9136"`. + + + + + + + + + + + + + + + + + + diff --git a/extensions/graph/configuration.md b/extensions/graph/configuration.md index 035e7fe0488..4df60163710 100644 --- a/extensions/graph/configuration.md +++ b/extensions/graph/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-13T09:00:37+0000" +date: "2021-10-13T11:32:51+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 7de20145976..fadc995aef7 100644 --- a/extensions/idp/configuration.md +++ b/extensions/idp/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-13T09:00:37+0000" +date: "2021-10-13T11:32:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/idp/templates @@ -35,243 +35,141 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### idp server +### idp health -Start integrated server +Check health status -Usage: `idp server [command options] [arguments...]` +Usage: `idp health [command options] [arguments...]` +-debug-addr | $IDP_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9134"`. --log-file | $IDP_LOG_FILE , $OCIS_LOG_FILE -: Enable log to file. --config-file | $IDP_CONFIG_FILE -: Path to config file. Default: `""`. --tracing-enabled | $IDP_TRACING_ENABLED , $OCIS_TRACING_ENABLED -: Enable sending traces. --tracing-type | $IDP_TRACING_TYPE , $OCIS_TRACING_TYPE -: Tracing backend type. Default: `"jaeger"`. --tracing-endpoint | $IDP_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. --tracing-collector | $IDP_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `""`. --tracing-service | $IDP_TRACING_SERVICE -: Service name for tracing. Default: `"idp"`. --debug-addr | $IDP_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9134"`. --debug-token | $IDP_DEBUG_TOKEN -: Token to grant metrics access. Default: `""`. --debug-pprof | $IDP_DEBUG_PPROF -: Enable pprof debugging. --debug-zpages | $IDP_DEBUG_ZPAGES -: Enable zpages debugging. --http-addr | $IDP_HTTP_ADDR -: Address to bind http server. Default: `"0.0.0.0:9130"`. --http-root | $IDP_HTTP_ROOT -: Root path of http server. Default: `"/"`. --http-namespace | $IDP_HTTP_NAMESPACE -: Set the base namespace for service discovery. Default: `"com.owncloud.web"`. --name | $IDP_NAME -: Service name. Default: `"idp"`. --identity-manager | $IDP_IDENTITY_MANAGER -: Identity manager (one of ldap,kc,cookie,dummy). Default: `"ldap"`. --ldap-uri | $IDP_LDAP_URI -: URI of the LDAP server (glauth). Default: `"ldap://localhost:9125"`. --ldap-bind-dn | $IDP_LDAP_BIND_DN -: Bind DN for the LDAP server (glauth). Default: `"cn=idp,ou=sysusers,dc=ocis,dc=test"`. --ldap-bind-password | $IDP_LDAP_BIND_PASSWORD -: Password for the Bind DN of the LDAP server (glauth). Default: `"idp"`. --ldap-base-dn | $IDP_LDAP_BASE_DN -: LDAP base DN of the oCIS users. Default: `"ou=users,dc=ocis,dc=test"`. --ldap-scope | $IDP_LDAP_SCOPE -: LDAP scope of the oCIS users. Default: `"sub"`. --ldap-login-attribute | $IDP_LDAP_LOGIN_ATTRIBUTE -: LDAP login attribute of the oCIS users. Default: `"cn"`. --ldap-email-attribute | $IDP_LDAP_EMAIL_ATTRIBUTE -: LDAP email attribute of the oCIS users. Default: `"mail"`. --ldap-name-attribute | $IDP_LDAP_NAME_ATTRIBUTE -: LDAP name attribute of the oCIS users. Default: `"sn"`. --ldap-uuid-attribute | $IDP_LDAP_UUID_ATTRIBUTE -: LDAP UUID attribute of the oCIS users. Default: `"uid"`. --ldap-uuid-attribute-type | $IDP_LDAP_UUID_ATTRIBUTE_TYPE -: LDAP UUID attribute type of the oCIS users. Default: `"text"`. --ldap-filter | $IDP_LDAP_FILTER -: LDAP filter of the oCIS users. Default: `"(objectClass=posixaccount)"`. --transport-tls-cert | $IDP_TRANSPORT_TLS_CERT -: Certificate file for transport encryption. Default: `flags.OverrideDefaultString(cfg.HTTP.TLSCert, path.Join(pkgos.MustUserConfigDir("ocis", "idp"), "server.crt"))`. --transport-tls-key | $IDP_TRANSPORT_TLS_KEY -: Secret file for transport encryption. Default: `flags.OverrideDefaultString(cfg.HTTP.TLSKey, path.Join(pkgos.MustUserConfigDir("ocis", "idp"), "server.key"))`. +### idp ocis-idp --iss | $IDP_ISS , $OCIS_URL -: OIDC issuer URL. Default: `"https://localhost:9200"`. +Serve IDP API for oCIS +Usage: `idp ocis-idp [command options] [arguments...]` --signing-private-key | $IDP_SIGNING_PRIVATE_KEY -: Full path to PEM encoded private key file (must match the --signing-method algorithm). Default: `nil`. +-log-level | $IDP_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. --signing-kid | $IDP_SIGNING_KID -: Value of kid field to use in created tokens (uniquely identifying the signing-private-key). Default: `""`. +-log-pretty | $IDP_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. --validation-keys-path | $IDP_VALIDATION_KEYS_PATH -: Full path to a folder containing PEM encoded private or public key files used for token validation (file name without extension is used as kid). Default: `""`. +-log-color | $IDP_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. --encryption-secret | $IDP_ENCRYPTION_SECRET -: Full path to a file containing a %d bytes secret key. Default: `""`. --signing-method | $IDP_SIGNING_METHOD -: JWT default signing method. Default: `"PS256"`. --uri-base-path | $IDP_URI_BASE_PATH -: Custom base path for URI endpoints. Default: `""`. --sign-in-uri | $IDP_SIGN_IN_URI -: Custom redirection URI to sign-in form. Default: `""`. --signed-out-uri | $IDP_SIGN_OUT_URI -: Custom redirection URI to signed-out goodbye page. Default: `""`. --authorization-endpoint-uri | $IDP_ENDPOINT_URI -: Custom authorization endpoint URI. Default: `""`. --endsession-endpoint-uri | $IDP_ENDSESSION_ENDPOINT_URI -: Custom endsession endpoint URI. Default: `""`. --asset-path | $IDP_ASSET_PATH -: Path to custom assets. Default: `""`. --identifier-client-path | $IDP_IDENTIFIER_CLIENT_PATH -: Path to the identifier web client base folder. Default: `"/var/tmp/ocis/idp"`. --identifier-registration-conf | $IDP_IDENTIFIER_REGISTRATION_CONF -: Path to a identifier-registration.yaml configuration file. Default: `"./config/identifier-registration.yaml"`. --identifier-scopes-conf | $IDP_IDENTIFIER_SCOPES_CONF -: Path to a scopes.yaml configuration file. Default: `""`. --insecure | $IDP_INSECURE -: Disable TLS certificate and hostname validation. --tls | $IDP_TLS -: Use TLS (disable only if idp is behind a TLS-terminating reverse-proxy).. Default: `false`. --trusted-proxy | $IDP_TRUSTED_PROXY -: Trusted proxy IP or IP network (can be used multiple times). Default: `nil`. --allow-scope | $IDP_ALLOW_SCOPE -: Allow OAuth 2 scope (can be used multiple times, if not set default scopes are allowed). Default: `nil`. --allow-client-guests | $IDP_ALLOW_CLIENT_GUESTS -: Allow sign in of client controlled guest users. --allow-dynamic-client-registration | $IDP_ALLOW_DYNAMIC_CLIENT_REGISTRATION -: Allow dynamic OAuth2 client registration. Default: `false`. --disable-identifier-webapp | $IDP_DISABLE_IDENTIFIER_WEBAPP -: Disable built-in identifier-webapp to use a frontend hosted elsewhere.. Default: `true`. --access-token-expiration | $IDP_ACCESS_TOKEN_EXPIRATION -: Expiration time of access tokens in seconds since generated. Default: `60 * 10`. --id-token-expiration | $IDP_ID_TOKEN_EXPIRATION -: Expiration time of id tokens in seconds since generated. Default: `60 * 60`. --refresh-token-expiration | $IDP_REFRESH_TOKEN_EXPIRATION -: Expiration time of refresh tokens in seconds since generated. Default: `60 * 60 * 24 * 365 * 3`. --extensions | -: Run specific extensions during supervised mode. This flag is set by the runtime. -### idp version -Print the versions of the running instances -Usage: `idp version [command options] [arguments...]` @@ -283,150 +181,248 @@ Usage: `idp version [command options] [arguments...]` +### idp server +Start integrated server +Usage: `idp server [command options] [arguments...]` +-log-file | $IDP_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. +-config-file | $IDP_CONFIG_FILE +: Path to config file. Default: `""`. +-tracing-enabled | $IDP_TRACING_ENABLED , $OCIS_TRACING_ENABLED +: Enable sending traces. +-tracing-type | $IDP_TRACING_TYPE , $OCIS_TRACING_TYPE +: Tracing backend type. Default: `"jaeger"`. +-tracing-endpoint | $IDP_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. +-tracing-collector | $IDP_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR +: Endpoint for the collector. Default: `""`. +-tracing-service | $IDP_TRACING_SERVICE +: Service name for tracing. Default: `"idp"`. +-debug-addr | $IDP_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9134"`. +-debug-token | $IDP_DEBUG_TOKEN +: Token to grant metrics access. Default: `""`. +-debug-pprof | $IDP_DEBUG_PPROF +: Enable pprof debugging. +-debug-zpages | $IDP_DEBUG_ZPAGES +: Enable zpages debugging. +-http-addr | $IDP_HTTP_ADDR +: Address to bind http server. Default: `"0.0.0.0:9130"`. +-http-root | $IDP_HTTP_ROOT +: Root path of http server. Default: `"/"`. +-http-namespace | $IDP_HTTP_NAMESPACE +: Set the base namespace for service discovery. Default: `"com.owncloud.web"`. +-name | $IDP_NAME +: Service name. Default: `"idp"`. +-identity-manager | $IDP_IDENTITY_MANAGER +: Identity manager (one of ldap,kc,cookie,dummy). Default: `"ldap"`. +-ldap-uri | $IDP_LDAP_URI +: URI of the LDAP server (glauth). Default: `"ldap://localhost:9125"`. +-ldap-bind-dn | $IDP_LDAP_BIND_DN +: Bind DN for the LDAP server (glauth). Default: `"cn=idp,ou=sysusers,dc=ocis,dc=test"`. +-ldap-bind-password | $IDP_LDAP_BIND_PASSWORD +: Password for the Bind DN of the LDAP server (glauth). Default: `"idp"`. +-ldap-base-dn | $IDP_LDAP_BASE_DN +: LDAP base DN of the oCIS users. Default: `"ou=users,dc=ocis,dc=test"`. +-ldap-scope | $IDP_LDAP_SCOPE +: LDAP scope of the oCIS users. Default: `"sub"`. --http-namespace | $IDP_HTTP_NAMESPACE -: Set the base namespace for service discovery. Default: `"com.owncloud.web"`. +-ldap-login-attribute | $IDP_LDAP_LOGIN_ATTRIBUTE +: LDAP login attribute of the oCIS users. Default: `"cn"`. --name | $IDP_NAME -: Service name. Default: `"idp"`. +-ldap-email-attribute | $IDP_LDAP_EMAIL_ATTRIBUTE +: LDAP email attribute of the oCIS users. Default: `"mail"`. -### idp health -Check health status +-ldap-name-attribute | $IDP_LDAP_NAME_ATTRIBUTE +: LDAP name attribute of the oCIS users. Default: `"sn"`. -Usage: `idp health [command options] [arguments...]` +-ldap-uuid-attribute | $IDP_LDAP_UUID_ATTRIBUTE +: LDAP UUID attribute of the oCIS users. Default: `"uid"`. +-ldap-uuid-attribute-type | $IDP_LDAP_UUID_ATTRIBUTE_TYPE +: LDAP UUID attribute type of the oCIS users. Default: `"text"`. --debug-addr | $IDP_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9134"`. +-ldap-filter | $IDP_LDAP_FILTER +: LDAP filter of the oCIS users. Default: `"(objectClass=posixaccount)"`. +-transport-tls-cert | $IDP_TRANSPORT_TLS_CERT +: Certificate file for transport encryption. Default: `flags.OverrideDefaultString(cfg.HTTP.TLSCert, path.Join(pkgos.MustUserConfigDir("ocis", "idp"), "server.crt"))`. +-transport-tls-key | $IDP_TRANSPORT_TLS_KEY +: Secret file for transport encryption. Default: `flags.OverrideDefaultString(cfg.HTTP.TLSKey, path.Join(pkgos.MustUserConfigDir("ocis", "idp"), "server.key"))`. +-iss | $IDP_ISS , $OCIS_URL +: OIDC issuer URL. Default: `"https://localhost:9200"`. +-signing-private-key | $IDP_SIGNING_PRIVATE_KEY +: Full path to PEM encoded private key file (must match the --signing-method algorithm). Default: `nil`. +-signing-kid | $IDP_SIGNING_KID +: Value of kid field to use in created tokens (uniquely identifying the signing-private-key). Default: `""`. +-validation-keys-path | $IDP_VALIDATION_KEYS_PATH +: Full path to a folder containing PEM encoded private or public key files used for token validation (file name without extension is used as kid). Default: `""`. +-encryption-secret | $IDP_ENCRYPTION_SECRET +: Full path to a file containing a %d bytes secret key. Default: `""`. +-signing-method | $IDP_SIGNING_METHOD +: JWT default signing method. Default: `"PS256"`. +-uri-base-path | $IDP_URI_BASE_PATH +: Custom base path for URI endpoints. Default: `""`. +-sign-in-uri | $IDP_SIGN_IN_URI +: Custom redirection URI to sign-in form. Default: `""`. +-signed-out-uri | $IDP_SIGN_OUT_URI +: Custom redirection URI to signed-out goodbye page. Default: `""`. +-authorization-endpoint-uri | $IDP_ENDPOINT_URI +: Custom authorization endpoint URI. Default: `""`. +-endsession-endpoint-uri | $IDP_ENDSESSION_ENDPOINT_URI +: Custom endsession endpoint URI. Default: `""`. +-asset-path | $IDP_ASSET_PATH +: Path to custom assets. Default: `""`. +-identifier-client-path | $IDP_IDENTIFIER_CLIENT_PATH +: Path to the identifier web client base folder. Default: `"/var/tmp/ocis/idp"`. +-identifier-registration-conf | $IDP_IDENTIFIER_REGISTRATION_CONF +: Path to a identifier-registration.yaml configuration file. Default: `"./config/identifier-registration.yaml"`. +-identifier-scopes-conf | $IDP_IDENTIFIER_SCOPES_CONF +: Path to a scopes.yaml configuration file. Default: `""`. +-insecure | $IDP_INSECURE +: Disable TLS certificate and hostname validation. +-tls | $IDP_TLS +: Use TLS (disable only if idp is behind a TLS-terminating reverse-proxy).. Default: `false`. +-trusted-proxy | $IDP_TRUSTED_PROXY +: Trusted proxy IP or IP network (can be used multiple times). Default: `nil`. +-allow-scope | $IDP_ALLOW_SCOPE +: Allow OAuth 2 scope (can be used multiple times, if not set default scopes are allowed). Default: `nil`. +-allow-client-guests | $IDP_ALLOW_CLIENT_GUESTS +: Allow sign in of client controlled guest users. +-allow-dynamic-client-registration | $IDP_ALLOW_DYNAMIC_CLIENT_REGISTRATION +: Allow dynamic OAuth2 client registration. Default: `false`. +-disable-identifier-webapp | $IDP_DISABLE_IDENTIFIER_WEBAPP +: Disable built-in identifier-webapp to use a frontend hosted elsewhere.. Default: `true`. +-access-token-expiration | $IDP_ACCESS_TOKEN_EXPIRATION +: Expiration time of access tokens in seconds since generated. Default: `60 * 10`. +-id-token-expiration | $IDP_ID_TOKEN_EXPIRATION +: Expiration time of id tokens in seconds since generated. Default: `60 * 60`. +-refresh-token-expiration | $IDP_REFRESH_TOKEN_EXPIRATION +: Expiration time of refresh tokens in seconds since generated. Default: `60 * 60 * 24 * 365 * 3`. +-extensions | +: Run specific extensions during supervised mode. This flag is set by the runtime. -### idp ocis-idp -Serve IDP API for oCIS +### idp version -Usage: `idp ocis-idp [command options] [arguments...]` +Print the versions of the running instances +Usage: `idp version [command options] [arguments...]` --log-level | $IDP_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. --log-pretty | $IDP_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $IDP_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. @@ -483,6 +479,10 @@ Usage: `idp ocis-idp [command options] [arguments...]` +-http-namespace | $IDP_HTTP_NAMESPACE +: Set the base namespace for service discovery. Default: `"com.owncloud.web"`. +-name | $IDP_NAME +: Service name. Default: `"idp"`. diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index 1c4f6243355..37a863829c2 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-13T09:00:37+0000" +date: "2021-10-13T11:32:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/templates diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index 09d524575d5..fc238bc993b 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-13T09:00:37+0000" +date: "2021-10-13T11:32:51+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 b63de61639e..9f2753ba3d1 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-13T09:00:37+0000" +date: "2021-10-13T11:32:51+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 d1d07d2d6a7..f54d57b169d 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-13T09:00:37+0000" +date: "2021-10-13T11:32:52+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -88,12 +88,20 @@ Usage: `storage [global options] command [command options] [arguments...]` +-config-file | $STORAGE_CONFIG_FILE +: Path to config file. +-log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. @@ -114,20 +122,12 @@ Usage: `storage [global options] command [command options] [arguments...]` --config-file | $STORAGE_CONFIG_FILE -: Path to config file. --log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. --log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. @@ -296,11 +296,11 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage users +### storage storage-public-link -Start users service +Start storage-public-link service -Usage: `storage users [command options] [arguments...]` +Usage: `storage storage-public-link [command options] [arguments...]` @@ -449,14 +449,24 @@ Usage: `storage users [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"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -499,80 +509,42 @@ Usage: `storage users [command options] [arguments...]` --debug-addr | $STORAGE_USERPROVIDER_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9145"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --network | $STORAGE_USERPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_USERPROVIDER_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9144"`. --endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `"localhost:9144"`. --service | $STORAGE_USERPROVIDER_SERVICES -: --service userprovider [--service otherservice]. Default: `cli.NewStringSlice("userprovider")`. --driver | $STORAGE_USERPROVIDER_DRIVER -: user driver: 'demo', 'json', 'ldap', 'owncloudsql' or 'rest'. Default: `"ldap"`. --json-config | $STORAGE_USERPROVIDER_JSON -: Path to users.json file. Default: `""`. --user-groups-cache-expiration | $STORAGE_USER_CACHE_EXPIRATION -: Time in minutes for redis cache expiration.. Default: `5`. --owncloudsql-dbhost | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBHOST -: hostname of the mysql db. Default: `"mysql"`. --owncloudsql-dbport | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBPORT -: port of the mysql db. Default: `3306`. --owncloudsql-dbname | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBNAME -: database name of the owncloud db. Default: `"owncloud"`. --owncloudsql-dbuser | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBUSER -: user name to use when connecting to the mysql owncloud db. Default: `"owncloud"`. --owncloudsql-dbpass | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBPASS -: password to use when connecting to the mysql owncloud db. Default: `"secret"`. --owncloudsql-idp | $STORAGE_USERPROVIDER_OWNCLOUDSQL_IDP , $OCIS_URL -: Identity provider to use for users. Default: `"https://localhost:9200"`. --owncloudsql-nobody | $STORAGE_USERPROVIDER_OWNCLOUDSQL_NOBODY -: fallback user id to use when user has no id. Default: `99`. --owncloudsql-join-username | $STORAGE_USERPROVIDER_OWNCLOUDSQL_JOIN_USERNAME -: join the username from the oc_preferences table. Default: `false`. --owncloudsql-join-ownclouduuid | $STORAGE_USERPROVIDER_OWNCLOUDSQL_JOIN_OWNCLOUDUUID -: join the ownclouduuid from the oc_preferences table. Default: `false`. --owncloudsql-enable-medial-search | $STORAGE_USERPROVIDER_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH -: enable medial search when finding users. Default: `false`. @@ -586,8 +558,11 @@ Usage: `storage users [command options] [arguments...]` +### storage app-provider +Start appprovider for providing apps +Usage: `storage app-provider [command options] [arguments...]` @@ -600,11 +575,8 @@ Usage: `storage users [command options] [arguments...]` -### storage app-provider -Start appprovider for providing apps -Usage: `storage app-provider [command options] [arguments...]` @@ -658,36 +630,68 @@ Usage: `storage app-provider [command options] [arguments...]` +-debug-addr | $APP_PROVIDER_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9165"`. +-network | $APP_PROVIDER_BASIC_GRPC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $APP_PROVIDER_BASIC_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9164"`. +-external-addr | $APP_PROVIDER_BASIC_EXTERNAL_ADDR +: Address to connect to the storage service for other services. Default: `"127.0.0.1:9164"`. +-service | $APP_PROVIDER_BASIC_SERVICES +: --service appprovider [--service otherservice]. Default: `cli.NewStringSlice("appprovider")`. +-driver | $APP_PROVIDER_DRIVER +: Driver to use for app provider. Default: `""`. +-wopi-driver-app-apikey | $APP_PROVIDER_WOPI_DRIVER_APP_API_KEY +: The API key used by the app, if applicable.. Default: `""`. +-wopi-driver-app-desktop-only | $APP_PROVIDER_WOPI_DRIVER_APP_DESKTOP_ONLY +: Whether the app can be opened only on desktop. Default: `false`. +-wopi-driver-app-icon-uri | $APP_PROVIDER_WOPI_DRIVER_APP_ICON_URI +: IOP Secret (Shared with WOPI server). Default: `""`. +-wopi-driver-app-internal-url | $APP_PROVIDER_WOPI_DRIVER_APP_INTERNAL_URL +: The internal app URL in case of dockerized deployments. Defaults to AppURL. Default: `""`. +-wopi-driver-app-name | $APP_PROVIDER_WOPI_DRIVER_APP_NAME +: The App user-friendly name.. Default: `""`. +-wopi-driver-app-url | $APP_PROVIDER_WOPI_DRIVER_APP_URL +: App server URL. Default: `""`. +-wopi-driver-insecure | $APP_PROVIDER_WOPI_DRIVER_INSECURE +: Disable SSL certificate verification of WOPI server and WOPI bridge. Default: `false`. +-wopi-driver-iopsecret | $APP_PROVIDER_WOPI_DRIVER_IOP_SECRET +: IOP Secret (Shared with WOPI server). Default: `""`. +-wopi-driver-wopiurl | $APP_PROVIDER_WOPI_DRIVER_WOPI_URL +: WOPI server URL. Default: `""`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -750,68 +754,36 @@ Usage: `storage app-provider [command options] [arguments...]` --debug-addr | $APP_PROVIDER_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9165"`. --network | $APP_PROVIDER_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $APP_PROVIDER_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9164"`. --external-addr | $APP_PROVIDER_BASIC_EXTERNAL_ADDR -: Address to connect to the storage service for other services. Default: `"127.0.0.1:9164"`. --service | $APP_PROVIDER_BASIC_SERVICES -: --service appprovider [--service otherservice]. Default: `cli.NewStringSlice("appprovider")`. --driver | $APP_PROVIDER_DRIVER -: Driver to use for app provider. Default: `""`. --wopi-driver-app-apikey | $APP_PROVIDER_WOPI_DRIVER_APP_API_KEY -: The API key used by the app, if applicable.. Default: `""`. --wopi-driver-app-desktop-only | $APP_PROVIDER_WOPI_DRIVER_APP_DESKTOP_ONLY -: Whether the app can be opened only on desktop. Default: `false`. --wopi-driver-app-icon-uri | $APP_PROVIDER_WOPI_DRIVER_APP_ICON_URI -: IOP Secret (Shared with WOPI server). Default: `""`. --wopi-driver-app-internal-url | $APP_PROVIDER_WOPI_DRIVER_APP_INTERNAL_URL -: The internal app URL in case of dockerized deployments. Defaults to AppURL. Default: `""`. --wopi-driver-app-name | $APP_PROVIDER_WOPI_DRIVER_APP_NAME -: The App user-friendly name.. Default: `""`. --wopi-driver-app-url | $APP_PROVIDER_WOPI_DRIVER_APP_URL -: App server URL. Default: `""`. --wopi-driver-insecure | $APP_PROVIDER_WOPI_DRIVER_INSECURE -: Disable SSL certificate verification of WOPI server and WOPI bridge. Default: `false`. --wopi-driver-iopsecret | $APP_PROVIDER_WOPI_DRIVER_IOP_SECRET -: IOP Secret (Shared with WOPI server). Default: `""`. --wopi-driver-wopiurl | $APP_PROVIDER_WOPI_DRIVER_WOPI_URL -: WOPI server URL. Default: `""`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -881,8 +853,11 @@ Usage: `storage app-provider [command options] [arguments...]` +### storage auth-basic +Start authprovider for basic auth +Usage: `storage auth-basic [command options] [arguments...]` @@ -895,11 +870,8 @@ Usage: `storage app-provider [command options] [arguments...]` -### storage auth-bearer -Start authprovider for bearer auth -Usage: `storage auth-bearer [command options] [arguments...]` @@ -927,18 +899,32 @@ Usage: `storage auth-bearer [command options] [arguments...]` +-debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9147"`. +-auth-driver | $STORAGE_AUTH_DRIVER +: auth driver: 'demo', 'json' or 'ldap'. Default: `"ldap"`. +-auth-json | $STORAGE_AUTH_JSON +: Path to users.json file. Default: `""`. +-network | $STORAGE_AUTH_BASIC_GRPC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_AUTH_BASIC_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9146"`. +-service | $STORAGE_AUTH_BASIC_SERVICES +: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -1003,52 +989,28 @@ Usage: `storage auth-bearer [command options] [arguments...]` --debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9149"`. --auth-driver | $STORAGE_AUTH_BEARER_DRIVER -: bearer auth driver: 'oidc' or 'machine'. Default: `"oidc"`. --oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL -: OIDC issuer. Default: `"https://localhost:9200"`. --oidc-insecure | $STORAGE_OIDC_INSECURE -: OIDC allow insecure communication. Default: `true`. --oidc-id-claim | $STORAGE_OIDC_ID_CLAIM -: OIDC id claim. Default: `"preferred_username"`. --oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM -: OIDC uid claim. Default: `""`. --oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM -: OIDC gid claim. Default: `""`. --machine-auth-api-key | $STORAGE_AUTH_BEARER_MACHINE_AUTH_API_KEY , $OCIS_MACHINE_AUTH_API_KEY -: the API key to be used for the machine auth driver in reva. Default: `"change-me-please"`. --network | $STORAGE_AUTH_BEARER_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_AUTH_BEARER_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9148"`. --service | $STORAGE_AUTH_BEARER_SERVICES -: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -1159,8 +1121,11 @@ Usage: `storage auth-bearer [command options] [arguments...]` +### storage storage-home +Start storage-home service +Usage: `storage storage-home [command options] [arguments...]` @@ -1178,11 +1143,8 @@ Usage: `storage auth-bearer [command options] [arguments...]` -### storage frontend -Start frontend service -Usage: `storage frontend [command options] [arguments...]` @@ -1192,124 +1154,94 @@ Usage: `storage frontend [command options] [arguments...]` --debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9141"`. --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. --webdav-namespace | $STORAGE_WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `"/home/"`. --dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `"/users/"`. --archiver-max-num-files | $STORAGE_ARCHIVER_MAX_NUM_FILES -: Maximum number of files to be included in the archiver. Default: `10000`. --archiver-max-size | $STORAGE_ARCHIVER_MAX_SIZE -: Maximum size for the sum of the sizes of all the files included in the archive. Default: `1073741824`. --network | $STORAGE_FRONTEND_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_FRONTEND_HTTP_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9140"`. --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `"https://localhost:9200"`. --service | $STORAGE_FRONTEND_SERVICES -: --service ocdav [--service ocs]. Default: `cli.NewStringSlice("datagateway", "ocdav", "ocs", "appprovider")`. --approvider-prefix | $STORAGE_FRONTEND_APPPROVIDER_PREFIX -: approvider prefix. Default: `""`. --archiver-prefix | $STORAGE_FRONTEND_ARCHIVER_PREFIX -: archiver prefix. Default: `"archiver"`. --datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `"data"`. +-debug-addr | $STORAGE_HOME_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9156"`. --favorites | $STORAGE_FRONTEND_FAVORITES -: announces favorites support to clients. Default: `false`. +-grpc-network | $STORAGE_HOME_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. Default: `""`. +-grpc-addr | $STORAGE_HOME_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9154"`. --ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX -: open collaboration services endpoint prefix. Default: `"ocs"`. +-http-network | $STORAGE_HOME_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --ocs-share-prefix | $STORAGE_FRONTEND_OCS_SHARE_PREFIX -: the prefix prepended to the path of shared files. Default: `"/Shares"`. +-http-addr | $STORAGE_HOME_HTTP_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9155"`. --ocs-home-namespace | $STORAGE_FRONTEND_OCS_HOME_NAMESPACE -: the prefix prepended to the incoming requests in OCS. Default: `"/home"`. +-driver | $STORAGE_HOME_DRIVER +: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. --ocs-resource-info-cache-ttl | $STORAGE_FRONTEND_OCS_RESOURCE_INFO_CACHE_TTL -: the TTL for statted resources in the share cache. Default: `0`. +-read-only | $STORAGE_HOME_READ_ONLY , $OCIS_STORAGE_READ_ONLY +: use storage driver in read-only mode. Default: `false`. --ocs-cache-warmup-driver | $STORAGE_FRONTEND_OCS_CACHE_WARMUP_DRIVER -: the driver to be used for warming up the share cache. Default: `""`. +-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `"/home"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. --default-upload-protocol | $STORAGE_FRONTEND_DEFAULT_UPLOAD_PROTOCOL -: Default upload chunking protocol to be used out of tus/v1/ng. Default: `"tus"`. +-expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. --upload-max-chunk-size | $STORAGE_FRONTEND_UPLOAD_MAX_CHUNK_SIZE -: Max chunk size in bytes to advertise to clients through capabilities, or 0 for unlimited. Default: `0`. +-data-server-url | $STORAGE_HOME_DATA_SERVER_URL +: data server url. Default: `"http://localhost:9155/data"`. --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: `""`. +-http-prefix | $STORAGE_HOME_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `"data"`. --checksum-supported-type | $STORAGE_FRONTEND_CHECKSUM_SUPPORTED_TYPES -: --checksum-supported-type sha1 [--checksum-supported-type adler32]. Default: `cli.NewStringSlice("sha1", "md5", "adler32")`. +-tmp-folder | $STORAGE_HOME_TMP_FOLDER +: path to tmp folder. Default: `"/var/tmp/ocis/tmp/home"`. --checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE -: Specify the preferred checksum algorithm used for uploads. Default: `""`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --archiver-url | $STORAGE_FRONTEND_ARCHIVER_URL -: URL where the archiver is reachable. Default: `"/archiver"`. +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9144"`. --appprovider-apps-url | $STORAGE_FRONTEND_APP_PROVIDER_APPS_URL -: URL where the app listing of the app provider is reachable. Default: `"/app/list"`. --appprovider-open-url | $STORAGE_FRONTEND_APP_PROVIDER_OPEN_URL -: URL where files can be handed over to an application from the app provider. Default: `"/app/open"`. --user-agent-whitelist-lock-in | $STORAGE_FRONTEND_MIDDLEWARE_AUTH_CREDENTIALS_BY_USER_AGENT -: --user-agent-whitelist-lock-in=mirall:basic,foo:bearer Given a tuple of comma separated [UserAgent:challenge] values, it locks a given user agent to the authentication challenge. Particularly useful for old clients whose USer-Agent is known and only support one authentication challenge. When this flag is set in the storage-frontend it configures Reva.. @@ -1481,8 +1413,11 @@ Usage: `storage frontend [command options] [arguments...]` +### storage storage-metadata +Start storage-metadata service +Usage: `storage storage-metadata [command options] [arguments...]` @@ -1515,11 +1450,8 @@ Usage: `storage frontend [command options] [arguments...]` -### storage gateway -Start gateway -Usage: `storage gateway [command options] [arguments...]` @@ -1534,12 +1466,20 @@ Usage: `storage gateway [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. @@ -1559,163 +1499,113 @@ Usage: `storage gateway [command options] [arguments...]` --debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9143"`. --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. --transfer-expires | $STORAGE_TRANSFER_EXPIRES -: Transfer token ttl in seconds. Default: `24 * 60 * 60`. --network | $STORAGE_GATEWAY_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_GATEWAY_GRPC_ADDR -: Address to bind REVA service. Default: `"0.0.0.0:9142"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --service | $STORAGE_GATEWAY_SERVICES -: --service gateway [--service authregistry]. Default: `cli.NewStringSlice("gateway", "authregistry", "storageregistry", "appregistry")`. --commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT -: Commit shares to the share manager. Default: `true`. --commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF -: Commit shares to the storage. Default: `true`. --share-folder | $STORAGE_GATEWAY_SHARE_FOLDER -: mount shares in this folder of the home storage provider. Default: `"Shares"`. --disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN -: Disable creation of home folder on login. --storage-home-mapping | $STORAGE_GATEWAY_HOME_MAPPING -: mapping template for user home paths to user-specific mount points, e.g. /home/{{substr 0 1 .Username}}. Default: `""`. --etag-cache-ttl | $STORAGE_GATEWAY_ETAG_CACHE_TTL -: TTL for the home and shares directory etags cache. Default: `0`. --auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT -: endpoint to use for the basic auth provider. Default: `"localhost:9146"`. --auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT -: endpoint to use for the bearer auth provider. Default: `"localhost:9148"`. --storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER -: driver of the storage registry. Default: `"static"`. --storage-registry-rule | $STORAGE_STORAGE_REGISTRY_RULES -: `Replaces the generated storage registry rules with this set: --storage-registry-rule "/eos=localhost:9158" [--storage-registry-rule "1284d238-aa92-42ce-bdc4-0b0000009162=localhost:9162"]`. Default: `cli.NewStringSlice()`. --storage-home-provider | $STORAGE_STORAGE_REGISTRY_HOME_PROVIDER -: mount point of the storage provider for user homes in the global namespace. Default: `"/home"`. --storage-registry-json | $STORAGE_STORAGE_REGISTRY_JSON -: JSON file containing the storage registry rules. Default: `""`. --app-registry-driver | $STORAGE_APP_REGISTRY_DRIVER -: driver of the app registry. Default: `"static"`. --app-registry-mimetypes-json | $STORAGE_APP_REGISTRY_MIMETYPES_JSON -: JSON file containing the storage registry rules. Default: `""`. --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `"https://localhost:9200"`. --datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL -: URL to use for the storage datagateway, defaults to /data. Default: `""`. --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider. Default: `"localhost:9144"`. --groupprovider-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: endpoint to use for the groupprovider. Default: `"localhost:9160"`. --sharing-endpoint | $STORAGE_SHARING_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9150"`. --appprovider-endpoint | $STORAGE_APPPROVIDER_ENDPOINT -: endpoint to use for the app provider. Default: `"localhost:9164"`. --storage-home-endpoint | $STORAGE_HOME_ENDPOINT -: endpoint to use for the home storage. Default: `"localhost:9154"`. --storage-home-mount-path | $STORAGE_HOME_MOUNT_PATH -: mount path. Default: `"/home"`. --storage-home-mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009154"`. --storage-users-endpoint | $STORAGE_USERS_ENDPOINT -: endpoint to use for the users storage. Default: `"localhost:9157"`. --storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH -: mount path. Default: `"/users"`. --storage-users-mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. --public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT -: endpoint to use for the public links service. Default: `"localhost:9178"`. --storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `"/public"`. +-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"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider service. Default: `"localhost:9144"`. @@ -1812,8 +1702,11 @@ Usage: `storage gateway [command options] [arguments...]` +### storage storage-users +Start storage-users service +Usage: `storage storage-users [command options] [arguments...]` @@ -1867,11 +1760,8 @@ Usage: `storage gateway [command options] [arguments...]` -### storage health -Check health status -Usage: `storage health [command options] [arguments...]` @@ -2005,34 +1895,64 @@ Usage: `storage health [command options] [arguments...]` +-debug-addr | $STORAGE_USERS_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9159"`. +-grpc-network | $STORAGE_USERS_GRPC_NETWORK +: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-grpc-addr | $STORAGE_USERS_GRPC_ADDR +: GRPC Address to bind users storage. Default: `"0.0.0.0:9157"`. +-http-network | $STORAGE_USERS_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-http-addr | $STORAGE_USERS_HTTP_ADDR +: HTTP Address to bind users storage. Default: `"0.0.0.0:9158"`. +-driver | $STORAGE_USERS_DRIVER +: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. +-read-only | $STORAGE_USERS_READ_ONLY , $OCIS_STORAGE_READ_ONLY +: use storage driver in read-only mode. Default: `false`. +-mount-path | $STORAGE_USERS_MOUNT_PATH +: mount path. Default: `"/users"`. +-mount-id | $STORAGE_USERS_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. +-expose-data-server | $STORAGE_USERS_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. +-data-server-url | $STORAGE_USERS_DATA_SERVER_URL +: data server url. Default: `"http://localhost:9158/data"`. +-http-prefix | $STORAGE_USERS_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `"data"`. +-tmp-folder | $STORAGE_USERS_TMP_FOLDER +: path to tmp folder. Default: `"/var/tmp/ocis/tmp/users"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9144"`. @@ -2074,8 +1994,11 @@ Usage: `storage health [command options] [arguments...]` +### storage groups +Start groups service +Usage: `storage groups [command options] [arguments...]` @@ -2092,8 +2015,6 @@ Usage: `storage health [command options] [arguments...]` --debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9109"`. @@ -2117,11 +2038,8 @@ Usage: `storage health [command options] [arguments...]` -### storage sharing -Start sharing service -Usage: `storage sharing [command options] [arguments...]` @@ -2164,22 +2082,40 @@ Usage: `storage sharing [command options] [arguments...]` +-debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9161"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-network | $STORAGE_GROUPPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_GROUPPROVIDER_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9160"`. +-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `"localhost:9160"`. +-service | $STORAGE_GROUPPROVIDER_SERVICES +: --service groupprovider [--service otherservice]. Default: `cli.NewStringSlice("groupprovider")`. +-driver | $STORAGE_GROUPPROVIDER_DRIVER +: group driver: 'json', 'ldap', or 'rest'. Default: `"ldap"`. +-json-config | $STORAGE_GROUPPROVIDER_JSON +: Path to groups.json file. Default: `""`. +-group-members-cache-expiration | $STORAGE_GROUP_CACHE_EXPIRATION +: Time in minutes for redis cache expiration.. Default: `5`. @@ -2332,8 +2268,11 @@ Usage: `storage sharing [command options] [arguments...]` +### storage health +Check health status +Usage: `storage health [command options] [arguments...]` @@ -2353,58 +2292,31 @@ Usage: `storage sharing [command options] [arguments...]` --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9151"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --network | $STORAGE_SHARING_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_SHARING_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9150"`. --service | $STORAGE_SHARING_SERVICES -: --service usershareprovider [--service publicshareprovider]. Default: `cli.NewStringSlice("usershareprovider", "publicshareprovider")`. --user-driver | $STORAGE_SHARING_USER_DRIVER -: driver to use for the UserShareProvider. Default: `"json"`. --user-json-file | $STORAGE_SHARING_USER_JSON_FILE -: file used to persist shares for the UserShareProvider. Default: `"/var/tmp/ocis/storage/shares.json"`. --public-driver | $STORAGE_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `"json"`. --public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE -: file used to persist shares for the PublicShareProvider. Default: `"/var/tmp/ocis/storage/publicshares.json"`. --public-password-hash-cost | $STORAGE_SHARING_PUBLIC_PASSWORD_HASH_COST -: the cost of hashing the public shares passwords. Default: `11`. --public-enable-expired-shares-cleanup | $STORAGE_SHARING_PUBLIC_ENABLE_EXPIRED_SHARES_CLEANUP -: whether to periodically delete expired public shares. Default: `true`. --public-janitor-run-interval | $STORAGE_SHARING_PUBLIC_JANITOR_RUN_INTERVAL -: the time period in seconds after which to start a janitor run. Default: `60`. -### storage storage-home -Start storage-home service -Usage: `storage storage-home [command options] [arguments...]` @@ -2453,6 +2365,8 @@ Usage: `storage storage-home [command options] [arguments...]` +-debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9109"`. @@ -2483,64 +2397,34 @@ Usage: `storage storage-home [command options] [arguments...]` --debug-addr | $STORAGE_HOME_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9156"`. --grpc-network | $STORAGE_HOME_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --grpc-addr | $STORAGE_HOME_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9154"`. --http-network | $STORAGE_HOME_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --http-addr | $STORAGE_HOME_HTTP_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9155"`. --driver | $STORAGE_HOME_DRIVER -: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. --read-only | $STORAGE_HOME_READ_ONLY , $OCIS_STORAGE_READ_ONLY -: use storage driver in read-only mode. Default: `false`. --mount-path | $STORAGE_HOME_MOUNT_PATH -: mount path. Default: `"/home"`. --mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. --expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. --data-server-url | $STORAGE_HOME_DATA_SERVER_URL -: data server url. Default: `"http://localhost:9155/data"`. --http-prefix | $STORAGE_HOME_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `"data"`. --tmp-folder | $STORAGE_HOME_TMP_FOLDER -: path to tmp folder. Default: `"/var/tmp/ocis/tmp/home"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9144"`. @@ -2634,8 +2518,11 @@ Usage: `storage storage-home [command options] [arguments...]` +### storage gateway +Start gateway +Usage: `storage gateway [command options] [arguments...]` @@ -2692,11 +2579,8 @@ Usage: `storage storage-home [command options] [arguments...]` -### storage storage-users -Start storage-users service -Usage: `storage storage-users [command options] [arguments...]` @@ -2792,104 +2676,144 @@ Usage: `storage storage-users [command options] [arguments...]` +-debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9143"`. +-transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. +-transfer-expires | $STORAGE_TRANSFER_EXPIRES +: Transfer token ttl in seconds. Default: `24 * 60 * 60`. +-network | $STORAGE_GATEWAY_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_GATEWAY_GRPC_ADDR +: Address to bind REVA service. Default: `"0.0.0.0:9142"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-service | $STORAGE_GATEWAY_SERVICES +: --service gateway [--service authregistry]. Default: `cli.NewStringSlice("gateway", "authregistry", "storageregistry", "appregistry")`. +-commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT +: Commit shares to the share manager. Default: `true`. +-commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF +: Commit shares to the storage. Default: `true`. +-share-folder | $STORAGE_GATEWAY_SHARE_FOLDER +: mount shares in this folder of the home storage provider. Default: `"Shares"`. +-disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN +: Disable creation of home folder on login. +-storage-home-mapping | $STORAGE_GATEWAY_HOME_MAPPING +: mapping template for user home paths to user-specific mount points, e.g. /home/{{substr 0 1 .Username}}. Default: `""`. +-etag-cache-ttl | $STORAGE_GATEWAY_ETAG_CACHE_TTL +: TTL for the home and shares directory etags cache. Default: `0`. +-auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT +: endpoint to use for the basic auth provider. Default: `"localhost:9146"`. +-auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT +: endpoint to use for the bearer auth provider. Default: `"localhost:9148"`. --debug-addr | $STORAGE_USERS_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9159"`. +-storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER +: driver of the storage registry. Default: `"static"`. --grpc-network | $STORAGE_USERS_GRPC_NETWORK -: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-storage-registry-rule | $STORAGE_STORAGE_REGISTRY_RULES +: `Replaces the generated storage registry rules with this set: --storage-registry-rule "/eos=localhost:9158" [--storage-registry-rule "1284d238-aa92-42ce-bdc4-0b0000009162=localhost:9162"]`. Default: `cli.NewStringSlice()`. --grpc-addr | $STORAGE_USERS_GRPC_ADDR -: GRPC Address to bind users storage. Default: `"0.0.0.0:9157"`. +-storage-home-provider | $STORAGE_STORAGE_REGISTRY_HOME_PROVIDER +: mount point of the storage provider for user homes in the global namespace. Default: `"/home"`. --http-network | $STORAGE_USERS_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-storage-registry-json | $STORAGE_STORAGE_REGISTRY_JSON +: JSON file containing the storage registry rules. Default: `""`. --http-addr | $STORAGE_USERS_HTTP_ADDR -: HTTP Address to bind users storage. Default: `"0.0.0.0:9158"`. +-app-registry-driver | $STORAGE_APP_REGISTRY_DRIVER +: driver of the app registry. Default: `"static"`. --driver | $STORAGE_USERS_DRIVER -: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. +-app-registry-mimetypes-json | $STORAGE_APP_REGISTRY_MIMETYPES_JSON +: JSON file containing the storage registry rules. Default: `""`. --read-only | $STORAGE_USERS_READ_ONLY , $OCIS_STORAGE_READ_ONLY -: use storage driver in read-only mode. Default: `false`. +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `"https://localhost:9200"`. --mount-path | $STORAGE_USERS_MOUNT_PATH -: mount path. Default: `"/users"`. +-datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL +: URL to use for the storage datagateway, defaults to /data. Default: `""`. --mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider. Default: `"localhost:9144"`. --expose-data-server | $STORAGE_USERS_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. +-groupprovider-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: endpoint to use for the groupprovider. Default: `"localhost:9160"`. --data-server-url | $STORAGE_USERS_DATA_SERVER_URL -: data server url. Default: `"http://localhost:9158/data"`. +-sharing-endpoint | $STORAGE_SHARING_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9150"`. --http-prefix | $STORAGE_USERS_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `"data"`. +-appprovider-endpoint | $STORAGE_APPPROVIDER_ENDPOINT +: endpoint to use for the app provider. Default: `"localhost:9164"`. --tmp-folder | $STORAGE_USERS_TMP_FOLDER -: path to tmp folder. Default: `"/var/tmp/ocis/tmp/users"`. +-storage-home-endpoint | $STORAGE_HOME_ENDPOINT +: endpoint to use for the home storage. Default: `"localhost:9154"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-storage-home-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `"/home"`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9144"`. +-storage-home-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009154"`. +-storage-users-endpoint | $STORAGE_USERS_ENDPOINT +: endpoint to use for the users storage. Default: `"localhost:9157"`. +-storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH +: mount path. Default: `"/users"`. +-storage-users-mount-id | $STORAGE_USERS_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. +-public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT +: endpoint to use for the public links service. Default: `"localhost:9178"`. +-storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `"/public"`. @@ -2946,8 +2870,11 @@ Usage: `storage storage-users [command options] [arguments...]` +### storage storage +Storage service for oCIS +Usage: `storage storage [command options] [arguments...]` @@ -2984,41 +2911,32 @@ Usage: `storage storage-users [command options] [arguments...]` -### 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. Default: `""`. --network | $STORAGE_AUTH_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_AUTH_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9146"`. +-config-file | $STORAGE_CONFIG_FILE +: Path to config file. --service | $STORAGE_AUTH_BASIC_SERVICES -: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. +-log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. @@ -3211,8 +3129,11 @@ Usage: `storage auth-basic [command options] [arguments...]` +### storage sharing +Start sharing service +Usage: `storage sharing [command options] [arguments...]` @@ -3252,11 +3173,8 @@ Usage: `storage auth-basic [command options] [arguments...]` -### storage storage -Storage service for oCIS -Usage: `storage storage [command options] [arguments...]` @@ -3331,42 +3249,58 @@ 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. +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9151"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-network | $STORAGE_SHARING_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9150"`. +-service | $STORAGE_SHARING_SERVICES +: --service usershareprovider [--service publicshareprovider]. Default: `cli.NewStringSlice("usershareprovider", "publicshareprovider")`. +-user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `"json"`. +-user-json-file | $STORAGE_SHARING_USER_JSON_FILE +: file used to persist shares for the UserShareProvider. Default: `"/var/tmp/ocis/storage/shares.json"`. +-public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `"json"`. +-public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE +: file used to persist shares for the PublicShareProvider. Default: `"/var/tmp/ocis/storage/publicshares.json"`. +-public-password-hash-cost | $STORAGE_SHARING_PUBLIC_PASSWORD_HASH_COST +: the cost of hashing the public shares passwords. Default: `11`. +-public-enable-expired-shares-cleanup | $STORAGE_SHARING_PUBLIC_ENABLE_EXPIRED_SHARES_CLEANUP +: whether to periodically delete expired public shares. Default: `true`. +-public-janitor-run-interval | $STORAGE_SHARING_PUBLIC_JANITOR_RUN_INTERVAL +: the time period in seconds after which to start a janitor run. Default: `60`. @@ -3478,8 +3412,11 @@ Usage: `storage storage [command options] [arguments...]` +### storage users +Start users service +Usage: `storage users [command options] [arguments...]` @@ -3511,11 +3448,8 @@ Usage: `storage storage [command options] [arguments...]` -### storage storage-metadata -Start storage-metadata service -Usage: `storage storage-metadata [command options] [arguments...]` @@ -3590,20 +3524,12 @@ Usage: `storage storage-metadata [command options] [arguments...]` --config-file | $STORAGE_CONFIG_FILE -: Path to config file. --log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. --log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. @@ -3621,44 +3547,24 @@ 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"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider service. Default: `"localhost:9144"`. @@ -3723,42 +3629,80 @@ Usage: `storage storage-metadata [command options] [arguments...]` +-debug-addr | $STORAGE_USERPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9145"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-network | $STORAGE_USERPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_USERPROVIDER_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9144"`. +-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `"localhost:9144"`. +-service | $STORAGE_USERPROVIDER_SERVICES +: --service userprovider [--service otherservice]. Default: `cli.NewStringSlice("userprovider")`. +-driver | $STORAGE_USERPROVIDER_DRIVER +: user driver: 'demo', 'json', 'ldap', 'owncloudsql' or 'rest'. Default: `"ldap"`. +-json-config | $STORAGE_USERPROVIDER_JSON +: Path to users.json file. Default: `""`. +-user-groups-cache-expiration | $STORAGE_USER_CACHE_EXPIRATION +: Time in minutes for redis cache expiration.. Default: `5`. +-owncloudsql-dbhost | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBHOST +: hostname of the mysql db. Default: `"mysql"`. +-owncloudsql-dbport | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBPORT +: port of the mysql db. Default: `3306`. +-owncloudsql-dbname | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBNAME +: database name of the owncloud db. Default: `"owncloud"`. +-owncloudsql-dbuser | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBUSER +: user name to use when connecting to the mysql owncloud db. Default: `"owncloud"`. +-owncloudsql-dbpass | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBPASS +: password to use when connecting to the mysql owncloud db. Default: `"secret"`. +-owncloudsql-idp | $STORAGE_USERPROVIDER_OWNCLOUDSQL_IDP , $OCIS_URL +: Identity provider to use for users. Default: `"https://localhost:9200"`. +-owncloudsql-nobody | $STORAGE_USERPROVIDER_OWNCLOUDSQL_NOBODY +: fallback user id to use when user has no id. Default: `99`. +-owncloudsql-join-username | $STORAGE_USERPROVIDER_OWNCLOUDSQL_JOIN_USERNAME +: join the username from the oc_preferences table. Default: `false`. +-owncloudsql-join-ownclouduuid | $STORAGE_USERPROVIDER_OWNCLOUDSQL_JOIN_OWNCLOUDUUID +: join the ownclouduuid from the oc_preferences table. Default: `false`. +-owncloudsql-enable-medial-search | $STORAGE_USERPROVIDER_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH +: enable medial search when finding users. Default: `false`. @@ -3772,8 +3716,11 @@ Usage: `storage storage-metadata [command options] [arguments...]` +### storage auth-bearer +Start authprovider for bearer auth +Usage: `storage auth-bearer [command options] [arguments...]` @@ -3800,11 +3747,8 @@ Usage: `storage storage-metadata [command options] [arguments...]` -### storage storage-public-link -Start storage-public-link service -Usage: `storage storage-public-link [command options] [arguments...]` @@ -3925,24 +3869,14 @@ 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"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -4018,94 +3952,178 @@ Usage: `storage storage-public-link [command options] [arguments...]` +-debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9149"`. +-auth-driver | $STORAGE_AUTH_BEARER_DRIVER +: bearer auth driver: 'oidc' or 'machine'. Default: `"oidc"`. +-oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL +: OIDC issuer. Default: `"https://localhost:9200"`. +-oidc-insecure | $STORAGE_OIDC_INSECURE +: OIDC allow insecure communication. Default: `true`. +-oidc-id-claim | $STORAGE_OIDC_ID_CLAIM +: OIDC id claim. Default: `"preferred_username"`. +-oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM +: OIDC uid claim. Default: `""`. +-oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM +: OIDC gid claim. Default: `""`. +-machine-auth-api-key | $STORAGE_AUTH_BEARER_MACHINE_AUTH_API_KEY , $OCIS_MACHINE_AUTH_API_KEY +: the API key to be used for the machine auth driver in reva. Default: `"change-me-please"`. +-network | $STORAGE_AUTH_BEARER_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_AUTH_BEARER_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9148"`. +-service | $STORAGE_AUTH_BEARER_SERVICES +: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +### 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"`. +-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/"`. +-archiver-max-num-files | $STORAGE_ARCHIVER_MAX_NUM_FILES +: Maximum number of files to be included in the archiver. Default: `10000`. +-archiver-max-size | $STORAGE_ARCHIVER_MAX_SIZE +: Maximum size for the sum of the sizes of all the files included in the archive. Default: `1073741824`. +-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"`. -### storage groups -Start groups service +-service | $STORAGE_FRONTEND_SERVICES +: --service ocdav [--service ocs]. Default: `cli.NewStringSlice("datagateway", "ocdav", "ocs", "appprovider")`. -Usage: `storage groups [command options] [arguments...]` +-approvider-prefix | $STORAGE_FRONTEND_APPPROVIDER_PREFIX +: approvider prefix. Default: `""`. +-archiver-prefix | $STORAGE_FRONTEND_ARCHIVER_PREFIX +: archiver prefix. Default: `"archiver"`. +-datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX +: datagateway prefix. Default: `"data"`. +-favorites | $STORAGE_FRONTEND_FAVORITES +: announces favorites support to clients. Default: `false`. +-ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX +: owncloud webdav endpoint prefix. Default: `""`. +-ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX +: open collaboration services endpoint prefix. Default: `"ocs"`. +-ocs-share-prefix | $STORAGE_FRONTEND_OCS_SHARE_PREFIX +: the prefix prepended to the path of shared files. Default: `"/Shares"`. +-ocs-home-namespace | $STORAGE_FRONTEND_OCS_HOME_NAMESPACE +: the prefix prepended to the incoming requests in OCS. Default: `"/home"`. +-ocs-resource-info-cache-ttl | $STORAGE_FRONTEND_OCS_RESOURCE_INFO_CACHE_TTL +: the TTL for statted resources in the share cache. Default: `0`. +-ocs-cache-warmup-driver | $STORAGE_FRONTEND_OCS_CACHE_WARMUP_DRIVER +: the driver to be used for warming up the share cache. Default: `""`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-default-upload-protocol | $STORAGE_FRONTEND_DEFAULT_UPLOAD_PROTOCOL +: Default upload chunking protocol to be used out of tus/v1/ng. Default: `"tus"`. +-upload-max-chunk-size | $STORAGE_FRONTEND_UPLOAD_MAX_CHUNK_SIZE +: Max chunk size in bytes to advertise to clients through capabilities, or 0 for unlimited. Default: `0`. +-upload-http-method-override | $STORAGE_FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE +: Specify an HTTP method (ex: POST) that clients should to use when uploading instead of PATCH. Default: `""`. +-checksum-supported-type | $STORAGE_FRONTEND_CHECKSUM_SUPPORTED_TYPES +: --checksum-supported-type sha1 [--checksum-supported-type adler32]. Default: `cli.NewStringSlice("sha1", "md5", "adler32")`. +-checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE +: Specify the preferred checksum algorithm used for uploads. Default: `""`. +-archiver-url | $STORAGE_FRONTEND_ARCHIVER_URL +: URL where the archiver is reachable. Default: `"/archiver"`. +-appprovider-apps-url | $STORAGE_FRONTEND_APP_PROVIDER_APPS_URL +: URL where the app listing of the app provider is reachable. Default: `"/app/list"`. +-appprovider-open-url | $STORAGE_FRONTEND_APP_PROVIDER_OPEN_URL +: URL where files can be handed over to an application from the app provider. Default: `"/app/open"`. +-user-agent-whitelist-lock-in | $STORAGE_FRONTEND_MIDDLEWARE_AUTH_CREDENTIALS_BY_USER_AGENT +: --user-agent-whitelist-lock-in=mirall:basic,foo:bearer Given a tuple of comma separated [UserAgent:challenge] values, it locks a given user agent to the authentication challenge. Particularly useful for old clients whose USer-Agent is known and only support one authentication challenge. When this flag is set in the storage-frontend it configures Reva.. @@ -4228,40 +4246,22 @@ Usage: `storage groups [command options] [arguments...]` --debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9161"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --network | $STORAGE_GROUPPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_GROUPPROVIDER_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9160"`. --endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `"localhost:9160"`. --service | $STORAGE_GROUPPROVIDER_SERVICES -: --service groupprovider [--service otherservice]. Default: `cli.NewStringSlice("groupprovider")`. --driver | $STORAGE_GROUPPROVIDER_DRIVER -: group driver: 'json', 'ldap', or 'rest'. Default: `"ldap"`. --json-config | $STORAGE_GROUPPROVIDER_JSON -: Path to groups.json file. Default: `""`. --group-members-cache-expiration | $STORAGE_GROUP_CACHE_EXPIRATION -: Time in minutes for redis cache expiration.. Default: `5`. diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index e18878c28d2..0405e3dda88 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-13T09:00:37+0000" +date: "2021-10-13T11:32:52+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 7ab5759edc5..668dd222ecb 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-13T09:00:37+0000" +date: "2021-10-13T11:32:52+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates @@ -34,38 +34,6 @@ If multiple variables are listed for one option, they are in order of precedence ### Command-line flags If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -### thumbnails ocis-thumbnails - -Example usage - -Usage: `thumbnails ocis-thumbnails [command options] [arguments...]` - - - - - - - - - - - - - - - - - - - - - - - - - - ### thumbnails server @@ -234,6 +202,38 @@ Usage: `thumbnails health [command options] [arguments...]` + + + + + + + +### 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 d21bf68bdea..bfbe58c6eb2 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-13T09:00:38+0000" +date: "2021-10-13T11:32:52+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/web/templates @@ -74,47 +74,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 @@ -246,4 +205,45 @@ Usage: `web server [command options] [arguments...]` -extensions | : Run specific extensions during supervised mode. This flag is set by the runtime. + +### 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 72ec09ee879..bb9292451c1 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-13T09:00:38+0000" +date: "2021-10-13T11:32:52+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 b9a55ec1168..8ecd2096f01 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-13T09:00:37+0000" +date: "2021-10-13T11:32:51+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -108,11 +108,11 @@ Usage: `ocis [global options] command [command options] [arguments...]` ## Sub Commands -### ocis health +### ocis list -Check health status +Lists running ocis extensions -Usage: `ocis health [command options] [arguments...]` +Usage: `ocis list [command options] [arguments...]` @@ -128,8 +128,6 @@ Usage: `ocis health [command options] [arguments...]` --debug-addr | $OCIS_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9010`. @@ -138,12 +136,12 @@ Usage: `ocis health [command options] [arguments...]` +### ocis kill -### ocis run +Kill an extension by name -Runs an extension +Usage: `ocis kill [command options] [arguments...]` -Usage: `ocis run [command options] [arguments...]` @@ -166,12 +164,12 @@ Usage: `ocis run [command options] [arguments...]` +### ocis health -### ocis server +Check health status -Start fullstack server +Usage: `ocis health [command options] [arguments...]` -Usage: `ocis server [command options] [arguments...]` @@ -186,44 +184,30 @@ Usage: `ocis server [command options] [arguments...]` +-debug-addr | $OCIS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9010`. --debug-addr | $OCIS_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9010`. --debug-token | $OCIS_DEBUG_TOKEN -: Token to grant metrics access. --debug-pprof | $OCIS_DEBUG_PPROF -: Enable pprof debugging. --debug-zpages | $OCIS_DEBUG_ZPAGES -: Enable zpages debugging. +### ocis run --http-addr | $OCIS_HTTP_ADDR -: Address to bind http server. Default: `0.0.0.0:9000`. +Runs an extension +Usage: `ocis run [command options] [arguments...]` --http-root | $OCIS_HTTP_ROOT -: Root path of http server. Default: `/`. --grpc-addr | $OCIS_GRPC_ADDR -: Address to bind grpc server. Default: `0.0.0.0:9001`. --extensions | $OCIS_RUN_EXTENSIONS -: Run specific extensions during supervised mode. -### ocis kill -Kill an extension by name -Usage: `ocis kill [command options] [arguments...]` @@ -239,19 +223,19 @@ Usage: `ocis kill [command options] [arguments...]` +### ocis server +Start fullstack server +Usage: `ocis server [command options] [arguments...]` -### ocis list -Lists running ocis extensions -Usage: `ocis list [command options] [arguments...]` @@ -260,114 +244,130 @@ Usage: `ocis list [command options] [arguments...]` +-debug-addr | $OCIS_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9010`. +-debug-token | $OCIS_DEBUG_TOKEN +: Token to grant metrics access. +-debug-pprof | $OCIS_DEBUG_PPROF +: Enable pprof debugging. +-debug-zpages | $OCIS_DEBUG_ZPAGES +: Enable zpages debugging. +-http-addr | $OCIS_HTTP_ADDR +: Address to bind http server. Default: `0.0.0.0:9000`. +-http-root | $OCIS_HTTP_ROOT +: Root path of http server. Default: `/`. +-grpc-addr | $OCIS_GRPC_ADDR +: Address to bind grpc server. Default: `0.0.0.0:9001`. +-extensions | $OCIS_RUN_EXTENSIONS +: Run specific extensions during supervised mode. ### List of available Extension subcommands There are more subcommands to start the individual extensions. Please check the documentation about their usage and options in the dedicated section of the documentation. -#### ocis webdav - -Start webdav server - -#### ocis storage-gateway +#### ocis idp -Start storage gateway +Start idp server -#### ocis storage-userprovider +#### ocis thumbnails -Start storage userprovider service +Start thumbnails server #### ocis storage-groupprovider Start storage groupprovider service -#### ocis storage-sharing +#### ocis glauth -Start storage sharing service +Start glauth server + +#### ocis proxy + +Start proxy server #### ocis settings Start settings server -#### ocis storage-app-provider +#### ocis storage-auth-basic -Start storage app-provider service +Start storage auth-basic service -#### ocis storage-frontend +#### ocis storage-gateway -Start storage frontend +Start storage gateway #### ocis storage-users Start storage and data provider for /users mount -#### ocis storage-public-link +#### ocis web -Start storage public link storage +Start web server -#### ocis glauth +#### ocis storage-auth-bearer -Start glauth server +Start storage auth-bearer service -#### ocis ocs +#### ocis storage-frontend -Start ocs server +Start storage frontend -#### ocis proxy +#### ocis storage-userprovider -Start proxy server +Start storage userprovider service -#### ocis storage-auth-basic +#### ocis store -Start storage auth-basic service +Start a go-micro store -#### ocis accounts +#### ocis ocs -Start accounts server +Start ocs server -#### ocis storage-metadata +#### ocis storage-app-provider -Start storage and data service for metadata +Start storage app-provider service -#### ocis version +#### ocis storage-sharing -Lists running services with version +Start storage sharing service -#### ocis storage-home +#### ocis storage-metadata -Start storage and data provider for /home mount +Start storage and data service for metadata -#### ocis store +#### ocis storage-public-link -Start a go-micro store +Start storage public link storage -#### ocis thumbnails +#### ocis version -Start thumbnails server +Lists running services with version -#### ocis storage-auth-bearer +#### ocis accounts -Start storage auth-bearer service +Start accounts server -#### ocis web +#### ocis storage-home -Start web server +Start storage and data provider for /home mount -#### ocis idp +#### ocis webdav -Start idp server +Start webdav server diff --git a/ocis/release_notes.md b/ocis/release_notes.md index 5aa286470d0..a8b8a4a3617 100644 --- a/ocis/release_notes.md +++ b/ocis/release_notes.md @@ -7,6 +7,25 @@ geekdocEditPath: edit/master/docs/ocis geekdocFilePath: release_notes.md --- +## ownCloud Infinite Scale 1.13.0 Technology Preview + +Version 1.13.0 brings progress on the backend for the 'Spaces' feature. ownCloud Web and Infinite Scale now provide ZIP/TAR download for multiple files/folders and can integrate external file viewer/editor applications (e.g., Collabora Online, ONLYOFFICE, CodiMD, Microsoft Office Online). + +The most prominent changes in ownCloud Infinite Scale 1.13.0 and ownCloud Web 4.3.0 comprise: + +- Infinite Scale and Web now allow downloading multiple files or folders as archives [ocis#2509](https://github.com/owncloud/ocis/pull/2509) [cs3org/reva#2088](https://github.com/cs3org/reva/pull/2088) +- Infinite Scale and Web can now integrate external applications like file viewers/editors via the [cs3org/wopiserver](https://github.com/cs3org/wopiserver) (e.g., Collabora Online, ONLYOFFICE, CodiMD, Microsoft Office Online). [web#5805](https://github.com/owncloud/web/pull/5805) +- The 'Shared with me' page in ownCloud Web now clearly separates pending, declined and accepted shares. Pending shares are always displayed prominently so that users are aware and can react accordingly. [web#5814](https://github.com/owncloud/web/pull/5814) +- Legacy URLs (e.g., from the address bar, public links) from ownCloud Classic are now properly resolved after migrating to Infinite Scale and Web [cs3org/reva#1089](https://github.com/cs3org/reva/pull/1989) +- A capability for the Favorites feature has been added [ocis#2599](https://github.com/owncloud/ocis/pull/2599) + +You can also read the full [ownCloud Infinite Scale changelog](https://github.com/owncloud/ocis/releases/tag/v1.13.0) and [ownCloud Web changelog](https://github.com/owncloud/web/releases/tag/v4.3.0) for further details on what has changed. + +### Breaking changes +{{< hint warning >}} +We are currently in a Tech Preview state and breaking changes may occur at any time. For more information see our [release roadmap]({{< ref "./release_roadmap" >}}) +{{< /hint >}} + ## ownCloud Infinite Scale 1.12.0 Technology Preview Version 1.12.0 is a maintenance release with the foundations for the 'Spaces' feature and for viewer/editor application integrations. The Infinite Scale backend has been further hardened by fixing known issues, improving error handling and stabilizing existing features. Apart from bugfixing, ownCloud Web 4.2.0 has received a number of usability and design improvements for sharing and the file list.