diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 4921138b04c..22750564104 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T07:12:05+0000" +date: "2021-06-29T07:13:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -35,17 +35,23 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### accounts inspect +### accounts ocis-accounts -Show detailed data on an existing account +Provide accounts and groups for oCIS -Usage: `accounts inspect [command options] [arguments...]` +Usage: `accounts ocis-accounts [command options] [arguments...]` +-log-level | $ACCOUNTS_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $ACCOUNTS_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $ACCOUNTS_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. @@ -93,19 +99,15 @@ Usage: `accounts inspect [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. --name | $ACCOUNTS_NAME -: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. -### accounts rebuildIndex -Rebuilds the service's index, i.e. deleting and then re-adding all existing documents +### accounts remove -Usage: `accounts rebuildIndex [command options] [arguments...]` +Removes an existing account +Usage: `accounts remove [command options] [arguments...]` @@ -157,13 +159,22 @@ Usage: `accounts rebuildIndex [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. -### accounts remove +-name | $ACCOUNTS_NAME +: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. + + + +### accounts inspect + +Show detailed data on an existing account + +Usage: `accounts inspect [command options] [arguments...]` -Removes an existing account -Usage: `accounts remove [command options] [arguments...]` @@ -222,13 +233,11 @@ Usage: `accounts remove [command options] [arguments...]` -name | $ACCOUNTS_NAME : service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. +### accounts list +List existing accounts -### accounts version - -Print the versions of the running instances - -Usage: `accounts version [command options] [arguments...]` +Usage: `accounts list [command options] [arguments...]` @@ -289,11 +298,11 @@ Usage: `accounts version [command options] [arguments...]` -### accounts add +### accounts rebuildIndex -Create a new account +Rebuilds the service's index, i.e. deleting and then re-adding all existing documents -Usage: `accounts add [command options] [arguments...]` +Usage: `accounts rebuildIndex [command options] [arguments...]` @@ -331,90 +340,115 @@ Usage: `accounts add [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. --name | $ACCOUNTS_NAME -: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. --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. --mail | -: Set the mail for the account. --description | -: Set the description for the account. +### accounts server --password | -: Set the password for the account. +Start ocis accounts service +Usage: `accounts server [command options] [arguments...]` --force-password-change | -: Force password change on next sign-in. --force-password-change-mfa | -: Force password change on next sign-in with mfa. +-log-file | $ACCOUNTS_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. +-tracing-enabled | $ACCOUNTS_TRACING_ENABLED +: Enable sending traces. +-tracing-type | $ACCOUNTS_TRACING_TYPE +: Tracing backend type. Default: `flags.OverrideDefaultString(cfg.Tracing.Type, "jaeger")`. -### accounts list -List existing accounts +-tracing-endpoint | $ACCOUNTS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `flags.OverrideDefaultString(cfg.Tracing.Endpoint, "")`. + + +-tracing-collector | $ACCOUNTS_TRACING_COLLECTOR +: Endpoint for the collector. Default: `flags.OverrideDefaultString(cfg.Tracing.Collector, "")`. + + +-tracing-service | $ACCOUNTS_TRACING_SERVICE +: Service name for tracing. Default: `flags.OverrideDefaultString(cfg.Tracing.Service, "accounts")`. -Usage: `accounts list [command options] [arguments...]` +-http-namespace | $ACCOUNTS_HTTP_NAMESPACE +: Set the base namespace for the http namespace. Default: `flags.OverrideDefaultString(cfg.HTTP.Namespace, "com.owncloud.web")`. +-http-addr | $ACCOUNTS_HTTP_ADDR +: Address to bind http server. Default: `flags.OverrideDefaultString(cfg.HTTP.Addr, "0.0.0.0:9181")`. + + +-http-root | $ACCOUNTS_HTTP_ROOT +: Root path of http server. Default: `flags.OverrideDefaultString(cfg.HTTP.Root, "/")`. + +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. +-grpc-addr | $ACCOUNTS_GRPC_ADDR +: Address to bind grpc server. Default: `flags.OverrideDefaultString(cfg.GRPC.Addr, "0.0.0.0:9180")`. +-name | $ACCOUNTS_NAME +: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. +-asset-path | $ACCOUNTS_ASSET_PATH +: Path to custom assets. Default: `flags.OverrideDefaultString(cfg.Asset.Path, "")`. +-jwt-secret | $ACCOUNTS_JWT_SECRET , $OCIS_JWT_SECRET +: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `flags.OverrideDefaultString(cfg.TokenManager.JWTSecret, "Pive-Fumkiu4")`. +-storage-disk-path | $ACCOUNTS_STORAGE_DISK_PATH +: Path on the local disk, e.g. /var/tmp/ocis/accounts. Default: `flags.OverrideDefaultString(cfg.Repo.Disk.Path, "")`. +-storage-cs3-provider-addr | $ACCOUNTS_STORAGE_CS3_PROVIDER_ADDR +: bind address for the metadata storage provider. Default: `flags.OverrideDefaultString(cfg.Repo.CS3.ProviderAddr, "localhost:9215")`. +-storage-cs3-data-url | $ACCOUNTS_STORAGE_CS3_DATA_URL +: http endpoint of the metadata storage. Default: `flags.OverrideDefaultString(cfg.Repo.CS3.DataURL, "http://localhost:9216")`. +-storage-cs3-data-prefix | $ACCOUNTS_STORAGE_CS3_DATA_PREFIX +: path prefix for the http endpoint of the metadata storage, without leading slash. Default: `flags.OverrideDefaultString(cfg.Repo.CS3.DataPrefix, "data")`. +-storage-cs3-jwt-secret | $ACCOUNTS_STORAGE_CS3_JWT_SECRET , $OCIS_JWT_SECRET +: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `flags.OverrideDefaultString(cfg.Repo.CS3.JWTSecret, "Pive-Fumkiu4")`. +-service-user-uuid | $ACCOUNTS_SERVICE_USER_UUID +: uuid of the internal service user (required on EOS). Default: `flags.OverrideDefaultString(cfg.ServiceUser.UUID, "95cb8724-03b2-11eb-a0a6-c33ef8ef53ad")`. +-service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME +: username of the internal service user (required on EOS). Default: `flags.OverrideDefaultString(cfg.ServiceUser.Username, "")`. @@ -438,34 +472,24 @@ Usage: `accounts list [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. --name | $ACCOUNTS_NAME -: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. -### accounts ocis-accounts +### accounts update -Provide accounts and groups for oCIS +Make changes to an existing account -Usage: `accounts ocis-accounts [command options] [arguments...]` +Usage: `accounts update [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. @@ -486,26 +510,48 @@ Usage: `accounts ocis-accounts [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. +-name | $ACCOUNTS_NAME +: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. +-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. +-mail | +: Set the mail for the account. +-description | +: Set the description for the account. +-password | +: Set the password for the account. +-force-password-change | +: Force password change on next sign-in. +-force-password-change-mfa | +: Force password change on next sign-in with mfa. @@ -517,98 +563,56 @@ Usage: `accounts ocis-accounts [command options] [arguments...]` -### accounts server -Start ocis accounts service -Usage: `accounts server [command options] [arguments...]` --log-file | $ACCOUNTS_LOG_FILE , $OCIS_LOG_FILE -: Enable log to file. +### accounts version --tracing-enabled | $ACCOUNTS_TRACING_ENABLED -: Enable sending traces. +Print the versions of the running instances +Usage: `accounts version [command options] [arguments...]` --tracing-type | $ACCOUNTS_TRACING_TYPE -: Tracing backend type. Default: `flags.OverrideDefaultString(cfg.Tracing.Type, "jaeger")`. --tracing-endpoint | $ACCOUNTS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `flags.OverrideDefaultString(cfg.Tracing.Endpoint, "")`. --tracing-collector | $ACCOUNTS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `flags.OverrideDefaultString(cfg.Tracing.Collector, "")`. --tracing-service | $ACCOUNTS_TRACING_SERVICE -: Service name for tracing. Default: `flags.OverrideDefaultString(cfg.Tracing.Service, "accounts")`. --http-namespace | $ACCOUNTS_HTTP_NAMESPACE -: Set the base namespace for the http namespace. Default: `flags.OverrideDefaultString(cfg.HTTP.Namespace, "com.owncloud.web")`. --http-addr | $ACCOUNTS_HTTP_ADDR -: Address to bind http server. Default: `flags.OverrideDefaultString(cfg.HTTP.Addr, "0.0.0.0:9181")`. --http-root | $ACCOUNTS_HTTP_ROOT -: Root path of http server. Default: `flags.OverrideDefaultString(cfg.HTTP.Root, "/")`. --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. --grpc-addr | $ACCOUNTS_GRPC_ADDR -: Address to bind grpc server. Default: `flags.OverrideDefaultString(cfg.GRPC.Addr, "0.0.0.0:9180")`. --name | $ACCOUNTS_NAME -: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. --asset-path | $ACCOUNTS_ASSET_PATH -: Path to custom assets. Default: `flags.OverrideDefaultString(cfg.Asset.Path, "")`. --jwt-secret | $ACCOUNTS_JWT_SECRET , $OCIS_JWT_SECRET -: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `flags.OverrideDefaultString(cfg.TokenManager.JWTSecret, "Pive-Fumkiu4")`. --storage-disk-path | $ACCOUNTS_STORAGE_DISK_PATH -: Path on the local disk, e.g. /var/tmp/ocis/accounts. Default: `flags.OverrideDefaultString(cfg.Repo.Disk.Path, "")`. --storage-cs3-provider-addr | $ACCOUNTS_STORAGE_CS3_PROVIDER_ADDR -: bind address for the metadata storage provider. Default: `flags.OverrideDefaultString(cfg.Repo.CS3.ProviderAddr, "localhost:9215")`. --storage-cs3-data-url | $ACCOUNTS_STORAGE_CS3_DATA_URL -: http endpoint of the metadata storage. Default: `flags.OverrideDefaultString(cfg.Repo.CS3.DataURL, "http://localhost:9216")`. --storage-cs3-data-prefix | $ACCOUNTS_STORAGE_CS3_DATA_PREFIX -: path prefix for the http endpoint of the metadata storage, without leading slash. Default: `flags.OverrideDefaultString(cfg.Repo.CS3.DataPrefix, "data")`. --storage-cs3-jwt-secret | $ACCOUNTS_STORAGE_CS3_JWT_SECRET , $OCIS_JWT_SECRET -: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `flags.OverrideDefaultString(cfg.Repo.CS3.JWTSecret, "Pive-Fumkiu4")`. --service-user-uuid | $ACCOUNTS_SERVICE_USER_UUID -: uuid of the internal service user (required on EOS). Default: `flags.OverrideDefaultString(cfg.ServiceUser.UUID, "95cb8724-03b2-11eb-a0a6-c33ef8ef53ad")`. --service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME -: username of the internal service user (required on EOS). Default: `flags.OverrideDefaultString(cfg.ServiceUser.Username, "")`. @@ -621,15 +625,22 @@ Usage: `accounts server [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. +-name | $ACCOUNTS_NAME +: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. +### accounts add +Create a new account +Usage: `accounts add [command options] [arguments...]` @@ -639,11 +650,8 @@ Usage: `accounts server [command options] [arguments...]` -### accounts update -Make changes to an existing account -Usage: `accounts update [command options] [arguments...]` @@ -686,6 +694,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. @@ -719,15 +731,3 @@ Usage: `accounts update [command options] [arguments...]` - - - - - - - - - - - - diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index 0630c53ec2c..da4ce82fd8c 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T07:12:51+0000" +date: "2021-06-29T07:14:34+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 6bfd39537e3..f2f8587c186 100644 --- a/extensions/graph-explorer/configuration.md +++ b/extensions/graph-explorer/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T07:12:51+0000" +date: "2021-06-29T07:14:34+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 bac8d4acbd4..b930597be3c 100644 --- a/extensions/graph/configuration.md +++ b/extensions/graph/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T07:12:51+0000" +date: "2021-06-29T07:14:34+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph/templates @@ -34,44 +34,6 @@ If multiple variables are listed for one option, they are in order of precedence ### Commandline flags If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -### graph health - -Check health status - -Usage: `graph health [command options] [arguments...]` - - - - - - --debug-addr | $GRAPH_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9124")`. - - - - - - - - - - - - - - - - - - - - - - - - ### graph ocis-graph @@ -226,4 +188,42 @@ Usage: `graph server [command options] [arguments...]` -webdav-namespace | $STORAGE_WEBDAV_NAMESPACE : Namespace prefix for the webdav endpoint. Default: `flags.OverrideDefaultString(cfg.WebdavNamespace, "/home")`. + +### graph health + +Check health status + +Usage: `graph health [command options] [arguments...]` + + + + + + +-debug-addr | $GRAPH_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9124")`. + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/extensions/idp/configuration.md b/extensions/idp/configuration.md index e6ceefc8029..b09e40d06ce 100644 --- a/extensions/idp/configuration.md +++ b/extensions/idp/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T07:12:51+0000" +date: "2021-06-29T07:14:35+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/idp/templates @@ -35,125 +35,215 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### idp version +### idp server -Print the versions of the running instances +Start integrated server -Usage: `idp version [command options] [arguments...]` +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: `flags.OverrideDefaultString(cfg.File, "")`. +-tracing-enabled | $IDP_TRACING_ENABLED +: Enable sending traces. +-tracing-type | $IDP_TRACING_TYPE +: Tracing backend type. Default: `flags.OverrideDefaultString(cfg.Tracing.Type, "jaeger")`. +-tracing-endpoint | $IDP_TRACING_ENDPOINT +: Endpoint for the agent. Default: `flags.OverrideDefaultString(cfg.Tracing.Endpoint, "")`. +-tracing-collector | $IDP_TRACING_COLLECTOR +: Endpoint for the collector. Default: `flags.OverrideDefaultString(cfg.Tracing.Collector, "")`. +-tracing-service | $IDP_TRACING_SERVICE +: Service name for tracing. Default: `flags.OverrideDefaultString(cfg.Tracing.Service, "idp")`. +-debug-addr | $IDP_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9134")`. +-debug-token | $IDP_DEBUG_TOKEN +: Token to grant metrics access. Default: `flags.OverrideDefaultString(cfg.Debug.Token, "")`. +-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: `flags.OverrideDefaultString(cfg.HTTP.Addr, "0.0.0.0:9130")`. +-http-root | $IDP_HTTP_ROOT +: Root path of http server. Default: `flags.OverrideDefaultString(cfg.HTTP.Root, "/")`. +-http-namespace | $IDP_HTTP_NAMESPACE +: Set the base namespace for service discovery. Default: `flags.OverrideDefaultString(cfg.Service.Namespace, "com.owncloud.web")`. +-name | $IDP_NAME +: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "idp")`. +-identity-manager | $IDP_IDENTITY_MANAGER +: Identity manager (one of ldap,kc,cookie,dummy). Default: `flags.OverrideDefaultString(cfg.IDP.IdentityManager, "ldap")`. +-ldap-uri | $IDP_LDAP_URI +: URI of the LDAP server (glauth). Default: `flags.OverrideDefaultString(cfg.Ldap.URI, "ldap://localhost:9125")`. +-ldap-bind-dn | $IDP_LDAP_BIND_DN +: Bind DN for the LDAP server (glauth). Default: `flags.OverrideDefaultString(cfg.Ldap.BindDN, "cn=idp,ou=sysusers,dc=example,dc=org")`. +-ldap-bind-password | $IDP_LDAP_BIND_PASSWORD +: Password for the Bind DN of the LDAP server (glauth). Default: `flags.OverrideDefaultString(cfg.Ldap.BindPassword, "idp")`. +-ldap-base-dn | $IDP_LDAP_BASE_DN +: LDAP base DN of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.BaseDN, "ou=users,dc=example,dc=org")`. +-ldap-scope | $IDP_LDAP_SCOPE +: LDAP scope of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.Scope, "sub")`. +-ldap-login-attribute | $IDP_LDAP_LOGIN_ATTRIBUTE +: LDAP login attribute of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.LoginAttribute, "cn")`. +-ldap-email-attribute | $IDP_LDAP_EMAIL_ATTRIBUTE +: LDAP email attribute of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.EmailAttribute, "mail")`. +-ldap-name-attribute | $IDP_LDAP_NAME_ATTRIBUTE +: LDAP name attribute of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.NameAttribute, "sn")`. --http-namespace | $IDP_HTTP_NAMESPACE -: Set the base namespace for service discovery. Default: `flags.OverrideDefaultString(cfg.Service.Namespace, "com.owncloud.web")`. +-ldap-uuid-attribute | $IDP_LDAP_UUID_ATTRIBUTE +: LDAP UUID attribute of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.UUIDAttribute, "uid")`. --name | $IDP_NAME -: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "idp")`. +-ldap-uuid-attribute-type | $IDP_LDAP_UUID_ATTRIBUTE_TYPE +: LDAP UUID attribute type of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.UUIDAttributeType, "text")`. -### idp health -Check health status +-ldap-filter | $IDP_LDAP_FILTER +: LDAP filter of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.Filter, "(objectClass=posixaccount)")`. -Usage: `idp health [command options] [arguments...]` +-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"))`. --debug-addr | $IDP_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9134")`. +-iss | $IDP_ISS , $OCIS_URL +: OIDC issuer URL. Default: `flags.OverrideDefaultString(cfg.IDP.Iss, "https://localhost:9200")`. +-signing-kid | $IDP_SIGNING_KID +: Value of kid field to use in created tokens (uniquely identifying the signing-private-key). Default: `flags.OverrideDefaultString(cfg.IDP.SigningKid, "")`. +-validation-keys-path | $IDP_VALIDATION_KEYS_PATH +: Full path to a folder containg PEM encoded private or public key files used for token validaton (file name without extension is used as kid). Default: `flags.OverrideDefaultString(cfg.IDP.ValidationKeysPath, "")`. +-encryption-secret | $IDP_ENCRYPTION_SECRET +: Full path to a file containing a %d bytes secret key. Default: `flags.OverrideDefaultString(cfg.IDP.EncryptionSecretFile, "")`. +-signing-method | $IDP_SIGNING_METHOD +: JWT default signing method. Default: `flags.OverrideDefaultString(cfg.IDP.SigningMethod, "PS256")`. +-uri-base-path | $IDP_URI_BASE_PATH +: Custom base path for URI endpoints. Default: `flags.OverrideDefaultString(cfg.IDP.URIBasePath, "")`. +-sign-in-uri | $IDP_SIGN_IN_URI +: Custom redirection URI to sign-in form. Default: `flags.OverrideDefaultString(cfg.IDP.SignInURI, "")`. +-signed-out-uri | $IDP_SIGN_OUT_URI +: Custom redirection URI to signed-out goodbye page. Default: `flags.OverrideDefaultString(cfg.IDP.SignedOutURI, "")`. +-authorization-endpoint-uri | $IDP_ENDPOINT_URI +: Custom authorization endpoint URI. Default: `flags.OverrideDefaultString(cfg.IDP.AuthorizationEndpointURI, "")`. +-endsession-endpoint-uri | $IDP_ENDSESSION_ENDPOINT_URI +: Custom endsession endpoint URI. Default: `flags.OverrideDefaultString(cfg.IDP.EndsessionEndpointURI, "")`. +-asset-path | $IDP_ASSET_PATH +: Path to custom assets. Default: `flags.OverrideDefaultString(cfg.Asset.Path, "")`. +-identifier-client-path | $IDP_IDENTIFIER_CLIENT_PATH +: Path to the identifier web client base folder. Default: `flags.OverrideDefaultString(cfg.IDP.IdentifierClientPath, "/var/tmp/ocis/idp")`. +-identifier-registration-conf | $IDP_IDENTIFIER_REGISTRATION_CONF +: Path to a identifier-registration.yaml configuration file. Default: `flags.OverrideDefaultString(cfg.IDP.IdentifierRegistrationConf, "./config/identifier-registration.yaml")`. +-identifier-scopes-conf | $IDP_IDENTIFIER_SCOPES_CONF +: Path to a scopes.yaml configuration file. Default: `flags.OverrideDefaultString(cfg.IDP.IdentifierScopesConf, "")`. +-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: `flags.OverrideDefaultBool(cfg.HTTP.TLS, false)`. +-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: `flags.OverrideDefaultBool(cfg.IDP.AllowDynamicClientRegistration, false)`. +-disable-identifier-webapp | $IDP_DISABLE_IDENTIFIER_WEBAPP +: Disable built-in identifier-webapp to use a frontend hosted elsewhere.. Default: `flags.OverrideDefaultBool(cfg.IDP.IdentifierClientDisabled, true)`. +### idp version +Print the versions of the running instances +Usage: `idp version [command options] [arguments...]` @@ -164,23 +254,14 @@ Usage: `idp health [command options] [arguments...]` -### idp ocis-idp -Serve IDP API for oCIS -Usage: `idp ocis-idp [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. @@ -217,223 +298,142 @@ Usage: `idp ocis-idp [command options] [arguments...]` +-http-namespace | $IDP_HTTP_NAMESPACE +: Set the base namespace for service discovery. Default: `flags.OverrideDefaultString(cfg.Service.Namespace, "com.owncloud.web")`. +-name | $IDP_NAME +: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "idp")`. +### idp health +Check health status +Usage: `idp health [command options] [arguments...]` +-debug-addr | $IDP_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9134")`. -### 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: `flags.OverrideDefaultString(cfg.File, "")`. --tracing-enabled | $IDP_TRACING_ENABLED -: Enable sending traces. --tracing-type | $IDP_TRACING_TYPE -: Tracing backend type. Default: `flags.OverrideDefaultString(cfg.Tracing.Type, "jaeger")`. --tracing-endpoint | $IDP_TRACING_ENDPOINT -: Endpoint for the agent. Default: `flags.OverrideDefaultString(cfg.Tracing.Endpoint, "")`. --tracing-collector | $IDP_TRACING_COLLECTOR -: Endpoint for the collector. Default: `flags.OverrideDefaultString(cfg.Tracing.Collector, "")`. --tracing-service | $IDP_TRACING_SERVICE -: Service name for tracing. Default: `flags.OverrideDefaultString(cfg.Tracing.Service, "idp")`. --debug-addr | $IDP_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9134")`. --debug-token | $IDP_DEBUG_TOKEN -: Token to grant metrics access. Default: `flags.OverrideDefaultString(cfg.Debug.Token, "")`. --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: `flags.OverrideDefaultString(cfg.HTTP.Addr, "0.0.0.0:9130")`. --http-root | $IDP_HTTP_ROOT -: Root path of http server. Default: `flags.OverrideDefaultString(cfg.HTTP.Root, "/")`. --http-namespace | $IDP_HTTP_NAMESPACE -: Set the base namespace for service discovery. Default: `flags.OverrideDefaultString(cfg.Service.Namespace, "com.owncloud.web")`. --name | $IDP_NAME -: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "idp")`. --identity-manager | $IDP_IDENTITY_MANAGER -: Identity manager (one of ldap,kc,cookie,dummy). Default: `flags.OverrideDefaultString(cfg.IDP.IdentityManager, "ldap")`. --ldap-uri | $IDP_LDAP_URI -: URI of the LDAP server (glauth). Default: `flags.OverrideDefaultString(cfg.Ldap.URI, "ldap://localhost:9125")`. --ldap-bind-dn | $IDP_LDAP_BIND_DN -: Bind DN for the LDAP server (glauth). Default: `flags.OverrideDefaultString(cfg.Ldap.BindDN, "cn=idp,ou=sysusers,dc=example,dc=org")`. --ldap-bind-password | $IDP_LDAP_BIND_PASSWORD -: Password for the Bind DN of the LDAP server (glauth). Default: `flags.OverrideDefaultString(cfg.Ldap.BindPassword, "idp")`. +### idp ocis-idp --ldap-base-dn | $IDP_LDAP_BASE_DN -: LDAP base DN of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.BaseDN, "ou=users,dc=example,dc=org")`. +Serve IDP API for oCIS +Usage: `idp ocis-idp [command options] [arguments...]` --ldap-scope | $IDP_LDAP_SCOPE -: LDAP scope of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.Scope, "sub")`. +-log-level | $IDP_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. --ldap-login-attribute | $IDP_LDAP_LOGIN_ATTRIBUTE -: LDAP login attribute of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.LoginAttribute, "cn")`. +-log-pretty | $IDP_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. --ldap-email-attribute | $IDP_LDAP_EMAIL_ATTRIBUTE -: LDAP email attribute of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.EmailAttribute, "mail")`. +-log-color | $IDP_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. --ldap-name-attribute | $IDP_LDAP_NAME_ATTRIBUTE -: LDAP name attribute of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.NameAttribute, "sn")`. --ldap-uuid-attribute | $IDP_LDAP_UUID_ATTRIBUTE -: LDAP UUID attribute of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.UUIDAttribute, "uid")`. --ldap-uuid-attribute-type | $IDP_LDAP_UUID_ATTRIBUTE_TYPE -: LDAP UUID attribute type of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.UUIDAttributeType, "text")`. --ldap-filter | $IDP_LDAP_FILTER -: LDAP filter of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.Filter, "(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: `flags.OverrideDefaultString(cfg.IDP.Iss, "https://localhost:9200")`. --signing-kid | $IDP_SIGNING_KID -: Value of kid field to use in created tokens (uniquely identifying the signing-private-key). Default: `flags.OverrideDefaultString(cfg.IDP.SigningKid, "")`. --validation-keys-path | $IDP_VALIDATION_KEYS_PATH -: Full path to a folder containg PEM encoded private or public key files used for token validaton (file name without extension is used as kid). Default: `flags.OverrideDefaultString(cfg.IDP.ValidationKeysPath, "")`. --encryption-secret | $IDP_ENCRYPTION_SECRET -: Full path to a file containing a %d bytes secret key. Default: `flags.OverrideDefaultString(cfg.IDP.EncryptionSecretFile, "")`. --signing-method | $IDP_SIGNING_METHOD -: JWT default signing method. Default: `flags.OverrideDefaultString(cfg.IDP.SigningMethod, "PS256")`. --uri-base-path | $IDP_URI_BASE_PATH -: Custom base path for URI endpoints. Default: `flags.OverrideDefaultString(cfg.IDP.URIBasePath, "")`. --sign-in-uri | $IDP_SIGN_IN_URI -: Custom redirection URI to sign-in form. Default: `flags.OverrideDefaultString(cfg.IDP.SignInURI, "")`. --signed-out-uri | $IDP_SIGN_OUT_URI -: Custom redirection URI to signed-out goodbye page. Default: `flags.OverrideDefaultString(cfg.IDP.SignedOutURI, "")`. --authorization-endpoint-uri | $IDP_ENDPOINT_URI -: Custom authorization endpoint URI. Default: `flags.OverrideDefaultString(cfg.IDP.AuthorizationEndpointURI, "")`. --endsession-endpoint-uri | $IDP_ENDSESSION_ENDPOINT_URI -: Custom endsession endpoint URI. Default: `flags.OverrideDefaultString(cfg.IDP.EndsessionEndpointURI, "")`. --asset-path | $IDP_ASSET_PATH -: Path to custom assets. Default: `flags.OverrideDefaultString(cfg.Asset.Path, "")`. --identifier-client-path | $IDP_IDENTIFIER_CLIENT_PATH -: Path to the identifier web client base folder. Default: `flags.OverrideDefaultString(cfg.IDP.IdentifierClientPath, "/var/tmp/ocis/idp")`. --identifier-registration-conf | $IDP_IDENTIFIER_REGISTRATION_CONF -: Path to a identifier-registration.yaml configuration file. Default: `flags.OverrideDefaultString(cfg.IDP.IdentifierRegistrationConf, "./config/identifier-registration.yaml")`. --identifier-scopes-conf | $IDP_IDENTIFIER_SCOPES_CONF -: Path to a scopes.yaml configuration file. Default: `flags.OverrideDefaultString(cfg.IDP.IdentifierScopesConf, "")`. --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: `flags.OverrideDefaultBool(cfg.HTTP.TLS, false)`. --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: `flags.OverrideDefaultBool(cfg.IDP.AllowDynamicClientRegistration, false)`. --disable-identifier-webapp | $IDP_DISABLE_IDENTIFIER_WEBAPP -: Disable built-in identifier-webapp to use a frontend hosted elsewhere.. Default: `flags.OverrideDefaultBool(cfg.IDP.IdentifierClientDisabled, true)`. diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index 4c56bcaf822..ea9d4125870 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T07:12:51+0000" +date: "2021-06-29T07:14:35+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/templates diff --git a/extensions/onlyoffice/configuration.md b/extensions/onlyoffice/configuration.md index 256317ebdbb..49930dcbfe1 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T07:12:51+0000" +date: "2021-06-29T07:14:35+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/onlyoffice/templates @@ -78,6 +78,34 @@ Usage: `onlyoffice [global options] command [command options] [arguments...]` ## Sub Commands +### onlyoffice health + +Check health status + +Usage: `onlyoffice health [command options] [arguments...]` + + + + + + +-debug-addr | $ONLYOFFICE_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9224")`. + + + + + + + + + + + + + + + ### onlyoffice server Start integrated server @@ -145,31 +173,3 @@ Usage: `onlyoffice server [command options] [arguments...]` -asset-path | $ONLYOFFICE_ASSET_PATH : Path to custom assets. Default: `flags.OverrideDefaultString(cfg.Asset.Path, "")`. -### onlyoffice health - -Check health status - -Usage: `onlyoffice health [command options] [arguments...]` - - - - - - --debug-addr | $ONLYOFFICE_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9224")`. - - - - - - - - - - - - - - - diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index d0a707a8d67..1bdb1661c81 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T07:12:51+0000" +date: "2021-06-29T07:14:35+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 0885bde2019..a4eb0be51f8 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T07:12:51+0000" +date: "2021-06-29T07:14:35+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/settings/templates @@ -35,43 +35,6 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### settings version - -Print the versions of the running instances - -Usage: `settings version [command options] [arguments...]` - - - - - - - - - - - - - - - - - - - - - - - - - --grpc-namespace | $SETTINGS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. - - --name | $SETTINGS_NAME -: service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "settings")`. - ### settings health Check health status @@ -234,3 +197,40 @@ Usage: `settings server [command options] [arguments...]` +### settings version + +Print the versions of the running instances + +Usage: `settings version [command options] [arguments...]` + + + + + + + + + + + + + + + + + + + + + + + + + +-grpc-namespace | $SETTINGS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. + + +-name | $SETTINGS_NAME +: service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "settings")`. + diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index c4e4199c027..0736119690f 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T07:12:52+0000" +date: "2021-06-29T07:14:35+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -97,12 +97,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. @@ -122,20 +130,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. @@ -269,11 +269,11 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage health +### storage frontend -Check health status +Start frontend service -Usage: `storage health [command options] [arguments...]` +Usage: `storage frontend [command options] [arguments...]` @@ -288,40 +288,70 @@ Usage: `storage health [command options] [arguments...]` --debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9109")`. +-debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.DebugAddr, "0.0.0.0:9141")`. +-transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `flags.OverrideDefaultString(cfg.Reva.TransferSecret, "replace-me-with-a-transfer-secret")`. +-webdav-namespace | $STORAGE_WEBDAV_NAMESPACE +: Namespace prefix for the /webdav endpoint. Default: `flags.OverrideDefaultString(cfg.Reva.OCDav.WebdavNamespace, "/home/")`. +-dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE +: Namespace prefix for the webdav /dav/files endpoint. Default: `flags.OverrideDefaultString(cfg.Reva.OCDav.DavFilesNamespace, "/users/")`. +-network | $STORAGE_FRONTEND_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.HTTPNetwork, "tcp")`. +-addr | $STORAGE_FRONTEND_HTTP_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.HTTPAddr, "0.0.0.0:9140")`. +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.PublicURL, "https://localhost:9200")`. +-datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX +: datagateway prefix. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.DatagatewayPrefix, "data")`. +-ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX +: owncloud webdav endpoint prefix. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCDavPrefix, "")`. +-ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX +: open collaboration services endpoint prefix. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCSPrefix, "ocs")`. +-ocs-share-prefix | $STORAGE_FRONTEND_OCS_SHARE_PREFIX +: the prefix prepended to the path of shared files. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCSSharePrefix, "/Shares")`. +-ocs-home-namespace | $STORAGE_FRONTEND_OCS_HOME_NAMESPACE +: the prefix prepended to the incoming requests in OCS. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCSHomeNamespace, "/home")`. +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. +-default-upload-protocol | $STORAGE_FRONTEND_DEFAULT_UPLOAD_PROTOCOL +: Default upload chunking protocol to be used out of tus/v1/ng. Default: `flags.OverrideDefaultString(cfg.Reva.DefaultUploadProtocol, "tus")`. +-upload-http-method-override | $STORAGE_FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE +: Specify an HTTP method (ex: POST) that clients should to use when uploading instead of PATCH. Default: `flags.OverrideDefaultString(cfg.Reva.UploadHTTPMethodOverride, "")`. +-checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE +: Specify the preferred checksum algorithm used for uploads. Default: `flags.OverrideDefaultString(cfg.Reva.ChecksumPreferredUploadType, "")`. @@ -492,11 +522,8 @@ Usage: `storage health [command options] [arguments...]` -### storage sharing -Start sharing service -Usage: `storage sharing [command options] [arguments...]` @@ -510,39 +537,26 @@ Usage: `storage sharing [command options] [arguments...]` +### storage groups +Start groups service +Usage: `storage groups [command options] [arguments...]` --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.DebugAddr, "0.0.0.0:9151")`. --network | $STORAGE_SHARING_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.GRPCNetwork, "tcp")`. --addr | $STORAGE_SHARING_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.GRPCAddr, "0.0.0.0:9150")`. --user-driver | $STORAGE_SHARING_USER_DRIVER -: driver to use for the UserShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.UserDriver, "json")`. --user-json-file | $STORAGE_SHARING_USER_JSON_FILE -: file used to persist shares for the UserShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.UserJSONFile, "/var/tmp/ocis/storage/shares.json")`. --public-driver | $STORAGE_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.PublicDriver, "json")`. --public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE -: file used to persist shares for the PublicShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.PublicJSONFile, "/var/tmp/ocis/storage/publicshares.json")`. --public-enable-expired-shares-cleanup | $STORAGE_SHARING_PUBLIC_ENABLE_EXPIRED_SHARES_CLEANUP -: whether to periodically delete expired public shares. Default: `flags.OverrideDefaultBool(cfg.Reva.Sharing.PublicEnableExpiredSharesCleanup, true)`. @@ -730,19 +744,28 @@ Usage: `storage sharing [command options] [arguments...]` +-debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.DebugAddr, "0.0.0.0:9161")`. +-network | $STORAGE_GROUPPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.GRPCNetwork, "tcp")`. +-addr | $STORAGE_GROUPPROVIDER_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.GRPCAddr, "0.0.0.0:9160")`. -### storage storage-public-link +-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Endpoint, "localhost:9160")`. -Start storage-public-link service -Usage: `storage storage-public-link [command options] [arguments...]` +-driver | $STORAGE_GROUPPROVIDER_DRIVER +: group driver: 'json', 'ldap', or 'rest'. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Driver, "ldap")`. +-json-config | $STORAGE_GROUPPROVIDER_JSON +: Path to groups.json file. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.JSON, "")`. @@ -752,8 +775,11 @@ Usage: `storage storage-public-link [command options] [arguments...]` +### storage sharing +Start sharing service +Usage: `storage sharing [command options] [arguments...]` @@ -952,46 +978,52 @@ Usage: `storage storage-public-link [command options] [arguments...]` --debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.DebugAddr, "0.0.0.0:9179")`. --network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.GRPCNetwork, "tcp")`. --addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.GRPCAddr, "0.0.0.0:9178")`. --mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.MountPath, "/public")`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. -### storage frontend -Start frontend service +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.DebugAddr, "0.0.0.0:9151")`. -Usage: `storage frontend [command options] [arguments...]` +-network | $STORAGE_SHARING_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.GRPCNetwork, "tcp")`. +-addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.GRPCAddr, "0.0.0.0:9150")`. +-user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.UserDriver, "json")`. +-user-json-file | $STORAGE_SHARING_USER_JSON_FILE +: file used to persist shares for the UserShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.UserJSONFile, "/var/tmp/ocis/storage/shares.json")`. +-public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.PublicDriver, "json")`. +-public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE +: file used to persist shares for the PublicShareProvider. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.PublicJSONFile, "/var/tmp/ocis/storage/publicshares.json")`. +-public-enable-expired-shares-cleanup | $STORAGE_SHARING_PUBLIC_ENABLE_EXPIRED_SHARES_CLEANUP +: whether to periodically delete expired public shares. Default: `flags.OverrideDefaultBool(cfg.Reva.Sharing.PublicEnableExpiredSharesCleanup, true)`. +### storage auth-basic +Start authprovider for basic auth +Usage: `storage auth-basic [command options] [arguments...]` @@ -1033,68 +1065,36 @@ Usage: `storage frontend [command options] [arguments...]` --debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.DebugAddr, "0.0.0.0:9141")`. --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `flags.OverrideDefaultString(cfg.Reva.TransferSecret, "replace-me-with-a-transfer-secret")`. --webdav-namespace | $STORAGE_WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `flags.OverrideDefaultString(cfg.Reva.OCDav.WebdavNamespace, "/home/")`. --dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `flags.OverrideDefaultString(cfg.Reva.OCDav.DavFilesNamespace, "/users/")`. --network | $STORAGE_FRONTEND_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.HTTPNetwork, "tcp")`. --addr | $STORAGE_FRONTEND_HTTP_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.HTTPAddr, "0.0.0.0:9140")`. --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.PublicURL, "https://localhost:9200")`. --datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.DatagatewayPrefix, "data")`. --ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCDavPrefix, "")`. --ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX -: open collaboration services endpoint prefix. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCSPrefix, "ocs")`. --ocs-share-prefix | $STORAGE_FRONTEND_OCS_SHARE_PREFIX -: the prefix prepended to the path of shared files. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCSSharePrefix, "/Shares")`. --ocs-home-namespace | $STORAGE_FRONTEND_OCS_HOME_NAMESPACE -: the prefix prepended to the incoming requests in OCS. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.OCSHomeNamespace, "/home")`. --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. --default-upload-protocol | $STORAGE_FRONTEND_DEFAULT_UPLOAD_PROTOCOL -: Default upload chunking protocol to be used out of tus/v1/ng. Default: `flags.OverrideDefaultString(cfg.Reva.DefaultUploadProtocol, "tus")`. --upload-http-method-override | $STORAGE_FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE -: Specify an HTTP method (ex: POST) that clients should to use when uploading instead of PATCH. Default: `flags.OverrideDefaultString(cfg.Reva.UploadHTTPMethodOverride, "")`. --checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE -: Specify the preferred checksum algorithm used for uploads. Default: `flags.OverrideDefaultString(cfg.Reva.ChecksumPreferredUploadType, "")`. @@ -1213,16 +1213,28 @@ Usage: `storage frontend [command options] [arguments...]` +-debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.DebugAddr, "0.0.0.0:9147")`. +-auth-driver | $STORAGE_AUTH_DRIVER +: auth driver: 'demo', 'json' or 'ldap'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthProvider.Driver, "ldap")`. +-auth-json | $STORAGE_AUTH_JSON +: Path to users.json file. Default: `flags.OverrideDefaultString(cfg.Reva.AuthProvider.JSON, "")`. +-network | $STORAGE_AUTH_BASIC_GRPC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.GRPCNetwork, "tcp")`. +-addr | $STORAGE_AUTH_BASIC_GRPC_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.GRPCAddr, "0.0.0.0:9146")`. +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. @@ -1239,17 +1251,17 @@ Usage: `storage frontend [command options] [arguments...]` -### storage gateway -Start gateway -Usage: `storage gateway [command options] [arguments...]` +### storage auth-bearer +Start authprovider for bearer auth +Usage: `storage auth-bearer [command options] [arguments...]` @@ -1318,22 +1330,40 @@ Usage: `storage gateway [command options] [arguments...]` +-debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.DebugAddr, "0.0.0.0:9149")`. +-oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL +: OIDC issuer. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.Issuer, "https://localhost:9200")`. +-oidc-insecure | $STORAGE_OIDC_INSECURE +: OIDC allow insecure communication. Default: `flags.OverrideDefaultBool(cfg.Reva.OIDC.Insecure, true)`. +-oidc-id-claim | $STORAGE_OIDC_ID_CLAIM +: OIDC id claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.IDClaim, "preferred_username")`. +-oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM +: OIDC uid claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.UIDClaim, "")`. +-oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM +: OIDC gid claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.GIDClaim, "")`. +-network | $STORAGE_AUTH_BEARER_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.GRPCNetwork, "tcp")`. +-addr | $STORAGE_AUTH_BEARER_GRPC_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.GRPCAddr, "0.0.0.0:9148")`. +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. @@ -1401,116 +1431,60 @@ Usage: `storage gateway [command options] [arguments...]` --debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.DebugAddr, "0.0.0.0:9143")`. --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `flags.OverrideDefaultString(cfg.Reva.TransferSecret, "replace-me-with-a-transfer-secret")`. --network | $STORAGE_GATEWAY_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.GRPCNetwork, "tcp")`. --addr | $STORAGE_GATEWAY_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.GRPCAddr, "0.0.0.0:9142")`. --endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. --commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT -: Commit shares to the share manager. Default: `flags.OverrideDefaultBool(cfg.Reva.Gateway.CommitShareToStorageGrant, true)`. --commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF -: Commit shares to the storage. Default: `flags.OverrideDefaultBool(cfg.Reva.Gateway.CommitShareToStorageRef, true)`. --share-folder | $STORAGE_GATEWAY_SHARE_FOLDER -: mount shares in this folder of the home storage provider. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.ShareFolder, "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: `flags.OverrideDefaultString(cfg.Reva.Gateway.HomeMapping, "")`. --auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT -: endpoint to use for the basic auth provider. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.Endpoint, "localhost:9146")`. --auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT -: endpoint to use for the bearer auth provider. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.Endpoint, "localhost:9148")`. --storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER -: driver of the storage registry. Default: `flags.OverrideDefaultString(cfg.Reva.StorageRegistry.Driver, "static")`. --storage-home-provider | $STORAGE_STORAGE_REGISTRY_HOME_PROVIDER -: mount point of the storage provider for user homes in the global namespace. Default: `flags.OverrideDefaultString(cfg.Reva.StorageRegistry.HomeProvider, "/home")`. --storage-registry-json | $STORAGE_STORAGE_REGISTRY_JSON -: JSON file containing the storage registry rules. Default: `flags.OverrideDefaultString(cfg.Reva.StorageRegistry.JSON, "")`. --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.PublicURL, "https://localhost:9200")`. --datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL -: URL to use for the storage datagateway, defaults to /data. Default: `flags.OverrideDefaultString(cfg.Reva.DataGateway.PublicURL, "")`. --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. --groupprovider-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: endpoint to use for the groupprovider. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Endpoint, "localhost:9160")`. --sharing-endpoint | $STORAGE_SHARING_ENDPOINT -: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.Endpoint, "localhost:9150")`. --storage-home-endpoint | $STORAGE_HOME_ENDPOINT -: endpoint to use for the home storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.Endpoint, "localhost:9154")`. --storage-home-mount-path | $STORAGE_HOME_MOUNT_PATH -: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountPath, "/home")`. --storage-home-mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountID, "1284d238-aa92-42ce-bdc4-0b0000009154")`. --storage-users-endpoint | $STORAGE_USERS_ENDPOINT -: endpoint to use for the users storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.Endpoint, "localhost:9157")`. --storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH -: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountPath, "/users")`. --storage-users-mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountID, "1284d238-aa92-42ce-bdc4-0b0000009157")`. --public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT -: endpoint to use for the public links service. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.Endpoint, "localhost:9178")`. --storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.MountPath, "/public")`. @@ -1530,8 +1504,11 @@ Usage: `storage gateway [command options] [arguments...]` +### storage storage-home +Start storage-home service +Usage: `storage storage-home [command options] [arguments...]` @@ -1543,11 +1520,8 @@ Usage: `storage gateway [command options] [arguments...]` -### storage storage-home -Start storage-home service -Usage: `storage storage-home [command options] [arguments...]` @@ -1638,64 +1612,34 @@ Usage: `storage storage-home [command options] [arguments...]` --debug-addr | $STORAGE_HOME_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.DebugAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageHome.GRPCNetwork, "tcp")`. --grpc-addr | $STORAGE_HOME_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.GRPCAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPNetwork, "tcp")`. --http-addr | $STORAGE_HOME_HTTP_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPAddr, "0.0.0.0:9155")`. --driver | $STORAGE_HOME_DRIVER -: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.Driver, "ocis")`. --mount-path | $STORAGE_HOME_MOUNT_PATH -: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountPath, "/home")`. --mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountID, "1284d238-aa92-42ce-bdc4-0b0000009157")`. --expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `flags.OverrideDefaultBool(cfg.Reva.StorageHome.ExposeDataServer, false)`. --data-server-url | $STORAGE_HOME_DATA_SERVER_URL -: data server url. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.DataServerURL, "http://localhost:9155/data")`. --http-prefix | $STORAGE_HOME_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPPrefix, "data")`. --tmp-folder | $STORAGE_HOME_TMP_FOLDER -: path to tmp folder. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.TempFolder, "/var/tmp/ocis/tmp/home")`. --enable-home | $STORAGE_HOME_ENABLE_HOME -: enable the creation of home directories. Default: `flags.OverrideDefaultBool(cfg.Reva.Storages.Home.EnableHome, true)`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. @@ -1739,34 +1683,64 @@ Usage: `storage storage-home [command options] [arguments...]` +-debug-addr | $STORAGE_HOME_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.DebugAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageHome.GRPCNetwork, "tcp")`. +-grpc-addr | $STORAGE_HOME_GRPC_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.GRPCAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPNetwork, "tcp")`. +-http-addr | $STORAGE_HOME_HTTP_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPAddr, "0.0.0.0:9155")`. +-driver | $STORAGE_HOME_DRIVER +: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.Driver, "ocis")`. +-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountPath, "/home")`. +-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountID, "1284d238-aa92-42ce-bdc4-0b0000009157")`. +-expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `flags.OverrideDefaultBool(cfg.Reva.StorageHome.ExposeDataServer, false)`. +-data-server-url | $STORAGE_HOME_DATA_SERVER_URL +: data server url. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.DataServerURL, "http://localhost:9155/data")`. +-http-prefix | $STORAGE_HOME_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPPrefix, "data")`. +-tmp-folder | $STORAGE_HOME_TMP_FOLDER +: path to tmp folder. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.TempFolder, "/var/tmp/ocis/tmp/home")`. +-enable-home | $STORAGE_HOME_ENABLE_HOME +: enable the creation of home directories. Default: `flags.OverrideDefaultBool(cfg.Reva.Storages.Home.EnableHome, true)`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. @@ -1795,8 +1769,11 @@ Usage: `storage storage-home [command options] [arguments...]` +### storage storage-metadata +Start storage-metadata service +Usage: `storage storage-metadata [command options] [arguments...]` @@ -1808,11 +1785,8 @@ Usage: `storage storage-home [command options] [arguments...]` -### storage users -Start users service -Usage: `storage users [command options] [arguments...]` @@ -1846,34 +1820,64 @@ Usage: `storage users [command options] [arguments...]` +-debug-addr | $STORAGE_METADATA_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.DebugAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.GRPCNetwork, "tcp")`. +-grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.GRPCAddr, "0.0.0.0:9215")`. +-data-server-url | $STORAGE_METADATA_DATA_SERVER_URL +: URL of the data-provider the storage-provider uses. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.DataServerURL, "http://localhost:9216")`. +-http-network | $STORAGE_METADATA_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.HTTPNetwork, "tcp")`. +-http-addr | $STORAGE_METADATA_HTTP_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.HTTPAddr, "0.0.0.0:9216")`. +-tmp-folder | $STORAGE_METADATA_TMP_FOLDER +: path to tmp folder. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.TempFolder, "/var/tmp/ocis/tmp/metadata")`. +-driver | $STORAGE_METADATA_DRIVER +: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.Driver, "ocis")`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. +-storage-root | $STORAGE_METADATA_ROOT +: the path to the metadata storage root. Default: `flags.OverrideDefaultString(cfg.Reva.Storages.Common.Root, "/var/tmp/ocis/storage/metadata")`. +-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. @@ -1918,28 +1922,16 @@ Usage: `storage users [command options] [arguments...]` --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Users.DebugAddr, "0.0.0.0:9145")`. --network | $STORAGE_USERPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Users.GRPCNetwork, "tcp")`. --addr | $STORAGE_USERPROVIDER_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.GRPCAddr, "0.0.0.0:9144")`. --endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. --driver | $STORAGE_USERPROVIDER_DRIVER -: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Driver, "ldap")`. --json-config | $STORAGE_USERPROVIDER_JSON -: Path to users.json file. Default: `flags.OverrideDefaultString(cfg.Reva.Users.JSON, "")`. @@ -2042,39 +2034,27 @@ Usage: `storage users [command options] [arguments...]` +### storage storage-public-link +Start storage-public-link service +Usage: `storage storage-public-link [command options] [arguments...]` -### storage auth-basic -Start authprovider for basic auth -Usage: `storage auth-basic [command options] [arguments...]` --debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.DebugAddr, "0.0.0.0:9147")`. --auth-driver | $STORAGE_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthProvider.Driver, "ldap")`. --auth-json | $STORAGE_AUTH_JSON -: Path to users.json file. Default: `flags.OverrideDefaultString(cfg.Reva.AuthProvider.JSON, "")`. --network | $STORAGE_AUTH_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.GRPCNetwork, "tcp")`. --addr | $STORAGE_AUTH_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.GRPCAddr, "0.0.0.0:9146")`. --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. @@ -2223,14 +2203,24 @@ Usage: `storage auth-basic [command options] [arguments...]` +-debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.DebugAddr, "0.0.0.0:9179")`. +-network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.GRPCNetwork, "tcp")`. +-addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.GRPCAddr, "0.0.0.0:9178")`. +-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.MountPath, "/public")`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. @@ -2279,39 +2269,67 @@ Usage: `storage auth-basic [command options] [arguments...]` +### storage storage-users +Start storage-users service +Usage: `storage storage-users [command options] [arguments...]` +-debug-addr | $STORAGE_USERS_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.DebugAddr, "0.0.0.0:9159")`. -### storage storage -Storage service for oCIS +-grpc-network | $STORAGE_USERS_GRPC_NETWORK +: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.GRPCNetwork, "tcp")`. -Usage: `storage storage [command options] [arguments...]` +-grpc-addr | $STORAGE_USERS_GRPC_ADDR +: GRPC Address to bind users storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.GRPCAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.HTTPNetwork, "tcp")`. +-http-addr | $STORAGE_USERS_HTTP_ADDR +: HTTP Address to bind users storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.HTTPAddr, "0.0.0.0:9158")`. +-driver | $STORAGE_USERS_DRIVER +: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.Driver, "ocis")`. +-mount-path | $STORAGE_USERS_MOUNT_PATH +: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountPath, "/users")`. +-mount-id | $STORAGE_USERS_MOUNT_ID +: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountID, "1284d238-aa92-42ce-bdc4-0b0000009157")`. +-expose-data-server | $STORAGE_USERS_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `flags.OverrideDefaultBool(cfg.Reva.StorageUsers.ExposeDataServer, false)`. +-data-server-url | $STORAGE_USERS_DATA_SERVER_URL +: data server url. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.DataServerURL, "http://localhost:9158/data")`. +-http-prefix | $STORAGE_USERS_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.HTTPPrefix, "data")`. +-tmp-folder | $STORAGE_USERS_TMP_FOLDER +: path to tmp folder. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.TempFolder, "/var/tmp/ocis/tmp/users")`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. @@ -2371,20 +2389,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. @@ -2516,16 +2526,16 @@ Usage: `storage storage [command options] [arguments...]` -### storage storage-metadata -Start storage-metadata service -Usage: `storage storage-metadata [command options] [arguments...]` +### storage users +Start users service +Usage: `storage users [command options] [arguments...]` @@ -2545,48 +2555,26 @@ Usage: `storage storage-metadata [command options] [arguments...]` --debug-addr | $STORAGE_METADATA_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.DebugAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.GRPCNetwork, "tcp")`. --grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.GRPCAddr, "0.0.0.0:9215")`. --data-server-url | $STORAGE_METADATA_DATA_SERVER_URL -: URL of the data-provider the storage-provider uses. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.DataServerURL, "http://localhost:9216")`. --http-network | $STORAGE_METADATA_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.HTTPNetwork, "tcp")`. --http-addr | $STORAGE_METADATA_HTTP_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.HTTPAddr, "0.0.0.0:9216")`. --tmp-folder | $STORAGE_METADATA_TMP_FOLDER -: path to tmp folder. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.TempFolder, "/var/tmp/ocis/tmp/metadata")`. --driver | $STORAGE_METADATA_DRIVER -: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.Driver, "ocis")`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. --storage-root | $STORAGE_METADATA_ROOT -: the path to the metadata storage root. Default: `flags.OverrideDefaultString(cfg.Reva.Storages.Common.Root, "/var/tmp/ocis/storage/metadata")`. @@ -2610,16 +2598,28 @@ Usage: `storage storage-metadata [command options] [arguments...]` +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Users.DebugAddr, "0.0.0.0:9145")`. +-network | $STORAGE_USERPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Users.GRPCNetwork, "tcp")`. +-addr | $STORAGE_USERPROVIDER_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.GRPCAddr, "0.0.0.0:9144")`. +-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. +-driver | $STORAGE_USERPROVIDER_DRIVER +: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Driver, "ldap")`. +-json-config | $STORAGE_USERPROVIDER_JSON +: Path to users.json file. Default: `flags.OverrideDefaultString(cfg.Reva.Users.JSON, "")`. @@ -2636,20 +2636,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. @@ -2777,15 +2769,15 @@ Usage: `storage storage-metadata [command options] [arguments...]` +### storage gateway +Start gateway +Usage: `storage gateway [command options] [arguments...]` -### storage storage-users -Start storage-users service -Usage: `storage storage-users [command options] [arguments...]` @@ -2821,60 +2813,32 @@ Usage: `storage storage-users [command options] [arguments...]` --debug-addr | $STORAGE_USERS_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.DebugAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.GRPCNetwork, "tcp")`. --grpc-addr | $STORAGE_USERS_GRPC_ADDR -: GRPC Address to bind users storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.GRPCAddr, "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: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.HTTPNetwork, "tcp")`. --http-addr | $STORAGE_USERS_HTTP_ADDR -: HTTP Address to bind users storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.HTTPAddr, "0.0.0.0:9158")`. --driver | $STORAGE_USERS_DRIVER -: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.Driver, "ocis")`. --mount-path | $STORAGE_USERS_MOUNT_PATH -: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountPath, "/users")`. --mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountID, "1284d238-aa92-42ce-bdc4-0b0000009157")`. --expose-data-server | $STORAGE_USERS_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `flags.OverrideDefaultBool(cfg.Reva.StorageUsers.ExposeDataServer, false)`. --data-server-url | $STORAGE_USERS_DATA_SERVER_URL -: data server url. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.DataServerURL, "http://localhost:9158/data")`. --http-prefix | $STORAGE_USERS_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.HTTPPrefix, "data")`. --tmp-folder | $STORAGE_USERS_TMP_FOLDER -: path to tmp folder. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.TempFolder, "/var/tmp/ocis/tmp/users")`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. @@ -2895,60 +2859,116 @@ Usage: `storage storage-users [command options] [arguments...]` +-debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.DebugAddr, "0.0.0.0:9143")`. +-transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `flags.OverrideDefaultString(cfg.Reva.TransferSecret, "replace-me-with-a-transfer-secret")`. +-network | $STORAGE_GATEWAY_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.GRPCNetwork, "tcp")`. +-addr | $STORAGE_GATEWAY_GRPC_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.GRPCAddr, "0.0.0.0:9142")`. +-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. +-commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT +: Commit shares to the share manager. Default: `flags.OverrideDefaultBool(cfg.Reva.Gateway.CommitShareToStorageGrant, true)`. +-commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF +: Commit shares to the storage. Default: `flags.OverrideDefaultBool(cfg.Reva.Gateway.CommitShareToStorageRef, true)`. +-share-folder | $STORAGE_GATEWAY_SHARE_FOLDER +: mount shares in this folder of the home storage provider. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.ShareFolder, "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: `flags.OverrideDefaultString(cfg.Reva.Gateway.HomeMapping, "")`. +-auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT +: endpoint to use for the basic auth provider. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.Endpoint, "localhost:9146")`. +-auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT +: endpoint to use for the bearer auth provider. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.Endpoint, "localhost:9148")`. +-storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER +: driver of the storage registry. Default: `flags.OverrideDefaultString(cfg.Reva.StorageRegistry.Driver, "static")`. +-storage-home-provider | $STORAGE_STORAGE_REGISTRY_HOME_PROVIDER +: mount point of the storage provider for user homes in the global namespace. Default: `flags.OverrideDefaultString(cfg.Reva.StorageRegistry.HomeProvider, "/home")`. +-storage-registry-json | $STORAGE_STORAGE_REGISTRY_JSON +: JSON file containing the storage registry rules. Default: `flags.OverrideDefaultString(cfg.Reva.StorageRegistry.JSON, "")`. +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.PublicURL, "https://localhost:9200")`. +-datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL +: URL to use for the storage datagateway, defaults to /data. Default: `flags.OverrideDefaultString(cfg.Reva.DataGateway.PublicURL, "")`. +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. +-groupprovider-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: endpoint to use for the groupprovider. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Endpoint, "localhost:9160")`. +-sharing-endpoint | $STORAGE_SHARING_ENDPOINT +: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.Endpoint, "localhost:9150")`. +-storage-home-endpoint | $STORAGE_HOME_ENDPOINT +: endpoint to use for the home storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.Endpoint, "localhost:9154")`. +-storage-home-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountPath, "/home")`. +-storage-home-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountID, "1284d238-aa92-42ce-bdc4-0b0000009154")`. +-storage-users-endpoint | $STORAGE_USERS_ENDPOINT +: endpoint to use for the users storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.Endpoint, "localhost:9157")`. +-storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH +: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountPath, "/users")`. +-storage-users-mount-id | $STORAGE_USERS_MOUNT_ID +: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountID, "1284d238-aa92-42ce-bdc4-0b0000009157")`. +-public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT +: endpoint to use for the public links service. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.Endpoint, "localhost:9178")`. +-storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.MountPath, "/public")`. @@ -3043,11 +3063,8 @@ Usage: `storage storage-users [command options] [arguments...]` -### storage auth-bearer -Start authprovider for bearer auth -Usage: `storage auth-bearer [command options] [arguments...]` @@ -3056,8 +3073,11 @@ Usage: `storage auth-bearer [command options] [arguments...]` +### storage health +Check health status +Usage: `storage health [command options] [arguments...]` @@ -3090,6 +3110,8 @@ Usage: `storage auth-bearer [command options] [arguments...]` +-debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9109")`. @@ -3159,40 +3181,22 @@ Usage: `storage auth-bearer [command options] [arguments...]` --debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.DebugAddr, "0.0.0.0:9149")`. --oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL -: OIDC issuer. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.Issuer, "https://localhost:9200")`. --oidc-insecure | $STORAGE_OIDC_INSECURE -: OIDC allow insecure communication. Default: `flags.OverrideDefaultBool(cfg.Reva.OIDC.Insecure, true)`. --oidc-id-claim | $STORAGE_OIDC_ID_CLAIM -: OIDC id claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.IDClaim, "preferred_username")`. --oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM -: OIDC uid claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.UIDClaim, "")`. --oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM -: OIDC gid claim. Default: `flags.OverrideDefaultString(cfg.Reva.OIDC.GIDClaim, "")`. --network | $STORAGE_AUTH_BEARER_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.GRPCNetwork, "tcp")`. --addr | $STORAGE_AUTH_BEARER_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.GRPCAddr, "0.0.0.0:9148")`. --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. @@ -3290,41 +3294,29 @@ Usage: `storage auth-bearer [command options] [arguments...]` -### storage groups -Start groups service -Usage: `storage groups [command options] [arguments...]` +### storage storage +Storage service for oCIS +Usage: `storage storage [command options] [arguments...]` --debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.DebugAddr, "0.0.0.0:9161")`. --network | $STORAGE_GROUPPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.GRPCNetwork, "tcp")`. --addr | $STORAGE_GROUPPROVIDER_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.GRPCAddr, "0.0.0.0:9160")`. --endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Endpoint, "localhost:9160")`. --driver | $STORAGE_GROUPPROVIDER_DRIVER -: group driver: 'json', 'ldap', or 'rest'. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Driver, "ldap")`. --json-config | $STORAGE_GROUPPROVIDER_JSON -: Path to groups.json file. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.JSON, "")`. @@ -3366,12 +3358,20 @@ Usage: `storage groups [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. diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index ddb1323c996..f351e53005c 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T07:12:52+0000" +date: "2021-06-29T07:14:35+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 2df32cf21ad..d4e442204f1 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T07:12:52+0000" +date: "2021-06-29T07:14:36+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates diff --git a/extensions/web/configuration.md b/extensions/web/configuration.md index d07db978344..45a5343cd2d 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T07:12:53+0000" +date: "2021-06-29T07:14:36+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/web/templates diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index 4236e1c433c..6e7dcb4c829 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T07:12:53+0000" +date: "2021-06-29T07:14:36+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates @@ -66,41 +66,6 @@ Usage: `webdav [global options] command [command options] [arguments...]` ## Sub Commands -### webdav version - -Print the versions of the running instances - -Usage: `webdav version [command options] [arguments...]` - - - - - - - - - - - - - - - - - - - - - - - --http-namespace | $WEBDAV_HTTP_NAMESPACE -: Set the base namespace for service discovery. Default: `flags.OverrideDefaultString(cfg.Service.Namespace, "com.owncloud.web")`. - - --service-name | $WEBDAV_SERVICE_NAME -: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "webdav")`. - ### webdav health Check health status @@ -222,3 +187,38 @@ Usage: `webdav server [command options] [arguments...]` +### webdav version + +Print the versions of the running instances + +Usage: `webdav version [command options] [arguments...]` + + + + + + + + + + + + + + + + + + + + + + + +-http-namespace | $WEBDAV_HTTP_NAMESPACE +: Set the base namespace for service discovery. Default: `flags.OverrideDefaultString(cfg.Service.Namespace, "com.owncloud.web")`. + + +-service-name | $WEBDAV_SERVICE_NAME +: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "webdav")`. + diff --git a/ocis/configuration.md b/ocis/configuration.md index ceb793916a9..33f9ba93358 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T07:12:51+0000" +date: "2021-06-29T07:14:35+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -107,11 +107,11 @@ Usage: `ocis [global options] command [command options] [arguments...]` ## Sub Commands -### ocis list +### ocis kill -Lists running ocis extensions +Kill an extension by name -Usage: `ocis list [command options] [arguments...]` +Usage: `ocis kill [command options] [arguments...]` @@ -134,11 +134,11 @@ Usage: `ocis list [command options] [arguments...]` -### ocis run +### ocis server -Runs an extension +Start fullstack server -Usage: `ocis run [command options] [arguments...]` +Usage: `ocis server [command options] [arguments...]` @@ -155,24 +155,38 @@ Usage: `ocis run [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. -### ocis health +-debug-zpages | $OCIS_DEBUG_ZPAGES +: Enable zpages debugging. -Check health status -Usage: `ocis health [command options] [arguments...]` +-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`. +### ocis run +Runs an extension +Usage: `ocis run [command options] [arguments...]` @@ -181,8 +195,6 @@ Usage: `ocis health [command options] [arguments...]` --debug-addr | $OCIS_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9010`. @@ -191,17 +203,17 @@ Usage: `ocis health [command options] [arguments...]` -### ocis kill -Kill an extension by name -Usage: `ocis kill [command options] [arguments...]` +### ocis health +Check health status +Usage: `ocis health [command options] [arguments...]` @@ -217,19 +229,21 @@ Usage: `ocis kill [command options] [arguments...]` +-debug-addr | $OCIS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9010`. -### ocis server -Start fullstack server -Usage: `ocis server [command options] [arguments...]` +### ocis list +Lists running ocis extensions +Usage: `ocis list [command options] [arguments...]` @@ -239,124 +253,110 @@ 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`. ### 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 glauth +#### ocis storage-gateway -Start glauth server +Start storage gateway -#### ocis storage-home +#### ocis storage-public-link -Start storage and data provider for /home mount +Start storage public link storage #### ocis web Start web server -#### ocis proxy - -Start proxy server - -#### ocis storage-public-link +#### ocis idp -Start storage public link storage +Start idp server -#### ocis storage-userprovider +#### ocis ocs -Start storage userprovider service +Start ocs server -#### ocis version +#### ocis storage-auth-bearer -Lists running services with version +Start storage auth-bearer service #### ocis storage-metadata Start storage and data service for metadata -#### ocis store +#### ocis storage-home -Start a go-micro store +Start storage and data provider for /home mount -#### ocis storage-auth-bearer +#### ocis thumbnails -Start storage auth-bearer service +Start thumbnails server -#### ocis storage-frontend +#### ocis storage-sharing -Start storage frontend +Start storage sharing service -#### ocis onlyoffice +#### ocis store -Start onlyoffice server +Start a go-micro store -#### ocis storage-gateway +#### ocis accounts -Start storage gateway +Start accounts server -#### ocis thumbnails +#### ocis proxy -Start thumbnails server +Start proxy server -#### ocis settings +#### ocis storage-frontend -Start settings server +Start storage frontend + +#### ocis onlyoffice + +Start onlyoffice server #### ocis storage-auth-basic Start storage auth-basic service -#### ocis storage-users +#### ocis storage-userprovider -Start storage and data provider for /users mount +Start storage userprovider service -#### ocis webdav +#### ocis glauth -Start webdav server +Start glauth server -#### ocis accounts +#### ocis settings -Start accounts server +Start settings server -#### ocis storage-sharing +#### ocis storage-users -Start storage sharing service +Start storage and data provider for /users mount -#### ocis idp +#### ocis version -Start idp server +Lists running services with version -#### ocis ocs +#### ocis webdav -Start ocs server +Start webdav server #### ocis storage-groupprovider