diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 3deb7eda555..d462e098316 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-08-13T10:26:09+0000" +date: "2021-08-13T13:03:20+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -155,11 +155,11 @@ Usage: `accounts add [command options] [arguments...]` -### accounts update +### accounts remove -Make changes to an existing account +Removes an existing account -Usage: `accounts update [command options] [arguments...]` +Usage: `accounts remove [command options] [arguments...]` @@ -196,139 +196,175 @@ Usage: `accounts update [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. --enabled | -: Enable the account. --displayname | -: Set the displayname for the account. --preferred-name | -: Set the preferred-name for the account. --on-premises-sam-account-name | -: Set the on-premises-sam-account-name. --uidnumber | -: Set the uidnumber for the account. --gidnumber | -: Set the gidnumber for the account. --mail | -: Set the mail for the account. --description | -: Set the description for the account. --password | -: Set the password for the account. --password-policies | -: Possible policies: DisableStrongPassword, DisablePasswordExpiration. --force-password-change | -: Force password change on next sign-in. --force-password-change-mfa | -: Force password change on next sign-in with mfa. +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +### accounts server +Start ocis accounts service +Usage: `accounts server [command options] [arguments...]` +-log-file | $ACCOUNTS_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. +-tracing-enabled | $ACCOUNTS_TRACING_ENABLED +: Enable sending traces. -### accounts remove +-tracing-type | $ACCOUNTS_TRACING_TYPE +: Tracing backend type. Default: `"jaeger"`. -Removes an existing account -Usage: `accounts remove [command options] [arguments...]` +-tracing-endpoint | $ACCOUNTS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. +-tracing-collector | $ACCOUNTS_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. @@ -344,44 +380,32 @@ Usage: `accounts remove [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. -### accounts ocis-accounts -Provide accounts and groups for oCIS -Usage: `accounts ocis-accounts [command options] [arguments...]` --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 version +Print the versions of the running instances +Usage: `accounts version [command options] [arguments...]` @@ -440,135 +464,79 @@ Usage: `accounts ocis-accounts [command options] [arguments...]` -### accounts server -Start ocis accounts service -Usage: `accounts server [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --log-file | $ACCOUNTS_LOG_FILE , $OCIS_LOG_FILE -: Enable log to file. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. --tracing-enabled | $ACCOUNTS_TRACING_ENABLED -: Enable sending traces. --tracing-type | $ACCOUNTS_TRACING_TYPE -: Tracing backend type. Default: `"jaeger"`. --tracing-endpoint | $ACCOUNTS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. +### accounts inspect +Show detailed data on an existing account --tracing-collector | $ACCOUNTS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `""`. +Usage: `accounts inspect [command options] [arguments...]` --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. @@ -588,11 +556,18 @@ 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"`. +### accounts list +List existing accounts +Usage: `accounts list [command options] [arguments...]` @@ -605,11 +580,8 @@ Usage: `accounts server [command options] [arguments...]` -### accounts version -Print the versions of the running instances -Usage: `accounts version [command options] [arguments...]` @@ -661,36 +633,36 @@ Usage: `accounts version [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +### accounts rebuildIndex +Rebuilds the service's index, i.e. deleting and then re-adding all existing documents +Usage: `accounts rebuildIndex [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. -### accounts inspect -Show detailed data on an existing account -Usage: `accounts inspect [command options] [arguments...]` @@ -747,31 +719,35 @@ Usage: `accounts inspect [command options] [arguments...]` +### accounts ocis-accounts +Provide accounts and groups for oCIS +Usage: `accounts ocis-accounts [command options] [arguments...]` +-log-level | $ACCOUNTS_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $ACCOUNTS_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $ACCOUNTS_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. +-extensions | +: Run specific extensions during supervised mode. --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. -### accounts list -List existing accounts -Usage: `accounts list [command options] [arguments...]` @@ -830,29 +806,25 @@ Usage: `accounts list [command options] [arguments...]` +### accounts update +Make changes to an existing account +Usage: `accounts update [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. -### accounts rebuildIndex -Rebuilds the service's index, i.e. deleting and then re-adding all existing documents -Usage: `accounts rebuildIndex [command options] [arguments...]` @@ -875,32 +847,60 @@ Usage: `accounts rebuildIndex [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +-enabled | +: Enable the account. +-displayname | +: Set the displayname for the account. +-preferred-name | +: Set the preferred-name for the account. +-on-premises-sam-account-name | +: Set the on-premises-sam-account-name. +-uidnumber | +: Set the uidnumber for the account. +-gidnumber | +: Set the gidnumber for the account. +-mail | +: Set the mail for the account. +-description | +: Set the description for the account. +-password | +: Set the password for the account. +-password-policies | +: Possible policies: DisableStrongPassword, DisablePasswordExpiration. +-force-password-change | +: Force password change on next sign-in. +-force-password-change-mfa | +: Force password change on next sign-in with mfa. diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index c238eb08e96..f7dd7198329 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-08-13T10:27:11+0000" +date: "2021-08-13T13:03:56+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 5039f608660..88b64d21003 100644 --- a/extensions/graph-explorer/configuration.md +++ b/extensions/graph-explorer/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-08-13T10:27:11+0000" +date: "2021-08-13T13:03:56+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 ac4e8b09e59..5b48fc80051 100644 --- a/extensions/graph/configuration.md +++ b/extensions/graph/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-08-13T10:27:11+0000" +date: "2021-08-13T13:03:56+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph/templates @@ -35,82 +35,105 @@ 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. -### graph health +### graph server -Check health status +Start integrated server -Usage: `graph health [command options] [arguments...]` +Usage: `graph server [command options] [arguments...]` --debug-addr | $GRAPH_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9124"`. +-log-file | $GRAPH_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. +-tracing-enabled | $GRAPH_TRACING_ENABLED +: Enable sending traces. +-tracing-type | $GRAPH_TRACING_TYPE +: Tracing backend type. Default: `"jaeger"`. +-tracing-endpoint | $GRAPH_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. +-tracing-collector | $GRAPH_TRACING_COLLECTOR +: Endpoint for the collector. Default: `""`. +-tracing-service | $GRAPH_TRACING_SERVICE +: Service name for tracing. Default: `"graph"`. +-debug-addr | $GRAPH_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9124"`. +-debug-token | $GRAPH_DEBUG_TOKEN +: Token to grant metrics access. Default: `""`. +-debug-pprof | $GRAPH_DEBUG_PPROF +: Enable pprof debugging. -### graph ocis-graph -Serve Graph API for oCIS +-debug-zpages | $GRAPH_DEBUG_ZPAGES +: Enable zpages debugging. -Usage: `graph ocis-graph [command options] [arguments...]` +-http-addr | $GRAPH_HTTP_ADDR +: Address to bind http server. Default: `"0.0.0.0:9120"`. --config-file | $GRAPH_CONFIG_FILE -: Path to config file. Default: `""`. +-http-root | $GRAPH_HTTP_ROOT +: Root path of http server. Default: `"/graph"`. --log-level | $GRAPH_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. +-http-namespace | $GRAPH_HTTP_NAMESPACE +: Set the base namespace for the http service for service discovery. Default: `"com.owncloud.web"`. --log-pretty | $GRAPH_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. +-spaces-webdav-base | $GRAPH_SPACES_WEBDAV_BASE +: spaces webdav base URL to use when rendering drive WabDAV URLs. Default: `"https://localhost:9200/dav/spaces/"`. --log-color | $GRAPH_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. +-jwt-secret | $GRAPH_JWT_SECRET , $OCIS_JWT_SECRET +: Used to validate the reva access JWT, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. +-reva-gateway-addr | $REVA_GATEWAY_ADDR +: REVA Gateway Endpoint. Default: `"127.0.0.1:9142"`. +-extensions | +: Run specific extensions during supervised mode. This flag is set by the runtime. +### graph health +Check health status +Usage: `graph health [command options] [arguments...]` +-debug-addr | $GRAPH_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9124"`. -### graph server -Start integrated server -Usage: `graph server [command options] [arguments...]` @@ -118,70 +141,47 @@ Usage: `graph server [command options] [arguments...]` --log-file | $GRAPH_LOG_FILE , $OCIS_LOG_FILE -: Enable log to file. --tracing-enabled | $GRAPH_TRACING_ENABLED -: Enable sending traces. --tracing-type | $GRAPH_TRACING_TYPE -: Tracing backend type. Default: `"jaeger"`. +### graph ocis-graph +Serve Graph API for oCIS --tracing-endpoint | $GRAPH_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. +Usage: `graph ocis-graph [command options] [arguments...]` --tracing-collector | $GRAPH_TRACING_COLLECTOR -: Endpoint for the collector. Default: `""`. +-config-file | $GRAPH_CONFIG_FILE +: Path to config file. Default: `""`. --tracing-service | $GRAPH_TRACING_SERVICE -: Service name for tracing. Default: `"graph"`. +-log-level | $GRAPH_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. --debug-addr | $GRAPH_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9124"`. +-log-pretty | $GRAPH_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. --debug-token | $GRAPH_DEBUG_TOKEN -: Token to grant metrics access. Default: `""`. +-log-color | $GRAPH_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. --debug-pprof | $GRAPH_DEBUG_PPROF -: Enable pprof debugging. --debug-zpages | $GRAPH_DEBUG_ZPAGES -: Enable zpages debugging. --http-addr | $GRAPH_HTTP_ADDR -: Address to bind http server. Default: `"0.0.0.0:9120"`. --http-root | $GRAPH_HTTP_ROOT -: Root path of http server. Default: `"/graph"`. --http-namespace | $GRAPH_HTTP_NAMESPACE -: Set the base namespace for the http service for service discovery. Default: `"com.owncloud.web"`. --spaces-webdav-base | $GRAPH_SPACES_WEBDAV_BASE -: spaces webdav base URL to use when rendering drive WabDAV URLs. Default: `"https://localhost:9200/dav/spaces/"`. --jwt-secret | $GRAPH_JWT_SECRET , $OCIS_JWT_SECRET -: Used to validate the reva access JWT, should equal reva's jwt-secret. Default: `"Pive-Fumkiu4"`. --reva-gateway-addr | $REVA_GATEWAY_ADDR -: REVA Gateway Endpoint. Default: `"127.0.0.1:9142"`. --extensions | -: Run specific extensions during supervised mode. This flag is set by the runtime. diff --git a/extensions/idp/configuration.md b/extensions/idp/configuration.md index db6845f34d3..68a52e916ac 100644 --- a/extensions/idp/configuration.md +++ b/extensions/idp/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-08-13T10:27:11+0000" +date: "2021-08-13T13:03:57+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/idp/templates @@ -35,243 +35,141 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### idp server +### idp health -Start integrated server +Check health status -Usage: `idp server [command options] [arguments...]` +Usage: `idp health [command options] [arguments...]` +-debug-addr | $IDP_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9134"`. --log-file | $IDP_LOG_FILE , $OCIS_LOG_FILE -: Enable log to file. --config-file | $IDP_CONFIG_FILE -: Path to config file. Default: `""`. --tracing-enabled | $IDP_TRACING_ENABLED -: Enable sending traces. --tracing-type | $IDP_TRACING_TYPE -: Tracing backend type. Default: `"jaeger"`. --tracing-endpoint | $IDP_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. --tracing-collector | $IDP_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 --iss | $IDP_ISS , $OCIS_URL -: OIDC issuer URL. Default: `"https://localhost:9200"`. +Serve IDP API for oCIS +Usage: `idp ocis-idp [command options] [arguments...]` --signing-private-key | $IDP_SIGNING_PRIVATE_KEY -: Full path to PEM encoded private key file (must match the --signing-method algorithm). Default: `nil`. +-log-level | $IDP_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. --signing-kid | $IDP_SIGNING_KID -: Value of kid field to use in created tokens (uniquely identifying the signing-private-key). Default: `""`. +-log-pretty | $IDP_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. --validation-keys-path | $IDP_VALIDATION_KEYS_PATH -: Full path to a folder 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...]` @@ -283,150 +181,248 @@ Usage: `idp version [command options] [arguments...]` +### idp server +Start integrated server +Usage: `idp server [command options] [arguments...]` +-log-file | $IDP_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. +-config-file | $IDP_CONFIG_FILE +: Path to config file. Default: `""`. +-tracing-enabled | $IDP_TRACING_ENABLED +: Enable sending traces. +-tracing-type | $IDP_TRACING_TYPE +: Tracing backend type. Default: `"jaeger"`. +-tracing-endpoint | $IDP_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. +-tracing-collector | $IDP_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"`. --http-namespace | $IDP_HTTP_NAMESPACE -: Set the base namespace for service discovery. Default: `"com.owncloud.web"`. +-ldap-login-attribute | $IDP_LDAP_LOGIN_ATTRIBUTE +: LDAP login attribute of the oCIS users. Default: `"cn"`. --name | $IDP_NAME -: Service name. Default: `"idp"`. +-ldap-email-attribute | $IDP_LDAP_EMAIL_ATTRIBUTE +: LDAP email attribute of the oCIS users. Default: `"mail"`. -### idp health -Check health status +-ldap-name-attribute | $IDP_LDAP_NAME_ATTRIBUTE +: LDAP name attribute of the oCIS users. Default: `"sn"`. -Usage: `idp health [command options] [arguments...]` +-ldap-uuid-attribute | $IDP_LDAP_UUID_ATTRIBUTE +: LDAP UUID attribute of the oCIS users. Default: `"uid"`. +-ldap-uuid-attribute-type | $IDP_LDAP_UUID_ATTRIBUTE_TYPE +: LDAP UUID attribute type of the oCIS users. Default: `"text"`. --debug-addr | $IDP_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9134"`. +-ldap-filter | $IDP_LDAP_FILTER +: LDAP filter of the oCIS users. Default: `"(objectClass=posixaccount)"`. +-transport-tls-cert | $IDP_TRANSPORT_TLS_CERT +: Certificate file for transport encryption. Default: `flags.OverrideDefaultString(cfg.HTTP.TLSCert, path.Join(pkgos.MustUserConfigDir("ocis", "idp"), "server.crt"))`. +-transport-tls-key | $IDP_TRANSPORT_TLS_KEY +: Secret file for transport encryption. Default: `flags.OverrideDefaultString(cfg.HTTP.TLSKey, path.Join(pkgos.MustUserConfigDir("ocis", "idp"), "server.key"))`. +-iss | $IDP_ISS , $OCIS_URL +: OIDC issuer URL. Default: `"https://localhost:9200"`. +-signing-private-key | $IDP_SIGNING_PRIVATE_KEY +: Full path to PEM encoded private key file (must match the --signing-method algorithm). Default: `nil`. +-signing-kid | $IDP_SIGNING_KID +: Value of kid field to use in created tokens (uniquely identifying the signing-private-key). Default: `""`. +-validation-keys-path | $IDP_VALIDATION_KEYS_PATH +: Full path to a folder 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 -Serve IDP API for oCIS +### idp version -Usage: `idp ocis-idp [command options] [arguments...]` +Print the versions of the running instances +Usage: `idp version [command options] [arguments...]` --log-level | $IDP_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. --log-pretty | $IDP_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $IDP_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. @@ -483,6 +479,10 @@ Usage: `idp ocis-idp [command options] [arguments...]` +-http-namespace | $IDP_HTTP_NAMESPACE +: Set the base namespace for service discovery. Default: `"com.owncloud.web"`. +-name | $IDP_NAME +: Service name. Default: `"idp"`. diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index a65a3e0a799..bdba103fc8b 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-08-13T10:27:11+0000" +date: "2021-08-13T13:03:57+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/templates @@ -34,6 +34,42 @@ 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. + +### ocs health + +Check health status + +Usage: `ocs health [command options] [arguments...]` + + +-debug-addr | $OCS_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9114"`. + + + + + + + + + + + + + + + + + + + + + + + + + + ### ocs ocis-ocs @@ -211,40 +247,4 @@ Usage: `ocs version [command options] [arguments...]` -name | $OCS_NAME : Service name. Default: `"ocs"`. - -### ocs health - -Check health status - -Usage: `ocs health [command options] [arguments...]` - - --debug-addr | $OCS_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9114"`. - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/extensions/onlyoffice/configuration.md b/extensions/onlyoffice/configuration.md index f900a42b2f2..4ac30e4bc24 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-08-13T10:27:11+0000" +date: "2021-08-13T13:03:57+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/onlyoffice/templates @@ -80,36 +80,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: `"0.0.0.0:9224"`. - - - - - - - - - - - - - - - - - ### onlyoffice server Start integrated server @@ -185,3 +155,33 @@ Usage: `onlyoffice server [command options] [arguments...]` -extensions | : Run specific extensions during supervised mode. This flag is set by the runtime. +### onlyoffice health + +Check health status + +Usage: `onlyoffice health [command options] [arguments...]` + + + + + + +-debug-addr | $ONLYOFFICE_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9224"`. + + + + + + + + + + + + + + + + + diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index baa5b83baf4..45dc16d5008 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-08-13T10:27:11+0000" +date: "2021-08-13T13:03:57+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 4d6c6d4f0dd..21d8fce223c 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-08-13T10:27:11+0000" +date: "2021-08-13T13:03:57+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/settings/templates @@ -35,73 +35,107 @@ 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 health +### settings server -Check health status +Start integrated server -Usage: `settings health [command options] [arguments...]` +Usage: `settings server [command options] [arguments...]` --debug-addr | $SETTINGS_DEBUG_ADDR -: Address to debug endpoint. Default: `"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: `"jaeger"`. +-tracing-endpoint | $SETTINGS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. +-tracing-collector | $SETTINGS_TRACING_COLLECTOR +: Endpoint for the collector. Default: `""`. +-tracing-service | $SETTINGS_TRACING_SERVICE +: Service name for tracing. Default: `"settings"`. +-debug-addr | $SETTINGS_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9194"`. +-debug-token | $SETTINGS_DEBUG_TOKEN +: Token to grant metrics access. Default: `""`. +-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: `"0.0.0.0:9190"`. +-http-namespace | $SETTINGS_HTTP_NAMESPACE +: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. -### settings ocis-settings -Provide settings and permissions for oCIS +-http-root | $SETTINGS_HTTP_ROOT +: Root path of http server. Default: `"/"`. -Usage: `settings ocis-settings [command options] [arguments...]` +-http-cache-ttl | $SETTINGS_CACHE_TTL +: Set the static assets caching duration in seconds. Default: `604800`. --log-level | $SETTINGS_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. +-grpc-addr | $SETTINGS_GRPC_ADDR +: Address to bind grpc server. Default: `"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: `""`. --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: `"com.owncloud.api"`. +-name | $SETTINGS_NAME +: service name. Default: `"settings"`. +-data-path | $SETTINGS_DATA_PATH +: Mount path for the storage. Default: `"/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: `"Pive-Fumkiu4"`. +-extensions | +: Run specific extensions during supervised mode. This flag is set by the runtime. +### settings version +Print the versions of the running instances +Usage: `settings version [command options] [arguments...]` @@ -113,112 +147,82 @@ Usage: `settings ocis-settings [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: `"jaeger"`. --tracing-endpoint | $SETTINGS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. --tracing-collector | $SETTINGS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `""`. +-grpc-namespace | $SETTINGS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --tracing-service | $SETTINGS_TRACING_SERVICE -: Service name for tracing. Default: `"settings"`. +-name | $SETTINGS_NAME +: service name. Default: `"settings"`. +### settings health --debug-addr | $SETTINGS_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9194"`. +Check health status +Usage: `settings health [command options] [arguments...]` --debug-token | $SETTINGS_DEBUG_TOKEN -: Token to grant metrics access. Default: `""`. --debug-pprof | $SETTINGS_DEBUG_PPROF -: Enable pprof debugging. --debug-zpages | $SETTINGS_DEBUG_ZPAGES -: Enable zpages debugging. +-debug-addr | $SETTINGS_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9194"`. --http-addr | $SETTINGS_HTTP_ADDR -: Address to bind http server. Default: `"0.0.0.0:9190"`. --http-namespace | $SETTINGS_HTTP_NAMESPACE -: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. --http-root | $SETTINGS_HTTP_ROOT -: Root path of http server. Default: `"/"`. --http-cache-ttl | $SETTINGS_CACHE_TTL -: Set the static assets caching duration in seconds. Default: `604800`. --grpc-addr | $SETTINGS_GRPC_ADDR -: Address to bind grpc server. Default: `"0.0.0.0:9191"`. --asset-path | $SETTINGS_ASSET_PATH -: Path to custom assets. Default: `""`. --grpc-namespace | $SETTINGS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $SETTINGS_NAME -: service name. Default: `"settings"`. --data-path | $SETTINGS_DATA_PATH -: Mount path for the storage. Default: `"/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: `"Pive-Fumkiu4"`. --extensions | -: Run specific extensions during supervised mode. This flag is set by the runtime. +### settings ocis-settings -### settings version +Provide settings and permissions for oCIS -Print the versions of the running instances +Usage: `settings ocis-settings [command options] [arguments...]` -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. @@ -241,10 +245,6 @@ Usage: `settings version [command options] [arguments...]` --grpc-namespace | $SETTINGS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $SETTINGS_NAME -: service name. Default: `"settings"`. diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index 698593412da..c8e47f2e55b 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-08-13T10:27:12+0000" +date: "2021-08-13T13:03:57+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -67,12 +67,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. @@ -182,20 +190,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. @@ -505,6 +505,15 @@ Usage: `storage gateway [command options] [arguments...]` + + + + + + + + + @@ -642,7 +651,11 @@ Usage: `storage gateway [command options] [arguments...]` -storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH : mount path. Default: `"/public"`. +### storage health + +Check health status +Usage: `storage health [command options] [arguments...]` @@ -651,11 +664,8 @@ Usage: `storage gateway [command options] [arguments...]` -### storage storage -Storage service for oCIS -Usage: `storage storage [command options] [arguments...]` @@ -672,6 +682,8 @@ Usage: `storage storage [command options] [arguments...]` +-debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9109"`. @@ -798,20 +810,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. @@ -903,8 +907,11 @@ Usage: `storage storage [command options] [arguments...]` +### storage sharing +Start sharing service +Usage: `storage sharing [command options] [arguments...]` @@ -916,11 +923,8 @@ Usage: `storage storage [command options] [arguments...]` -### storage storage-public-link -Start storage-public-link service -Usage: `storage storage-public-link [command options] [arguments...]` @@ -984,24 +988,14 @@ Usage: `storage storage-public-link [command options] [arguments...]` --debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9179"`. --network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9178"`. --mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `"/public"`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `"localhost:9142"`. @@ -1052,26 +1046,48 @@ Usage: `storage storage-public-link [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`. @@ -1177,109 +1193,81 @@ Usage: `storage storage-public-link [command options] [arguments...]` +### storage groups +Start groups service +Usage: `storage groups [command options] [arguments...]` -### storage frontend -Start frontend service -Usage: `storage frontend [command options] [arguments...]` --debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9141"`. --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. --webdav-namespace | $STORAGE_WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `"/home/"`. --dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `"/users/"`. +-debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9161"`. --network | $STORAGE_FRONTEND_HTTP_NETWORK +-network | $STORAGE_GROUPPROVIDER_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"`. +-addr | $STORAGE_GROUPPROVIDER_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9160"`. --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `"https://localhost:9200"`. +-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `"localhost:9160"`. --service | $STORAGE_FRONTEND_SERVICES -: --service ocdav [--service ocs]. Default: `cli.NewStringSlice("datagateway", "ocdav", "ocs")`. +-service | $STORAGE_GROUPPROVIDER_SERVICES +: --service groupprovider [--service otherservice]. Default: `cli.NewStringSlice("groupprovider")`. --datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `"data"`. +-driver | $STORAGE_GROUPPROVIDER_DRIVER +: group driver: 'json', 'ldap', or 'rest'. Default: `"ldap"`. --ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. Default: `""`. +-json-config | $STORAGE_GROUPPROVIDER_JSON +: Path to groups.json file. Default: `""`. --ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX -: open collaboration services endpoint prefix. Default: `"ocs"`. +-group-members-cache-expiration | $STORAGE_GROUP_CACHE_EXPIRATION +: Time in minutes for redis cache expiration.. Default: `5`. --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.. @@ -1482,33 +1470,55 @@ Usage: `storage frontend [command options] [arguments...]` +### storage storage-metadata +Start storage-metadata service +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"`. -### storage groups -Start groups service +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider service. Default: `"localhost:9144"`. -Usage: `storage groups [command options] [arguments...]` +-storage-root | $STORAGE_METADATA_ROOT +: the path to the metadata storage root. Default: `"/var/tmp/ocis/storage/metadata"`. @@ -1525,12 +1535,20 @@ Usage: `storage groups [command options] [arguments...]` +-config-file | $STORAGE_CONFIG_FILE +: Path to config file. +-log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. @@ -1613,36 +1631,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`. @@ -1766,8 +1768,11 @@ Usage: `storage groups [command options] [arguments...]` +### storage auth-basic +Start authprovider for basic auth +Usage: `storage auth-basic [command options] [arguments...]` @@ -1780,11 +1785,8 @@ Usage: `storage groups [command options] [arguments...]` -### storage health -Check health status -Usage: `storage health [command options] [arguments...]` @@ -1828,18 +1830,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"`. @@ -2025,22 +2041,20 @@ Usage: `storage health [command options] [arguments...]` --debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9109"`. +### storage storage +Storage service for oCIS +Usage: `storage storage [command options] [arguments...]` -### storage users -Start users service -Usage: `storage users [command options] [arguments...]` @@ -2060,12 +2074,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. @@ -2282,42 +2304,26 @@ Usage: `storage users [command options] [arguments...]` --debug-addr | $STORAGE_SHARING_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"`. +### storage storage-public-link --addr | $STORAGE_USERPROVIDER_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9144"`. +Start storage-public-link service +Usage: `storage storage-public-link [command options] [arguments...]` --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 auth-basic -Start authprovider for basic auth -Usage: `storage auth-basic [command options] [arguments...]` @@ -2436,32 +2442,18 @@ Usage: `storage auth-basic [command options] [arguments...]` --debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9147"`. --auth-driver | $STORAGE_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `"ldap"`. --auth-json | $STORAGE_AUTH_JSON -: Path to users.json file. Default: `""`. --network | $STORAGE_AUTH_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_AUTH_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9146"`. --service | $STORAGE_AUTH_BASIC_SERVICES -: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `"localhost:9142"`. @@ -2499,14 +2491,24 @@ Usage: `storage auth-basic [command options] [arguments...]` +-debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9179"`. +-network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9178"`. +-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `"/public"`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `"localhost:9142"`. @@ -2573,8 +2575,11 @@ Usage: `storage auth-basic [command options] [arguments...]` +### storage users +Start users service +Usage: `storage users [command options] [arguments...]` @@ -2587,11 +2592,8 @@ Usage: `storage auth-basic [command options] [arguments...]` -### storage sharing -Start sharing service -Usage: `storage sharing [command options] [arguments...]` @@ -2738,48 +2740,16 @@ 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`. @@ -2809,20 +2779,36 @@ Usage: `storage sharing [command options] [arguments...]` +-debug-addr | $STORAGE_SHARING_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`. @@ -2866,18 +2852,18 @@ Usage: `storage sharing [command options] [arguments...]` +### storage auth-bearer +Start authprovider for bearer auth +Usage: `storage auth-bearer [command options] [arguments...]` -### storage storage-home -Start storage-home service -Usage: `storage storage-home [command options] [arguments...]` @@ -2935,24 +2921,44 @@ Usage: `storage storage-home [command options] [arguments...]` +-debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9149"`. +-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"`. @@ -3040,68 +3046,36 @@ Usage: `storage storage-home [command options] [arguments...]` --debug-addr | $STORAGE_HOME_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9156"`. --grpc-network | $STORAGE_HOME_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --grpc-addr | $STORAGE_HOME_GRPC_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9154"`. --http-network | $STORAGE_HOME_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --http-addr | $STORAGE_HOME_HTTP_ADDR -: Address to bind storage service. Default: `"0.0.0.0:9155"`. --driver | $STORAGE_HOME_DRIVER -: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. --read-only | $STORAGE_HOME_READ_ONLY , $OCIS_STORAGE_READ_ONLY -: use storage driver in read-only mode. Default: `false`. --mount-path | $STORAGE_HOME_MOUNT_PATH -: mount path. Default: `"/home"`. --mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. --expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. --data-server-url | $STORAGE_HOME_DATA_SERVER_URL -: data server url. Default: `"http://localhost:9155/data"`. --http-prefix | $STORAGE_HOME_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `"data"`. --tmp-folder | $STORAGE_HOME_TMP_FOLDER -: path to tmp folder. Default: `"/var/tmp/ocis/tmp/home"`. --enable-home | $STORAGE_HOME_ENABLE_HOME -: enable the creation of home directories. Default: `true`. --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"`. @@ -3161,8 +3135,11 @@ Usage: `storage storage-home [command options] [arguments...]` +### storage frontend +Start frontend service +Usage: `storage frontend [command options] [arguments...]` @@ -3174,11 +3151,8 @@ Usage: `storage storage-home [command options] [arguments...]` -### storage storage-users -Start storage-users service -Usage: `storage storage-users [command options] [arguments...]` @@ -3323,109 +3297,123 @@ Usage: `storage storage-users [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.. --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"`. @@ -3466,17 +3454,17 @@ Usage: `storage storage-users [command options] [arguments...]` +### storage storage-home +Start storage-home service +Usage: `storage storage-home [command options] [arguments...]` -### storage storage-metadata -Start storage-metadata service -Usage: `storage storage-metadata [command options] [arguments...]` @@ -3563,36 +3551,68 @@ Usage: `storage storage-metadata [command options] [arguments...]` +-debug-addr | $STORAGE_HOME_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9156"`. +-grpc-network | $STORAGE_HOME_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-grpc-addr | $STORAGE_HOME_GRPC_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9154"`. +-http-network | $STORAGE_HOME_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-http-addr | $STORAGE_HOME_HTTP_ADDR +: Address to bind storage service. Default: `"0.0.0.0:9155"`. +-driver | $STORAGE_HOME_DRIVER +: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. +-read-only | $STORAGE_HOME_READ_ONLY , $OCIS_STORAGE_READ_ONLY +: use storage driver in read-only mode. Default: `false`. +-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `"/home"`. +-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. +-expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. +-data-server-url | $STORAGE_HOME_DATA_SERVER_URL +: data server url. Default: `"http://localhost:9155/data"`. +-http-prefix | $STORAGE_HOME_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `"data"`. +-tmp-folder | $STORAGE_HOME_TMP_FOLDER +: path to tmp folder. Default: `"/var/tmp/ocis/tmp/home"`. +-enable-home | $STORAGE_HOME_ENABLE_HOME +: enable the creation of home directories. Default: `true`. +-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"`. @@ -3619,20 +3639,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. @@ -3667,48 +3679,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"`. @@ -3765,16 +3755,16 @@ Usage: `storage storage-metadata [command options] [arguments...]` +### storage storage-users +Start storage-users service +Usage: `storage storage-users [command options] [arguments...]` -### storage auth-bearer -Start authprovider for bearer auth -Usage: `storage auth-bearer [command options] [arguments...]` @@ -3843,44 +3833,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"`. @@ -3974,34 +3944,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"`. +-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"`. diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index 76f612fe732..f7d522845d7 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-08-13T10:27:12+0000" +date: "2021-08-13T13:03:57+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 c0f4234a019..9d7bb197adb 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-08-13T10:27:13+0000" +date: "2021-08-13T13:03:58+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates @@ -35,185 +35,181 @@ 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 server +### thumbnails health -Start integrated server +Check health status -Usage: `thumbnails server [command options] [arguments...]` +Usage: `thumbnails health [command options] [arguments...]` +-debug-addr | $THUMBNAILS_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9189"`. --log-file | $THUMBNAILS_LOG_FILE , $OCIS_LOG_FILE -: Enable log to file. --log-level | $THUMBNAILS_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. --log-pretty | $THUMBNAILS_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $THUMBNAILS_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. --config-file | $THUMBNAILS_CONFIG_FILE -: Path to config file. --tracing-enabled | $THUMBNAILS_TRACING_ENABLED -: Enable sending traces. --tracing-type | $THUMBNAILS_TRACING_TYPE -: Tracing backend type. Default: `"jaeger"`. --tracing-endpoint | $THUMBNAILS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. --tracing-collector | $THUMBNAILS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `""`. --tracing-service | $THUMBNAILS_TRACING_SERVICE -: Service name for tracing. Default: `"thumbnails"`. --debug-addr | $THUMBNAILS_DEBUG_ADDR -: Address to bind debug server. Default: `"0.0.0.0:9189"`. --debug-token | $THUMBNAILS_DEBUG_TOKEN -: Token to grant metrics access. Default: `""`. --debug-pprof | $THUMBNAILS_DEBUG_PPROF -: Enable pprof debugging. +### thumbnails ocis-thumbnails --debug-zpages | $THUMBNAILS_DEBUG_ZPAGES -: Enable zpages debugging. +Example usage +Usage: `thumbnails ocis-thumbnails [command options] [arguments...]` --grpc-name | $THUMBNAILS_GRPC_NAME -: Name of the service. Default: `"thumbnails"`. --grpc-addr | $THUMBNAILS_GRPC_ADDR -: Address to bind grpc server. Default: `"0.0.0.0:9185"`. --grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --filesystemstorage-root | $THUMBNAILS_FILESYSTEMSTORAGE_ROOT -: Root path of the filesystem storage directory. Default: `/var/tmp/ocis/thumbnails`. --reva-gateway-addr | $THUMBNAILS_REVA_GATEWAY , $PROXY_REVA_GATEWAY_ADDR -: Reva gateway address. Default: `"127.0.0.1:9142"`. --webdavsource-insecure | $THUMBNAILS_WEBDAVSOURCE_INSECURE -: Whether to skip certificate checks. Default: `true`. --thumbnail-resolution | $THUMBNAILS_RESOLUTIONS -: --thumbnail-resolution 16x16 [--thumbnail-resolution 32x32]. Default: `cli.NewStringSlice("16x16", "32x32", "64x64", "128x128", "1920x1080", "3840x2160", "7680x4320")`. --webdav-namespace | $STORAGE_WEBDAV_NAMESPACE -: Namespace prefix for the webdav endpoint. Default: `"/home"`. --extensions | -: Run specific extensions during supervised mode. -### thumbnails version -Print the versions of the running instances -Usage: `thumbnails version [command options] [arguments...]` +### thumbnails server +Start integrated server +Usage: `thumbnails server [command options] [arguments...]` +-log-file | $THUMBNAILS_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. +-log-level | $THUMBNAILS_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $THUMBNAILS_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $THUMBNAILS_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. +-config-file | $THUMBNAILS_CONFIG_FILE +: Path to config file. +-tracing-enabled | $THUMBNAILS_TRACING_ENABLED +: Enable sending traces. +-tracing-type | $THUMBNAILS_TRACING_TYPE +: Tracing backend type. Default: `"jaeger"`. +-tracing-endpoint | $THUMBNAILS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. --grpc-name | $THUMBNAILS_GRPC_NAME -: Name of the service. Default: `"thumbnails"`. +-tracing-collector | $THUMBNAILS_TRACING_COLLECTOR +: Endpoint for the collector. Default: `""`. --grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-tracing-service | $THUMBNAILS_TRACING_SERVICE +: Service name for tracing. Default: `"thumbnails"`. -### thumbnails health -Check health status +-debug-addr | $THUMBNAILS_DEBUG_ADDR +: Address to bind debug server. Default: `"0.0.0.0:9189"`. -Usage: `thumbnails health [command options] [arguments...]` +-debug-token | $THUMBNAILS_DEBUG_TOKEN +: Token to grant metrics access. Default: `""`. --debug-addr | $THUMBNAILS_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9189"`. +-debug-pprof | $THUMBNAILS_DEBUG_PPROF +: Enable pprof debugging. +-debug-zpages | $THUMBNAILS_DEBUG_ZPAGES +: Enable zpages debugging. +-grpc-name | $THUMBNAILS_GRPC_NAME +: Name of the service. Default: `"thumbnails"`. +-grpc-addr | $THUMBNAILS_GRPC_ADDR +: Address to bind grpc server. Default: `"0.0.0.0:9185"`. +-grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-filesystemstorage-root | $THUMBNAILS_FILESYSTEMSTORAGE_ROOT +: Root path of the filesystem storage directory. Default: `/var/tmp/ocis/thumbnails`. +-reva-gateway-addr | $THUMBNAILS_REVA_GATEWAY , $PROXY_REVA_GATEWAY_ADDR +: Reva gateway address. Default: `"127.0.0.1:9142"`. +-webdavsource-insecure | $THUMBNAILS_WEBDAVSOURCE_INSECURE +: Whether to skip certificate checks. Default: `true`. +-thumbnail-resolution | $THUMBNAILS_RESOLUTIONS +: --thumbnail-resolution 16x16 [--thumbnail-resolution 32x32]. Default: `cli.NewStringSlice("16x16", "32x32", "64x64", "128x128", "1920x1080", "3840x2160", "7680x4320")`. +-webdav-namespace | $STORAGE_WEBDAV_NAMESPACE +: Namespace prefix for the webdav endpoint. Default: `"/home"`. +-extensions | +: Run specific extensions during supervised mode. +### thumbnails version +Print the versions of the running instances -### thumbnails ocis-thumbnails +Usage: `thumbnails version [command options] [arguments...]` -Example usage -Usage: `thumbnails ocis-thumbnails [command options] [arguments...]` @@ -238,6 +234,10 @@ Usage: `thumbnails ocis-thumbnails [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 b03dd8c5a44..e8d960d3cc3 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-08-13T10:27:14+0000" +date: "2021-08-13T13:03:58+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/web/templates @@ -73,46 +73,6 @@ Usage: `web [global options] command [command options] [arguments...]` ## Sub Commands - -### web health - -Check health status - -Usage: `web health [command options] [arguments...]` - - - - - --debug-addr | $WEB_DEBUG_ADDR -: Address to debug endpoint. Default: `"0.0.0.0:9104"`. - - - - - - - - - - - - - - - - - - - - - - - - - - - ### web server @@ -240,4 +200,44 @@ Usage: `web server [command options] [arguments...]` -extensions | : Run specific extensions during supervised mode. This flag is set by the runtime. + +### web health + +Check health status + +Usage: `web health [command options] [arguments...]` + + + + + +-debug-addr | $WEB_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9104"`. + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index 14095e17b24..0bfb8dc57bc 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-08-13T10:27:14+0000" +date: "2021-08-13T13:03:58+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates @@ -66,39 +66,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: `"0.0.0.0:9119"`. - - - - - - - - - - - - - - - - - - - - - - - ### webdav server @@ -228,4 +195,37 @@ Usage: `webdav version [command options] [arguments...]` -service-name | $WEBDAV_SERVICE_NAME : Service name. Default: `"webdav"`. + +### webdav health + +Check health status + +Usage: `webdav health [command options] [arguments...]` + + +-debug-addr | $WEBDAV_DEBUG_ADDR +: Address to debug endpoint. Default: `"0.0.0.0:9119"`. + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ocis/configuration.md b/ocis/configuration.md index 104f1b1d2e3..ce8c08fc91d 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-08-13T10:27:11+0000" +date: "2021-08-13T13:03:57+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -108,11 +108,11 @@ Usage: `ocis [global options] command [command options] [arguments...]` ## Sub Commands -### ocis list +### ocis health -Lists running ocis extensions +Check health status -Usage: `ocis list [command options] [arguments...]` +Usage: `ocis health [command options] [arguments...]` @@ -128,6 +128,8 @@ Usage: `ocis list [command options] [arguments...]` +-debug-addr | $OCIS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9010`. @@ -136,12 +138,12 @@ Usage: `ocis list [command options] [arguments...]` -### ocis kill -Kill an extension by name +### ocis server -Usage: `ocis kill [command options] [arguments...]` +Start fullstack server +Usage: `ocis server [command options] [arguments...]` @@ -158,34 +160,48 @@ Usage: `ocis kill [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`. +-extensions | $OCIS_RUN_EXTENSIONS +: Run specific extensions during supervised mode. +### ocis run +Runs an extension +Usage: `ocis run [command options] [arguments...]` --debug-addr | $OCIS_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9010`. @@ -195,19 +211,19 @@ Usage: `ocis health [command options] [arguments...]` -### ocis run -Runs an extension -Usage: `ocis run [command options] [arguments...]` +### ocis kill +Kill an extension by name +Usage: `ocis kill [command options] [arguments...]` @@ -223,19 +239,19 @@ Usage: `ocis run [command options] [arguments...]` -### ocis server -Start fullstack server -Usage: `ocis server [command options] [arguments...]` +### ocis list +Lists running ocis extensions +Usage: `ocis list [command options] [arguments...]` @@ -244,120 +260,84 @@ Usage: `ocis server [command options] [arguments...]` --debug-addr | $OCIS_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9010`. --debug-token | $OCIS_DEBUG_TOKEN -: Token to grant metrics access. --debug-pprof | $OCIS_DEBUG_PPROF -: Enable pprof debugging. --debug-zpages | $OCIS_DEBUG_ZPAGES -: Enable zpages debugging. --http-addr | $OCIS_HTTP_ADDR -: Address to bind http server. Default: `0.0.0.0:9000`. --http-root | $OCIS_HTTP_ROOT -: Root path of http server. Default: `/`. --grpc-addr | $OCIS_GRPC_ADDR -: Address to bind grpc server. Default: `0.0.0.0:9001`. --extensions | $OCIS_RUN_EXTENSIONS -: Run specific extensions during supervised mode. ### List of available Extension subcommands There are more subcommands to start the individual extensions. Please check the documentation about their usage and options in the dedicated section of the documentation. -#### ocis storage-sharing - -Start storage sharing service - -#### ocis glauth - -Start glauth server - #### ocis idp Start idp server -#### ocis ocs +#### ocis onlyoffice -Start ocs server +Start onlyoffice server #### ocis proxy Start proxy server -#### ocis storage-metadata - -Start storage and data service for metadata - -#### ocis storage-public-link - -Start storage public link storage - -#### ocis storage-userprovider - -Start storage userprovider service - -#### ocis onlyoffice - -Start onlyoffice server - -#### ocis settings +#### ocis storage-groupprovider -Start settings server +Start storage groupprovider service #### ocis version Lists running services with version -#### ocis storage-frontend - -Start storage frontend - -#### ocis storage-users - -Start storage and data provider for /users mount - #### ocis web Start web server +#### ocis glauth + +Start glauth server + #### ocis accounts Start accounts server +#### ocis settings + +Start settings server + #### ocis storage-home Start storage and data provider for /home mount +#### ocis webdav + +Start webdav server + #### ocis thumbnails Start thumbnails server -#### ocis storage-auth-bearer +#### ocis ocs -Start storage auth-bearer service +Start ocs server -#### ocis storage-groupprovider +#### ocis storage-auth-bearer -Start storage groupprovider service +Start storage auth-bearer service -#### ocis webdav +#### ocis storage-userprovider -Start webdav server +Start storage userprovider service #### ocis storage-auth-basic @@ -367,6 +347,26 @@ Start storage auth-basic service Start storage gateway +#### ocis storage-metadata + +Start storage and data service for metadata + +#### ocis storage-users + +Start storage and data provider for /users mount + +#### ocis storage-frontend + +Start storage frontend + +#### ocis storage-public-link + +Start storage public link storage + +#### ocis storage-sharing + +Start storage sharing service + #### ocis store Start a go-micro store