diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 4d0585ae7e7..c5b83c62728 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-09-02T11:47:54+0000" +date: "2021-09-03T12:34:40+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -35,12 +35,11 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### accounts version - -Print the versions of the running instances +### accounts inspect -Usage: `accounts version [command options] [arguments...]` +Show detailed data on an existing account +Usage: `accounts inspect [command options] [arguments...]` @@ -105,23 +104,23 @@ Usage: `accounts version [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. -### accounts add +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. -Create a new account +### accounts list -Usage: `accounts add [command options] [arguments...]` +List existing accounts +Usage: `accounts list [command options] [arguments...]` @@ -171,64 +170,41 @@ Usage: `accounts add [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. --enabled | -: Enable the account. --displayname | -: Set the displayname for the account. --username | -: Username will be written to preferred-name and on_premises_sam_account_name. --preferred-name | -: Set the preferred-name for the account. --on-premises-sam-account-name | -: Set the on-premises-sam-account-name. --uidnumber | -: Set the uidnumber for the account. --gidnumber | -: Set the gidnumber for the account. +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --mail | -: Set the mail for the account. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. --description | -: Set the description for the account. --password | -: Set the password for the account. +### accounts rebuildIndex --password-policies | -: Possible policies: DisableStrongPassword, DisablePasswordExpiration. +Rebuilds the service's index, i.e. deleting and then re-adding all existing documents +Usage: `accounts rebuildIndex [command options] [arguments...]` --force-password-change | -: Force password change on next sign-in. --force-password-change-mfa | -: Force password change on next sign-in with mfa. @@ -236,11 +212,8 @@ Usage: `accounts add [command options] [arguments...]` -### accounts list -List existing accounts -Usage: `accounts list [command options] [arguments...]` @@ -299,29 +272,25 @@ Usage: `accounts list [command options] [arguments...]` +### accounts remove +Removes an existing account +Usage: `accounts remove [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. -### accounts remove -Removes an existing account -Usage: `accounts remove [command options] [arguments...]` @@ -375,13 +344,20 @@ Usage: `accounts remove [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +### accounts add +Create a new account +Usage: `accounts add [command options] [arguments...]` @@ -389,20 +365,13 @@ Usage: `accounts remove [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. -### accounts update -Make changes to an existing account -Usage: `accounts update [command options] [arguments...]` @@ -455,6 +424,10 @@ Usage: `accounts update [command options] [arguments...]` : Set the displayname for the account. +-username | +: Username will be written to preferred-name and on_premises_sam_account_name. + + -preferred-name | : Set the preferred-name for the account. @@ -500,26 +473,33 @@ Usage: `accounts update [command options] [arguments...]` +### accounts ocis-accounts +Provide accounts and groups for oCIS +Usage: `accounts ocis-accounts [command options] [arguments...]` +-log-level | $ACCOUNTS_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $ACCOUNTS_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $ACCOUNTS_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. +-extensions | +: Run specific extensions during supervised mode. -### accounts inspect - -Show detailed data on an existing account -Usage: `accounts inspect [command options] [arguments...]` @@ -580,79 +560,135 @@ Usage: `accounts inspect [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. --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-tracing-enabled | $ACCOUNTS_TRACING_ENABLED , $OCIS_TRACING_ENABLED +: Enable sending traces. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. -### accounts rebuildIndex +-tracing-type | $ACCOUNTS_TRACING_TYPE , $OCIS_TRACING_TYPE +: Tracing backend type. Default: `"jaeger"`. -Rebuilds the service's index, i.e. deleting and then re-adding all existing documents -Usage: `accounts rebuildIndex [command options] [arguments...]` +-tracing-endpoint | $ACCOUNTS_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. +-tracing-collector | $ACCOUNTS_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR +: Endpoint for the collector. Default: `""`. +-tracing-service | $ACCOUNTS_TRACING_SERVICE +: Service name for tracing. Default: `"accounts"`. +-http-namespace | $ACCOUNTS_HTTP_NAMESPACE +: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. +-http-addr | $ACCOUNTS_HTTP_ADDR +: Address to bind http server. Default: `"0.0.0.0:9181"`. +-http-root | $ACCOUNTS_HTTP_ROOT +: Root path of http server. Default: `"/"`. +-http-cache-ttl | $ACCOUNTS_CACHE_TTL +: Set the static assets caching duration in seconds. Default: `604800`. +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-grpc-addr | $ACCOUNTS_GRPC_ADDR +: Address to bind grpc server. Default: `"0.0.0.0:9180"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +-accounts-hash-difficulty | $ACCOUNTS_HASH_DIFFICULTY +: accounts password hash difficulty. Default: `11`. +-asset-path | $ACCOUNTS_ASSET_PATH +: Path to custom assets. Default: `""`. +-jwt-secret | $ACCOUNTS_JWT_SECRET , $OCIS_JWT_SECRET +: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. +-storage-disk-path | $ACCOUNTS_STORAGE_DISK_PATH +: Path on the local disk, e.g. /var/tmp/ocis/accounts. Default: `""`. +-storage-cs3-provider-addr | $ACCOUNTS_STORAGE_CS3_PROVIDER_ADDR +: bind address for the metadata storage provider. Default: `"localhost:9215"`. +-storage-cs3-data-url | $ACCOUNTS_STORAGE_CS3_DATA_URL +: http endpoint of the metadata storage. Default: `"http://localhost:9216"`. +-storage-cs3-data-prefix | $ACCOUNTS_STORAGE_CS3_DATA_PREFIX +: path prefix for the http endpoint of the metadata storage, without leading slash. Default: `"data"`. +-storage-cs3-jwt-secret | $ACCOUNTS_STORAGE_CS3_JWT_SECRET , $OCIS_JWT_SECRET +: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. +-service-user-uuid | $ACCOUNTS_SERVICE_USER_UUID +: uuid of the internal service user (required on EOS). Default: `"95cb8724-03b2-11eb-a0a6-c33ef8ef53ad"`. +-service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME +: username of the internal service user (required on EOS). Default: `""`. +-service-user-uid | $ACCOUNTS_SERVICE_USER_UID +: uid of the internal service user (required on EOS). Default: `0`. +-service-user-gid | $ACCOUNTS_SERVICE_USER_GID +: gid of the internal service user (required on EOS). Default: `0`. +-uid-index-lower-bound | $ACCOUNTS_UID_INDEX_LOWER_BOUND +: define a starting point for the account UID. Default: `0`. +-gid-index-lower-bound | $ACCOUNTS_GID_INDEX_LOWER_BOUND +: define a starting point for the account GID. Default: `1000`. +-uid-index-upper-bound | $ACCOUNTS_UID_INDEX_UPPER_BOUND +: define an ending point for the account UID. Default: `0`. +-gid-index-upper-bound | $ACCOUNTS_GID_INDEX_UPPER_BOUND +: define an ending point for the account GID. Default: `1000`. +-extensions | +: Run specific extensions during supervised mode. @@ -671,27 +707,16 @@ Usage: `accounts rebuildIndex [command options] [arguments...]` -### accounts ocis-accounts -Provide accounts and groups for oCIS -Usage: `accounts ocis-accounts [command options] [arguments...]` --log-level | $ACCOUNTS_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. --log-pretty | $ACCOUNTS_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $ACCOUNTS_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. --extensions | -: Run specific extensions during supervised mode. @@ -700,8 +725,11 @@ Usage: `accounts ocis-accounts [command options] [arguments...]` +### accounts update +Make changes to an existing account +Usage: `accounts update [command options] [arguments...]` @@ -738,155 +766,123 @@ Usage: `accounts ocis-accounts [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +-enabled | +: Enable the account. +-displayname | +: Set the displayname for the account. +-preferred-name | +: Set the preferred-name for the account. +-on-premises-sam-account-name | +: Set the on-premises-sam-account-name. +-uidnumber | +: Set the uidnumber for the account. +-gidnumber | +: Set the gidnumber for the account. +-mail | +: Set the mail for the account. +-description | +: Set the description for the account. -### accounts server +-password | +: Set the password for the account. -Start ocis accounts service -Usage: `accounts server [command options] [arguments...]` +-password-policies | +: Possible policies: DisableStrongPassword, DisablePasswordExpiration. +-force-password-change | +: Force password change on next sign-in. +-force-password-change-mfa | +: Force password change on next sign-in with mfa. --log-file | $ACCOUNTS_LOG_FILE , $OCIS_LOG_FILE -: Enable log to file. --tracing-enabled | $ACCOUNTS_TRACING_ENABLED , $OCIS_TRACING_ENABLED -: Enable sending traces. --tracing-type | $ACCOUNTS_TRACING_TYPE , $OCIS_TRACING_TYPE -: Tracing backend type. Default: `"jaeger"`. --tracing-endpoint | $ACCOUNTS_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. --tracing-collector | $ACCOUNTS_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `""`. --tracing-service | $ACCOUNTS_TRACING_SERVICE -: Service name for tracing. Default: `"accounts"`. --http-namespace | $ACCOUNTS_HTTP_NAMESPACE -: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. --http-addr | $ACCOUNTS_HTTP_ADDR -: Address to bind http server. Default: `"0.0.0.0:9181"`. --http-root | $ACCOUNTS_HTTP_ROOT -: Root path of http server. Default: `"/"`. --http-cache-ttl | $ACCOUNTS_CACHE_TTL -: Set the static assets caching duration in seconds. Default: `604800`. --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +### accounts version +Print the versions of the running instances --grpc-addr | $ACCOUNTS_GRPC_ADDR -: Address to bind grpc server. Default: `"0.0.0.0:9180"`. +Usage: `accounts version [command options] [arguments...]` --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. --accounts-hash-difficulty | $ACCOUNTS_HASH_DIFFICULTY -: accounts password hash difficulty. Default: `11`. --asset-path | $ACCOUNTS_ASSET_PATH -: Path to custom assets. Default: `""`. --jwt-secret | $ACCOUNTS_JWT_SECRET , $OCIS_JWT_SECRET -: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. --storage-disk-path | $ACCOUNTS_STORAGE_DISK_PATH -: Path on the local disk, e.g. /var/tmp/ocis/accounts. Default: `""`. --storage-cs3-provider-addr | $ACCOUNTS_STORAGE_CS3_PROVIDER_ADDR -: bind address for the metadata storage provider. Default: `"localhost:9215"`. --storage-cs3-data-url | $ACCOUNTS_STORAGE_CS3_DATA_URL -: http endpoint of the metadata storage. Default: `"http://localhost:9216"`. --storage-cs3-data-prefix | $ACCOUNTS_STORAGE_CS3_DATA_PREFIX -: path prefix for the http endpoint of the metadata storage, without leading slash. Default: `"data"`. --storage-cs3-jwt-secret | $ACCOUNTS_STORAGE_CS3_JWT_SECRET , $OCIS_JWT_SECRET -: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. --service-user-uuid | $ACCOUNTS_SERVICE_USER_UUID -: uuid of the internal service user (required on EOS). Default: `"95cb8724-03b2-11eb-a0a6-c33ef8ef53ad"`. --service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME -: username of the internal service user (required on EOS). Default: `""`. --service-user-uid | $ACCOUNTS_SERVICE_USER_UID -: uid of the internal service user (required on EOS). Default: `0`. --service-user-gid | $ACCOUNTS_SERVICE_USER_GID -: gid of the internal service user (required on EOS). Default: `0`. --uid-index-lower-bound | $ACCOUNTS_UID_INDEX_LOWER_BOUND -: define a starting point for the account UID. Default: `0`. --gid-index-lower-bound | $ACCOUNTS_GID_INDEX_LOWER_BOUND -: define a starting point for the account GID. Default: `1000`. --uid-index-upper-bound | $ACCOUNTS_UID_INDEX_UPPER_BOUND -: define an ending point for the account UID. Default: `0`. --gid-index-upper-bound | $ACCOUNTS_GID_INDEX_UPPER_BOUND -: define an ending point for the account GID. Default: `1000`. --extensions | -: Run specific extensions during supervised mode. @@ -916,8 +912,12 @@ Usage: `accounts server [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index 2c4fd4f2a04..425412b7742 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-09-02T11:48:50+0000" +date: "2021-09-03T12:35:33+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 83bacf8c049..804860becda 100644 --- a/extensions/graph-explorer/configuration.md +++ b/extensions/graph-explorer/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-09-02T11:48:50+0000" +date: "2021-09-03T12:35:33+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph-explorer/templates @@ -73,6 +73,36 @@ Usage: `graph-explorer [global options] command [command options] [arguments...] ## Sub Commands +### graph-explorer health + +Check health status + +Usage: `graph-explorer health [command options] [arguments...]` + + + + + +-debug-addr | $GRAPH_EXPLORER_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9136"`. + + + + + + + + + + + + + + + + + + ### graph-explorer server Start integrated server @@ -151,33 +181,3 @@ Usage: `graph-explorer server [command options] [arguments...]` -extensions | : Run specific extensions during supervised mode. This flag is set by the runtime. -### graph-explorer health - -Check health status - -Usage: `graph-explorer health [command options] [arguments...]` - - - - - --debug-addr | $GRAPH_EXPLORER_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9136"`. - - - - - - - - - - - - - - - - - - diff --git a/extensions/graph/configuration.md b/extensions/graph/configuration.md index 11c1e0b960e..d5212936b96 100644 --- a/extensions/graph/configuration.md +++ b/extensions/graph/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-09-02T11:48:50+0000" +date: "2021-09-03T12:35:33+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph/templates diff --git a/extensions/idp/configuration.md b/extensions/idp/configuration.md index c0214780c67..1a4bb9a466c 100644 --- a/extensions/idp/configuration.md +++ b/extensions/idp/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-09-02T11:48:51+0000" +date: "2021-09-03T12:35:33+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/idp/templates @@ -35,141 +35,243 @@ 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: `"0.0.0.0:9134"`. +-log-file | $IDP_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. +-config-file | $IDP_CONFIG_FILE +: Path to config file. Default: `""`. +-tracing-enabled | $IDP_TRACING_ENABLED , $OCIS_TRACING_ENABLED +: Enable sending traces. +-tracing-type | $IDP_TRACING_TYPE , $OCIS_TRACING_TYPE +: Tracing backend type. Default: `"jaeger"`. +-tracing-endpoint | $IDP_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. +-tracing-collector | $IDP_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR +: Endpoint for the collector. Default: `""`. +-tracing-service | $IDP_TRACING_SERVICE +: Service name for tracing. Default: `"idp"`. +-debug-addr | $IDP_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9134"`. +-debug-token | $IDP_DEBUG_TOKEN +: Token to grant metrics access. Default: `""`. +-debug-pprof | $IDP_DEBUG_PPROF +: Enable pprof debugging. +-debug-zpages | $IDP_DEBUG_ZPAGES +: Enable zpages debugging. +-http-addr | $IDP_HTTP_ADDR +: Address to bind http server. Default: `"0.0.0.0:9130"`. +-http-root | $IDP_HTTP_ROOT +: Root path of http server. Default: `"/"`. +-http-namespace | $IDP_HTTP_NAMESPACE +: Set the base namespace for service discovery. Default: `"com.owncloud.web"`. +-name | $IDP_NAME +: Service name. Default: `"idp"`. +-identity-manager | $IDP_IDENTITY_MANAGER +: Identity manager (one of ldap,kc,cookie,dummy). Default: `"ldap"`. +-ldap-uri | $IDP_LDAP_URI +: URI of the LDAP server (glauth). Default: `"ldap://localhost:9125"`. +-ldap-bind-dn | $IDP_LDAP_BIND_DN +: Bind DN for the LDAP server (glauth). Default: `"cn=idp,ou=sysusers,dc=example,dc=org"`. +-ldap-bind-password | $IDP_LDAP_BIND_PASSWORD +: Password for the Bind DN of the LDAP server (glauth). Default: `"idp"`. +-ldap-base-dn | $IDP_LDAP_BASE_DN +: LDAP base DN of the oCIS users. Default: `"ou=users,dc=example,dc=org"`. +-ldap-scope | $IDP_LDAP_SCOPE +: LDAP scope of the oCIS users. Default: `"sub"`. +-ldap-login-attribute | $IDP_LDAP_LOGIN_ATTRIBUTE +: LDAP login attribute of the oCIS users. Default: `"cn"`. +-ldap-email-attribute | $IDP_LDAP_EMAIL_ATTRIBUTE +: LDAP email attribute of the oCIS users. Default: `"mail"`. +-ldap-name-attribute | $IDP_LDAP_NAME_ATTRIBUTE +: LDAP name attribute of the oCIS users. Default: `"sn"`. +-ldap-uuid-attribute | $IDP_LDAP_UUID_ATTRIBUTE +: LDAP UUID attribute of the oCIS users. Default: `"uid"`. +-ldap-uuid-attribute-type | $IDP_LDAP_UUID_ATTRIBUTE_TYPE +: LDAP UUID attribute type of the oCIS users. Default: `"text"`. +-ldap-filter | $IDP_LDAP_FILTER +: LDAP filter of the oCIS users. Default: `"(objectClass=posixaccount)"`. +-transport-tls-cert | $IDP_TRANSPORT_TLS_CERT +: Certificate file for transport encryption. Default: `flags.OverrideDefaultString(cfg.HTTP.TLSCert, path.Join(pkgos.MustUserConfigDir("ocis", "idp"), "server.crt"))`. +-transport-tls-key | $IDP_TRANSPORT_TLS_KEY +: Secret file for transport encryption. Default: `flags.OverrideDefaultString(cfg.HTTP.TLSKey, path.Join(pkgos.MustUserConfigDir("ocis", "idp"), "server.key"))`. -### idp ocis-idp -Serve IDP API for oCIS +-iss | $IDP_ISS , $OCIS_URL +: OIDC issuer URL. Default: `"https://localhost:9200"`. -Usage: `idp ocis-idp [command options] [arguments...]` +-signing-private-key | $IDP_SIGNING_PRIVATE_KEY +: Full path to PEM encoded private key file (must match the --signing-method algorithm). Default: `nil`. --log-level | $IDP_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. +-signing-kid | $IDP_SIGNING_KID +: Value of kid field to use in created tokens (uniquely identifying the signing-private-key). Default: `""`. --log-pretty | $IDP_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. +-validation-keys-path | $IDP_VALIDATION_KEYS_PATH +: Full path to a folder containg PEM encoded private or public key files used for token validaton (file name without extension is used as kid). Default: `""`. --log-color | $IDP_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. +-encryption-secret | $IDP_ENCRYPTION_SECRET +: Full path to a file containing a %d bytes secret key. Default: `""`. +-signing-method | $IDP_SIGNING_METHOD +: JWT default signing method. Default: `"PS256"`. +-uri-base-path | $IDP_URI_BASE_PATH +: Custom base path for URI endpoints. Default: `""`. +-sign-in-uri | $IDP_SIGN_IN_URI +: Custom redirection URI to sign-in form. Default: `""`. +-signed-out-uri | $IDP_SIGN_OUT_URI +: Custom redirection URI to signed-out goodbye page. Default: `""`. +-authorization-endpoint-uri | $IDP_ENDPOINT_URI +: Custom authorization endpoint URI. Default: `""`. +-endsession-endpoint-uri | $IDP_ENDSESSION_ENDPOINT_URI +: Custom endsession endpoint URI. Default: `""`. +-asset-path | $IDP_ASSET_PATH +: Path to custom assets. Default: `""`. +-identifier-client-path | $IDP_IDENTIFIER_CLIENT_PATH +: Path to the identifier web client base folder. Default: `"/var/tmp/ocis/idp"`. +-identifier-registration-conf | $IDP_IDENTIFIER_REGISTRATION_CONF +: Path to a identifier-registration.yaml configuration file. Default: `"./config/identifier-registration.yaml"`. +-identifier-scopes-conf | $IDP_IDENTIFIER_SCOPES_CONF +: Path to a scopes.yaml configuration file. Default: `""`. +-insecure | $IDP_INSECURE +: Disable TLS certificate and hostname validation. +-tls | $IDP_TLS +: Use TLS (disable only if idp is behind a TLS-terminating reverse-proxy).. Default: `false`. +-trusted-proxy | $IDP_TRUSTED_PROXY +: Trusted proxy IP or IP network (can be used multiple times). Default: `nil`. +-allow-scope | $IDP_ALLOW_SCOPE +: Allow OAuth 2 scope (can be used multiple times, if not set default scopes are allowed). Default: `nil`. +-allow-client-guests | $IDP_ALLOW_CLIENT_GUESTS +: Allow sign in of client controlled guest users. +-allow-dynamic-client-registration | $IDP_ALLOW_DYNAMIC_CLIENT_REGISTRATION +: Allow dynamic OAuth2 client registration. Default: `false`. +-disable-identifier-webapp | $IDP_DISABLE_IDENTIFIER_WEBAPP +: Disable built-in identifier-webapp to use a frontend hosted elsewhere.. Default: `true`. +-access-token-expiration | $IDP_ACCESS_TOKEN_EXPIRATION +: Expiration time of access tokens in seconds since generated. Default: `60 * 10`. +-id-token-expiration | $IDP_ID_TOKEN_EXPIRATION +: Expiration time of id tokens in seconds since generated. Default: `60 * 60`. +-refresh-token-expiration | $IDP_REFRESH_TOKEN_EXPIRATION +: Expiration time of refresh tokens in seconds since generated. Default: `60 * 60 * 24 * 365 * 3`. +-extensions | +: Run specific extensions during supervised mode. This flag is set by the runtime. +### idp version +Print the versions of the running instances +Usage: `idp version [command options] [arguments...]` @@ -181,248 +283,150 @@ 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: `""`. --tracing-enabled | $IDP_TRACING_ENABLED , $OCIS_TRACING_ENABLED -: Enable sending traces. --tracing-type | $IDP_TRACING_TYPE , $OCIS_TRACING_TYPE -: Tracing backend type. Default: `"jaeger"`. --tracing-endpoint | $IDP_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. --tracing-collector | $IDP_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `""`. --tracing-service | $IDP_TRACING_SERVICE -: Service name for tracing. Default: `"idp"`. --debug-addr | $IDP_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9134"`. --debug-token | $IDP_DEBUG_TOKEN -: Token to grant metrics access. Default: `""`. --debug-pprof | $IDP_DEBUG_PPROF -: Enable pprof debugging. --debug-zpages | $IDP_DEBUG_ZPAGES -: Enable zpages debugging. --http-addr | $IDP_HTTP_ADDR -: Address to bind http server. Default: `"0.0.0.0:9130"`. --http-root | $IDP_HTTP_ROOT -: Root path of http server. Default: `"/"`. --http-namespace | $IDP_HTTP_NAMESPACE -: Set the base namespace for service discovery. Default: `"com.owncloud.web"`. --name | $IDP_NAME -: Service name. Default: `"idp"`. --identity-manager | $IDP_IDENTITY_MANAGER -: Identity manager (one of ldap,kc,cookie,dummy). Default: `"ldap"`. --ldap-uri | $IDP_LDAP_URI -: URI of the LDAP server (glauth). Default: `"ldap://localhost:9125"`. --ldap-bind-dn | $IDP_LDAP_BIND_DN -: Bind DN for the LDAP server (glauth). Default: `"cn=idp,ou=sysusers,dc=example,dc=org"`. --ldap-bind-password | $IDP_LDAP_BIND_PASSWORD -: Password for the Bind DN of the LDAP server (glauth). Default: `"idp"`. --ldap-base-dn | $IDP_LDAP_BASE_DN -: LDAP base DN of the oCIS users. Default: `"ou=users,dc=example,dc=org"`. --ldap-scope | $IDP_LDAP_SCOPE -: LDAP scope of the oCIS users. Default: `"sub"`. --ldap-login-attribute | $IDP_LDAP_LOGIN_ATTRIBUTE -: LDAP login attribute of the oCIS users. Default: `"cn"`. +-http-namespace | $IDP_HTTP_NAMESPACE +: Set the base namespace for service discovery. Default: `"com.owncloud.web"`. --ldap-email-attribute | $IDP_LDAP_EMAIL_ATTRIBUTE -: LDAP email attribute of the oCIS users. Default: `"mail"`. +-name | $IDP_NAME +: Service name. Default: `"idp"`. +### idp health --ldap-name-attribute | $IDP_LDAP_NAME_ATTRIBUTE -: LDAP name attribute of the oCIS users. Default: `"sn"`. +Check health status +Usage: `idp health [command options] [arguments...]` --ldap-uuid-attribute | $IDP_LDAP_UUID_ATTRIBUTE -: LDAP UUID attribute of the oCIS users. Default: `"uid"`. --ldap-uuid-attribute-type | $IDP_LDAP_UUID_ATTRIBUTE_TYPE -: LDAP UUID attribute type of the oCIS users. Default: `"text"`. --ldap-filter | $IDP_LDAP_FILTER -: LDAP filter of the oCIS users. Default: `"(objectClass=posixaccount)"`. +-debug-addr | $IDP_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9134"`. --transport-tls-cert | $IDP_TRANSPORT_TLS_CERT -: Certificate file for transport encryption. Default: `flags.OverrideDefaultString(cfg.HTTP.TLSCert, path.Join(pkgos.MustUserConfigDir("ocis", "idp"), "server.crt"))`. --transport-tls-key | $IDP_TRANSPORT_TLS_KEY -: Secret file for transport encryption. Default: `flags.OverrideDefaultString(cfg.HTTP.TLSKey, path.Join(pkgos.MustUserConfigDir("ocis", "idp"), "server.key"))`. --iss | $IDP_ISS , $OCIS_URL -: OIDC issuer URL. Default: `"https://localhost:9200"`. --signing-private-key | $IDP_SIGNING_PRIVATE_KEY -: Full path to PEM encoded private key file (must match the --signing-method algorithm). Default: `nil`. --signing-kid | $IDP_SIGNING_KID -: Value of kid field to use in created tokens (uniquely identifying the signing-private-key). Default: `""`. --validation-keys-path | $IDP_VALIDATION_KEYS_PATH -: Full path to a folder containg PEM encoded private or public key files used for token validaton (file name without extension is used as kid). Default: `""`. --encryption-secret | $IDP_ENCRYPTION_SECRET -: Full path to a file containing a %d bytes secret key. Default: `""`. --signing-method | $IDP_SIGNING_METHOD -: JWT default signing method. Default: `"PS256"`. --uri-base-path | $IDP_URI_BASE_PATH -: Custom base path for URI endpoints. Default: `""`. --sign-in-uri | $IDP_SIGN_IN_URI -: Custom redirection URI to sign-in form. Default: `""`. --signed-out-uri | $IDP_SIGN_OUT_URI -: Custom redirection URI to signed-out goodbye page. Default: `""`. --authorization-endpoint-uri | $IDP_ENDPOINT_URI -: Custom authorization endpoint URI. Default: `""`. --endsession-endpoint-uri | $IDP_ENDSESSION_ENDPOINT_URI -: Custom endsession endpoint URI. Default: `""`. --asset-path | $IDP_ASSET_PATH -: Path to custom assets. Default: `""`. --identifier-client-path | $IDP_IDENTIFIER_CLIENT_PATH -: Path to the identifier web client base folder. Default: `"/var/tmp/ocis/idp"`. --identifier-registration-conf | $IDP_IDENTIFIER_REGISTRATION_CONF -: Path to a identifier-registration.yaml configuration file. Default: `"./config/identifier-registration.yaml"`. --identifier-scopes-conf | $IDP_IDENTIFIER_SCOPES_CONF -: Path to a scopes.yaml configuration file. Default: `""`. --insecure | $IDP_INSECURE -: Disable TLS certificate and hostname validation. --tls | $IDP_TLS -: Use TLS (disable only if idp is behind a TLS-terminating reverse-proxy).. Default: `false`. --trusted-proxy | $IDP_TRUSTED_PROXY -: Trusted proxy IP or IP network (can be used multiple times). Default: `nil`. --allow-scope | $IDP_ALLOW_SCOPE -: Allow OAuth 2 scope (can be used multiple times, if not set default scopes are allowed). Default: `nil`. --allow-client-guests | $IDP_ALLOW_CLIENT_GUESTS -: Allow sign in of client controlled guest users. --allow-dynamic-client-registration | $IDP_ALLOW_DYNAMIC_CLIENT_REGISTRATION -: Allow dynamic OAuth2 client registration. Default: `false`. --disable-identifier-webapp | $IDP_DISABLE_IDENTIFIER_WEBAPP -: Disable built-in identifier-webapp to use a frontend hosted elsewhere.. Default: `true`. --access-token-expiration | $IDP_ACCESS_TOKEN_EXPIRATION -: Expiration time of access tokens in seconds since generated. Default: `60 * 10`. --id-token-expiration | $IDP_ID_TOKEN_EXPIRATION -: Expiration time of id tokens in seconds since generated. Default: `60 * 60`. --refresh-token-expiration | $IDP_REFRESH_TOKEN_EXPIRATION -: Expiration time of refresh tokens in seconds since generated. Default: `60 * 60 * 24 * 365 * 3`. --extensions | -: Run specific extensions during supervised mode. This flag is set by the runtime. +### idp ocis-idp -### 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. @@ -479,10 +483,6 @@ Usage: `idp version [command options] [arguments...]` --http-namespace | $IDP_HTTP_NAMESPACE -: Set the base namespace for service discovery. Default: `"com.owncloud.web"`. --name | $IDP_NAME -: Service name. Default: `"idp"`. diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index 1aee25d91c1..584b0273e7e 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-09-02T11:48:51+0000" +date: "2021-09-03T12:35:33+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/templates @@ -35,6 +35,45 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. +### ocs version + +Print the versions of the running instances + +Usage: `ocs version [command options] [arguments...]` + + + + + + + + + + + + + + + + + + + + + + + + + + + +-http-namespace | $OCS_NAMESPACE +: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. + + +-name | $OCS_NAME +: Service name. Default: `"ocs"`. + ### ocs health Check health status @@ -209,42 +248,3 @@ Usage: `ocs server [command options] [arguments...]` -### ocs version - -Print the versions of the running instances - -Usage: `ocs version [command options] [arguments...]` - - - - - - - - - - - - - - - - - - - - - - - - - - - --http-namespace | $OCS_NAMESPACE -: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. - - --name | $OCS_NAME -: Service name. Default: `"ocs"`. - diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index e16079db227..827a833f004 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-09-02T11:48:51+0000" +date: "2021-09-03T12:35:33+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/proxy/templates diff --git a/extensions/settings/configuration.md b/extensions/settings/configuration.md index bc2d404368d..fd196bf16d4 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-09-02T11:48:51+0000" +date: "2021-09-03T12:35:33+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/settings/templates diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index 4653ee2ca22..b1421880602 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-09-02T11:48:51+0000" +date: "2021-09-03T12:35:34+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -179,16 +179,6 @@ Usage: `storage [global options] command [command options] [arguments...]` - - - - - - - - - - @@ -300,13 +290,9 @@ Usage: `storage [global options] command [command options] [arguments...]` -## Sub Commands -### storage storage -Storage service for oCIS -Usage: `storage storage [command options] [arguments...]` @@ -332,9 +318,13 @@ Usage: `storage storage [command options] [arguments...]` +## Sub Commands +### storage frontend +Start frontend service +Usage: `storage frontend [command options] [arguments...]` @@ -467,20 +457,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. @@ -543,53 +525,96 @@ Usage: `storage storage [command options] [arguments...]` +-debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9141"`. +-transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. +-webdav-namespace | $STORAGE_WEBDAV_NAMESPACE +: Namespace prefix for the /webdav endpoint. Default: `"/home/"`. +-dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE +: Namespace prefix for the webdav /dav/files endpoint. Default: `"/users/"`. +-network | $STORAGE_FRONTEND_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_FRONTEND_HTTP_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9140"`. +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `"https://localhost:9200"`. +-service | $STORAGE_FRONTEND_SERVICES +: --service ocdav [--service ocs]. Default: `cli.NewStringSlice("datagateway", "ocdav", "ocs", "appprovider")`. +-approvider-prefix | $STORAGE_FRONTEND_APPPROVIDER_PREFIX +: approvider prefix. Default: `""`. +-datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX +: datagateway prefix. Default: `"data"`. +-ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX +: owncloud webdav endpoint prefix. Default: `""`. +-ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX +: open collaboration services endpoint prefix. Default: `"ocs"`. -### storage sharing +-ocs-share-prefix | $STORAGE_FRONTEND_OCS_SHARE_PREFIX +: the prefix prepended to the path of shared files. Default: `"/Shares"`. -Start sharing service -Usage: `storage sharing [command options] [arguments...]` +-ocs-home-namespace | $STORAGE_FRONTEND_OCS_HOME_NAMESPACE +: the prefix prepended to the incoming requests in OCS. Default: `"/home"`. +-ocs-resource-info-cache-ttl | $STORAGE_FRONTEND_OCS_RESOURCE_INFO_CACHE_TTL +: the TTL for statted resources in the share cache. Default: `0`. +-ocs-cache-warmup-driver | $STORAGE_FRONTEND_OCS_CACHE_WARMUP_DRIVER +: the driver to be used for warming up the share cache. Default: `""`. +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `"localhost:9142"`. +-default-upload-protocol | $STORAGE_FRONTEND_DEFAULT_UPLOAD_PROTOCOL +: Default upload chunking protocol to be used out of tus/v1/ng. Default: `"tus"`. +-upload-max-chunk-size | $STORAGE_FRONTEND_UPLOAD_MAX_CHUNK_SIZE +: Max chunk size in bytes to advertise to clients through capabilities, or 0 for unlimited. Default: `0`. +-upload-http-method-override | $STORAGE_FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE +: Specify an HTTP method (ex: POST) that clients should to use when uploading instead of PATCH. Default: `""`. +-checksum-suppored-type | $STORAGE_FRONTEND_CHECKSUM_SUPPORTED_TYPES +: --checksum-suppored-type sha1 [--checksum-suppored-type adler32]. Default: `cli.NewStringSlice("sha1", "md5", "adler32")`. +-checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE +: Specify the preferred checksum algorithm used for uploads. Default: `""`. +-user-agent-whitelist-lock-in | $STORAGE_FRONTEND_MIDDLEWARE_AUTH_CREDENTIALS_BY_USER_AGENT +: --user-agent-whitelist-lock-in=mirall:basic,foo:bearer Given a tuple of comma separated [UserAgent:challenge] values, it locks a given user agent to the authentication challenge. Particularly useful for old clients whose USer-Agent is known and only support one authentication challenge. When this flag is set in the storage-frontend it configures Reva.. @@ -635,8 +660,11 @@ Usage: `storage sharing [command options] [arguments...]` +### storage health +Check health status +Usage: `storage health [command options] [arguments...]` @@ -646,48 +674,26 @@ Usage: `storage sharing [command options] [arguments...]` --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9151"`. --network | $STORAGE_SHARING_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_SHARING_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9150"`. --service | $STORAGE_SHARING_SERVICES -: --service usershareprovider [--service publicshareprovider]. Default: `cli.NewStringSlice("usershareprovider", "publicshareprovider")`. --user-driver | $STORAGE_SHARING_USER_DRIVER -: driver to use for the UserShareProvider. Default: `"json"`. --user-json-file | $STORAGE_SHARING_USER_JSON_FILE -: file used to persist shares for the UserShareProvider. Default: `"/var/tmp/ocis/storage/shares.json"`. --public-driver | $STORAGE_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `"json"`. --public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE -: file used to persist shares for the PublicShareProvider. Default: `"/var/tmp/ocis/storage/publicshares.json"`. --public-password-hash-cost | $STORAGE_SHARING_PUBLIC_PASSWORD_HASH_COST -: the cost of hashing the public shares passwords. Default: `11`. --public-enable-expired-shares-cleanup | $STORAGE_SHARING_PUBLIC_ENABLE_EXPIRED_SHARES_CLEANUP -: whether to periodically delete expired public shares. Default: `true`. --public-janitor-run-interval | $STORAGE_SHARING_PUBLIC_JANITOR_RUN_INTERVAL -: the time period in seconds after which to start a janitor run. Default: `60`. @@ -731,6 +737,8 @@ Usage: `storage sharing [command options] [arguments...]` +-debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9109"`. @@ -853,11 +861,8 @@ Usage: `storage sharing [command options] [arguments...]` -### storage storage-users -Start storage-users service -Usage: `storage storage-users [command options] [arguments...]` @@ -929,8 +934,11 @@ Usage: `storage storage-users [command options] [arguments...]` +### storage storage-public-link +Start storage-public-link service +Usage: `storage storage-public-link [command options] [arguments...]` @@ -1042,14 +1050,24 @@ Usage: `storage storage-users [command options] [arguments...]` +-debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9179"`. +-network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9178"`. +-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `"/public"`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `"localhost:9142"`. @@ -1058,64 +1076,34 @@ Usage: `storage storage-users [command options] [arguments...]` --debug-addr | $STORAGE_USERS_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9159"`. --grpc-network | $STORAGE_USERS_GRPC_NETWORK -: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --grpc-addr | $STORAGE_USERS_GRPC_ADDR -: GRPC Address to bind users storage. Default: `"0.0.0.0:9157"`. --http-network | $STORAGE_USERS_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --http-addr | $STORAGE_USERS_HTTP_ADDR -: HTTP Address to bind users storage. Default: `"0.0.0.0:9158"`. --driver | $STORAGE_USERS_DRIVER -: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. --read-only | $STORAGE_USERS_READ_ONLY , $OCIS_STORAGE_READ_ONLY -: use storage driver in read-only mode. Default: `false`. --mount-path | $STORAGE_USERS_MOUNT_PATH -: mount path. Default: `"/users"`. --mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. --expose-data-server | $STORAGE_USERS_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. --data-server-url | $STORAGE_USERS_DATA_SERVER_URL -: data server url. Default: `"http://localhost:9158/data"`. --http-prefix | $STORAGE_USERS_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `"data"`. --tmp-folder | $STORAGE_USERS_TMP_FOLDER -: path to tmp folder. Default: `"/var/tmp/ocis/tmp/users"`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `"localhost:9142"`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9144"`. @@ -1151,11 +1139,8 @@ Usage: `storage storage-users [command options] [arguments...]` -### storage auth-bearer -Start authprovider for bearer auth -Usage: `storage auth-bearer [command options] [arguments...]` @@ -1178,44 +1163,24 @@ Usage: `storage auth-bearer [command options] [arguments...]` --debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9149"`. --oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL -: OIDC issuer. Default: `"https://localhost:9200"`. --oidc-insecure | $STORAGE_OIDC_INSECURE -: OIDC allow insecure communication. Default: `true`. --oidc-id-claim | $STORAGE_OIDC_ID_CLAIM -: OIDC id claim. Default: `"preferred_username"`. --oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM -: OIDC uid claim. Default: `""`. --oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM -: OIDC gid claim. Default: `""`. --network | $STORAGE_AUTH_BEARER_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_AUTH_BEARER_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9148"`. --service | $STORAGE_AUTH_BEARER_SERVICES -: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `"localhost:9142"`. @@ -1255,8 +1220,11 @@ Usage: `storage auth-bearer [command options] [arguments...]` +### storage storage-users +Start storage-users service +Usage: `storage storage-users [command options] [arguments...]` @@ -1411,37 +1379,64 @@ Usage: `storage auth-bearer [command options] [arguments...]` +-debug-addr | $STORAGE_USERS_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9159"`. +-grpc-network | $STORAGE_USERS_GRPC_NETWORK +: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-grpc-addr | $STORAGE_USERS_GRPC_ADDR +: GRPC Address to bind users storage. Default: `"0.0.0.0:9157"`. +-http-network | $STORAGE_USERS_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-http-addr | $STORAGE_USERS_HTTP_ADDR +: HTTP Address to bind users storage. Default: `"0.0.0.0:9158"`. +-driver | $STORAGE_USERS_DRIVER +: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. +-read-only | $STORAGE_USERS_READ_ONLY , $OCIS_STORAGE_READ_ONLY +: use storage driver in read-only mode. Default: `false`. +-mount-path | $STORAGE_USERS_MOUNT_PATH +: mount path. Default: `"/users"`. +-mount-id | $STORAGE_USERS_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. +-expose-data-server | $STORAGE_USERS_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. +-data-server-url | $STORAGE_USERS_DATA_SERVER_URL +: data server url. Default: `"http://localhost:9158/data"`. +-http-prefix | $STORAGE_USERS_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `"data"`. -### storage frontend -Start frontend service +-tmp-folder | $STORAGE_USERS_TMP_FOLDER +: path to tmp folder. Default: `"/var/tmp/ocis/tmp/users"`. -Usage: `storage frontend [command options] [arguments...]` +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `"localhost:9142"`. +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9144"`. @@ -1541,8 +1536,11 @@ Usage: `storage frontend [command options] [arguments...]` +### storage groups +Start groups service +Usage: `storage groups [command options] [arguments...]` @@ -1607,20 +1605,36 @@ Usage: `storage frontend [command options] [arguments...]` +-debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9161"`. +-network | $STORAGE_GROUPPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_GROUPPROVIDER_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9160"`. +-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `"localhost:9160"`. +-service | $STORAGE_GROUPPROVIDER_SERVICES +: --service groupprovider [--service otherservice]. Default: `cli.NewStringSlice("groupprovider")`. +-driver | $STORAGE_GROUPPROVIDER_DRIVER +: group driver: 'json', 'ldap', or 'rest'. Default: `"ldap"`. +-json-config | $STORAGE_GROUPPROVIDER_JSON +: Path to groups.json file. Default: `""`. +-group-members-cache-expiration | $STORAGE_GROUP_CACHE_EXPIRATION +: Time in minutes for redis cache expiration.. Default: `5`. @@ -1666,98 +1680,51 @@ Usage: `storage frontend [command options] [arguments...]` --debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9141"`. --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. --webdav-namespace | $STORAGE_WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `"/home/"`. --dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `"/users/"`. --network | $STORAGE_FRONTEND_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_FRONTEND_HTTP_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9140"`. --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `"https://localhost:9200"`. --service | $STORAGE_FRONTEND_SERVICES -: --service ocdav [--service ocs]. Default: `cli.NewStringSlice("datagateway", "ocdav", "ocs")`. --datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `"data"`. --ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. Default: `""`. --ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX -: open collaboration services endpoint prefix. Default: `"ocs"`. --ocs-share-prefix | $STORAGE_FRONTEND_OCS_SHARE_PREFIX -: the prefix prepended to the path of shared files. Default: `"/Shares"`. --ocs-home-namespace | $STORAGE_FRONTEND_OCS_HOME_NAMESPACE -: the prefix prepended to the incoming requests in OCS. Default: `"/home"`. --ocs-resource-info-cache-ttl | $STORAGE_FRONTEND_OCS_RESOURCE_INFO_CACHE_TTL -: the TTL for statted resources in the share cache. Default: `0`. --ocs-cache-warmup-driver | $STORAGE_FRONTEND_OCS_CACHE_WARMUP_DRIVER -: the driver to be used for warming up the share cache. Default: `""`. --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `"localhost:9142"`. --default-upload-protocol | $STORAGE_FRONTEND_DEFAULT_UPLOAD_PROTOCOL -: Default upload chunking protocol to be used out of tus/v1/ng. Default: `"tus"`. --upload-max-chunk-size | $STORAGE_FRONTEND_UPLOAD_MAX_CHUNK_SIZE -: Max chunk size in bytes to advertise to clients through capabilities, or 0 for unlimited. Default: `0`. --upload-http-method-override | $STORAGE_FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE -: Specify an HTTP method (ex: POST) that clients should to use when uploading instead of PATCH. Default: `""`. --checksum-suppored-type | $STORAGE_FRONTEND_CHECKSUM_SUPPORTED_TYPES -: --checksum-suppored-type sha1 [--checksum-suppored-type adler32]. Default: `cli.NewStringSlice("sha1", "md5", "adler32")`. --checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE -: Specify the preferred checksum algorithm used for uploads. Default: `""`. --user-agent-whitelist-lock-in | $STORAGE_FRONTEND_MIDDLEWARE_AUTH_CREDENTIALS_BY_USER_AGENT -: --user-agent-whitelist-lock-in=mirall:basic,foo:bearer Given a tuple of comma separated [UserAgent:challenge] values, it locks a given user agent to the authentication challenge. Particularly useful for old clients whose USer-Agent is known and only support one authentication challenge. When this flag is set in the storage-frontend it configures Reva.. -### storage gateway -Start gateway -Usage: `storage gateway [command options] [arguments...]` @@ -1800,132 +1767,653 @@ Usage: `storage gateway [command options] [arguments...]` --debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9143"`. --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. --transfer-expires | $STORAGE_TRANSFER_EXPIRES -: Transfer token ttl in seconds. Default: `24 * 60 * 60`. --network | $STORAGE_GATEWAY_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_GATEWAY_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9142"`. --endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9142"`. --service | $STORAGE_GATEWAY_SERVICES -: --service gateway [--service authregistry]. Default: `cli.NewStringSlice("gateway", "authregistry", "storageregistry")`. --commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT -: Commit shares to the share manager. Default: `true`. --commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF -: Commit shares to the storage. Default: `true`. --share-folder | $STORAGE_GATEWAY_SHARE_FOLDER -: mount shares in this folder of the home storage provider. Default: `"Shares"`. --disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN -: Disable creation of home folder on login. --storage-home-mapping | $STORAGE_GATEWAY_HOME_MAPPING -: mapping template for user home paths to user-specific mount points, e.g. /home/{{substr 0 1 .Username}}. Default: `""`. --etag-cache-ttl | $STORAGE_GATEWAY_ETAG_CACHE_TTL -: TTL for the home and shares directory etags cache. Default: `0`. --auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT -: endpoint to use for the basic auth provider. Default: `"localhost:9146"`. --auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT -: endpoint to use for the bearer auth provider. Default: `"localhost:9148"`. --storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER -: driver of the storage registry. Default: `"static"`. --storage-registry-rule | $STORAGE_STORAGE_REGISTRY_RULES -: `Replaces the generated storage registry rules with this set: --storage-registry-rule "/eos=localhost:9158" [--storage-registry-rule "1284d238-aa92-42ce-bdc4-0b0000009162=localhost:9162"]`. Default: `cli.NewStringSlice()`. --storage-home-provider | $STORAGE_STORAGE_REGISTRY_HOME_PROVIDER -: mount point of the storage provider for user homes in the global namespace. Default: `"/home"`. --storage-registry-json | $STORAGE_STORAGE_REGISTRY_JSON -: JSON file containing the storage registry rules. Default: `""`. --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `"https://localhost:9200"`. --datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL -: URL to use for the storage datagateway, defaults to /data. Default: `""`. --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider. Default: `"localhost:9144"`. --groupprovider-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: endpoint to use for the groupprovider. Default: `"localhost:9160"`. --sharing-endpoint | $STORAGE_SHARING_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9150"`. --storage-home-endpoint | $STORAGE_HOME_ENDPOINT -: endpoint to use for the home storage. Default: `"localhost:9154"`. --storage-home-mount-path | $STORAGE_HOME_MOUNT_PATH -: mount path. Default: `"/home"`. --storage-home-mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009154"`. --storage-users-endpoint | $STORAGE_USERS_ENDPOINT -: endpoint to use for the users storage. Default: `"localhost:9157"`. --storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH -: mount path. Default: `"/users"`. --storage-users-mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. --public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT -: endpoint to use for the public links service. Default: `"localhost:9178"`. --storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `"/public"`. + + +### storage users + +Start users service + +Usage: `storage users [command options] [arguments...]` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +-debug-addr | $STORAGE_USERPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9145"`. + + +-network | $STORAGE_USERPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. + + +-addr | $STORAGE_USERPROVIDER_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9144"`. + + +-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `"localhost:9144"`. + + +-service | $STORAGE_USERPROVIDER_SERVICES +: --service userprovider [--service otherservice]. Default: `cli.NewStringSlice("userprovider")`. + + +-driver | $STORAGE_USERPROVIDER_DRIVER +: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `"ldap"`. + + +-json-config | $STORAGE_USERPROVIDER_JSON +: Path to users.json file. Default: `""`. + + +-user-groups-cache-expiration | $STORAGE_USER_CACHE_EXPIRATION +: Time in minutes for redis cache expiration.. Default: `5`. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +### storage app-provider + +Start appprovider for providing apps + +Usage: `storage app-provider [command options] [arguments...]` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +-debug-addr | $APP_PROVIDER_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9165"`. + + +-network | $APP_PROVIDER_BASIC_GRPC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. + + +-addr | $APP_PROVIDER_BASIC_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9164"`. + + +-external-addr | $APP_PROVIDER_BASIC_EXTERNAL_ADDR +: Address to connect to the storage service for other services. Default: `"127.0.0.1:9164"`. + + +-service | $APP_PROVIDER_BASIC_SERVICES +: --service appprovider [--service otherservice]. Default: `cli.NewStringSlice("appprovider")`. + + +-driver | $APP_PROVIDER_DRIVER +: Driver to use for app provider. Default: `""`. + + +-wopi-driver-app-apikey | $APP_PROVIDER_WOPI_DRIVER_APP_API_KEY +: The API key used by the app, if applicable.. Default: `""`. + + +-wopi-driver-app-desktop-only | $APP_PROVIDER_WOPI_DRIVER_APP_DESKTOP_ONLY +: Whether the app can be opened only on desktop. Default: `false`. + + +-wopi-driver-app-icon-uri | $APP_PROVIDER_WOPI_DRIVER_APP_ICON_URI +: IOP Secret (Shared with WOPI server). Default: `""`. + + +-wopi-driver-app-internal-url | $APP_PROVIDER_WOPI_DRIVER_APP_INTERNAL_URL +: The internal app URL in case of dockerized deployments. Defaults to AppURL. Default: `""`. + + +-wopi-driver-app-name | $APP_PROVIDER_WOPI_DRIVER_APP_NAME +: The App user-friendly name.. Default: `""`. + + +-wopi-driver-app-url | $APP_PROVIDER_WOPI_DRIVER_APP_URL +: App server URL. Default: `""`. + + +-wopi-driver-insecure | $APP_PROVIDER_WOPI_DRIVER_INSECURE +: Disable SSL certificate verification of WOPI server and WOPI bridge. Default: `false`. + + +-wopi-driver-iopsecret | $APP_PROVIDER_WOPI_DRIVER_IOP_SECRET +: IOP Secret (Shared with WOPI server). Default: `""`. + + +-wopi-driver-wopiurl | $APP_PROVIDER_WOPI_DRIVER_WOPI_URL +: WOPI server URL. Default: `""`. + + +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `"localhost:9142"`. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1957,28 +2445,51 @@ Usage: `storage gateway [command options] [arguments...]` +### storage auth-bearer +Start authprovider for bearer auth +Usage: `storage auth-bearer [command options] [arguments...]` +-debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9149"`. +-oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL +: OIDC issuer. Default: `"https://localhost:9200"`. +-oidc-insecure | $STORAGE_OIDC_INSECURE +: OIDC allow insecure communication. Default: `true`. +-oidc-id-claim | $STORAGE_OIDC_ID_CLAIM +: OIDC id claim. Default: `"preferred_username"`. +-oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM +: OIDC uid claim. Default: `""`. +-oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM +: OIDC gid claim. Default: `""`. +-network | $STORAGE_AUTH_BEARER_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_AUTH_BEARER_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9148"`. +-service | $STORAGE_AUTH_BEARER_SERVICES +: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `"localhost:9142"`. @@ -2102,11 +2613,8 @@ Usage: `storage gateway [command options] [arguments...]` -### storage storage-metadata -Start storage-metadata service -Usage: `storage storage-metadata [command options] [arguments...]` @@ -2222,6 +2730,47 @@ Usage: `storage storage-metadata [command options] [arguments...]` + + + + + + + + + + + + + + + + +### storage gateway + +Start gateway + +Usage: `storage gateway [command options] [arguments...]` + + + + + + + + + + + + + + + + + + + + @@ -2267,20 +2816,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. @@ -2288,48 +2829,26 @@ Usage: `storage storage-metadata [command options] [arguments...]` --debug-addr | $STORAGE_METADATA_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9217"`. --grpc-network | $STORAGE_METADATA_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9215"`. --data-server-url | $STORAGE_METADATA_DATA_SERVER_URL -: URL of the data-provider the storage-provider uses. Default: `"http://localhost:9216"`. --http-network | $STORAGE_METADATA_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --http-addr | $STORAGE_METADATA_HTTP_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9216"`. --tmp-folder | $STORAGE_METADATA_TMP_FOLDER -: path to tmp folder. Default: `"/var/tmp/ocis/tmp/metadata"`. --driver | $STORAGE_METADATA_DRIVER -: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the gateway service. Default: `"localhost:9142"`. --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider service. Default: `"localhost:9144"`. --storage-root | $STORAGE_METADATA_ROOT -: the path to the metadata storage root. Default: `"/var/tmp/ocis/storage/metadata"`. @@ -2400,11 +2919,8 @@ Usage: `storage storage-metadata [command options] [arguments...]` -### storage users -Start users service -Usage: `storage users [command options] [arguments...]` @@ -2412,36 +2928,20 @@ Usage: `storage users [command options] [arguments...]` --debug-addr | $STORAGE_USERPROVIDER_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9145"`. --network | $STORAGE_USERPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_USERPROVIDER_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9144"`. --endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `"localhost:9144"`. --service | $STORAGE_USERPROVIDER_SERVICES -: --service userprovider [--service otherservice]. Default: `cli.NewStringSlice("userprovider")`. --driver | $STORAGE_USERPROVIDER_DRIVER -: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `"ldap"`. --json-config | $STORAGE_USERPROVIDER_JSON -: Path to users.json file. Default: `""`. --user-groups-cache-expiration | $STORAGE_USER_CACHE_EXPIRATION -: Time in minutes for redis cache expiration.. Default: `5`. @@ -2473,26 +2973,137 @@ Usage: `storage users [command options] [arguments...]` + +-debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9143"`. + + +-transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. + + +-transfer-expires | $STORAGE_TRANSFER_EXPIRES +: Transfer token ttl in seconds. Default: `24 * 60 * 60`. + + +-network | $STORAGE_GATEWAY_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. + + +-addr | $STORAGE_GATEWAY_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9142"`. + + +-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9142"`. + + +-service | $STORAGE_GATEWAY_SERVICES +: --service gateway [--service authregistry]. Default: `cli.NewStringSlice("gateway", "authregistry", "storageregistry", "appregistry")`. + + +-commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT +: Commit shares to the share manager. Default: `true`. + + +-commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF +: Commit shares to the storage. Default: `true`. + + +-share-folder | $STORAGE_GATEWAY_SHARE_FOLDER +: mount shares in this folder of the home storage provider. Default: `"Shares"`. + + +-disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN +: Disable creation of home folder on login. + + +-storage-home-mapping | $STORAGE_GATEWAY_HOME_MAPPING +: mapping template for user home paths to user-specific mount points, e.g. /home/{{substr 0 1 .Username}}. Default: `""`. + + +-etag-cache-ttl | $STORAGE_GATEWAY_ETAG_CACHE_TTL +: TTL for the home and shares directory etags cache. Default: `0`. + + +-auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT +: endpoint to use for the basic auth provider. Default: `"localhost:9146"`. + + +-auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT +: endpoint to use for the bearer auth provider. Default: `"localhost:9148"`. + + +-storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER +: driver of the storage registry. Default: `"static"`. + + +-storage-registry-rule | $STORAGE_STORAGE_REGISTRY_RULES +: `Replaces the generated storage registry rules with this set: --storage-registry-rule "/eos=localhost:9158" [--storage-registry-rule "1284d238-aa92-42ce-bdc4-0b0000009162=localhost:9162"]`. Default: `cli.NewStringSlice()`. + + +-storage-home-provider | $STORAGE_STORAGE_REGISTRY_HOME_PROVIDER +: mount point of the storage provider for user homes in the global namespace. Default: `"/home"`. + + +-storage-registry-json | $STORAGE_STORAGE_REGISTRY_JSON +: JSON file containing the storage registry rules. Default: `""`. + + +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `"https://localhost:9200"`. + + +-datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL +: URL to use for the storage datagateway, defaults to /data. Default: `""`. + + +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider. Default: `"localhost:9144"`. + + +-groupprovider-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: endpoint to use for the groupprovider. Default: `"localhost:9160"`. +-sharing-endpoint | $STORAGE_SHARING_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9150"`. +-appprovider-endpoint | $STORAGE_APPPROVIDER_ENDPOINT +: endpoint to use for the app provider. Default: `"localhost:9164"`. +-storage-home-endpoint | $STORAGE_HOME_ENDPOINT +: endpoint to use for the home storage. Default: `"localhost:9154"`. +-storage-home-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `"/home"`. +-storage-home-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009154"`. +-storage-users-endpoint | $STORAGE_USERS_ENDPOINT +: endpoint to use for the users storage. Default: `"localhost:9157"`. +-storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH +: mount path. Default: `"/users"`. +-storage-users-mount-id | $STORAGE_USERS_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. +-public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT +: endpoint to use for the public links service. Default: `"localhost:9178"`. +-storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `"/public"`. @@ -2505,8 +3116,11 @@ Usage: `storage users [command options] [arguments...]` +### storage storage +Storage service for oCIS +Usage: `storage storage [command options] [arguments...]` @@ -2657,12 +3271,20 @@ Usage: `storage users [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. @@ -2677,11 +3299,8 @@ Usage: `storage users [command options] [arguments...]` -### storage groups -Start groups service -Usage: `storage groups [command options] [arguments...]` @@ -2780,8 +3399,11 @@ Usage: `storage groups [command options] [arguments...]` +### storage auth-basic +Start authprovider for basic auth +Usage: `storage auth-basic [command options] [arguments...]` @@ -2834,36 +3456,20 @@ Usage: `storage groups [command options] [arguments...]` --debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9161"`. --network | $STORAGE_GROUPPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_GROUPPROVIDER_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9160"`. --endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `"localhost:9160"`. --service | $STORAGE_GROUPPROVIDER_SERVICES -: --service groupprovider [--service otherservice]. Default: `cli.NewStringSlice("groupprovider")`. --driver | $STORAGE_GROUPPROVIDER_DRIVER -: group driver: 'json', 'ldap', or 'rest'. Default: `"ldap"`. --json-config | $STORAGE_GROUPPROVIDER_JSON -: Path to groups.json file. Default: `""`. --group-members-cache-expiration | $STORAGE_GROUP_CACHE_EXPIRATION -: Time in minutes for redis cache expiration.. Default: `5`. @@ -2954,11 +3560,8 @@ Usage: `storage groups [command options] [arguments...]` -### storage health -Check health status -Usage: `storage health [command options] [arguments...]` @@ -2980,18 +3583,32 @@ Usage: `storage health [command options] [arguments...]` +-debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9147"`. +-auth-driver | $STORAGE_AUTH_DRIVER +: auth driver: 'demo', 'json' or 'ldap'. Default: `"ldap"`. +-auth-json | $STORAGE_AUTH_JSON +: Path to users.json file. Default: `""`. +-network | $STORAGE_AUTH_BASIC_GRPC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_AUTH_BASIC_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9146"`. +-service | $STORAGE_AUTH_BASIC_SERVICES +: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `"localhost:9142"`. @@ -3044,8 +3661,6 @@ Usage: `storage health [command options] [arguments...]` --debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9109"`. @@ -3076,8 +3691,11 @@ Usage: `storage health [command options] [arguments...]` +### storage sharing +Start sharing service +Usage: `storage sharing [command options] [arguments...]` @@ -3210,11 +3828,8 @@ Usage: `storage health [command options] [arguments...]` -### storage storage-home -Start storage-home service -Usage: `storage storage-home [command options] [arguments...]` @@ -3337,29 +3952,54 @@ Usage: `storage storage-home [command options] [arguments...]` +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9151"`. +-network | $STORAGE_SHARING_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9150"`. +-service | $STORAGE_SHARING_SERVICES +: --service usershareprovider [--service publicshareprovider]. Default: `cli.NewStringSlice("usershareprovider", "publicshareprovider")`. +-user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `"json"`. +-user-json-file | $STORAGE_SHARING_USER_JSON_FILE +: file used to persist shares for the UserShareProvider. Default: `"/var/tmp/ocis/storage/shares.json"`. +-public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `"json"`. +-public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE +: file used to persist shares for the PublicShareProvider. Default: `"/var/tmp/ocis/storage/publicshares.json"`. +-public-password-hash-cost | $STORAGE_SHARING_PUBLIC_PASSWORD_HASH_COST +: the cost of hashing the public shares passwords. Default: `11`. +-public-enable-expired-shares-cleanup | $STORAGE_SHARING_PUBLIC_ENABLE_EXPIRED_SHARES_CLEANUP +: whether to periodically delete expired public shares. Default: `true`. +-public-janitor-run-interval | $STORAGE_SHARING_PUBLIC_JANITOR_RUN_INTERVAL +: the time period in seconds after which to start a janitor run. Default: `60`. +### storage storage-home +Start storage-home service +Usage: `storage storage-home [command options] [arguments...]` @@ -3494,89 +4134,6 @@ Usage: `storage storage-home [command options] [arguments...]` - - - - - - - - - - - - - - - - - -### storage auth-basic - -Start authprovider for basic auth - -Usage: `storage auth-basic [command options] [arguments...]` - - - - - - - - - - - - - - - --debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9147"`. - - --auth-driver | $STORAGE_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `"ldap"`. - - --auth-json | $STORAGE_AUTH_JSON -: Path to users.json file. Default: `""`. - - --network | $STORAGE_AUTH_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. - - --addr | $STORAGE_AUTH_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9146"`. - - --service | $STORAGE_AUTH_BASIC_SERVICES -: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. - - --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `"localhost:9142"`. - - - - - - - - - - - - - - - - - - - - @@ -3757,8 +4314,11 @@ Usage: `storage auth-basic [command options] [arguments...]` +### storage storage-metadata +Start storage-metadata service +Usage: `storage storage-metadata [command options] [arguments...]` @@ -3785,31 +4345,18 @@ Usage: `storage auth-basic [command options] [arguments...]` -### storage storage-public-link -Start storage-public-link service -Usage: `storage storage-public-link [command options] [arguments...]` --debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9179"`. --network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9178"`. --mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `"/public"`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `"localhost:9142"`. @@ -3872,26 +4419,48 @@ Usage: `storage storage-public-link [command options] [arguments...]` +-debug-addr | $STORAGE_METADATA_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9217"`. +-grpc-network | $STORAGE_METADATA_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9215"`. +-data-server-url | $STORAGE_METADATA_DATA_SERVER_URL +: URL of the data-provider the storage-provider uses. Default: `"http://localhost:9216"`. +-http-network | $STORAGE_METADATA_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-http-addr | $STORAGE_METADATA_HTTP_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9216"`. +-tmp-folder | $STORAGE_METADATA_TMP_FOLDER +: path to tmp folder. Default: `"/var/tmp/ocis/tmp/metadata"`. +-driver | $STORAGE_METADATA_DRIVER +: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the gateway service. Default: `"localhost:9142"`. +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider service. Default: `"localhost:9144"`. +-storage-root | $STORAGE_METADATA_ROOT +: the path to the metadata storage root. Default: `"/var/tmp/ocis/storage/metadata"`. @@ -3933,12 +4502,20 @@ Usage: `storage storage-public-link [command options] [arguments...]` +-config-file | $STORAGE_CONFIG_FILE +: Path to config file. +-log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. diff --git a/extensions/storage/ports.md b/extensions/storage/ports.md index 83ef871b860..2ab34f5dd92 100644 --- a/extensions/storage/ports.md +++ b/extensions/storage/ports.md @@ -34,6 +34,8 @@ For now, the storage service uses these ports to preconfigure those services: | 9159 | storage users debug | | 9160 | groups | | 9161 | groups debug | +| 9164 | storage appprovider | +| 9165 | storage appprovider debug | | 9178 | storage public link | | 9179 | storage public link data | | 9215 | storage meta grpc | diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index d79fcf9a698..32270d52eb1 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-09-02T11:48:51+0000" +date: "2021-09-03T12:35:34+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates @@ -35,39 +35,6 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### store version - -Print the versions of the running instances - -Usage: `store version [command options] [arguments...]` - - - - - - - - - - - - - - - - - - - - - --grpc-namespace | $STORE_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. - - --name | $STORE_NAME -: Service name. Default: `"store"`. - ### store health Check health status @@ -206,3 +173,36 @@ Usage: `store server [command options] [arguments...]` +### store version + +Print the versions of the running instances + +Usage: `store version [command options] [arguments...]` + + + + + + + + + + + + + + + + + + + + + +-grpc-namespace | $STORE_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. + + +-name | $STORE_NAME +: Service name. Default: `"store"`. + diff --git a/extensions/thumbnails/configuration.md b/extensions/thumbnails/configuration.md index 7b88c4ff820..20eb8ebdeb1 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-09-02T11:48:52+0000" +date: "2021-09-03T12:35:34+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates @@ -35,6 +35,44 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. +### thumbnails version + +Print the versions of the running instances + +Usage: `thumbnails version [command options] [arguments...]` + + + + + + + + + + + + + + + + + + + + + + + + + + +-grpc-name | $THUMBNAILS_GRPC_NAME +: Name of the service. Default: `"thumbnails"`. + + +-grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. + ### thumbnails health Check health status @@ -203,41 +241,3 @@ Usage: `thumbnails server [command options] [arguments...]` -### thumbnails version - -Print the versions of the running instances - -Usage: `thumbnails version [command options] [arguments...]` - - - - - - - - - - - - - - - - - - - - - - - - - - --grpc-name | $THUMBNAILS_GRPC_NAME -: Name of the service. Default: `"thumbnails"`. - - --grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. - diff --git a/extensions/web/configuration.md b/extensions/web/configuration.md index f2d45697b89..a212d464b5c 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-09-02T11:48:52+0000" +date: "2021-09-03T12:35:35+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 22efeb417a5..4bec1c43584 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-09-02T11:48:52+0000" +date: "2021-09-03T12:35:35+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates @@ -67,42 +67,6 @@ Usage: `webdav [global options] command [command options] [arguments...]` ## Sub Commands -### webdav version - -Print the versions of the running instances - -Usage: `webdav version [command options] [arguments...]` - - - - - - - - - - - - - - - - - - - - - - - - --http-namespace | $WEBDAV_HTTP_NAMESPACE -: Set the base namespace for service discovery. Default: `"com.owncloud.web"`. - - --service-name | $WEBDAV_SERVICE_NAME -: Service name. Default: `"webdav"`. - ### webdav health Check health status @@ -229,3 +193,39 @@ Usage: `webdav server [command options] [arguments...]` +### webdav version + +Print the versions of the running instances + +Usage: `webdav version [command options] [arguments...]` + + + + + + + + + + + + + + + + + + + + + + + + +-http-namespace | $WEBDAV_HTTP_NAMESPACE +: Set the base namespace for service discovery. Default: `"com.owncloud.web"`. + + +-service-name | $WEBDAV_SERVICE_NAME +: Service name. Default: `"webdav"`. + diff --git a/ocis/configuration.md b/ocis/configuration.md index c7d0a175065..94850b35fb9 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-09-02T11:48:51+0000" +date: "2021-09-03T12:35:33+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -133,34 +133,6 @@ Usage: `ocis run [command options] [arguments...]` - - - -### ocis list - -Lists running ocis extensions - -Usage: `ocis list [command options] [arguments...]` - - - - - - - - - - - - - - - - - - - - @@ -216,11 +188,11 @@ Usage: `ocis server [command options] [arguments...]` -extensions | $OCIS_RUN_EXTENSIONS : Run specific extensions during supervised mode. -### ocis kill +### ocis health -Kill an extension by name +Check health status -Usage: `ocis kill [command options] [arguments...]` +Usage: `ocis health [command options] [arguments...]` @@ -236,6 +208,8 @@ Usage: `ocis kill [command options] [arguments...]` +-debug-addr | $OCIS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9010`. @@ -244,12 +218,12 @@ Usage: `ocis kill [command options] [arguments...]` -### ocis health -Check health status +### ocis list -Usage: `ocis health [command options] [arguments...]` +Lists running ocis extensions +Usage: `ocis list [command options] [arguments...]` @@ -264,8 +238,6 @@ Usage: `ocis health [command options] [arguments...]` --debug-addr | $OCIS_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9010`. @@ -275,29 +247,37 @@ Usage: `ocis health [command options] [arguments...]` -### List of available Extension subcommands +### ocis kill + +Kill an extension by name + +Usage: `ocis kill [command options] [arguments...]` + + + + + + + + + + -There are more subcommands to start the individual extensions. Please check the documentation about their usage and options in the dedicated section of the documentation. -#### ocis accounts -Start accounts server -#### ocis storage-groupprovider -Start storage groupprovider service -#### ocis storage-userprovider -Start storage userprovider service -#### ocis web -Start web server -#### ocis storage-auth-bearer -Start storage auth-bearer service + + +### 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 thumbnails @@ -311,59 +291,83 @@ Start idp server Start storage auth-basic service -#### ocis storage-frontend - -Start storage frontend - #### ocis storage-metadata Start storage and data service for metadata -#### ocis version +#### ocis storage-users -Lists running services with version +Start storage and data provider for /users mount -#### ocis glauth +#### ocis webdav -Start glauth server +Start webdav server -#### ocis storage-sharing +#### ocis storage-auth-bearer -Start storage sharing service +Start storage auth-bearer service -#### ocis storage-users +#### ocis storage-gateway -Start storage and data provider for /users mount +Start storage gateway -#### ocis store +#### ocis version -Start a go-micro store +Lists running services with version #### ocis ocs Start ocs server -#### ocis proxy +#### ocis settings -Start proxy server +Start settings server -#### ocis storage-gateway +#### ocis storage-frontend -Start storage gateway +Start storage frontend + +#### ocis storage-groupprovider + +Start storage groupprovider service + +#### ocis web + +Start web server + +#### ocis glauth + +Start glauth server + +#### ocis proxy + +Start proxy server #### ocis storage-home Start storage and data provider for /home mount -#### ocis webdav +#### ocis storage-app-provider -Start webdav server +Start storage app-provider service -#### ocis settings +#### ocis accounts -Start settings server +Start accounts server #### ocis storage-public-link Start storage public link storage +#### ocis storage-sharing + +Start storage sharing service + +#### ocis storage-userprovider + +Start storage userprovider service + +#### ocis store + +Start a go-micro store +