diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 419da91b8f1..1ca6582fc0f 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-08T19:32:03+0000" +date: "2021-10-11T08:36:31+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -35,12 +35,11 @@ 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 add - -Create a new account +### accounts list -Usage: `accounts add [command options] [arguments...]` +List existing accounts +Usage: `accounts list [command options] [arguments...]` @@ -91,76 +90,40 @@ 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"`. --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. +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --force-password-change-mfa | -: Force password change on next sign-in with mfa. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +### accounts remove +Removes an existing account -### accounts rebuildIndex +Usage: `accounts remove [command options] [arguments...]` -Rebuilds the service's index, i.e. deleting and then re-adding all existing documents -Usage: `accounts rebuildIndex [command options] [arguments...]` @@ -227,8 +190,12 @@ Usage: `accounts rebuildIndex [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. @@ -401,11 +368,25 @@ Usage: `accounts server [command options] [arguments...]` -### accounts update +### accounts add + +Create a new account + +Usage: `accounts add [command options] [arguments...]` + + + + + + + + + + + + -Make changes to an existing account -Usage: `accounts update [command options] [arguments...]` @@ -459,6 +440,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. @@ -504,8 +489,11 @@ Usage: `accounts update [command options] [arguments...]` +### accounts inspect +Show detailed data on an existing account +Usage: `accounts inspect [command options] [arguments...]` @@ -519,14 +507,6 @@ Usage: `accounts update [command options] [arguments...]` -### accounts version - -Print the versions of the running instances - -Usage: `accounts version [command options] [arguments...]` - - - @@ -584,28 +564,28 @@ Usage: `accounts version [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +### accounts rebuildIndex +Rebuilds the service's index, i.e. deleting and then re-adding all existing documents +Usage: `accounts rebuildIndex [command options] [arguments...]` --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...]` @@ -667,27 +647,31 @@ Usage: `accounts inspect [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. --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-extensions | +: Run specific extensions during supervised mode. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. -### accounts list -List existing accounts -Usage: `accounts list [command options] [arguments...]` @@ -751,25 +735,21 @@ Usage: `accounts list [command options] [arguments...]` +### accounts update +Make changes to an existing account +Usage: `accounts update [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...]` @@ -797,32 +777,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. @@ -838,36 +846,24 @@ 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 ocis-accounts -Provide accounts and groups for oCIS -Usage: `accounts ocis-accounts [command options] [arguments...]` +### accounts version +Print the versions of the running instances --log-level | $ACCOUNTS_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. +Usage: `accounts version [command options] [arguments...]` --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. @@ -928,8 +924,12 @@ 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"`. diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index da1e9876b2b..b3b7889e228 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-08T19:33:09+0000" +date: "2021-10-11T08:37:11+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 c2055dcb511..c2590d63ffb 100644 --- a/extensions/graph-explorer/configuration.md +++ b/extensions/graph-explorer/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-08T19:33:09+0000" +date: "2021-10-11T08:37:11+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph-explorer/templates diff --git a/extensions/graph/configuration.md b/extensions/graph/configuration.md index 071f598545f..c20d9f0a3c2 100644 --- a/extensions/graph/configuration.md +++ b/extensions/graph/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-08T19:33:09+0000" +date: "2021-10-11T08:37:11+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph/templates @@ -35,6 +35,37 @@ 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. +### graph health + +Check health status + +Usage: `graph health [command options] [arguments...]` + + + + + + +-debug-addr | $GRAPH_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9124"`. + + + + + + + + + + + + + + + + + + ### graph ocis-graph Serve Graph API for oCIS @@ -154,34 +185,3 @@ Usage: `graph server [command options] [arguments...]` -extensions | : Run specific extensions during supervised mode. This flag is set by the runtime. -### graph health - -Check health status - -Usage: `graph health [command options] [arguments...]` - - - - - - --debug-addr | $GRAPH_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9124"`. - - - - - - - - - - - - - - - - - - diff --git a/extensions/idp/configuration.md b/extensions/idp/configuration.md index 0e1cef8dee7..099263b8b80 100644 --- a/extensions/idp/configuration.md +++ b/extensions/idp/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-08T19:33:09+0000" +date: "2021-10-11T08:37:11+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 0f14559e52b..9985b6724ca 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-08T19:33:09+0000" +date: "2021-10-11T08:37:11+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/templates @@ -35,197 +35,193 @@ 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. -### ocs server +### ocs health -Start integrated server +Check health status -Usage: `ocs server [command options] [arguments...]` +Usage: `ocs health [command options] [arguments...]` +-debug-addr | $OCS_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9114"`. --log-file | $OCS_LOG_FILE , $OCIS_LOG_FILE -: Enable log to file. --log-level | $OCS_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. --log-pretty | $OCS_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $OCS_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. --config-file | $OCS_CONFIG_FILE -: Path to config file. --tracing-enabled | $OCS_TRACING_ENABLED , $OCIS_TRACING_ENABLED -: Enable sending traces. Default: `false`. --tracing-type | $OCS_TRACING_TYPE , $OCIS_TRACING_TYPE -: Tracing backend type. Default: `"jaeger"`. --tracing-endpoint | $OCS_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. --tracing-collector | $OCS_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `""`. --tracing-service | $OCS_TRACING_SERVICE -: Service name for tracing. Default: `"ocs"`. --debug-addr | $OCS_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9114"`. --debug-token | $OCS_DEBUG_TOKEN -: Token to grant metrics access. Default: `""`. --debug-pprof | $OCS_DEBUG_PPROF -: Enable pprof debugging. --debug-zpages | $OCS_DEBUG_ZPAGES -: Enable zpages debugging. +### ocs ocis-ocs --http-addr | $OCS_HTTP_ADDR -: Address to bind http server. Default: `"0.0.0.0:9110"`. +Serve OCS API for oCIS +Usage: `ocs ocis-ocs [command options] [arguments...]` --http-namespace | $OCS_NAMESPACE -: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. --name | $OCS_NAME -: Service name. Default: `"ocs"`. --http-root | $OCS_HTTP_ROOT -: Root path of http server. Default: `"/ocs"`. --jwt-secret | $OCS_JWT_SECRET , $OCIS_JWT_SECRET -: Used to dismantle the access token, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. --account-backend-type | $OCS_ACCOUNT_BACKEND_TYPE -: account-backend-type. Default: `"accounts"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --machine-auth-api-key | $OCS_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"`. --idm-address | $OCS_IDM_ADDRESS , $OCIS_URL -: keeps track of the IDM Address. Needed because of Reva requisite of uniqueness for users. Default: `"https://localhost:9200"`. --users-driver | $OCS_STORAGE_USERS_DRIVER , $STORAGE_USERS_DRIVER -: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. --extensions | -: Run specific extensions during supervised mode. -### ocs version -Print the versions of the running instances -Usage: `ocs version [command options] [arguments...]` +### ocs server +Start integrated server +Usage: `ocs server [command options] [arguments...]` +-log-file | $OCS_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. +-log-level | $OCS_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $OCS_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $OCS_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. +-config-file | $OCS_CONFIG_FILE +: Path to config file. +-tracing-enabled | $OCS_TRACING_ENABLED , $OCIS_TRACING_ENABLED +: Enable sending traces. Default: `false`. +-tracing-type | $OCS_TRACING_TYPE , $OCIS_TRACING_TYPE +: Tracing backend type. Default: `"jaeger"`. +-tracing-endpoint | $OCS_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. +-tracing-collector | $OCS_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR +: Endpoint for the collector. Default: `""`. --http-namespace | $OCS_NAMESPACE -: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. +-tracing-service | $OCS_TRACING_SERVICE +: Service name for tracing. Default: `"ocs"`. --name | $OCS_NAME -: Service name. Default: `"ocs"`. +-debug-addr | $OCS_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9114"`. -### ocs health -Check health status +-debug-token | $OCS_DEBUG_TOKEN +: Token to grant metrics access. Default: `""`. -Usage: `ocs health [command options] [arguments...]` +-debug-pprof | $OCS_DEBUG_PPROF +: Enable pprof debugging. --debug-addr | $OCS_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9114"`. +-debug-zpages | $OCS_DEBUG_ZPAGES +: Enable zpages debugging. +-http-addr | $OCS_HTTP_ADDR +: Address to bind http server. Default: `"0.0.0.0:9110"`. +-http-namespace | $OCS_NAMESPACE +: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. +-name | $OCS_NAME +: Service name. Default: `"ocs"`. +-http-root | $OCS_HTTP_ROOT +: Root path of http server. Default: `"/ocs"`. +-jwt-secret | $OCS_JWT_SECRET , $OCIS_JWT_SECRET +: Used to dismantle the access token, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. +-account-backend-type | $OCS_ACCOUNT_BACKEND_TYPE +: account-backend-type. Default: `"accounts"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-machine-auth-api-key | $OCS_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"`. +-idm-address | $OCS_IDM_ADDRESS , $OCIS_URL +: keeps track of the IDM Address. Needed because of Reva requisite of uniqueness for users. Default: `"https://localhost:9200"`. +-users-driver | $OCS_STORAGE_USERS_DRIVER , $STORAGE_USERS_DRIVER +: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. +-extensions | +: Run specific extensions during supervised mode. +### ocs version +Print the versions of the running instances -### ocs ocis-ocs +Usage: `ocs version [command options] [arguments...]` -Serve OCS API for oCIS -Usage: `ocs ocis-ocs [command options] [arguments...]` @@ -252,6 +248,10 @@ Usage: `ocs ocis-ocs [command options] [arguments...]` +-http-namespace | $OCS_NAMESPACE +: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. +-name | $OCS_NAME +: Service name. Default: `"ocs"`. diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index 50e4a6864a1..2ebd8d4f27c 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-08T19:33:09+0000" +date: "2021-10-11T08:37:11+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 34e21475909..ef9a10c48d6 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-08T19:33:09+0000" +date: "2021-10-11T08:37:11+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 c8aa8a988cc..615829d8ae9 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-08T19:33:10+0000" +date: "2021-10-11T08:37:12+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -175,20 +175,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. @@ -284,11 +276,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. @@ -345,187 +346,198 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage frontend - -Start frontend service +### storage gateway -Usage: `storage frontend [command options] [arguments...]` +Start gateway +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"`. --debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9141"`. +-storage-users-endpoint | $STORAGE_USERS_ENDPOINT +: endpoint to use for the users storage. Default: `"localhost:9157"`. --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. +-storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH +: mount path. Default: `"/users"`. --webdav-namespace | $STORAGE_WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `"/home/"`. +-storage-users-mount-id | $STORAGE_USERS_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. --dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `"/users/"`. +-public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT +: endpoint to use for the public links service. Default: `"localhost:9178"`. --archiver-max-num-files | $STORAGE_ARCHIVER_MAX_NUM_FILES -: Maximum number of files to be included in the archiver. Default: `10000`. +-storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `"/public"`. --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"`. --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.. @@ -728,19 +740,19 @@ Usage: `storage frontend [command options] [arguments...]` -### storage groups -Start groups service -Usage: `storage groups [command options] [arguments...]` +### storage groups +Start groups service +Usage: `storage groups [command options] [arguments...]` @@ -1051,11 +1063,8 @@ Usage: `storage groups [command options] [arguments...]` -### storage sharing -Start sharing service -Usage: `storage sharing [command options] [arguments...]` @@ -1063,8 +1072,11 @@ Usage: `storage sharing [command options] [arguments...]` +### storage storage-home +Start storage-home service +Usage: `storage storage-home [command options] [arguments...]` @@ -1195,52 +1207,28 @@ 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`. @@ -1329,36 +1317,68 @@ Usage: `storage sharing [command options] [arguments...]` +-debug-addr | $STORAGE_HOME_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9156"`. +-grpc-network | $STORAGE_HOME_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-grpc-addr | $STORAGE_HOME_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9154"`. +-http-network | $STORAGE_HOME_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-http-addr | $STORAGE_HOME_HTTP_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9155"`. +-driver | $STORAGE_HOME_DRIVER +: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. +-read-only | $STORAGE_HOME_READ_ONLY , $OCIS_STORAGE_READ_ONLY +: use storage driver in read-only mode. Default: `false`. +-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `"/home"`. +-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. +-expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. +-data-server-url | $STORAGE_HOME_DATA_SERVER_URL +: data server url. Default: `"http://localhost:9155/data"`. +-http-prefix | $STORAGE_HOME_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `"data"`. +-tmp-folder | $STORAGE_HOME_TMP_FOLDER +: path to tmp folder. Default: `"/var/tmp/ocis/tmp/home"`. +-enable-home | $STORAGE_HOME_ENABLE_HOME +: enable the creation of home directories. Default: `true`. +-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"`. @@ -1383,11 +1403,8 @@ Usage: `storage sharing [command options] [arguments...]` -### storage auth-basic -Start authprovider for basic auth -Usage: `storage auth-basic [command options] [arguments...]` @@ -1400,8 +1417,11 @@ Usage: `storage auth-basic [command options] [arguments...]` +### storage storage-public-link +Start storage-public-link service +Usage: `storage storage-public-link [command options] [arguments...]` @@ -1425,32 +1445,18 @@ Usage: `storage auth-basic [command options] [arguments...]` --debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9147"`. --auth-driver | $STORAGE_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `"ldap"`. --auth-json | $STORAGE_AUTH_JSON -: Path to users.json file. Default: `""`. --network | $STORAGE_AUTH_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_AUTH_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9146"`. --service | $STORAGE_AUTH_BASIC_SERVICES -: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -1513,14 +1519,24 @@ Usage: `storage auth-basic [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"`. @@ -1700,11 +1716,8 @@ Usage: `storage auth-basic [command options] [arguments...]` -### storage storage-home -Start storage-home service -Usage: `storage storage-home [command options] [arguments...]` @@ -1716,8 +1729,11 @@ Usage: `storage storage-home [command options] [arguments...]` +### storage auth-bearer +Start authprovider for bearer auth +Usage: `storage auth-bearer [command options] [arguments...]` @@ -1861,68 +1877,36 @@ Usage: `storage storage-home [command options] [arguments...]` --debug-addr | $STORAGE_HOME_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9156"`. --grpc-network | $STORAGE_HOME_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --grpc-addr | $STORAGE_HOME_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9154"`. --http-network | $STORAGE_HOME_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --http-addr | $STORAGE_HOME_HTTP_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9155"`. --driver | $STORAGE_HOME_DRIVER -: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. --read-only | $STORAGE_HOME_READ_ONLY , $OCIS_STORAGE_READ_ONLY -: use storage driver in read-only mode. Default: `false`. --mount-path | $STORAGE_HOME_MOUNT_PATH -: mount path. Default: `"/home"`. --mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. --expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. --data-server-url | $STORAGE_HOME_DATA_SERVER_URL -: data server url. Default: `"http://localhost:9155/data"`. --http-prefix | $STORAGE_HOME_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `"data"`. --tmp-folder | $STORAGE_HOME_TMP_FOLDER -: path to tmp folder. Default: `"/var/tmp/ocis/tmp/home"`. --enable-home | $STORAGE_HOME_ENABLE_HOME -: enable the creation of home directories. Default: `true`. --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"`. @@ -2006,28 +1990,52 @@ Usage: `storage storage-home [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"`. @@ -2044,11 +2052,8 @@ Usage: `storage storage-home [command options] [arguments...]` -### storage storage-metadata -Start storage-metadata service -Usage: `storage storage-metadata [command options] [arguments...]` @@ -2057,8 +2062,11 @@ Usage: `storage storage-metadata [command options] [arguments...]` +### storage storage +Storage service for oCIS +Usage: `storage storage [command options] [arguments...]` @@ -2184,20 +2192,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. @@ -2233,48 +2233,26 @@ 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"`. --storage-root | $STORAGE_METADATA_ROOT -: the path to the metadata storage root. Default: `"/var/tmp/ocis/storage/metadata"`. @@ -2325,12 +2303,20 @@ 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. @@ -2385,11 +2371,11 @@ Usage: `storage storage-metadata [command options] [arguments...]` -### storage storage-users +### storage storage-metadata -Start storage-users service +Start storage-metadata service -Usage: `storage storage-users [command options] [arguments...]` +Usage: `storage storage-metadata [command options] [arguments...]` @@ -2607,64 +2593,42 @@ Usage: `storage storage-users [command options] [arguments...]` --debug-addr | $STORAGE_USERS_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9159"`. --grpc-network | $STORAGE_USERS_GRPC_NETWORK -: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --grpc-addr | $STORAGE_USERS_GRPC_ADDR -: GRPC Address to bind users storage. Default: `"0.0.0.0:9157"`. --http-network | $STORAGE_USERS_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --http-addr | $STORAGE_USERS_HTTP_ADDR -: HTTP Address to bind users storage. Default: `"0.0.0.0:9158"`. --driver | $STORAGE_USERS_DRIVER -: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. --read-only | $STORAGE_USERS_READ_ONLY , $OCIS_STORAGE_READ_ONLY -: use storage driver in read-only mode. Default: `false`. --mount-path | $STORAGE_USERS_MOUNT_PATH -: mount path. Default: `"/users"`. --mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. --expose-data-server | $STORAGE_USERS_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. +-config-file | $STORAGE_CONFIG_FILE +: Path to config file. --data-server-url | $STORAGE_USERS_DATA_SERVER_URL -: data server url. Default: `"http://localhost:9158/data"`. +-log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. --http-prefix | $STORAGE_USERS_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `"data"`. +-log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. --tmp-folder | $STORAGE_USERS_TMP_FOLDER -: path to tmp folder. Default: `"/var/tmp/ocis/tmp/users"`. +-log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. --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"`. @@ -2706,32 +2670,54 @@ Usage: `storage storage-users [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"`. -### storage app-provider +-storage-root | $STORAGE_METADATA_ROOT +: the path to the metadata storage root. Default: `"/var/tmp/ocis/storage/metadata"`. -Start appprovider for providing apps +### storage users -Usage: `storage app-provider [command options] [arguments...]` +Start users service +Usage: `storage users [command options] [arguments...]` @@ -2865,42 +2851,80 @@ Usage: `storage app-provider [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`. @@ -2914,68 +2938,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"`. @@ -3070,18 +3062,16 @@ Usage: `storage app-provider [command options] [arguments...]` -### storage health -Check health status -Usage: `storage health [command options] [arguments...]` --debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9109"`. +### storage auth-basic +Start authprovider for basic auth +Usage: `storage auth-basic [command options] [arguments...]` @@ -3184,18 +3174,32 @@ Usage: `storage health [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"`. @@ -3369,11 +3373,8 @@ Usage: `storage health [command options] [arguments...]` -### storage storage-public-link -Start storage-public-link service -Usage: `storage storage-public-link [command options] [arguments...]` @@ -3384,8 +3385,11 @@ Usage: `storage storage-public-link [command options] [arguments...]` +### storage health +Check health status +Usage: `storage health [command options] [arguments...]` @@ -3423,6 +3427,8 @@ Usage: `storage storage-public-link [command options] [arguments...]` +-debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9109"`. @@ -3645,24 +3651,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"`. @@ -3680,11 +3676,8 @@ Usage: `storage storage-public-link [command options] [arguments...]` -### storage users -Start users service -Usage: `storage users [command options] [arguments...]` @@ -3692,8 +3685,11 @@ Usage: `storage users [command options] [arguments...]` +### storage storage-users +Start storage-users service +Usage: `storage storage-users [command options] [arguments...]` @@ -3776,108 +3772,100 @@ 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`. +-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"`. @@ -4033,17 +4021,17 @@ Usage: `storage users [command options] [arguments...]` -### storage auth-bearer -Start authprovider for bearer auth -Usage: `storage auth-bearer [command options] [arguments...]` +### storage frontend +Start frontend service +Usage: `storage frontend [command options] [arguments...]` @@ -4250,126 +4238,159 @@ Usage: `storage auth-bearer [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"`. +-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.. --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 storage -Storage service for oCIS -Usage: `storage storage [command options] [arguments...]` @@ -4393,8 +4414,11 @@ Usage: `storage storage [command options] [arguments...]` +### storage sharing +Start sharing service +Usage: `storage sharing [command options] [arguments...]` @@ -4505,20 +4529,12 @@ 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. @@ -4584,28 +4600,52 @@ Usage: `storage storage [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`. @@ -4673,11 +4713,8 @@ Usage: `storage storage [command options] [arguments...]` -### storage gateway -Start gateway -Usage: `storage gateway [command options] [arguments...]` @@ -4710,8 +4747,11 @@ Usage: `storage gateway [command options] [arguments...]` +### storage app-provider +Start appprovider for providing apps +Usage: `storage app-provider [command options] [arguments...]` @@ -4764,20 +4804,68 @@ Usage: `storage gateway [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"`. @@ -4914,144 +5002,74 @@ 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"`. diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index 5253128d049..1a97c285d78 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-08T19:33:10+0000" +date: "2021-10-11T08:37:12+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 5a7ced0288a..ed6a5059136 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-08T19:33:11+0000" +date: "2021-10-11T08:37:12+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates @@ -34,6 +34,38 @@ 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 @@ -202,38 +234,6 @@ 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 969e0867f07..5d6e2e8a8ff 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-08T19:33:12+0000" +date: "2021-10-11T08:37:12+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/web/templates @@ -73,46 +73,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 @@ -240,4 +200,44 @@ 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 5afc3122467..633cfdc732d 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-08T19:33:12+0000" +date: "2021-10-11T08:37:12+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 6baba418ef7..28496c9f3ec 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-10-08T19:33:09+0000" +date: "2021-10-11T08:37:11+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 run +### ocis kill -Runs an extension +Kill an extension by name -Usage: `ocis run [command options] [arguments...]` +Usage: `ocis kill [command options] [arguments...]` @@ -136,11 +136,12 @@ Usage: `ocis run [command options] [arguments...]` -### ocis health +### ocis server -Check health status +Start fullstack server + +Usage: `ocis server [command options] [arguments...]` -Usage: `ocis health [command options] [arguments...]` @@ -157,27 +158,41 @@ Usage: `ocis health [command options] [arguments...]` -debug-addr | $OCIS_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9010`. +: 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`. -### ocis kill -Kill an extension by name +-http-root | $OCIS_HTTP_ROOT +: Root path of http server. Default: `/`. -Usage: `ocis kill [command options] [arguments...]` +-grpc-addr | $OCIS_GRPC_ADDR +: Address to bind grpc server. Default: `0.0.0.0:9001`. +-extensions | $OCIS_RUN_EXTENSIONS +: Run specific extensions during supervised mode. +### ocis health +Check health status +Usage: `ocis health [command options] [arguments...]` @@ -193,21 +208,22 @@ Usage: `ocis kill [command options] [arguments...]` +-debug-addr | $OCIS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9010`. -### ocis list -Lists running ocis extensions - -Usage: `ocis list [command options] [arguments...]` +### ocis list +Lists running ocis extensions +Usage: `ocis list [command options] [arguments...]` @@ -223,19 +239,19 @@ Usage: `ocis list [command options] [arguments...]` -### ocis server -Start fullstack server -Usage: `ocis server [command options] [arguments...]` +### ocis run +Runs an extension +Usage: `ocis run [command options] [arguments...]` @@ -244,130 +260,114 @@ Usage: `ocis server [command options] [arguments...]` --debug-addr | $OCIS_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9010`. --debug-token | $OCIS_DEBUG_TOKEN -: Token to grant metrics access. --debug-pprof | $OCIS_DEBUG_PPROF -: Enable pprof debugging. --debug-zpages | $OCIS_DEBUG_ZPAGES -: Enable zpages debugging. --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 accounts - -Start accounts server - -#### ocis storage-auth-basic +#### ocis thumbnails -Start storage auth-basic service +Start thumbnails server -#### ocis storage-home +#### ocis web -Start storage and data provider for /home mount +Start web server -#### ocis storage-userprovider +#### ocis storage-frontend -Start storage userprovider service +Start storage frontend #### ocis ocs Start ocs server -#### ocis proxy +#### ocis storage-auth-bearer -Start proxy server +Start storage auth-bearer service #### ocis storage-users Start storage and data provider for /users mount -#### ocis storage-app-provider +#### ocis storage-auth-basic -Start storage app-provider service +Start storage auth-basic service -#### ocis storage-metadata +#### ocis version -Start storage and data service for metadata +Lists running services with version -#### ocis store +#### ocis idp -Start a go-micro store +Start idp server -#### ocis webdav +#### ocis storage-groupprovider -Start webdav server +Start storage groupprovider service -#### ocis storage-gateway +#### ocis accounts -Start storage gateway +Start accounts server -#### ocis storage-groupprovider +#### ocis storage-metadata -Start storage groupprovider service +Start storage and data service for metadata -#### ocis storage-public-link +#### ocis storage-sharing -Start storage public link storage +Start storage sharing service -#### ocis version +#### ocis settings -Lists running services with version +Start settings server -#### ocis glauth +#### ocis storage-userprovider -Start glauth server +Start storage userprovider service -#### ocis storage-frontend +#### ocis webdav -Start storage frontend +Start webdav server -#### ocis idp +#### ocis proxy -Start idp server +Start proxy server -#### ocis settings +#### ocis storage-gateway -Start settings server +Start storage gateway -#### ocis storage-auth-bearer +#### ocis storage-home -Start storage auth-bearer service +Start storage and data provider for /home mount -#### ocis storage-sharing +#### ocis storage-public-link -Start storage sharing service +Start storage public link storage -#### ocis thumbnails +#### ocis store -Start thumbnails server +Start a go-micro store -#### ocis web +#### ocis glauth -Start web server +Start glauth server + +#### ocis storage-app-provider + +Start storage app-provider service