diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index ab3f333d0f9..9e4b7c2e0e0 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T10:42:44+0000" +date: "2021-06-29T11:00:15+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -35,111 +35,76 @@ 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 server +### accounts list -Start ocis accounts service +List existing accounts -Usage: `accounts server [command options] [arguments...]` +Usage: `accounts list [command options] [arguments...]` --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")`. --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, "")`. +-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 update +Make changes to an existing account +Usage: `accounts update [command options] [arguments...]` @@ -157,11 +122,8 @@ Usage: `accounts server [command options] [arguments...]` -### accounts add -Create a new account -Usage: `accounts add [command options] [arguments...]` @@ -169,26 +131,48 @@ 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. +-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. @@ -199,52 +183,31 @@ 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. +### accounts version --preferred-name | -: Set the preferred-name for the account. +Print the versions of the running instances +Usage: `accounts version [command options] [arguments...]` --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. @@ -252,11 +215,8 @@ Usage: `accounts add [command options] [arguments...]` -### accounts inspect -Show detailed data on an existing account -Usage: `accounts inspect [command options] [arguments...]` @@ -286,15 +246,22 @@ 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 add +Create a new account +Usage: `accounts add [command options] [arguments...]` @@ -310,18 +277,11 @@ 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 -Usage: `accounts rebuildIndex [command options] [arguments...]` @@ -339,28 +299,52 @@ 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")`. +-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. +-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. @@ -368,19 +352,19 @@ Usage: `accounts rebuildIndex [command options] [arguments...]` +### accounts inspect +Show detailed data on an existing account +Usage: `accounts inspect [command options] [arguments...]` -### accounts update -Make changes to an existing account -Usage: `accounts update [command options] [arguments...]` @@ -407,52 +391,37 @@ Usage: `accounts update [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. +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. --force-password-change-mfa | -: Force password change on next sign-in with mfa. +-name | $ACCOUNTS_NAME +: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. +### accounts rebuildIndex +Rebuilds the service's index, i.e. deleting and then re-adding all existing documents +Usage: `accounts rebuildIndex [command options] [arguments...]` @@ -468,11 +437,8 @@ Usage: `accounts update [command options] [arguments...]` -### accounts version -Print the versions of the running instances -Usage: `accounts version [command options] [arguments...]` @@ -510,8 +476,11 @@ Usage: `accounts version [command options] [arguments...]` +### accounts remove +Removes an existing account +Usage: `accounts remove [command options] [arguments...]` @@ -522,22 +491,15 @@ Usage: `accounts version [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. --name | $ACCOUNTS_NAME -: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. -### accounts list -List existing accounts -Usage: `accounts list [command options] [arguments...]` @@ -570,39 +532,45 @@ Usage: `accounts list [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. +-name | $ACCOUNTS_NAME +: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. +### accounts ocis-accounts +Provide accounts and groups for oCIS +Usage: `accounts ocis-accounts [command options] [arguments...]` +-log-level | $ACCOUNTS_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $ACCOUNTS_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $ACCOUNTS_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. --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 remove -Removes an existing account -Usage: `accounts remove [command options] [arguments...]` @@ -641,66 +609,98 @@ Usage: `accounts remove [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. +-tracing-enabled | $ACCOUNTS_TRACING_ENABLED +: Enable sending traces. +-tracing-type | $ACCOUNTS_TRACING_TYPE +: Tracing backend type. Default: `flags.OverrideDefaultString(cfg.Tracing.Type, "jaeger")`. --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. +-tracing-endpoint | $ACCOUNTS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `flags.OverrideDefaultString(cfg.Tracing.Endpoint, "")`. --name | $ACCOUNTS_NAME -: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. +-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")`. -### accounts ocis-accounts -Provide accounts and groups for oCIS +-http-namespace | $ACCOUNTS_HTTP_NAMESPACE +: Set the base namespace for the http namespace. Default: `flags.OverrideDefaultString(cfg.HTTP.Namespace, "com.owncloud.web")`. -Usage: `accounts ocis-accounts [command options] [arguments...]` +-http-addr | $ACCOUNTS_HTTP_ADDR +: Address to bind http server. Default: `flags.OverrideDefaultString(cfg.HTTP.Addr, "0.0.0.0:9181")`. --log-level | $ACCOUNTS_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. +-http-root | $ACCOUNTS_HTTP_ROOT +: Root path of http server. Default: `flags.OverrideDefaultString(cfg.HTTP.Root, "/")`. --log-pretty | $ACCOUNTS_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. --log-color | $ACCOUNTS_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. +-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, "")`. diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index a66dcde555f..b655216eb2c 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T10:43:36+0000" +date: "2021-06-29T11:00:50+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 2e36a670006..55a43067969 100644 --- a/extensions/graph-explorer/configuration.md +++ b/extensions/graph-explorer/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T10:43:36+0000" +date: "2021-06-29T11:00:50+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 278f91104d6..6ae17f5ae84 100644 --- a/extensions/graph/configuration.md +++ b/extensions/graph/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T10:43:36+0000" +date: "2021-06-29T11:00:50+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph/templates @@ -34,6 +34,44 @@ 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 @@ -188,42 +226,4 @@ 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 780f476c440..6bf31242722 100644 --- a/extensions/idp/configuration.md +++ b/extensions/idp/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T10:43:36+0000" +date: "2021-06-29T11:00:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/idp/templates @@ -35,127 +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 health +### idp server -Check health status +Start integrated server -Usage: `idp health [command options] [arguments...]` +Usage: `idp server [command options] [arguments...]` --debug-addr | $IDP_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9134")`. +-log-file | $IDP_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. +-config-file | $IDP_CONFIG_FILE +: Path to config file. Default: `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")`. +-ldap-uuid-attribute | $IDP_LDAP_UUID_ATTRIBUTE +: LDAP UUID attribute of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.UUIDAttribute, "uid")`. -### idp ocis-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")`. -Serve IDP API for oCIS -Usage: `idp ocis-idp [command options] [arguments...]` +-ldap-filter | $IDP_LDAP_FILTER +: LDAP filter of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.Filter, "(objectClass=posixaccount)")`. --log-level | $IDP_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. +-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"))`. --log-pretty | $IDP_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. +-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"))`. --log-color | $IDP_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. +-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...]` @@ -167,220 +255,136 @@ Usage: `idp ocis-idp [command options] [arguments...]` -### idp server -Start integrated server -Usage: `idp server [command options] [arguments...]` --log-file | $IDP_LOG_FILE , $OCIS_LOG_FILE -: Enable log to file. --config-file | $IDP_CONFIG_FILE -: Path to config file. Default: `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")`. +-http-namespace | $IDP_HTTP_NAMESPACE +: Set the base namespace for service discovery. Default: `flags.OverrideDefaultString(cfg.Service.Namespace, "com.owncloud.web")`. --ldap-bind-password | $IDP_LDAP_BIND_PASSWORD -: Password for the Bind DN of the LDAP server (glauth). Default: `flags.OverrideDefaultString(cfg.Ldap.BindPassword, "idp")`. +-name | $IDP_NAME +: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "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")`. +### idp health +Check health status --ldap-scope | $IDP_LDAP_SCOPE -: LDAP scope of the oCIS users. Default: `flags.OverrideDefaultString(cfg.Ldap.Scope, "sub")`. +Usage: `idp health [command options] [arguments...]` --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")`. +-debug-addr | $IDP_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9134")`. --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)`. +### idp ocis-idp -### idp version +Serve IDP API for oCIS -Print the versions of the running instances +Usage: `idp ocis-idp [command options] [arguments...]` -Usage: `idp version [command options] [arguments...]` +-log-level | $IDP_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $IDP_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $IDP_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. @@ -430,10 +434,6 @@ Usage: `idp version [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")`. diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index 5d042b82506..0633d407247 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T10:43:36+0000" +date: "2021-06-29T11:00:51+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 9950a5c67f0..47fa473d42b 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T10:43:36+0000" +date: "2021-06-29T11:00:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/onlyoffice/templates @@ -78,34 +78,6 @@ Usage: `onlyoffice [global options] command [command options] [arguments...]` ## Sub Commands -### onlyoffice health - -Check health status - -Usage: `onlyoffice health [command options] [arguments...]` - - - - - - --debug-addr | $ONLYOFFICE_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9224")`. - - - - - - - - - - - - - - - ### onlyoffice server Start integrated server @@ -173,3 +145,31 @@ 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 ce91d2af285..7bc18a68b5d 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T10:43:36+0000" +date: "2021-06-29T11:00:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/proxy/templates @@ -34,49 +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. - -### proxy health - -Check health status - -Usage: `proxy health [command options] [arguments...]` - - - - - --debug-addr | $PROXY_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9109")`. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ### proxy ocis-proxy @@ -305,4 +262,47 @@ Usage: `proxy version [command options] [arguments...]` -service-name | $PROXY_SERVICE_NAME : Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "proxy")`. + +### proxy health + +Check health status + +Usage: `proxy health [command options] [arguments...]` + + + + + +-debug-addr | $PROXY_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9109")`. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/extensions/settings/configuration.md b/extensions/settings/configuration.md index 64ed5fde9c4..aaebd7b05fc 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T10:43:36+0000" +date: "2021-06-29T11:00:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/settings/templates @@ -35,99 +35,69 @@ 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 server +### settings health -Start integrated server +Check health status -Usage: `settings server [command options] [arguments...]` +Usage: `settings health [command options] [arguments...]` +-debug-addr | $SETTINGS_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9194")`. --config-file | $SETTINGS_CONFIG_FILE -: Path to config file. --tracing-enabled | $SETTINGS_TRACING_ENABLED -: Enable sending traces. --tracing-type | $SETTINGS_TRACING_TYPE -: Tracing backend type. Default: `flags.OverrideDefaultString(cfg.Tracing.Type, "jaeger")`. --tracing-endpoint | $SETTINGS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `flags.OverrideDefaultString(cfg.Tracing.Endpoint, "")`. --tracing-collector | $SETTINGS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `flags.OverrideDefaultString(cfg.Tracing.Collector, "")`. --tracing-service | $SETTINGS_TRACING_SERVICE -: Service name for tracing. Default: `flags.OverrideDefaultString(cfg.Tracing.Service, "settings")`. --debug-addr | $SETTINGS_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9194")`. --debug-token | $SETTINGS_DEBUG_TOKEN -: Token to grant metrics access. Default: `flags.OverrideDefaultString(cfg.Debug.Token, "")`. --debug-pprof | $SETTINGS_DEBUG_PPROF -: Enable pprof debugging. --debug-zpages | $SETTINGS_DEBUG_ZPAGES -: Enable zpages debugging. --http-addr | $SETTINGS_HTTP_ADDR -: Address to bind http server. Default: `flags.OverrideDefaultString(cfg.HTTP.Addr, "0.0.0.0:9190")`. +### settings ocis-settings --http-namespace | $SETTINGS_HTTP_NAMESPACE -: Set the base namespace for the http namespace. Default: `flags.OverrideDefaultString(cfg.HTTP.Namespace, "com.owncloud.web")`. +Provide settings and permissions for oCIS +Usage: `settings ocis-settings [command options] [arguments...]` --http-root | $SETTINGS_HTTP_ROOT -: Root path of http server. Default: `flags.OverrideDefaultString(cfg.HTTP.Root, "/")`. +-log-level | $SETTINGS_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. --grpc-addr | $SETTINGS_GRPC_ADDR -: Address to bind grpc server. Default: `flags.OverrideDefaultString(cfg.GRPC.Addr, "0.0.0.0:9191")`. +-log-pretty | $SETTINGS_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. --asset-path | $SETTINGS_ASSET_PATH -: Path to custom assets. Default: `flags.OverrideDefaultString(cfg.Asset.Path, "")`. +-log-color | $SETTINGS_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. --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")`. --data-path | $SETTINGS_DATA_PATH -: Mount path for the storage. Default: `flags.OverrideDefaultString(cfg.Service.DataPath, "/var/tmp/ocis/settings")`. --jwt-secret | $SETTINGS_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")`. -### settings version -Print the versions of the running instances -Usage: `settings version [command options] [arguments...]` @@ -139,78 +109,104 @@ Usage: `settings version [command options] [arguments...]` +### settings server +Start integrated server +Usage: `settings server [command options] [arguments...]` +-config-file | $SETTINGS_CONFIG_FILE +: Path to config file. +-tracing-enabled | $SETTINGS_TRACING_ENABLED +: Enable sending traces. +-tracing-type | $SETTINGS_TRACING_TYPE +: Tracing backend type. Default: `flags.OverrideDefaultString(cfg.Tracing.Type, "jaeger")`. --grpc-namespace | $SETTINGS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. +-tracing-endpoint | $SETTINGS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `flags.OverrideDefaultString(cfg.Tracing.Endpoint, "")`. --name | $SETTINGS_NAME -: service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "settings")`. +-tracing-collector | $SETTINGS_TRACING_COLLECTOR +: Endpoint for the collector. Default: `flags.OverrideDefaultString(cfg.Tracing.Collector, "")`. -### settings health -Check health status +-tracing-service | $SETTINGS_TRACING_SERVICE +: Service name for tracing. Default: `flags.OverrideDefaultString(cfg.Tracing.Service, "settings")`. -Usage: `settings health [command options] [arguments...]` +-debug-addr | $SETTINGS_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9194")`. +-debug-token | $SETTINGS_DEBUG_TOKEN +: Token to grant metrics access. Default: `flags.OverrideDefaultString(cfg.Debug.Token, "")`. --debug-addr | $SETTINGS_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9194")`. +-debug-pprof | $SETTINGS_DEBUG_PPROF +: Enable pprof debugging. +-debug-zpages | $SETTINGS_DEBUG_ZPAGES +: Enable zpages debugging. +-http-addr | $SETTINGS_HTTP_ADDR +: Address to bind http server. Default: `flags.OverrideDefaultString(cfg.HTTP.Addr, "0.0.0.0:9190")`. +-http-namespace | $SETTINGS_HTTP_NAMESPACE +: Set the base namespace for the http namespace. Default: `flags.OverrideDefaultString(cfg.HTTP.Namespace, "com.owncloud.web")`. +-http-root | $SETTINGS_HTTP_ROOT +: Root path of http server. Default: `flags.OverrideDefaultString(cfg.HTTP.Root, "/")`. +-grpc-addr | $SETTINGS_GRPC_ADDR +: Address to bind grpc server. Default: `flags.OverrideDefaultString(cfg.GRPC.Addr, "0.0.0.0:9191")`. +-asset-path | $SETTINGS_ASSET_PATH +: Path to custom assets. Default: `flags.OverrideDefaultString(cfg.Asset.Path, "")`. +-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")`. +-data-path | $SETTINGS_DATA_PATH +: Mount path for the storage. Default: `flags.OverrideDefaultString(cfg.Service.DataPath, "/var/tmp/ocis/settings")`. +-jwt-secret | $SETTINGS_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")`. -### settings ocis-settings -Provide settings and permissions for oCIS +### settings version -Usage: `settings ocis-settings [command options] [arguments...]` +Print the versions of the running instances +Usage: `settings version [command options] [arguments...]` --log-level | $SETTINGS_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. --log-pretty | $SETTINGS_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $SETTINGS_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. @@ -231,6 +227,10 @@ Usage: `settings ocis-settings [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 ef8a2a8c532..6eda68eaa43 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T10:43:36+0000" +date: "2021-06-29T11:00:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -161,20 +161,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. @@ -191,12 +183,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. @@ -269,61 +269,81 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage auth-basic +### storage frontend -Start authprovider for basic auth +Start frontend service -Usage: `storage auth-basic [command options] [arguments...]` +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")`. --debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.DebugAddr, "0.0.0.0:9147")`. +-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")`. --auth-driver | $STORAGE_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `flags.OverrideDefaultString(cfg.Reva.AuthProvider.Driver, "ldap")`. +-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, "")`. --auth-json | $STORAGE_AUTH_JSON -: Path to users.json file. Default: `flags.OverrideDefaultString(cfg.Reva.AuthProvider.JSON, "")`. +-checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE +: Specify the preferred checksum algorithm used for uploads. Default: `flags.OverrideDefaultString(cfg.Reva.ChecksumPreferredUploadType, "")`. --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")`. @@ -507,11 +527,8 @@ Usage: `storage auth-basic [command options] [arguments...]` -### storage auth-bearer -Start authprovider for bearer auth -Usage: `storage auth-bearer [command options] [arguments...]` @@ -520,8 +537,11 @@ Usage: `storage auth-bearer [command options] [arguments...]` +### storage sharing +Start sharing service +Usage: `storage sharing [command options] [arguments...]` @@ -546,40 +566,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")`. @@ -687,20 +689,36 @@ Usage: `storage auth-bearer [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)`. @@ -754,11 +772,8 @@ Usage: `storage auth-bearer [command options] [arguments...]` -### storage sharing -Start sharing service -Usage: `storage sharing [command options] [arguments...]` @@ -766,8 +781,11 @@ Usage: `storage sharing [command options] [arguments...]` +### storage storage-home +Start storage-home service +Usage: `storage storage-home [command options] [arguments...]` @@ -850,70 +868,84 @@ Usage: `storage sharing [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")`. --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)`. @@ -998,11 +1030,8 @@ Usage: `storage sharing [command options] [arguments...]` -### storage storage-users -Start storage-users service -Usage: `storage storage-users [command options] [arguments...]` @@ -1017,8 +1046,11 @@ Usage: `storage storage-users [command options] [arguments...]` +### storage auth-bearer +Start authprovider for bearer auth +Usage: `storage auth-bearer [command options] [arguments...]` @@ -1063,22 +1095,40 @@ Usage: `storage storage-users [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")`. @@ -1191,60 +1241,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")`. @@ -1260,11 +1282,8 @@ Usage: `storage storage-users [command options] [arguments...]` -### storage frontend -Start frontend service -Usage: `storage frontend [command options] [arguments...]` @@ -1274,8 +1293,11 @@ Usage: `storage frontend [command options] [arguments...]` +### storage storage-public-link +Start storage-public-link service +Usage: `storage storage-public-link [command options] [arguments...]` @@ -1333,68 +1355,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, "")`. @@ -1519,20 +1509,30 @@ Usage: `storage frontend [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 groups +### storage gateway -Start groups service +Start gateway -Usage: `storage groups [command options] [arguments...]` +Usage: `storage gateway [command options] [arguments...]` @@ -1648,60 +1648,116 @@ Usage: `storage groups [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")`. @@ -1714,28 +1770,16 @@ Usage: `storage groups [command options] [arguments...]` --debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.DebugAddr, "0.0.0.0:9161")`. --network | $STORAGE_GROUPPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.GRPCNetwork, "tcp")`. --addr | $STORAGE_GROUPPROVIDER_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.GRPCAddr, "0.0.0.0:9160")`. --endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Endpoint, "localhost:9160")`. --driver | $STORAGE_GROUPPROVIDER_DRIVER -: group driver: 'json', 'ldap', or 'rest'. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Driver, "ldap")`. --json-config | $STORAGE_GROUPPROVIDER_JSON -: Path to groups.json file. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.JSON, "")`. @@ -1766,11 +1810,8 @@ Usage: `storage groups [command options] [arguments...]` -### storage storage-metadata -Start storage-metadata service -Usage: `storage storage-metadata [command options] [arguments...]` @@ -1791,8 +1832,11 @@ Usage: `storage storage-metadata [command options] [arguments...]` +### storage storage +Storage service for oCIS +Usage: `storage storage [command options] [arguments...]` @@ -1892,20 +1936,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. @@ -1916,48 +1952,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")`. @@ -1966,12 +1980,20 @@ Usage: `storage storage-metadata [command options] [arguments...]` +-config-file | $STORAGE_CONFIG_FILE +: Path to config file. +-log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. @@ -2031,11 +2053,8 @@ Usage: `storage storage-metadata [command options] [arguments...]` -### storage storage-public-link -Start storage-public-link service -Usage: `storage storage-public-link [command options] [arguments...]` @@ -2045,8 +2064,11 @@ Usage: `storage storage-public-link [command options] [arguments...]` +### storage storage-users +Start storage-users service +Usage: `storage storage-users [command options] [arguments...]` @@ -2071,32 +2093,60 @@ Usage: `storage storage-public-link [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")`. @@ -2241,24 +2291,14 @@ 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")`. @@ -2266,11 +2306,8 @@ Usage: `storage storage-public-link [command options] [arguments...]` -### storage users -Start users service -Usage: `storage users [command options] [arguments...]` @@ -2289,8 +2326,11 @@ Usage: `storage users [command options] [arguments...]` +### storage auth-basic +Start authprovider for basic auth +Usage: `storage auth-basic [command options] [arguments...]` @@ -2393,16 +2433,28 @@ Usage: `storage users [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")`. @@ -2481,34 +2533,19 @@ Usage: `storage users [command options] [arguments...]` --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Users.DebugAddr, "0.0.0.0:9145")`. --network | $STORAGE_USERPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Users.GRPCNetwork, "tcp")`. --addr | $STORAGE_USERPROVIDER_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.GRPCAddr, "0.0.0.0:9144")`. --endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. --driver | $STORAGE_USERPROVIDER_DRIVER -: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Driver, "ldap")`. --json-config | $STORAGE_USERPROVIDER_JSON -: Path to users.json file. Default: `flags.OverrideDefaultString(cfg.Reva.Users.JSON, "")`. -### storage gateway -Start gateway -Usage: `storage gateway [command options] [arguments...]` @@ -2527,8 +2564,11 @@ Usage: `storage gateway [command options] [arguments...]` +### storage health +Check health status +Usage: `storage health [command options] [arguments...]` @@ -2593,116 +2633,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")`. @@ -2795,28 +2779,28 @@ Usage: `storage gateway [command options] [arguments...]` +-debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9109")`. +### storage users +Start users service +Usage: `storage users [command options] [arguments...]` -### storage health -Check health status -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")`. @@ -2846,16 +2830,28 @@ Usage: `storage health [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, "")`. @@ -3029,13 +3025,13 @@ Usage: `storage health [command options] [arguments...]` +### storage groups +Start groups service -### storage storage +Usage: `storage groups [command options] [arguments...]` -Storage service for oCIS -Usage: `storage storage [command options] [arguments...]` @@ -3052,16 +3048,28 @@ 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, "")`. @@ -3157,20 +3165,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. @@ -3263,11 +3263,11 @@ Usage: `storage storage [command options] [arguments...]` -### storage storage-home +### storage storage-metadata -Start storage-home service +Start storage-metadata service -Usage: `storage storage-home [command options] [arguments...]` +Usage: `storage storage-metadata [command options] [arguments...]` @@ -3411,12 +3411,20 @@ Usage: `storage storage-home [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. @@ -3428,64 +3436,56 @@ 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")`. +-debug-addr | $STORAGE_METADATA_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.DebugAddr, "0.0.0.0:9217")`. --grpc-addr | $STORAGE_HOME_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.GRPCAddr, "0.0.0.0:9154")`. +-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")`. --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")`. +-grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.GRPCAddr, "0.0.0.0:9215")`. --http-addr | $STORAGE_HOME_HTTP_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPAddr, "0.0.0.0:9155")`. +-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")`. --driver | $STORAGE_HOME_DRIVER -: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.Driver, "ocis")`. +-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")`. --mount-path | $STORAGE_HOME_MOUNT_PATH -: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountPath, "/home")`. +-http-addr | $STORAGE_METADATA_HTTP_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.HTTPAddr, "0.0.0.0:9216")`. --mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountID, "1284d238-aa92-42ce-bdc4-0b0000009157")`. +-tmp-folder | $STORAGE_METADATA_TMP_FOLDER +: path to tmp folder. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.TempFolder, "/var/tmp/ocis/tmp/metadata")`. --expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `flags.OverrideDefaultBool(cfg.Reva.StorageHome.ExposeDataServer, false)`. +-driver | $STORAGE_METADATA_DRIVER +: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.Driver, "ocis")`. --data-server-url | $STORAGE_HOME_DATA_SERVER_URL -: data server url. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.DataServerURL, "http://localhost:9155/data")`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. --http-prefix | $STORAGE_HOME_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPPrefix, "data")`. +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. --tmp-folder | $STORAGE_HOME_TMP_FOLDER -: path to tmp folder. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.TempFolder, "/var/tmp/ocis/tmp/home")`. +-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")`. --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")`. diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index 87b5aea17fb..0297a8b88a5 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T10:43:37+0000" +date: "2021-06-29T11:00:51+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 bfca90614f8..cc14134ddbe 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T10:43:37+0000" +date: "2021-06-29T11:00:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates @@ -34,36 +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. - -### thumbnails ocis-thumbnails - -Example usage - -Usage: `thumbnails ocis-thumbnails [command options] [arguments...]` - - - - - - - - - - - - - - - - - - - - - - - - ### thumbnails server @@ -222,6 +192,36 @@ Usage: `thumbnails health [command options] [arguments...]` + + + + + +### thumbnails ocis-thumbnails + +Example usage + +Usage: `thumbnails ocis-thumbnails [command options] [arguments...]` + + + + + + + + + + + + + + + + + + + + diff --git a/extensions/web/configuration.md b/extensions/web/configuration.md index c224b528060..3b9ed218ea2 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T10:43:37+0000" +date: "2021-06-29T11:00:52+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 e7b5b50abd0..795deec7768 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T10:43:38+0000" +date: "2021-06-29T11:00:52+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates @@ -65,38 +65,6 @@ Usage: `webdav [global options] command [command options] [arguments...]` ## Sub Commands - -### webdav health - -Check health status - -Usage: `webdav health [command options] [arguments...]` - - --debug-addr | $WEBDAV_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9119")`. - - - - - - - - - - - - - - - - - - - - - - ### webdav server @@ -221,4 +189,36 @@ Usage: `webdav version [command options] [arguments...]` -service-name | $WEBDAV_SERVICE_NAME : Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "webdav")`. + +### webdav health + +Check health status + +Usage: `webdav health [command options] [arguments...]` + + +-debug-addr | $WEBDAV_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9119")`. + + + + + + + + + + + + + + + + + + + + + + diff --git a/ocis/configuration.md b/ocis/configuration.md index cfe2bf28155..aff2185c832 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-29T10:43:36+0000" +date: "2021-06-29T11:00:51+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 run +### ocis kill -Runs an extension +Kill an extension by name -Usage: `ocis run [command options] [arguments...]` +Usage: `ocis kill [command options] [arguments...]` @@ -134,11 +134,11 @@ Usage: `ocis run [command options] [arguments...]` -### ocis kill +### ocis list -Kill an extension by name +Lists running ocis extensions -Usage: `ocis kill [command options] [arguments...]` +Usage: `ocis list [command options] [arguments...]` @@ -161,11 +161,11 @@ Usage: `ocis kill [command options] [arguments...]` -### ocis list +### ocis server -Lists running ocis extensions +Start fullstack server -Usage: `ocis list [command options] [arguments...]` +Usage: `ocis server [command options] [arguments...]` @@ -182,24 +182,38 @@ Usage: `ocis list [command options] [arguments...]` +-debug-addr | $OCIS_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9010`. +-debug-token | $OCIS_DEBUG_TOKEN +: Token to grant metrics access. +-debug-pprof | $OCIS_DEBUG_PPROF +: Enable pprof debugging. -### 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...]` @@ -208,8 +222,6 @@ Usage: `ocis health [command options] [arguments...]` --debug-addr | $OCIS_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9010`. @@ -218,17 +230,17 @@ Usage: `ocis health [command options] [arguments...]` -### ocis server -Start fullstack server -Usage: `ocis server [command options] [arguments...]` +### ocis health +Check health status +Usage: `ocis health [command options] [arguments...]` @@ -239,126 +251,114 @@ Usage: `ocis server [command options] [arguments...]` --debug-addr | $OCIS_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9010`. --debug-token | $OCIS_DEBUG_TOKEN -: Token to grant metrics access. --debug-pprof | $OCIS_DEBUG_PPROF -: Enable pprof debugging. +-debug-addr | $OCIS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9010`. --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 idp +#### ocis storage-auth-basic -Start idp server +Start storage auth-basic service -#### ocis storage-metadata +#### ocis storage-users -Start storage and data service for metadata +Start storage and data provider for /users mount -#### ocis storage-groupprovider +#### ocis webdav -Start storage groupprovider service +Start webdav server -#### ocis store +#### ocis onlyoffice -Start a go-micro store +Start onlyoffice server -#### ocis storage-sharing +#### ocis storage-gateway -Start storage sharing service +Start storage gateway -#### ocis version +#### ocis storage-groupprovider -Lists running services with version +Start storage groupprovider service -#### ocis webdav +#### ocis settings -Start webdav server +Start settings server -#### ocis glauth +#### ocis proxy -Start glauth server +Start proxy server -#### ocis storage-auth-bearer +#### ocis accounts -Start storage auth-bearer service +Start accounts server #### ocis storage-public-link Start storage public link storage -#### ocis storage-userprovider +#### ocis thumbnails -Start storage userprovider service +Start thumbnails server -#### ocis settings +#### ocis storage-home -Start settings server +Start storage and data provider for /home mount -#### ocis storage-frontend +#### ocis storage-auth-bearer -Start storage frontend +Start storage auth-bearer service -#### ocis accounts +#### ocis storage-userprovider -Start accounts server +Start storage userprovider service #### ocis web Start web server -#### ocis storage-auth-basic +#### ocis glauth -Start storage auth-basic service +Start glauth server -#### ocis storage-gateway +#### ocis ocs -Start storage gateway +Start ocs server -#### ocis storage-home +#### ocis idp -Start storage and data provider for /home mount +Start idp server -#### ocis ocs +#### ocis storage-frontend -Start ocs server +Start storage frontend -#### ocis onlyoffice +#### ocis storage-sharing -Start onlyoffice server +Start storage sharing service -#### ocis proxy +#### ocis store -Start proxy server +Start a go-micro store -#### ocis thumbnails +#### ocis storage-metadata -Start thumbnails server +Start storage and data service for metadata -#### ocis storage-users +#### ocis version -Start storage and data provider for /users mount +Lists running services with version