diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 803c8fd9058..36a6f665b95 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-11-19T14:22:19+0000" +date: "2021-11-19T14:57:09+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -35,11 +35,11 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### accounts rebuildIndex +### accounts version -Rebuilds the service's index, i.e. deleting and then re-adding all existing documents +Print the versions of the running instances -Usage: `accounts rebuildIndex [command options] [arguments...]` +Usage: `accounts version [command options] [arguments...]` @@ -111,32 +111,28 @@ 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 ocis-accounts -Provide accounts and groups for oCIS -Usage: `accounts ocis-accounts [command options] [arguments...]` +### accounts add +Create a new account --log-level | $ACCOUNTS_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. +Usage: `accounts add [command options] [arguments...]` --log-pretty | $ACCOUNTS_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. --log-color | $ACCOUNTS_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. --extensions | -: Run specific extensions during supervised mode. @@ -187,37 +183,64 @@ Usage: `accounts ocis-accounts [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +-enabled | +: Enable the account. +-displayname | +: Set the displayname for the account. +-username | +: Username will be written to preferred-name and on_premises_sam_account_name. +-preferred-name | +: Set the preferred-name for the account. +-on-premises-sam-account-name | +: Set the on-premises-sam-account-name. +-uidnumber | +: Set the uidnumber for the account. +-gidnumber | +: Set the gidnumber for the account. +-mail | +: Set the mail for the account. +-description | +: Set the description for the account. -### accounts update +-password | +: Set the password for the account. -Make changes to an existing account -Usage: `accounts update [command options] [arguments...]` +-password-policies | +: Possible policies: DisableStrongPassword, DisablePasswordExpiration. +-force-password-change | +: Force password change on next sign-in. +-force-password-change-mfa | +: Force password change on next sign-in with mfa. @@ -225,8 +248,11 @@ Usage: `accounts update [command options] [arguments...]` +### accounts inspect +Show detailed data on an existing account +Usage: `accounts inspect [command options] [arguments...]` @@ -256,60 +282,32 @@ 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. @@ -330,14 +328,18 @@ Usage: `accounts update [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. -### accounts add +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. -Create a new account +### accounts rebuildIndex -Usage: `accounts add [command options] [arguments...]` +Rebuilds the service's index, i.e. deleting and then re-adding all existing documents +Usage: `accounts rebuildIndex [command options] [arguments...]` @@ -393,138 +395,180 @@ Usage: `accounts add [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. --enabled | -: Enable the account. --displayname | -: Set the displayname for the account. --username | -: Username will be written to preferred-name and on_premises_sam_account_name. --preferred-name | -: Set the preferred-name for the account. --on-premises-sam-account-name | -: Set the on-premises-sam-account-name. --uidnumber | -: Set the uidnumber for the account. --gidnumber | -: Set the gidnumber for the account. --mail | -: Set the mail for the account. --description | -: Set the description for the account. +### accounts server --password | -: Set the password for the account. +Start ocis accounts service +Usage: `accounts server [command options] [arguments...]` --password-policies | -: Possible policies: DisableStrongPassword, DisablePasswordExpiration. --force-password-change | -: Force password change on next sign-in. --force-password-change-mfa | -: Force password change on next sign-in with mfa. +-log-file | $ACCOUNTS_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. +-tracing-enabled | $ACCOUNTS_TRACING_ENABLED , $OCIS_TRACING_ENABLED +: Enable sending traces. +-tracing-type | $ACCOUNTS_TRACING_TYPE , $OCIS_TRACING_TYPE +: Tracing backend type. Default: `"jaeger"`. -### accounts list +-tracing-endpoint | $ACCOUNTS_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. -List existing accounts -Usage: `accounts list [command options] [arguments...]` +-tracing-collector | $ACCOUNTS_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR +: Endpoint for the collector. Default: `""`. +-tracing-service | $ACCOUNTS_TRACING_SERVICE +: Service name for tracing. Default: `"accounts"`. +-http-namespace | $ACCOUNTS_HTTP_NAMESPACE +: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. +-http-addr | $ACCOUNTS_HTTP_ADDR +: Address to bind http server. Default: `"127.0.0.1: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`. +-cors-allowed-origins | $ACCOUNTS_CORS_ALLOW_ORIGINS , $OCIS_CORS_ALLOW_ORIGINS +: Set the allowed CORS origins. Default: `cli.NewStringSlice("*")`. +-cors-allowed-methods | $ACCOUNTS_CORS_ALLOW_METHODS , $OCIS_CORS_ALLOW_METHODS +: Set the allowed CORS origins. Default: `cli.NewStringSlice("GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS")`. +-cors-allowed-headers | $ACCOUNTS_CORS_ALLOW_HEADERS , $OCIS_CORS_ALLOW_HEADERS +: Set the allowed CORS origins. Default: `cli.NewStringSlice("Authorization", "Origin", "Content-Type", "Accept", "X-Requested-With")`. +-cors-allow-credentials | $ACCOUNTS_CORS_ALLOW_CREDENTIALS , $OCIS_CORS_ALLOW_CREDENTIALS +: Allow credentials for CORS. Default: `true`. +-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: `"127.0.0.1:9180"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +-accounts-hash-difficulty | $ACCOUNTS_HASH_DIFFICULTY +: accounts password hash difficulty. Default: `11`. +-demo-users-and-groups | $ACCOUNTS_DEMO_USERS_AND_GROUPS +: Enable demo users and groups. Default: `true`. +-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-backend | $ACCOUNTS_STORAGE_BACKEND +: Which backend to use to store accounts data (CS3 or disk). Default: `"CS3"`. +-storage-disk-path | $ACCOUNTS_STORAGE_DISK_PATH +: Path on the local disk to store accounts data when backend is set to disk. Default: `flags.OverrideDefaultString(cfg.Repo.Disk.Path, path.Join(defaults.BaseDataPath(), "accounts"))`. +-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. @@ -534,22 +578,15 @@ Usage: `accounts list [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. -### accounts remove -Removes an existing account -Usage: `accounts remove [command options] [arguments...]` @@ -568,8 +605,11 @@ Usage: `accounts remove [command options] [arguments...]` +### accounts update +Make changes to an existing account +Usage: `accounts update [command options] [arguments...]` @@ -612,179 +652,131 @@ Usage: `accounts remove [command options] [arguments...]` +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-name | $ACCOUNTS_NAME +: service name. Default: `"accounts"`. +-enabled | +: Enable the account. +-displayname | +: Set the displayname for the account. +-preferred-name | +: Set the preferred-name for the account. +-on-premises-sam-account-name | +: Set the on-premises-sam-account-name. --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. +-uidnumber | +: Set the uidnumber for the account. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. +-gidnumber | +: Set the gidnumber for the account. -### accounts server +-mail | +: Set the mail for the account. -Start ocis accounts service -Usage: `accounts server [command options] [arguments...]` +-description | +: Set the description for the account. +-password | +: Set the password for the account. +-password-policies | +: Possible policies: DisableStrongPassword, DisablePasswordExpiration. --log-file | $ACCOUNTS_LOG_FILE , $OCIS_LOG_FILE -: Enable log to file. +-force-password-change | +: Force password change on next sign-in. --tracing-enabled | $ACCOUNTS_TRACING_ENABLED , $OCIS_TRACING_ENABLED -: Enable sending traces. +-force-password-change-mfa | +: Force password change on next sign-in with mfa. --tracing-type | $ACCOUNTS_TRACING_TYPE , $OCIS_TRACING_TYPE -: Tracing backend type. Default: `"jaeger"`. --tracing-endpoint | $ACCOUNTS_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. --tracing-collector | $ACCOUNTS_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `""`. --tracing-service | $ACCOUNTS_TRACING_SERVICE -: Service name for tracing. Default: `"accounts"`. --http-namespace | $ACCOUNTS_HTTP_NAMESPACE -: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. --http-addr | $ACCOUNTS_HTTP_ADDR -: Address to bind http server. Default: `"127.0.0.1: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`. --cors-allowed-origins | $ACCOUNTS_CORS_ALLOW_ORIGINS , $OCIS_CORS_ALLOW_ORIGINS -: Set the allowed CORS origins. Default: `cli.NewStringSlice("*")`. --cors-allowed-methods | $ACCOUNTS_CORS_ALLOW_METHODS , $OCIS_CORS_ALLOW_METHODS -: Set the allowed CORS origins. Default: `cli.NewStringSlice("GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS")`. --cors-allowed-headers | $ACCOUNTS_CORS_ALLOW_HEADERS , $OCIS_CORS_ALLOW_HEADERS -: Set the allowed CORS origins. Default: `cli.NewStringSlice("Authorization", "Origin", "Content-Type", "Accept", "X-Requested-With")`. +### accounts list +List existing accounts --cors-allow-credentials | $ACCOUNTS_CORS_ALLOW_CREDENTIALS , $OCIS_CORS_ALLOW_CREDENTIALS -: Allow credentials for CORS. Default: `true`. +Usage: `accounts list [command options] [arguments...]` --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: `"127.0.0.1:9180"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. --accounts-hash-difficulty | $ACCOUNTS_HASH_DIFFICULTY -: accounts password hash difficulty. Default: `11`. --demo-users-and-groups | $ACCOUNTS_DEMO_USERS_AND_GROUPS -: Enable demo users and groups. Default: `true`. --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-backend | $ACCOUNTS_STORAGE_BACKEND -: Which backend to use to store accounts data (CS3 or disk). Default: `"CS3"`. --storage-disk-path | $ACCOUNTS_STORAGE_DISK_PATH -: Path on the local disk to store accounts data when backend is set to disk. Default: `flags.OverrideDefaultString(cfg.Repo.Disk.Path, path.Join(defaults.BaseDataPath(), "accounts"))`. --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. @@ -812,20 +804,24 @@ 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 remove +Removes an existing account -### accounts version +Usage: `accounts remove [command options] [arguments...]` -Print the versions of the running instances -Usage: `accounts version [command options] [arguments...]` @@ -906,19 +902,27 @@ Usage: `accounts version [command options] [arguments...]` +### accounts ocis-accounts +Provide accounts and groups for oCIS -### accounts inspect +Usage: `accounts ocis-accounts [command options] [arguments...]` -Show detailed data on an existing account -Usage: `accounts inspect [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. @@ -988,10 +992,6 @@ Usage: `accounts inspect [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. --name | $ACCOUNTS_NAME -: service name. Default: `"accounts"`. diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index e0b7bf31aca..6e4bd09d4d6 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-11-19T14:23:17+0000" +date: "2021-11-19T14:58:02+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/glauth/templates @@ -35,255 +35,255 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### glauth server +### glauth health -Start integrated server +Check health status -Usage: `glauth server [command options] [arguments...]` +Usage: `glauth health [command options] [arguments...]` +-debug-addr | $GLAUTH_DEBUG_ADDR +: Address to debug endpoint. Default: `"127.0.0.1:9129"`. --log-file | $GLAUTH_LOG_FILE , $OCIS_LOG_FILE -: Enable log to file. --config-file | $GLAUTH_CONFIG_FILE -: Path to config file. Default: `""`. --tracing-enabled | $GLAUTH_TRACING_ENABLED , $OCIS_TRACING_ENABLED -: Enable sending traces. --tracing-type | $GLAUTH_TRACING_TYPE , $OCIS_TRACING_TYPE -: Tracing backend type. Default: `"jaeger"`. --tracing-endpoint | $GLAUTH_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT -: Endpoint for the agent. Default: `""`. --tracing-collector | $GLAUTH_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR -: Endpoint for the collector. Default: `""`. --tracing-service | $GLAUTH_TRACING_SERVICE -: Service name for tracing. Default: `"glauth"`. --debug-addr | $GLAUTH_DEBUG_ADDR -: Address to bind debug server. Default: `"127.0.0.1:9129"`. --debug-token | $GLAUTH_DEBUG_TOKEN -: Token to grant metrics access. Default: `""`. --debug-pprof | $GLAUTH_DEBUG_PPROF -: Enable pprof debugging. --debug-zpages | $GLAUTH_DEBUG_ZPAGES -: Enable zpages debugging. --role-bundle-id | $GLAUTH_ROLE_BUNDLE_ID -: roleid used to make internal grpc requests. Default: `"71881883-1768-46bd-a24d-a356a2afdf7f"`. --ldap-addr | $GLAUTH_LDAP_ADDR -: Address to bind ldap server. Default: `"127.0.0.1:9125"`. --ldap-enabled | $GLAUTH_LDAP_ENABLED -: Enable ldap server. Default: `true`. --ldaps-addr | $GLAUTH_LDAPS_ADDR -: Address to bind ldaps server. Default: `"127.0.0.1:9126"`. --ldaps-enabled | $GLAUTH_LDAPS_ENABLED -: Enable ldaps server. Default: `true`. --ldaps-cert | $GLAUTH_LDAPS_CERT -: path to ldaps certificate in PEM format. Default: `flags.OverrideDefaultString(cfg.Ldaps.Cert, path.Join(defaults.BaseDataPath(), "ldap", "ldap.crt"))`. --ldaps-key | $GLAUTH_LDAPS_KEY -: path to ldaps key in PEM format. Default: `flags.OverrideDefaultString(cfg.Ldaps.Key, path.Join(defaults.BaseDataPath(), "ldap", "ldap.key"))`. +### glauth ocis-glauth --backend-basedn | $GLAUTH_BACKEND_BASEDN -: base distinguished name to expose. Default: `"dc=ocis,dc=test"`. +Serve GLAuth API for oCIS +Usage: `glauth ocis-glauth [command options] [arguments...]` --backend-name-format | $GLAUTH_BACKEND_NAME_FORMAT -: name attribute for entries to expose. typically cn or uid. Default: `"cn"`. +-log-level | $GLAUTH_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. --backend-group-format | $GLAUTH_BACKEND_GROUP_FORMAT -: name attribute for entries to expose. typically ou, cn or dc. Default: `"ou"`. +-log-pretty | $GLAUTH_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. --backend-ssh-key-attr | $GLAUTH_BACKEND_SSH_KEY_ATTR -: ssh key attribute for entries to expose. Default: `"sshPublicKey"`. +-log-color | $GLAUTH_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. --backend-datastore | $GLAUTH_BACKEND_DATASTORE -: datastore to use as the backend. one of accounts, ldap or owncloud. Default: `"accounts"`. --backend-insecure | $GLAUTH_BACKEND_INSECURE -: Allow insecure requests to the datastore. Default: `false`. --backend-server | $GLAUTH_BACKEND_SERVERS -: `--backend-server https://demo.owncloud.com/apps/graphapi/v1.0 [--backend-server "https://demo2.owncloud.com/apps/graphapi/v1.0"]`. Default: `cli.NewStringSlice()`. --backend-use-graphapi | $GLAUTH_BACKEND_USE_GRAPHAPI -: use Graph API, only for owncloud datastore. Default: `true`. --fallback-basedn | $GLAUTH_FALLBACK_BASEDN -: base distinguished name to expose. Default: `"dc=ocis,dc=test"`. --fallback-name-format | $GLAUTH_FALLBACK_NAME_FORMAT -: name attribute for entries to expose. typically cn or uid. Default: `"cn"`. --fallback-group-format | $GLAUTH_FALLBACK_GROUP_FORMAT -: name attribute for entries to expose. typically ou, cn or dc. Default: `"ou"`. --fallback-ssh-key-attr | $GLAUTH_FALLBACK_SSH_KEY_ATTR -: ssh key attribute for entries to expose. Default: `"sshPublicKey"`. --fallback-datastore | $GLAUTH_FALLBACK_DATASTORE -: datastore to use as the fallback. one of accounts, ldap or owncloud. Default: `""`. --fallback-insecure | $GLAUTH_FALLBACK_INSECURE -: Allow insecure requests to the datastore. Default: `false`. --fallback-server | $GLAUTH_FALLBACK_SERVERS -: `--fallback-server http://internal1.example.com [--fallback-server http://internal2.example.com]`. Default: `cli.NewStringSlice("https://demo.owncloud.com/apps/graphapi/v1.0")`. --fallback-use-graphapi | $GLAUTH_FALLBACK_USE_GRAPHAPI -: use Graph API, only for owncloud datastore. Default: `true`. --extensions | -: Run specific extensions during supervised mode. This flag is set by the runtime. -### glauth health -Check health status -Usage: `glauth health [command options] [arguments...]` --debug-addr | $GLAUTH_DEBUG_ADDR -: Address to debug endpoint. Default: `"127.0.0.1:9129"`. +### glauth server +Start integrated server +Usage: `glauth server [command options] [arguments...]` +-log-file | $GLAUTH_LOG_FILE , $OCIS_LOG_FILE +: Enable log to file. +-config-file | $GLAUTH_CONFIG_FILE +: Path to config file. Default: `""`. +-tracing-enabled | $GLAUTH_TRACING_ENABLED , $OCIS_TRACING_ENABLED +: Enable sending traces. +-tracing-type | $GLAUTH_TRACING_TYPE , $OCIS_TRACING_TYPE +: Tracing backend type. Default: `"jaeger"`. +-tracing-endpoint | $GLAUTH_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT +: Endpoint for the agent. Default: `""`. +-tracing-collector | $GLAUTH_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR +: Endpoint for the collector. Default: `""`. +-tracing-service | $GLAUTH_TRACING_SERVICE +: Service name for tracing. Default: `"glauth"`. +-debug-addr | $GLAUTH_DEBUG_ADDR +: Address to bind debug server. Default: `"127.0.0.1:9129"`. +-debug-token | $GLAUTH_DEBUG_TOKEN +: Token to grant metrics access. Default: `""`. +-debug-pprof | $GLAUTH_DEBUG_PPROF +: Enable pprof debugging. +-debug-zpages | $GLAUTH_DEBUG_ZPAGES +: Enable zpages debugging. +-role-bundle-id | $GLAUTH_ROLE_BUNDLE_ID +: roleid used to make internal grpc requests. Default: `"71881883-1768-46bd-a24d-a356a2afdf7f"`. -### glauth ocis-glauth +-ldap-addr | $GLAUTH_LDAP_ADDR +: Address to bind ldap server. Default: `"127.0.0.1:9125"`. -Serve GLAuth API for oCIS -Usage: `glauth ocis-glauth [command options] [arguments...]` +-ldap-enabled | $GLAUTH_LDAP_ENABLED +: Enable ldap server. Default: `true`. --log-level | $GLAUTH_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. +-ldaps-addr | $GLAUTH_LDAPS_ADDR +: Address to bind ldaps server. Default: `"127.0.0.1:9126"`. --log-pretty | $GLAUTH_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. +-ldaps-enabled | $GLAUTH_LDAPS_ENABLED +: Enable ldaps server. Default: `true`. --log-color | $GLAUTH_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. +-ldaps-cert | $GLAUTH_LDAPS_CERT +: path to ldaps certificate in PEM format. Default: `flags.OverrideDefaultString(cfg.Ldaps.Cert, path.Join(defaults.BaseDataPath(), "ldap", "ldap.crt"))`. +-ldaps-key | $GLAUTH_LDAPS_KEY +: path to ldaps key in PEM format. Default: `flags.OverrideDefaultString(cfg.Ldaps.Key, path.Join(defaults.BaseDataPath(), "ldap", "ldap.key"))`. +-backend-basedn | $GLAUTH_BACKEND_BASEDN +: base distinguished name to expose. Default: `"dc=ocis,dc=test"`. +-backend-name-format | $GLAUTH_BACKEND_NAME_FORMAT +: name attribute for entries to expose. typically cn or uid. Default: `"cn"`. +-backend-group-format | $GLAUTH_BACKEND_GROUP_FORMAT +: name attribute for entries to expose. typically ou, cn or dc. Default: `"ou"`. +-backend-ssh-key-attr | $GLAUTH_BACKEND_SSH_KEY_ATTR +: ssh key attribute for entries to expose. Default: `"sshPublicKey"`. +-backend-datastore | $GLAUTH_BACKEND_DATASTORE +: datastore to use as the backend. one of accounts, ldap or owncloud. Default: `"accounts"`. +-backend-insecure | $GLAUTH_BACKEND_INSECURE +: Allow insecure requests to the datastore. Default: `false`. +-backend-server | $GLAUTH_BACKEND_SERVERS +: `--backend-server https://demo.owncloud.com/apps/graphapi/v1.0 [--backend-server "https://demo2.owncloud.com/apps/graphapi/v1.0"]`. Default: `cli.NewStringSlice()`. +-backend-use-graphapi | $GLAUTH_BACKEND_USE_GRAPHAPI +: use Graph API, only for owncloud datastore. Default: `true`. +-fallback-basedn | $GLAUTH_FALLBACK_BASEDN +: base distinguished name to expose. Default: `"dc=ocis,dc=test"`. +-fallback-name-format | $GLAUTH_FALLBACK_NAME_FORMAT +: name attribute for entries to expose. typically cn or uid. Default: `"cn"`. +-fallback-group-format | $GLAUTH_FALLBACK_GROUP_FORMAT +: name attribute for entries to expose. typically ou, cn or dc. Default: `"ou"`. +-fallback-ssh-key-attr | $GLAUTH_FALLBACK_SSH_KEY_ATTR +: ssh key attribute for entries to expose. Default: `"sshPublicKey"`. +-fallback-datastore | $GLAUTH_FALLBACK_DATASTORE +: datastore to use as the fallback. one of accounts, ldap or owncloud. Default: `""`. +-fallback-insecure | $GLAUTH_FALLBACK_INSECURE +: Allow insecure requests to the datastore. Default: `false`. +-fallback-server | $GLAUTH_FALLBACK_SERVERS +: `--fallback-server http://internal1.example.com [--fallback-server http://internal2.example.com]`. Default: `cli.NewStringSlice("https://demo.owncloud.com/apps/graphapi/v1.0")`. +-fallback-use-graphapi | $GLAUTH_FALLBACK_USE_GRAPHAPI +: use Graph API, only for owncloud datastore. Default: `true`. +-extensions | +: Run specific extensions during supervised mode. This flag is set by the runtime. diff --git a/extensions/graph-explorer/configuration.md b/extensions/graph-explorer/configuration.md index af0fa9e98a4..87650c18ed2 100644 --- a/extensions/graph-explorer/configuration.md +++ b/extensions/graph-explorer/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-11-19T14:23:17+0000" +date: "2021-11-19T14:58:02+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph-explorer/templates @@ -74,6 +74,37 @@ Usage: `graph-explorer [global options] command [command options] [arguments...] ## Sub Commands +### graph-explorer health + +Check health status + +Usage: `graph-explorer health [command options] [arguments...]` + + + + + +-debug-addr | $GRAPH_EXPLORER_DEBUG_ADDR +: Address to debug endpoint. Default: `"127.0.0.1:9136"`. + + + + + + + + + + + + + + + + + + + ### graph-explorer server Start integrated server @@ -156,34 +187,3 @@ Usage: `graph-explorer server [command options] [arguments...]` -extensions | : Run specific extensions during supervised mode. This flag is set by the runtime. -### graph-explorer health - -Check health status - -Usage: `graph-explorer health [command options] [arguments...]` - - - - - --debug-addr | $GRAPH_EXPLORER_DEBUG_ADDR -: Address to debug endpoint. Default: `"127.0.0.1:9136"`. - - - - - - - - - - - - - - - - - - - diff --git a/extensions/graph/configuration.md b/extensions/graph/configuration.md index 5ec7a0d5598..9b54fc22644 100644 --- a/extensions/graph/configuration.md +++ b/extensions/graph/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-11-19T14:23:17+0000" +date: "2021-11-19T14:58:02+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph/templates diff --git a/extensions/idp/configuration.md b/extensions/idp/configuration.md index 51111f225ae..164c8914107 100644 --- a/extensions/idp/configuration.md +++ b/extensions/idp/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-11-19T14:23:17+0000" +date: "2021-11-19T14:58:03+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/idp/templates diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index 3e62cc2b79b..a8cee364b6e 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-11-19T14:23:17+0000" +date: "2021-11-19T14:58:03+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/templates @@ -35,50 +35,6 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### ocs version - -Print the versions of the running instances - -Usage: `ocs version [command options] [arguments...]` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --http-namespace | $OCS_NAMESPACE -: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. - - --name | $OCS_NAME -: Service name. Default: `"ocs"`. - ### ocs health Check health status @@ -283,3 +239,47 @@ Usage: `ocs server [command options] [arguments...]` +### ocs version + +Print the versions of the running instances + +Usage: `ocs version [command options] [arguments...]` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +-http-namespace | $OCS_NAMESPACE +: Set the base namespace for the http namespace. Default: `"com.owncloud.web"`. + + +-name | $OCS_NAME +: Service name. Default: `"ocs"`. + diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index 6cfc58854f8..bdedd0e53ac 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-11-19T14:23:17+0000" +date: "2021-11-19T14:58:03+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 aee06e26c7f..1b6063118aa 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-11-19T14:23:18+0000" +date: "2021-11-19T14:58:03+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/settings/templates diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index 368a062bf77..7b2cc7ee7b8 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-11-19T14:23:23+0000" +date: "2021-11-19T14:58:10+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -106,12 +106,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. @@ -243,20 +251,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. @@ -312,11 +312,11 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage auth-machine +### storage app-provider -Start authprovider for machine auth +Start appprovider for providing apps -Usage: `storage auth-machine [command options] [arguments...]` +Usage: `storage app-provider [command options] [arguments...]` @@ -423,28 +423,16 @@ Usage: `storage auth-machine [command options] [arguments...]` --debug-addr | $STORAGE_AUTH_MACHINE_DEBUG_ADDR -: Address to bind debug server. Default: `"127.0.0.1:9167"`. --machine-auth-api-key | $STORAGE_AUTH_MACHINE_AUTH_API_KEY , $OCIS_MACHINE_AUTH_API_KEY -: the API key to be used for the machine auth driver in reva. Default: `"change-me-please"`. --network | $STORAGE_AUTH_MACHINE_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_AUTH_MACHINE_GRPC_ADDR -: Address to bind storage service. Default: `"127.0.0.1:9166"`. --service | $STORAGE_AUTH_MACHINE_SERVICES -: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -572,42 +560,74 @@ Usage: `storage auth-machine [command options] [arguments...]` +-debug-addr | $APP_PROVIDER_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `"127.0.0.1:9165"`. +-network | $APP_PROVIDER_BASIC_GRPC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $APP_PROVIDER_BASIC_GRPC_ADDR +: Address to bind storage service. Default: `"127.0.0.1:9164"`. +-external-addr | $APP_PROVIDER_BASIC_EXTERNAL_ADDR +: Address to connect to the storage service for other services. Default: `"127.0.0.1:9164"`. +-service | $APP_PROVIDER_BASIC_SERVICES +: --service appprovider [--service otherservice]. Default: `cli.NewStringSlice("appprovider")`. +-driver | $APP_PROVIDER_DRIVER +: Driver to use for app provider. Default: `""`. +-wopi-driver-app-apikey | $APP_PROVIDER_WOPI_DRIVER_APP_API_KEY +: The API key used by the app, if applicable.. Default: `""`. +-wopi-driver-app-desktop-only | $APP_PROVIDER_WOPI_DRIVER_APP_DESKTOP_ONLY +: Whether the app can be opened only on desktop. Default: `false`. +-wopi-driver-app-icon-uri | $APP_PROVIDER_WOPI_DRIVER_APP_ICON_URI +: IOP Secret (Shared with WOPI server). Default: `""`. +-wopi-driver-app-internal-url | $APP_PROVIDER_WOPI_DRIVER_APP_INTERNAL_URL +: The internal app URL in case of dockerized deployments. Defaults to AppURL. Default: `""`. +-wopi-driver-app-name | $APP_PROVIDER_WOPI_DRIVER_APP_NAME +: The App user-friendly name.. Default: `""`. -### storage storage-metadata -Start storage-metadata service +-wopi-driver-app-url | $APP_PROVIDER_WOPI_DRIVER_APP_URL +: App server URL. Default: `""`. -Usage: `storage storage-metadata [command options] [arguments...]` +-wopi-driver-insecure | $APP_PROVIDER_WOPI_DRIVER_INSECURE +: Disable SSL certificate verification of WOPI server and WOPI bridge. Default: `false`. +-wopi-driver-iopsecret | $APP_PROVIDER_WOPI_DRIVER_IOP_SECRET +: IOP Secret (Shared with WOPI server). Default: `""`. +-wopi-driver-wopiurl | $APP_PROVIDER_WOPI_DRIVER_WOPI_URL +: WOPI server URL. Default: `""`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +### storage auth-basic +Start authprovider for basic auth +Usage: `storage auth-basic [command options] [arguments...]` @@ -709,18 +729,32 @@ Usage: `storage storage-metadata [command options] [arguments...]` +-debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `"127.0.0.1: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: `"127.0.0.1:9146"`. +-service | $STORAGE_AUTH_BASIC_SERVICES +: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -801,64 +835,32 @@ 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. --debug-addr | $STORAGE_METADATA_DEBUG_ADDR -: Address to bind debug server. Default: `"127.0.0.1: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: `"127.0.0.1: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: `"127.0.0.1:9216"`. --tmp-folder | $STORAGE_METADATA_TMP_FOLDER -: path to tmp folder. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.TempFolder, path.Join(defaults.BaseDataPath(), "tmp", "metadata"))`. --driver | $STORAGE_METADATA_DRIVER -: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. --dataprovider-insecure | $STORAGE_METADATA_DATAPROVIDER_INSECURE , $OCIS_INSECURE -: dataprovider insecure. Default: `false`. - - --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider service. Default: `"localhost:9144"`. @@ -901,15 +903,15 @@ Usage: `storage storage-metadata [command options] [arguments...]` -### storage users -Start users service -Usage: `storage users [command options] [arguments...]` +### storage frontend +Start frontend service +Usage: `storage frontend [command options] [arguments...]` @@ -1018,142 +1020,174 @@ Usage: `storage users [command options] [arguments...]` +-debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR +: Address to bind debug server. Default: `"127.0.0.1:9141"`. +-transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. +-chunk-folder | $STORAGE_CHUNK_FOLDER +: temp directory for chunked uploads. Default: `flags.OverrideDefaultString(cfg.Reva.OCDav.WebdavNamespace, path.Join(defaults.BaseDataPath(), "tmp", "chunks"))`. +-webdav-namespace | $STORAGE_WEBDAV_NAMESPACE +: Namespace prefix for the /webdav endpoint. Default: `"/home/"`. +-dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE +: Namespace prefix for the webdav /dav/files endpoint. Default: `"/users/"`. +-archiver-max-num-files | $STORAGE_ARCHIVER_MAX_NUM_FILES +: Maximum number of files to be included in the archiver. Default: `10000`. +-archiver-max-size | $STORAGE_ARCHIVER_MAX_SIZE +: Maximum size for the sum of the sizes of all the files included in the archive. Default: `1073741824`. +-network | $STORAGE_FRONTEND_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_FRONTEND_HTTP_ADDR +: Address to bind storage service. Default: `"127.0.0.1:9140"`. +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `"https://localhost:9200"`. +-service | $STORAGE_FRONTEND_SERVICES +: --service ocdav [--service ocs]. Default: `cli.NewStringSlice("datagateway", "ocdav", "ocs", "appprovider")`. +-approvider-prefix | $STORAGE_FRONTEND_APPPROVIDER_PREFIX +: approvider prefix. Default: `""`. +-approvider-insecure | $STORAGE_FRONTEND_APPPROVIDER_INSECURE , $OCIS_INSECURE +: approvider insecure. Default: `false`. +-archiver-prefix | $STORAGE_FRONTEND_ARCHIVER_PREFIX +: archiver prefix. Default: `"archiver"`. +-archiver-insecure | $STORAGE_FRONTEND_ARCHIVER_INSECURE , $OCIS_INSECURE +: archiver insecure. Default: `false`. +-datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX +: datagateway prefix. Default: `"data"`. +-favorites | $STORAGE_FRONTEND_FAVORITES +: announces favorites support to clients. Default: `false`. +-ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX +: owncloud webdav endpoint prefix. Default: `""`. +-ocdav-insecure | $STORAGE_FRONTEND_OCDAV_INSECURE , $OCIS_INSECURE +: owncloud webdav insecure. Default: `false`. +-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: `""`. +-ocs-additional-info-attribute | $STORAGE_FRONTEND_OCS_ADDITIONAL_INFO_ATTRIBUTE +: the additional info to be returned when searching for users. Default: `"{{.Mail}}"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-default-upload-protocol | $STORAGE_FRONTEND_DEFAULT_UPLOAD_PROTOCOL +: Default upload chunking protocol to be used out of tus/v1/ng. Default: `"tus"`. +-upload-max-chunk-size | $STORAGE_FRONTEND_UPLOAD_MAX_CHUNK_SIZE +: Max chunk size in bytes to advertise to clients through capabilities, or 0 for unlimited. Default: `1e+8`. +-upload-http-method-override | $STORAGE_FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE +: Specify an HTTP method (ex: POST) that clients should to use when uploading instead of PATCH. Default: `""`. +-checksum-supported-type | $STORAGE_FRONTEND_CHECKSUM_SUPPORTED_TYPES +: --checksum-supported-type sha1 [--checksum-supported-type adler32]. Default: `cli.NewStringSlice("sha1", "md5", "adler32")`. +-checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE +: Specify the preferred checksum algorithm used for uploads. Default: `""`. --debug-addr | $STORAGE_USERPROVIDER_DEBUG_ADDR -: Address to bind debug server. Default: `"127.0.0.1:9145"`. +-archiver-url | $STORAGE_FRONTEND_ARCHIVER_URL +: URL where the archiver is reachable. Default: `"/archiver"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-appprovider-apps-url | $STORAGE_FRONTEND_APP_PROVIDER_APPS_URL +: URL where the app listing of the app provider is reachable. Default: `"/app/list"`. --network | $STORAGE_USERPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-appprovider-open-url | $STORAGE_FRONTEND_APP_PROVIDER_OPEN_URL +: URL where files can be handed over to an application from the app provider. Default: `"/app/open"`. --addr | $STORAGE_USERPROVIDER_ADDR -: Address to bind storage service. Default: `"127.0.0.1:9144"`. +-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.. --endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `"localhost:9144"`. --service | $STORAGE_USERPROVIDER_SERVICES -: --service userprovider [--service otherservice]. Default: `cli.NewStringSlice("userprovider")`. --driver | $STORAGE_USERPROVIDER_DRIVER -: user driver: 'demo', 'json', 'ldap', 'owncloudsql' or 'rest'. Default: `"ldap"`. --json-config | $STORAGE_USERPROVIDER_JSON -: Path to users.json file. Default: `""`. --user-groups-cache-expiration | $STORAGE_USER_CACHE_EXPIRATION -: Time in minutes for redis cache expiration.. Default: `5`. --owncloudsql-dbhost | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBHOST -: hostname of the mysql db. Default: `"mysql"`. --owncloudsql-dbport | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBPORT -: port of the mysql db. Default: `3306`. --owncloudsql-dbname | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBNAME -: database name of the owncloud db. Default: `"owncloud"`. --owncloudsql-dbuser | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBUSER -: user name to use when connecting to the mysql owncloud db. Default: `"owncloud"`. --owncloudsql-dbpass | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBPASS -: password to use when connecting to the mysql owncloud db. Default: `"secret"`. --owncloudsql-idp | $STORAGE_USERPROVIDER_OWNCLOUDSQL_IDP , $OCIS_URL -: Identity provider to use for users. Default: `"https://localhost:9200"`. --owncloudsql-nobody | $STORAGE_USERPROVIDER_OWNCLOUDSQL_NOBODY -: fallback user id to use when user has no id. Default: `99`. --owncloudsql-join-username | $STORAGE_USERPROVIDER_OWNCLOUDSQL_JOIN_USERNAME -: join the username from the oc_preferences table. Default: `false`. --owncloudsql-join-ownclouduuid | $STORAGE_USERPROVIDER_OWNCLOUDSQL_JOIN_OWNCLOUDUUID -: join the ownclouduuid from the oc_preferences table. Default: `false`. --owncloudsql-enable-medial-search | $STORAGE_USERPROVIDER_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH -: enable medial search when finding users. Default: `false`. @@ -1221,75 +1255,43 @@ Usage: `storage users [command options] [arguments...]` -### storage app-provider -Start appprovider for providing apps -Usage: `storage app-provider [command options] [arguments...]` --debug-addr | $APP_PROVIDER_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `"127.0.0.1:9165"`. --network | $APP_PROVIDER_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $APP_PROVIDER_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `"127.0.0.1:9164"`. --external-addr | $APP_PROVIDER_BASIC_EXTERNAL_ADDR -: Address to connect to the storage service for other services. Default: `"127.0.0.1:9164"`. --service | $APP_PROVIDER_BASIC_SERVICES -: --service appprovider [--service otherservice]. Default: `cli.NewStringSlice("appprovider")`. --driver | $APP_PROVIDER_DRIVER -: Driver to use for app provider. Default: `""`. --wopi-driver-app-apikey | $APP_PROVIDER_WOPI_DRIVER_APP_API_KEY -: The API key used by the app, if applicable.. Default: `""`. --wopi-driver-app-desktop-only | $APP_PROVIDER_WOPI_DRIVER_APP_DESKTOP_ONLY -: Whether the app can be opened only on desktop. Default: `false`. --wopi-driver-app-icon-uri | $APP_PROVIDER_WOPI_DRIVER_APP_ICON_URI -: IOP Secret (Shared with WOPI server). Default: `""`. +### storage users +Start users service --wopi-driver-app-internal-url | $APP_PROVIDER_WOPI_DRIVER_APP_INTERNAL_URL -: The internal app URL in case of dockerized deployments. Defaults to AppURL. Default: `""`. +Usage: `storage users [command options] [arguments...]` --wopi-driver-app-name | $APP_PROVIDER_WOPI_DRIVER_APP_NAME -: The App user-friendly name.. Default: `""`. --wopi-driver-app-url | $APP_PROVIDER_WOPI_DRIVER_APP_URL -: App server URL. Default: `""`. --wopi-driver-insecure | $APP_PROVIDER_WOPI_DRIVER_INSECURE -: Disable SSL certificate verification of WOPI server and WOPI bridge. Default: `false`. --wopi-driver-iopsecret | $APP_PROVIDER_WOPI_DRIVER_IOP_SECRET -: IOP Secret (Shared with WOPI server). Default: `""`. --wopi-driver-wopiurl | $APP_PROVIDER_WOPI_DRIVER_WOPI_URL -: WOPI server URL. Default: `""`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -1502,45 +1504,80 @@ Usage: `storage app-provider [command options] [arguments...]` +-debug-addr | $STORAGE_USERPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `"127.0.0.1:9145"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-network | $STORAGE_USERPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_USERPROVIDER_ADDR +: Address to bind storage service. Default: `"127.0.0.1:9144"`. +-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `"localhost:9144"`. +-service | $STORAGE_USERPROVIDER_SERVICES +: --service userprovider [--service otherservice]. Default: `cli.NewStringSlice("userprovider")`. +-driver | $STORAGE_USERPROVIDER_DRIVER +: user driver: 'demo', 'json', 'ldap', 'owncloudsql' or 'rest'. Default: `"ldap"`. +-json-config | $STORAGE_USERPROVIDER_JSON +: Path to users.json file. Default: `""`. +-user-groups-cache-expiration | $STORAGE_USER_CACHE_EXPIRATION +: Time in minutes for redis cache expiration.. Default: `5`. +-owncloudsql-dbhost | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBHOST +: hostname of the mysql db. Default: `"mysql"`. +-owncloudsql-dbport | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBPORT +: port of the mysql db. Default: `3306`. +-owncloudsql-dbname | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBNAME +: database name of the owncloud db. Default: `"owncloud"`. +-owncloudsql-dbuser | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBUSER +: user name to use when connecting to the mysql owncloud db. Default: `"owncloud"`. +-owncloudsql-dbpass | $STORAGE_USERPROVIDER_OWNCLOUDSQL_DBPASS +: password to use when connecting to the mysql owncloud db. Default: `"secret"`. +-owncloudsql-idp | $STORAGE_USERPROVIDER_OWNCLOUDSQL_IDP , $OCIS_URL +: Identity provider to use for users. Default: `"https://localhost:9200"`. -### storage auth-bearer +-owncloudsql-nobody | $STORAGE_USERPROVIDER_OWNCLOUDSQL_NOBODY +: fallback user id to use when user has no id. Default: `99`. -Start authprovider for bearer auth -Usage: `storage auth-bearer [command options] [arguments...]` +-owncloudsql-join-username | $STORAGE_USERPROVIDER_OWNCLOUDSQL_JOIN_USERNAME +: join the username from the oc_preferences table. Default: `false`. +-owncloudsql-join-ownclouduuid | $STORAGE_USERPROVIDER_OWNCLOUDSQL_JOIN_OWNCLOUDUUID +: join the ownclouduuid from the oc_preferences table. Default: `false`. +-owncloudsql-enable-medial-search | $STORAGE_USERPROVIDER_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH +: enable medial search when finding users. Default: `false`. @@ -1558,8 +1595,11 @@ Usage: `storage auth-bearer [command options] [arguments...]` +### storage auth-bearer +Start authprovider for bearer auth +Usage: `storage auth-bearer [command options] [arguments...]` @@ -1651,24 +1691,44 @@ Usage: `storage auth-bearer [command options] [arguments...]` +-debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR +: Address to bind debug server. Default: `"127.0.0.1:9149"`. +-oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL +: OIDC issuer. Default: `"https://localhost:9200"`. +-oidc-insecure | $STORAGE_OIDC_INSECURE , $OCIS_INSECURE +: OIDC allow insecure communication. Default: `false`. +-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: `"127.0.0.1:9148"`. +-service | $STORAGE_AUTH_BEARER_SERVICES +: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -1730,44 +1790,24 @@ Usage: `storage auth-bearer [command options] [arguments...]` --debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR -: Address to bind debug server. Default: `"127.0.0.1:9149"`. --oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL -: OIDC issuer. Default: `"https://localhost:9200"`. --oidc-insecure | $STORAGE_OIDC_INSECURE , $OCIS_INSECURE -: OIDC allow insecure communication. Default: `false`. --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: `"127.0.0.1:9148"`. --service | $STORAGE_AUTH_BEARER_SERVICES -: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -1825,11 +1865,8 @@ Usage: `storage auth-bearer [command options] [arguments...]` -### storage gateway -Start gateway -Usage: `storage gateway [command options] [arguments...]` @@ -1851,156 +1888,85 @@ Usage: `storage gateway [command options] [arguments...]` +### storage storage-home +Start storage-home service +Usage: `storage storage-home [command options] [arguments...]` --debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR -: Address to bind debug server. Default: `"127.0.0.1:9143"`. --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. --transfer-expires | $STORAGE_TRANSFER_EXPIRES -: Transfer token ttl in seconds. Default: `24 * 60 * 60`. --network | $STORAGE_GATEWAY_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_GATEWAY_GRPC_ADDR -: Address to bind REVA service. Default: `"127.0.0.1:9142"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --service | $STORAGE_GATEWAY_SERVICES -: --service gateway [--service authregistry]. Default: `cli.NewStringSlice("gateway", "authregistry", "storageregistry", "appregistry")`. --commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT -: Commit shares to the share manager. Default: `true`. --commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF -: Commit shares to the storage. Default: `true`. --share-folder | $STORAGE_GATEWAY_SHARE_FOLDER -: mount shares in this folder of the home storage provider. Default: `"Shares"`. --disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN -: Disable creation of home folder on login. --storage-home-mapping | $STORAGE_GATEWAY_HOME_MAPPING -: mapping template for user home paths to user-specific mount points, e.g. /home/{{substr 0 1 .Username}}. Default: `""`. --etag-cache-ttl | $STORAGE_GATEWAY_ETAG_CACHE_TTL -: TTL for the home and shares directory etags cache. Default: `0`. --auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT -: endpoint to use for the basic auth provider. Default: `"localhost:9146"`. --auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT -: endpoint to use for the bearer auth provider. Default: `"localhost:9148"`. --auth-machine-endpoint | $STORAGE_AUTH_MACHINE_ENDPOINT -: endpoint to use for the machine auth provider. Default: `"localhost:9166"`. --storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER -: driver of the storage registry. Default: `"static"`. --storage-registry-rule | $STORAGE_STORAGE_REGISTRY_RULES -: `Replaces the generated storage registry rules with this set: --storage-registry-rule "/eos=localhost:9158" [--storage-registry-rule "1284d238-aa92-42ce-bdc4-0b0000009162=localhost:9162"]`. Default: `cli.NewStringSlice()`. --storage-home-provider | $STORAGE_STORAGE_REGISTRY_HOME_PROVIDER -: mount point of the storage provider for user homes in the global namespace. Default: `"/home"`. --storage-registry-json | $STORAGE_STORAGE_REGISTRY_JSON -: JSON file containing the storage registry rules. Default: `""`. --app-registry-driver | $STORAGE_APP_REGISTRY_DRIVER -: driver of the app registry. Default: `"static"`. --app-registry-mimetypes-json | $STORAGE_APP_REGISTRY_MIMETYPES_JSON -: JSON file containing the storage registry rules. Default: `""`. --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `"https://localhost:9200"`. --datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL -: URL to use for the storage datagateway, defaults to /data. Default: `""`. --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider. Default: `"localhost:9144"`. --groupprovider-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: endpoint to use for the groupprovider. Default: `"localhost:9160"`. --sharing-endpoint | $STORAGE_SHARING_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9150"`. --appprovider-endpoint | $STORAGE_APPPROVIDER_ENDPOINT -: endpoint to use for the app provider. Default: `"localhost:9164"`. --storage-home-endpoint | $STORAGE_HOME_ENDPOINT -: endpoint to use for the home storage. Default: `"localhost:9154"`. --storage-home-mount-path | $STORAGE_HOME_MOUNT_PATH -: mount path. Default: `"/home"`. --storage-home-mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009154"`. --storage-users-endpoint | $STORAGE_USERS_ENDPOINT -: endpoint to use for the users storage. Default: `"localhost:9157"`. --storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH -: mount path. Default: `"/users"`. --storage-users-mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. --public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT -: endpoint to use for the public links service. Default: `"localhost:9178"`. --storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `"/public"`. --storage-public-link-mount-id | $STORAGE_PUBLIC_LINK_MOUNT_ID -: mount id. Default: `"e1a73ede-549b-4226-abdf-40e69ca8230d"`. @@ -2135,36 +2101,68 @@ Usage: `storage gateway [command options] [arguments...]` +-debug-addr | $STORAGE_HOME_DEBUG_ADDR +: Address to bind debug server. Default: `"127.0.0.1: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: `"127.0.0.1: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: `"127.0.0.1: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: `flags.OverrideDefaultString(cfg.Reva.StorageHome.TempFolder, path.Join(defaults.BaseDataPath(), "tmp", "home"))`. +-dataprovider-insecure | $STORAGE_HOME_DATAPROVIDER_INSECURE , $OCIS_INSECURE +: dataprovider insecure. Default: `false`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9144"`. @@ -2199,13 +2197,13 @@ Usage: `storage gateway [command options] [arguments...]` -### storage storage-users -Start storage-users service -Usage: `storage storage-users [command options] [arguments...]` +### storage sharing +Start sharing service +Usage: `storage sharing [command options] [arguments...]` @@ -2242,28 +2240,52 @@ Usage: `storage storage-users [command options] [arguments...]` +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `"127.0.0.1:9151"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-network | $STORAGE_SHARING_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `"127.0.0.1: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: `flags.OverrideDefaultString(cfg.Reva.Sharing.UserJSONFile, path.Join(defaults.BaseDataPath(), "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: `flags.OverrideDefaultString(cfg.Reva.Sharing.PublicJSONFile, path.Join(defaults.BaseDataPath(), "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`. @@ -2362,68 +2384,36 @@ Usage: `storage storage-users [command options] [arguments...]` --debug-addr | $STORAGE_USERS_DEBUG_ADDR -: Address to bind debug server. Default: `"127.0.0.1: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: `"127.0.0.1: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: `"127.0.0.1:9158"`. --driver | $STORAGE_USERS_DRIVER -: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. --dataprovider-insecure | $STORAGE_USERS_DATAPROVIDER_INSECURE , $OCIS_INSECURE -: dataprovider insecure. Default: `false`. --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: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.TempFolder, path.Join(defaults.BaseDataPath(), "tmp", "users"))`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9144"`. @@ -2508,23 +2498,35 @@ Usage: `storage storage-users [command options] [arguments...]` +### storage storage-public-link +Start storage-public-link service -### storage health +Usage: `storage storage-public-link [command options] [arguments...]` -Check health status -Usage: `storage health [command options] [arguments...]` +-debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR +: Address to bind debug server. Default: `"127.0.0.1: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: `"127.0.0.1:9178"`. +-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `"/public"`. +-mount-id | $STORAGE_PUBLIC_LINK_MOUNT_ID +: mount id. Default: `"e1a73ede-549b-4226-abdf-40e69ca8230d"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -2773,17 +2775,15 @@ Usage: `storage health [command options] [arguments...]` --debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `"127.0.0.1:9109"`. -### storage storage -Storage service for oCIS -Usage: `storage storage [command options] [arguments...]` +### storage storage-users +Start storage-users service +Usage: `storage storage-users [command options] [arguments...]` @@ -2859,36 +2859,68 @@ Usage: `storage storage [command options] [arguments...]` +-debug-addr | $STORAGE_USERS_DEBUG_ADDR +: Address to bind debug server. Default: `"127.0.0.1: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: `"127.0.0.1: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: `"127.0.0.1:9158"`. +-driver | $STORAGE_USERS_DRIVER +: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. +-dataprovider-insecure | $STORAGE_USERS_DATAPROVIDER_INSECURE , $OCIS_INSECURE +: dataprovider insecure. Default: `false`. +-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: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.TempFolder, path.Join(defaults.BaseDataPath(), "tmp", "users"))`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9144"`. @@ -2984,20 +3016,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. @@ -3051,11 +3075,8 @@ Usage: `storage storage [command options] [arguments...]` -### storage sharing -Start sharing service -Usage: `storage sharing [command options] [arguments...]` @@ -3069,8 +3090,11 @@ Usage: `storage sharing [command options] [arguments...]` +### storage auth-machine +Start authprovider for machine auth +Usage: `storage auth-machine [command options] [arguments...]` @@ -3128,16 +3152,28 @@ Usage: `storage sharing [command options] [arguments...]` +-debug-addr | $STORAGE_AUTH_MACHINE_DEBUG_ADDR +: Address to bind debug server. Default: `"127.0.0.1:9167"`. +-machine-auth-api-key | $STORAGE_AUTH_MACHINE_AUTH_API_KEY , $OCIS_MACHINE_AUTH_API_KEY +: the API key to be used for the machine auth driver in reva. Default: `"change-me-please"`. +-network | $STORAGE_AUTH_MACHINE_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-addr | $STORAGE_AUTH_MACHINE_GRPC_ADDR +: Address to bind storage service. Default: `"127.0.0.1:9166"`. +-service | $STORAGE_AUTH_MACHINE_SERVICES +: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -3145,52 +3181,28 @@ Usage: `storage sharing [command options] [arguments...]` --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `"127.0.0.1:9151"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --network | $STORAGE_SHARING_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_SHARING_GRPC_ADDR -: Address to bind storage service. Default: `"127.0.0.1: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: `flags.OverrideDefaultString(cfg.Reva.Sharing.UserJSONFile, path.Join(defaults.BaseDataPath(), "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: `flags.OverrideDefaultString(cfg.Reva.Sharing.PublicJSONFile, path.Join(defaults.BaseDataPath(), "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`. @@ -3350,11 +3362,8 @@ Usage: `storage sharing [command options] [arguments...]` -### storage storage-home -Start storage-home service -Usage: `storage storage-home [command options] [arguments...]` @@ -3362,8 +3371,11 @@ Usage: `storage storage-home [command options] [arguments...]` +### storage groups +Start groups service +Usage: `storage groups [command options] [arguments...]` @@ -3412,73 +3424,59 @@ Usage: `storage storage-home [command options] [arguments...]` +-debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `"127.0.0.1:9161"`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-network | $STORAGE_GROUPPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --debug-addr | $STORAGE_HOME_DEBUG_ADDR -: Address to bind debug server. Default: `"127.0.0.1:9156"`. +-addr | $STORAGE_GROUPPROVIDER_ADDR +: Address to bind storage service. Default: `"127.0.0.1:9160"`. --grpc-network | $STORAGE_HOME_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `"localhost:9160"`. --grpc-addr | $STORAGE_HOME_GRPC_ADDR -: Address to bind storage service. Default: `"127.0.0.1:9154"`. +-service | $STORAGE_GROUPPROVIDER_SERVICES +: --service groupprovider [--service otherservice]. Default: `cli.NewStringSlice("groupprovider")`. --http-network | $STORAGE_HOME_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-driver | $STORAGE_GROUPPROVIDER_DRIVER +: group driver: 'json', 'ldap', or 'rest'. Default: `"ldap"`. --http-addr | $STORAGE_HOME_HTTP_ADDR -: Address to bind storage service. Default: `"127.0.0.1:9155"`. +-json-config | $STORAGE_GROUPPROVIDER_JSON +: Path to groups.json file. Default: `""`. --driver | $STORAGE_HOME_DRIVER -: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. +-group-members-cache-expiration | $STORAGE_GROUP_CACHE_EXPIRATION +: Time in minutes for redis cache expiration.. Default: `5`. --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: `flags.OverrideDefaultString(cfg.Reva.StorageHome.TempFolder, path.Join(defaults.BaseDataPath(), "tmp", "home"))`. --dataprovider-insecure | $STORAGE_HOME_DATAPROVIDER_INSECURE , $OCIS_INSECURE -: dataprovider insecure. Default: `false`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `"localhost:9144"`. @@ -3661,13 +3659,13 @@ Usage: `storage storage-home [command options] [arguments...]` -### storage auth-basic -Start authprovider for basic auth -Usage: `storage auth-basic [command options] [arguments...]` +### storage health +Check health status +Usage: `storage health [command options] [arguments...]` @@ -3684,32 +3682,20 @@ Usage: `storage auth-basic [command options] [arguments...]` --debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `"127.0.0.1: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: `"127.0.0.1:9146"`. +-debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `"127.0.0.1:9109"`. --service | $STORAGE_AUTH_BASIC_SERVICES -: --service authprovider [--service otherservice]. Default: `cli.NewStringSlice("authprovider")`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. @@ -3941,15 +3927,15 @@ Usage: `storage auth-basic [command options] [arguments...]` +### storage storage +Storage service for oCIS +Usage: `storage storage [command options] [arguments...]` -### storage frontend -Start frontend service -Usage: `storage frontend [command options] [arguments...]` @@ -4012,12 +3998,20 @@ Usage: `storage frontend [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. @@ -4173,151 +4167,81 @@ Usage: `storage frontend [command options] [arguments...]` --debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR -: Address to bind debug server. Default: `"127.0.0.1:9141"`. --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. --chunk-folder | $STORAGE_CHUNK_FOLDER -: temp directory for chunked uploads. Default: `flags.OverrideDefaultString(cfg.Reva.OCDav.WebdavNamespace, path.Join(defaults.BaseDataPath(), "tmp", "chunks"))`. --webdav-namespace | $STORAGE_WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `"/home/"`. --dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `"/users/"`. --archiver-max-num-files | $STORAGE_ARCHIVER_MAX_NUM_FILES -: Maximum number of files to be included in the archiver. Default: `10000`. --archiver-max-size | $STORAGE_ARCHIVER_MAX_SIZE -: Maximum size for the sum of the sizes of all the files included in the archive. Default: `1073741824`. --network | $STORAGE_FRONTEND_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --addr | $STORAGE_FRONTEND_HTTP_ADDR -: Address to bind storage service. Default: `"127.0.0.1:9140"`. --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `"https://localhost:9200"`. --service | $STORAGE_FRONTEND_SERVICES -: --service ocdav [--service ocs]. Default: `cli.NewStringSlice("datagateway", "ocdav", "ocs", "appprovider")`. --approvider-prefix | $STORAGE_FRONTEND_APPPROVIDER_PREFIX -: approvider prefix. Default: `""`. --approvider-insecure | $STORAGE_FRONTEND_APPPROVIDER_INSECURE , $OCIS_INSECURE -: approvider insecure. Default: `false`. --archiver-prefix | $STORAGE_FRONTEND_ARCHIVER_PREFIX -: archiver prefix. Default: `"archiver"`. --archiver-insecure | $STORAGE_FRONTEND_ARCHIVER_INSECURE , $OCIS_INSECURE -: archiver insecure. Default: `false`. --datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `"data"`. --favorites | $STORAGE_FRONTEND_FAVORITES -: announces favorites support to clients. Default: `false`. --ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. Default: `""`. +### storage gateway --ocdav-insecure | $STORAGE_FRONTEND_OCDAV_INSECURE , $OCIS_INSECURE -: owncloud webdav insecure. Default: `false`. +Start gateway +Usage: `storage gateway [command options] [arguments...]` --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: `""`. --ocs-additional-info-attribute | $STORAGE_FRONTEND_OCS_ADDITIONAL_INFO_ATTRIBUTE -: the additional info to be returned when searching for users. Default: `"{{.Mail}}"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --default-upload-protocol | $STORAGE_FRONTEND_DEFAULT_UPLOAD_PROTOCOL -: Default upload chunking protocol to be used out of tus/v1/ng. Default: `"tus"`. --upload-max-chunk-size | $STORAGE_FRONTEND_UPLOAD_MAX_CHUNK_SIZE -: Max chunk size in bytes to advertise to clients through capabilities, or 0 for unlimited. Default: `1e+8`. --upload-http-method-override | $STORAGE_FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE -: Specify an HTTP method (ex: POST) that clients should to use when uploading instead of PATCH. Default: `""`. --checksum-supported-type | $STORAGE_FRONTEND_CHECKSUM_SUPPORTED_TYPES -: --checksum-supported-type sha1 [--checksum-supported-type adler32]. Default: `cli.NewStringSlice("sha1", "md5", "adler32")`. --checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE -: Specify the preferred checksum algorithm used for uploads. Default: `""`. --archiver-url | $STORAGE_FRONTEND_ARCHIVER_URL -: URL where the archiver is reachable. Default: `"/archiver"`. --appprovider-apps-url | $STORAGE_FRONTEND_APP_PROVIDER_APPS_URL -: URL where the app listing of the app provider is reachable. Default: `"/app/list"`. --appprovider-open-url | $STORAGE_FRONTEND_APP_PROVIDER_OPEN_URL -: URL where files can be handed over to an application from the app provider. Default: `"/app/open"`. --user-agent-whitelist-lock-in | $STORAGE_FRONTEND_MIDDLEWARE_AUTH_CREDENTIALS_BY_USER_AGENT -: --user-agent-whitelist-lock-in=mirall:basic,foo:bearer Given a tuple of comma separated [UserAgent:challenge] values, it locks a given user agent to the authentication challenge. Particularly useful for old clients whose USer-Agent is known and only support one authentication challenge. When this flag is set in the storage-frontend it configures Reva.. -### storage groups -Start groups service -Usage: `storage groups [command options] [arguments...]` @@ -4426,94 +4350,152 @@ Usage: `storage groups [command options] [arguments...]` +-debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR +: Address to bind debug server. Default: `"127.0.0.1:9143"`. +-transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `"replace-me-with-a-transfer-secret"`. +-transfer-expires | $STORAGE_TRANSFER_EXPIRES +: Transfer token ttl in seconds. Default: `24 * 60 * 60`. +-network | $STORAGE_GATEWAY_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. --debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR -: Address to bind debug server. Default: `"127.0.0.1:9161"`. + +-addr | $STORAGE_GATEWAY_GRPC_ADDR +: Address to bind REVA service. Default: `"127.0.0.1:9142"`. -reva-gateway-addr | $REVA_GATEWAY : Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. --network | $STORAGE_GROUPPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `"tcp"`. +-service | $STORAGE_GATEWAY_SERVICES +: --service gateway [--service authregistry]. Default: `cli.NewStringSlice("gateway", "authregistry", "storageregistry", "appregistry")`. --addr | $STORAGE_GROUPPROVIDER_ADDR -: Address to bind storage service. Default: `"127.0.0.1:9160"`. +-commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT +: Commit shares to the share manager. Default: `true`. --endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `"localhost:9160"`. +-commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF +: Commit shares to the storage. Default: `true`. --service | $STORAGE_GROUPPROVIDER_SERVICES -: --service groupprovider [--service otherservice]. Default: `cli.NewStringSlice("groupprovider")`. +-share-folder | $STORAGE_GATEWAY_SHARE_FOLDER +: mount shares in this folder of the home storage provider. Default: `"Shares"`. --driver | $STORAGE_GROUPPROVIDER_DRIVER -: group driver: 'json', 'ldap', or 'rest'. Default: `"ldap"`. +-disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN +: Disable creation of home folder on login. --json-config | $STORAGE_GROUPPROVIDER_JSON -: Path to groups.json file. Default: `""`. +-storage-home-mapping | $STORAGE_GATEWAY_HOME_MAPPING +: mapping template for user home paths to user-specific mount points, e.g. /home/{{substr 0 1 .Username}}. Default: `""`. --group-members-cache-expiration | $STORAGE_GROUP_CACHE_EXPIRATION -: Time in minutes for redis cache expiration.. Default: `5`. +-etag-cache-ttl | $STORAGE_GATEWAY_ETAG_CACHE_TTL +: TTL for the home and shares directory etags cache. Default: `0`. + +-auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT +: endpoint to use for the basic auth provider. Default: `"localhost:9146"`. +-auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT +: endpoint to use for the bearer auth provider. Default: `"localhost:9148"`. +-auth-machine-endpoint | $STORAGE_AUTH_MACHINE_ENDPOINT +: endpoint to use for the machine auth provider. Default: `"localhost:9166"`. +-storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER +: driver of the storage registry. Default: `"static"`. +-storage-registry-rule | $STORAGE_STORAGE_REGISTRY_RULES +: `Replaces the generated storage registry rules with this set: --storage-registry-rule "/eos=localhost:9158" [--storage-registry-rule "1284d238-aa92-42ce-bdc4-0b0000009162=localhost:9162"]`. Default: `cli.NewStringSlice()`. +-storage-home-provider | $STORAGE_STORAGE_REGISTRY_HOME_PROVIDER +: mount point of the storage provider for user homes in the global namespace. Default: `"/home"`. +-storage-registry-json | $STORAGE_STORAGE_REGISTRY_JSON +: JSON file containing the storage registry rules. Default: `""`. +-app-registry-driver | $STORAGE_APP_REGISTRY_DRIVER +: driver of the app registry. Default: `"static"`. +-app-registry-mimetypes-json | $STORAGE_APP_REGISTRY_MIMETYPES_JSON +: JSON file containing the storage registry rules. Default: `""`. +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `"https://localhost:9200"`. +-datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL +: URL to use for the storage datagateway, defaults to /data. Default: `""`. +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider. Default: `"localhost:9144"`. +-groupprovider-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: endpoint to use for the groupprovider. Default: `"localhost:9160"`. +-sharing-endpoint | $STORAGE_SHARING_ENDPOINT +: endpoint to use for the storage service. Default: `"localhost:9150"`. +-appprovider-endpoint | $STORAGE_APPPROVIDER_ENDPOINT +: endpoint to use for the app provider. Default: `"localhost:9164"`. +-storage-home-endpoint | $STORAGE_HOME_ENDPOINT +: endpoint to use for the home storage. Default: `"localhost:9154"`. +-storage-home-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `"/home"`. +-storage-home-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009154"`. +-storage-users-endpoint | $STORAGE_USERS_ENDPOINT +: endpoint to use for the users storage. Default: `"localhost:9157"`. +-storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH +: mount path. Default: `"/users"`. +-storage-users-mount-id | $STORAGE_USERS_MOUNT_ID +: mount id. Default: `"1284d238-aa92-42ce-bdc4-0b0000009157"`. +-public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT +: endpoint to use for the public links service. Default: `"localhost:9178"`. +-storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `"/public"`. +-storage-public-link-mount-id | $STORAGE_PUBLIC_LINK_MOUNT_ID +: mount id. Default: `"e1a73ede-549b-4226-abdf-40e69ca8230d"`. @@ -4594,8 +4576,11 @@ Usage: `storage groups [command options] [arguments...]` +### storage storage-metadata +Start storage-metadata service +Usage: `storage storage-metadata [command options] [arguments...]` @@ -4603,35 +4588,54 @@ Usage: `storage groups [command options] [arguments...]` -### storage storage-public-link -Start storage-public-link service -Usage: `storage storage-public-link [command options] [arguments...]` +-debug-addr | $STORAGE_METADATA_DEBUG_ADDR +: Address to bind debug server. Default: `"127.0.0.1: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: `"127.0.0.1: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: `"127.0.0.1:9216"`. +-tmp-folder | $STORAGE_METADATA_TMP_FOLDER +: path to tmp folder. Default: `flags.OverrideDefaultString(cfg.Reva.StorageMetadata.TempFolder, path.Join(defaults.BaseDataPath(), "tmp", "metadata"))`. +-driver | $STORAGE_METADATA_DRIVER +: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `"ocis"`. +-dataprovider-insecure | $STORAGE_METADATA_DATAPROVIDER_INSECURE , $OCIS_INSECURE +: dataprovider insecure. Default: `false`. +-reva-gateway-addr | $REVA_GATEWAY +: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider service. Default: `"localhost:9144"`. @@ -4676,12 +4680,20 @@ Usage: `storage storage-public-link [command options] [arguments...]` +-config-file | $STORAGE_CONFIG_FILE +: Path to config file. +-log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. +-log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. +-log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. @@ -4760,28 +4772,16 @@ Usage: `storage storage-public-link [command options] [arguments...]` --debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR -: Address to bind debug server. Default: `"127.0.0.1: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: `"127.0.0.1:9178"`. --mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `"/public"`. --mount-id | $STORAGE_PUBLIC_LINK_MOUNT_ID -: mount id. Default: `"e1a73ede-549b-4226-abdf-40e69ca8230d"`. --reva-gateway-addr | $REVA_GATEWAY -: Address of REVA gateway endpoint. Default: `"127.0.0.1:9142"`. diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index b5a3dfe4f9f..998a2ab69f1 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-11-19T14:23:23+0000" +date: "2021-11-19T14:58:10+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates @@ -35,6 +35,40 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. +### store version + +Print the versions of the running instances + +Usage: `store version [command options] [arguments...]` + + + + + + + + + + + + + + + + + + + + + + +-grpc-namespace | $STORE_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. + + +-name | $STORE_NAME +: Service name. Default: `"store"`. + ### store health Check health status @@ -179,37 +213,3 @@ Usage: `store server [command options] [arguments...]` -### store version - -Print the versions of the running instances - -Usage: `store version [command options] [arguments...]` - - - - - - - - - - - - - - - - - - - - - - --grpc-namespace | $STORE_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `"com.owncloud.api"`. - - --name | $STORE_NAME -: Service name. Default: `"store"`. - diff --git a/extensions/thumbnails/configuration.md b/extensions/thumbnails/configuration.md index 4317efb8922..f91f976d1bf 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-11-19T14:23:29+0000" +date: "2021-11-19T14:58:17+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates diff --git a/extensions/web/configuration.md b/extensions/web/configuration.md index 75db3fe2bb9..4610046ca2c 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-11-19T14:23:36+0000" +date: "2021-11-19T14:58:21+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/web/templates @@ -74,47 +74,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: `"127.0.0.1:9104"`. - - - - - - - - - - - - - - - - - - - - - - - - - - - - ### web server @@ -246,4 +205,45 @@ 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: `"127.0.0.1:9104"`. + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index 25a93457238..dca210fbf0f 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-11-19T14:23:36+0000" +date: "2021-11-19T14:58:21+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates @@ -70,6 +70,43 @@ 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: `"127.0.0.1:9119"`. + + + + + + + + + + + + + + + + + + + + + + + + + + + ### webdav server @@ -219,41 +256,4 @@ 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: `"127.0.0.1:9119"`. - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ocis/configuration.md b/ocis/configuration.md index 78d23214404..014af61df69 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-11-19T14:23:17+0000" +date: "2021-11-19T14:58:03+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -112,11 +112,11 @@ Usage: `ocis [global options] command [command options] [arguments...]` ## Sub Commands -### ocis server +### ocis list -Start fullstack server +Lists running ocis extensions -Usage: `ocis server [command options] [arguments...]` +Usage: `ocis list [command options] [arguments...]` @@ -134,42 +134,26 @@ Usage: `ocis server [command options] [arguments...]` --debug-addr | $OCIS_DEBUG_ADDR -: Address to bind debug server. Default: `127.0.0.1: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. +### ocis server --http-addr | $OCIS_HTTP_ADDR -: Address to bind http server. Default: `127.0.0.1:9000`. +Start fullstack server +Usage: `ocis server [command options] [arguments...]` --http-root | $OCIS_HTTP_ROOT -: Root path of http server. Default: `/`. --grpc-addr | $OCIS_GRPC_ADDR -: Address to bind grpc server. Default: `127.0.0.1:9001`. --extensions | $OCIS_RUN_EXTENSIONS -: Run specific extensions during supervised mode. -### ocis health -Check health status -Usage: `ocis health [command options] [arguments...]` @@ -179,29 +163,43 @@ Usage: `ocis health [command options] [arguments...]` +-debug-addr | $OCIS_DEBUG_ADDR +: Address to bind debug server. Default: `127.0.0.1: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. --debug-addr | $OCIS_DEBUG_ADDR -: Address to debug endpoint. Default: `127.0.0.1:9010`. +-http-addr | $OCIS_HTTP_ADDR +: Address to bind http server. Default: `127.0.0.1:9000`. +-http-root | $OCIS_HTTP_ROOT +: Root path of http server. Default: `/`. +-grpc-addr | $OCIS_GRPC_ADDR +: Address to bind grpc server. Default: `127.0.0.1:9001`. +-extensions | $OCIS_RUN_EXTENSIONS +: Run specific extensions during supervised mode. +### ocis kill -### ocis run +Kill an extension by name -Runs an extension +Usage: `ocis kill [command options] [arguments...]` -Usage: `ocis run [command options] [arguments...]` @@ -225,12 +223,12 @@ Usage: `ocis run [command options] [arguments...]` +### ocis health -### ocis kill +Check health status -Kill an extension by name +Usage: `ocis health [command options] [arguments...]` -Usage: `ocis kill [command options] [arguments...]` @@ -246,6 +244,8 @@ Usage: `ocis kill [command options] [arguments...]` +-debug-addr | $OCIS_DEBUG_ADDR +: Address to debug endpoint. Default: `127.0.0.1:9010`. @@ -255,11 +255,11 @@ Usage: `ocis kill [command options] [arguments...]` -### ocis list +### ocis run -Lists running ocis extensions +Runs an extension -Usage: `ocis list [command options] [arguments...]` +Usage: `ocis run [command options] [arguments...]` @@ -288,85 +288,81 @@ Usage: `ocis list [command options] [arguments...]` There are more subcommands to start the individual extensions. Please check the documentation about their usage and options in the dedicated section of the documentation. +#### ocis storage-sharing + +Start storage sharing service + #### ocis ocs Start ocs server -#### ocis storage-metadata +#### ocis proxy -Start storage and data service for metadata +Start proxy server -#### ocis store +#### ocis version -Start a go-micro store +Lists running services with version -#### ocis storage-auth-basic +#### ocis storage-users -Start storage auth-basic service +Start storage and data provider for /users mount -#### ocis storage-auth-bearer +#### ocis accounts -Start storage auth-bearer service +Start accounts server -#### ocis web +#### ocis storage-auth-basic -Start web server +Start storage auth-basic service #### ocis storage-home Start storage and data provider for /home mount -#### ocis idp +#### ocis settings -Start idp server +Start settings server -#### ocis storage-frontend +#### ocis store -Start storage frontend +Start a go-micro store + +#### ocis web + +Start web server #### ocis storage-gateway Start storage gateway -#### ocis proxy +#### ocis storage-metadata -Start proxy server +Start storage and data service for metadata -#### ocis storage-app-provider +#### ocis thumbnails -Start storage app-provider service +Start thumbnails server #### ocis storage-public-link Start storage public link storage -#### ocis storage-sharing - -Start storage sharing service - -#### ocis storage-users - -Start storage and data provider for /users mount - -#### ocis accounts - -Start accounts server - -#### ocis settings +#### ocis webdav -Start settings server +Start webdav server -#### ocis thumbnails +#### ocis storage-app-provider -Start thumbnails server +Start storage app-provider service -#### ocis version +#### ocis storage-auth-bearer -Lists running services with version +Start storage auth-bearer service -#### ocis webdav +#### ocis storage-frontend -Start webdav server +Start storage frontend #### ocis storage-userprovider @@ -376,6 +372,10 @@ Start storage userprovider service Start glauth server +#### ocis idp + +Start idp server + #### ocis storage-groupprovider Start storage groupprovider service