diff --git a/extensions/konnectd/configuration.md b/extensions/konnectd/configuration.md index 6d5ab0ebcc6..a1eca1f58e8 100644 --- a/extensions/konnectd/configuration.md +++ b/extensions/konnectd/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-22T17:10:32+0000" +date: "2020-10-23T07:45:43+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis-konnectd geekdocEditPath: edit/master/docs @@ -57,6 +57,27 @@ Usage: `ocis-konnectd [global options] command [command options] [arguments...]` ## Sub Commands +### ocis-konnectd health + +Check health status + +Usage: `ocis-konnectd health [command options] [arguments...]` + +--debug-addr | $KONNECTD_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9134`. + +### ocis-konnectd version + +Print the versions of the running instances + +Usage: `ocis-konnectd version [command options] [arguments...]` + +--http-namespace | $KONNECTD_HTTP_NAMESPACE +: Set the base namespace for service discovery. Default: `com.owncloud.web`. + +--name | $KONNECTD_NAME +: Service name. Default: `konnectd`. + ### ocis-konnectd server Start integrated server @@ -168,24 +189,3 @@ Usage: `ocis-konnectd server [command options] [arguments...]` --disable-identifier-webapp | $KONNECTD_DISABLE_IDENTIFIER_WEBAPP : Disable built-in identifier-webapp to use a frontend hosted elsewhere.. Default: `true`. -### ocis-konnectd version - -Print the versions of the running instances - -Usage: `ocis-konnectd version [command options] [arguments...]` - ---http-namespace | $KONNECTD_HTTP_NAMESPACE -: Set the base namespace for service discovery. Default: `com.owncloud.web`. - ---name | $KONNECTD_NAME -: Service name. Default: `konnectd`. - -### ocis-konnectd health - -Check health status - -Usage: `ocis-konnectd health [command options] [arguments...]` - ---debug-addr | $KONNECTD_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9134`. - diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index a6a630f596e..7a41f23ce54 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-22T17:10:35+0000" +date: "2020-10-23T07:45:47+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis-proxy geekdocEditPath: edit/master/docs @@ -57,6 +57,18 @@ Usage: `ocis-proxy [global options] command [command options] [arguments...]` ## Sub Commands +### ocis-proxy version + +Print the versions of the running instances + +Usage: `ocis-proxy version [command options] [arguments...]` + +--service-namespace | $PROXY_SERVICE_NAMESPACE +: Set the base namespace for the service namespace. Default: `com.owncloud.web`. + +--service-name | $PROXY_SERVICE_NAME +: Service name. Default: `proxy`. + ### ocis-proxy server Start integrated server @@ -129,18 +141,6 @@ Usage: `ocis-proxy server [command options] [arguments...]` --autoprovision-accounts | $PROXY_AUTOPROVISION_ACCOUNTS : create accounts from OIDC access tokens to learn new users. Default: `false`. -### ocis-proxy version - -Print the versions of the running instances - -Usage: `ocis-proxy version [command options] [arguments...]` - ---service-namespace | $PROXY_SERVICE_NAMESPACE -: Set the base namespace for the service namespace. Default: `com.owncloud.web`. - ---service-name | $PROXY_SERVICE_NAME -: Service name. Default: `proxy`. - ### ocis-proxy health Check health status diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index ca83b4d1098..6f9dc5f99d2 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-22T17:10:33+0000" +date: "2020-10-23T07:45:45+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/extensions/storage @@ -57,26 +57,68 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage auth-basic +### storage storage-users -Start authprovider for basic auth +Start storage-users service -Usage: `storage auth-basic [command options] [arguments...]` +Usage: `storage storage-users [command options] [arguments...]` ---debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9147`. +--debug-addr | $STORAGE_USERS_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9159`. ---auth-driver | $STORAGE_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. +--grpc-network | $STORAGE_USERS_GRPC_NETWORK +: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---auth-json | $STORAGE_AUTH_JSON -: Path to users.json file. +--grpc-addr | $STORAGE_USERS_GRPC_ADDR +: GRPC Address to bind users storage. Default: `0.0.0.0:9157`. ---network | $STORAGE_AUTH_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--http-network | $STORAGE_USERS_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---addr | $STORAGE_AUTH_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9146`. +--http-addr | $STORAGE_USERS_HTTP_ADDR +: HTTP Address to bind users storage. Default: `0.0.0.0:9158`. + +--driver | $STORAGE_USERS_DRIVER +: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. + +--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`. + +--gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `localhost:9142`. + +--users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `localhost:9144`. + +### storage storage + +Storage service for oCIS + +Usage: `storage storage [command options] [arguments...]` + +--config-file | $STORAGE_CONFIG_FILE +: Path to config file. + +--log-level | $STORAGE_LOG_LEVEL +: Set logging level. Default: `info`. + +--log-pretty | $STORAGE_LOG_PRETTY +: Enable pretty logging. + +--log-color | $STORAGE_LOG_COLOR +: Enable colored logging. ### storage users @@ -129,71 +171,29 @@ Usage: `storage users [command options] [arguments...]` --rest-target-api | $STORAGE_REST_TARGET_API : The target application. -### storage storage-public-link - -Start storage-public-link service - -Usage: `storage storage-public-link [command options] [arguments...]` - ---debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9179`. - ---network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9178`. - ---mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `/public`. - ---gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `localhost:9142`. - -### storage storage-users - -Start storage-users service - -Usage: `storage storage-users [command options] [arguments...]` +### storage sharing ---debug-addr | $STORAGE_USERS_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9159`. +Start sharing service ---grpc-network | $STORAGE_USERS_GRPC_NETWORK -: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +Usage: `storage sharing [command options] [arguments...]` ---grpc-addr | $STORAGE_USERS_GRPC_ADDR -: GRPC Address to bind users storage. Default: `0.0.0.0:9157`. +--debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9151`. ---http-network | $STORAGE_USERS_HTTP_NETWORK +--network | $STORAGE_SHARING_GRPC_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---http-addr | $STORAGE_USERS_HTTP_ADDR -: HTTP Address to bind users storage. Default: `0.0.0.0:9158`. - ---driver | $STORAGE_USERS_DRIVER -: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. - ---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`. +--addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9150`. ---http-prefix | $STORAGE_USERS_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `data`. +--user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `json`. ---gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `localhost:9142`. +--user-json-file | $STORAGE_SHARING_USER_JSON_FILE +: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/shares.json`. ---users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `localhost:9144`. +--public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `json`. ### storage storage-metadata @@ -231,105 +231,6 @@ Usage: `storage storage-metadata [command options] [arguments...]` --storage-root | $STORAGE_METADATA_ROOT : the path to the metadata storage root. Default: `/var/tmp/ocis/metadata`. -### storage storage - -Storage service for oCIS - -Usage: `storage storage [command options] [arguments...]` - ---config-file | $STORAGE_CONFIG_FILE -: Path to config file. - ---log-level | $STORAGE_LOG_LEVEL -: Set logging level. Default: `info`. - ---log-pretty | $STORAGE_LOG_PRETTY -: Enable pretty logging. - ---log-color | $STORAGE_LOG_COLOR -: Enable colored logging. - -### storage gateway - -Start gateway - -Usage: `storage gateway [command options] [arguments...]` - ---debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9143`. - ---transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. - ---network | $STORAGE_GATEWAY_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---addr | $STORAGE_GATEWAY_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9142`. - ---endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage service. Default: `localhost:9142`. - ---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. - ---auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT -: endpoint to use for the basic auth provider. Default: `localhost:9146`. - ---auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT -: endpoint to use for the bearer auth provider. Default: `localhost:9148`. - ---storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER -: driver of the storage registry. Default: `static`. - ---storage-home-provider | $STORAGE_REGISTRY_HOME_PROVIDER -: mount point of the storage provider for user homes in the global namespace. Default: `/home`. - ---public-url | $STORAGE_FRONTEND_PUBLIC_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. Default: `https://localhost:9200/data`. - ---userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider. Default: `localhost:9144`. - ---sharing-endpoint | $STORAGE_SHARING_ENDPOINT -: endpoint to use for the storage service. Default: `localhost:9150`. - ---storage-home-endpoint | $STORAGE_STORAGE_HOME_ENDPOINT -: endpoint to use for the home storage. Default: `localhost:9154`. - ---storage-home-mount-path | $STORAGE_STORAGE_HOME_MOUNT_PATH -: mount path. Default: `/home`. - ---storage-home-mount-id | $STORAGE_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_STORAGE_PUBLIC_LINK_ENDPOINT -: endpoint to use for the public links service. Default: `localhost:9178`. - ---storage-public-link-mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `/public`. - ### storage health Check health status @@ -339,36 +240,6 @@ Usage: `storage health [command options] [arguments...]` --debug-addr | $STORAGE_DEBUG_ADDR : Address to debug endpoint. Default: `0.0.0.0:9109`. -### storage auth-bearer - -Start authprovider for bearer auth - -Usage: `storage auth-bearer [command options] [arguments...]` - ---debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9149`. - ---oidc-issuer | $STORAGE_OIDC_ISSUER -: OIDC issuer. Default: `https://localhost:9200`. - ---oidc-insecure | $STORAGE_OIDC_INSECURE -: OIDC allow insecure communication. Default: `true`. - ---oidc-id-claim | $STORAGE_OIDC_ID_CLAIM -: OIDC id claim. Default: `preferred_username`. - ---oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM -: OIDC uid claim. - ---oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM -: OIDC gid claim. - ---network | $STORAGE_AUTH_BEARER_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---addr | $STORAGE_AUTH_BEARER_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9148`. - ### storage storage-home Start storage-home service @@ -462,29 +333,158 @@ Usage: `storage frontend [command options] [arguments...]` --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. -### storage sharing +### storage auth-basic -Start sharing service +Start authprovider for basic auth -Usage: `storage sharing [command options] [arguments...]` +Usage: `storage auth-basic [command options] [arguments...]` ---debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9151`. +--debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9147`. ---network | $STORAGE_SHARING_GRPC_NETWORK +--auth-driver | $STORAGE_AUTH_DRIVER +: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. + +--auth-json | $STORAGE_AUTH_JSON +: Path to users.json file. + +--network | $STORAGE_AUTH_BASIC_GRPC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--addr | $STORAGE_AUTH_BASIC_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9146`. + +### storage auth-bearer + +Start authprovider for bearer auth + +Usage: `storage auth-bearer [command options] [arguments...]` + +--debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9149`. + +--oidc-issuer | $STORAGE_OIDC_ISSUER +: OIDC issuer. Default: `https://localhost:9200`. + +--oidc-insecure | $STORAGE_OIDC_INSECURE +: OIDC allow insecure communication. Default: `true`. + +--oidc-id-claim | $STORAGE_OIDC_ID_CLAIM +: OIDC id claim. Default: `preferred_username`. + +--oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM +: OIDC uid claim. + +--oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM +: OIDC gid claim. + +--network | $STORAGE_AUTH_BEARER_GRPC_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---addr | $STORAGE_SHARING_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9150`. +--addr | $STORAGE_AUTH_BEARER_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9148`. ---user-driver | $STORAGE_SHARING_USER_DRIVER -: driver to use for the UserShareProvider. Default: `json`. +### storage storage-public-link ---user-json-file | $STORAGE_SHARING_USER_JSON_FILE -: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/shares.json`. +Start storage-public-link service ---public-driver | $STORAGE_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `json`. +Usage: `storage storage-public-link [command options] [arguments...]` + +--debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9179`. + +--network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9178`. + +--mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `/public`. + +--gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `localhost:9142`. + +### storage gateway + +Start gateway + +Usage: `storage gateway [command options] [arguments...]` + +--debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9143`. + +--transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. + +--network | $STORAGE_GATEWAY_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--addr | $STORAGE_GATEWAY_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9142`. + +--endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage service. Default: `localhost:9142`. + +--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. + +--auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT +: endpoint to use for the basic auth provider. Default: `localhost:9146`. + +--auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT +: endpoint to use for the bearer auth provider. Default: `localhost:9148`. + +--storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER +: driver of the storage registry. Default: `static`. + +--storage-home-provider | $STORAGE_REGISTRY_HOME_PROVIDER +: mount point of the storage provider for user homes in the global namespace. Default: `/home`. + +--public-url | $STORAGE_FRONTEND_PUBLIC_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. Default: `https://localhost:9200/data`. + +--userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider. Default: `localhost:9144`. + +--sharing-endpoint | $STORAGE_SHARING_ENDPOINT +: endpoint to use for the storage service. Default: `localhost:9150`. + +--storage-home-endpoint | $STORAGE_STORAGE_HOME_ENDPOINT +: endpoint to use for the home storage. Default: `localhost:9154`. + +--storage-home-mount-path | $STORAGE_STORAGE_HOME_MOUNT_PATH +: mount path. Default: `/home`. + +--storage-home-mount-id | $STORAGE_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_STORAGE_PUBLIC_LINK_ENDPOINT +: endpoint to use for the public links service. Default: `localhost:9178`. + +--storage-public-link-mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `/public`. ## Config for the different Storage Drivers diff --git a/extensions/storage/testing.md b/extensions/storage/testing.md deleted file mode 100644 index d4b5ccacbf8..00000000000 --- a/extensions/storage/testing.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -title: "Testing" -date: 2018-05-02T00:00:00+00:00 -weight: 37 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs/extensions/storage -geekdocFilePath: testing.md ---- - - -## API Acceptance tests - -We are using the ownCloud 10 API acceptance testsuite against ocis. To set this up you need the owncloud 10 core repo, a ldap server that the acceptance tests can use to manage users, a redis server for file-versions and the ocis-reva code. - -### Getting the tests - -All you need to do to get the acceptance tests is check out the core repo: -``` -git clone https://github.com/owncloud/core.git -``` - -### Run a ldap server in a docker container - -The ownCloud 10 acceptance tests will need write permission. You can start a suitable ldap server in a docker container with: - -``` -docker run --hostname ldap.my-company.com \ - -e LDAP_TLS_VERIFY_CLIENT=never \ - -e LDAP_DOMAIN=owncloud.com \ - -e LDAP_ORGANISATION=ownCloud \ - -e LDAP_ADMIN_PASSWORD=admin \ - --name docker-slapd \ - -p 127.0.0.1:389:389 \ - -p 636:636 -d osixia/openldap -``` -### Run a redis server in a docker container - -File versions need a redis server. Start one with docker by using: - -`docker run -e REDIS_DATABASES=1 -p 6379:6379 -d webhippie/redis:latest` - -### Run ocis-reva with that ldap server - -`storage` provides multiple subcommands. To configure them all via env vars you can export these environment variables. - -``` -export STORAGE_USERS_DRIVER=ldap -export STORAGE_LDAP_HOSTNAME=localhost -export STORAGE_LDAP_PORT=636 -export STORAGE_LDAP_BASE_DN='dc=owncloud,dc=com' -export STORAGE_LDAP_USERFILTER='(&(objectclass=posixAccount)(cn=%s))' -export STORAGE_LDAP_GROUPFILTER='(&(objectclass=posixGroup)(cn=%s))' -export STORAGE_LDAP_BIND_DN='cn=admin,dc=owncloud,dc=com' -export STORAGE_LDAP_BIND_PASSWORD=admin -export STORAGE_LDAP_SCHEMA_UID=uid -export STORAGE_LDAP_SCHEMA_MAIL=mail -export STORAGE_LDAP_SCHEMA_DISPLAYNAME=displayName -export STORAGE_LDAP_SCHEMA_CN=cn -export STORAGE_FRONTEND_URL=http://localhost:9140 # needed because the proxy is not started -export STORAGE_DATAGATEWAY_URL=http://localhost:9140/data # needed because the proxy is not started -``` - -Then you need to start the ocis-reva services -``` -bin/storage frontend & \ -bin/storage gateway & \ -bin/storage auth-basic & \ -bin/storage auth-bearer & \ -bin/storage sharing & \ -bin/storage storage-home & \ -bin/storage storage-home-data & \ -bin/storage storage-oc & \ -bin/storage storage-oc-data & \ -bin/storage users & -``` - -### Run the API acceptance tests - -In the ownCloud 10 core repo run - -``` -make test-acceptance-api \ -TEST_SERVER_URL=https://localhost:9200 \ -TEST_EXTERNAL_USER_BACKENDS=true \ -TEST_OCIS=true \ -OCIS_REVA_DATA_ROOT=/var/tmp/ocis/owncloud/ \ -BEHAT_FILTER_TAGS='~@notToImplementOnOCIS&&~@toImplementOnOCIS&&~@preview-extension-required' \ -SKELETON_DIR=apps/testing/data/apiSkeleton -``` - -Make sure to adjust the settings `TEST_SERVER_URL`,`OCIS_REVA_DATA_ROOT` and `SKELETON_DIR` according to your environment. - -This will run all tests that are relevant to OCIS. - -To run a single test add `BEHAT_FEATURE=` and specify the path to the feature file and an optional line number. For example: `BEHAT_FEATURE='tests/acceptance/features/apiWebdavUpload1/uploadFile.feature:12'` - -### use existing tests for BDD - -As a lot of scenarios are written for oC10, we can use those tests for Behaviour driven development in ocis. -Every scenario that does not work in OCIS with OC storage, is listed in `tests/acceptance/expected-failures-on-OC-storage.txt` with a link to the related issue. -Similarly, scenarios that do not work in OCIS with EOS storage are listed in `tests/acceptance/expected-failures-on-EOS-storage.txt`. -Scenarios from the oC10 API acceptance tests are run in the ordinary acceptance test pipeline in CI. The scenarios that fail are checked against the -expected failures. If there are any differences then the CI pipeline fails. - -Additionally, some issues have scenarios that demonstrate the current buggy behaviour in ocis(reva). -Those scenarios are in this ocis-reva repository in `tests/acceptance/features/apiOcisSpecific`. -Have a look into the [documentation](https://doc.owncloud.com/server/developer_manual/testing/acceptance-tests.html#writing-scenarios-for-bugs) to understand why we are writing those tests. -Also, ocis behaves partly differently with EOS-Storage and OC-Storage. There are scenarios that do not work in OCIS when run on EOS-storage, but works when on OC-Storage, and vice-versa. For those kind of scenarios, ` @skipOnOcis-EOS-Storage` and `@skipOnOcis-OC-Storage` tags are used. For instance, for a scenario that fails on EOS-Storage but passes on OC-Storage, we use `@skipOnOcis-EOS-Storage` tag to let it run on OC-Storage, where it works as expected, instead of skipping the test completely. - -If you want to work on a specific issue - -1. adjust the core commit id to the latest commit in core so that CI will run the latest test code and scenarios from core. - For that change `coreCommit` in the `config` section: - - config = { - 'apiTests': { - 'coreBranch': 'master', - 'coreCommit': 'a06b1bd5ba8e5244bfaf7fa04f441961e6fb0daa', - 'numberOfParts': 2 - } - } - -2. locally run each of the tests marked with that issue in the expected failures file: - - E.g.: - ``` - make test-acceptance-api \ - TEST_SERVER_URL=https://localhost:9200 \ - TEST_EXTERNAL_USER_BACKENDS=true \ - TEST_OCIS=true \ - OCIS_REVA_DATA_ROOT=/var/tmp/ocis/owncloud/ \ - BEHAT_FEATURE='tests/acceptance/features/apiComments/comments.feature:123' - ``` - -3. the tests will fail, try to understand how and why they are failing -4. fix the code -5. go back to 2. and repeat till the tests are passing. -6. remove those tests from the expected failures file. -7. run each of the local tests that were demonstrating the **buggy** behavior. They should fail. -8. delete each of the local tests that were demonstrating the **buggy** behavior. -9. make a PR that has the fixed code, relevant lines removed from the expected failures file and bug demonstration tests deleted. - - If the changes also affect the `ocis` repository make sure the changes get ported over there. - That will need the fixed code in `storage` to be applied to `ocis` along with the test-related changes. - -### Notes -- in a normal case the test-code cleans up users after the test-run, but if a test-run is interrupted (e.g. by CTRL+C) users might have been left on the LDAP server. In that case rerunning the tests requires wiping the users in the ldap server, otherwise the tests will fail when trying to populate the users. This can be done by simply running `docker stop docker-slapd && docker rm docker-slapd` and [restarting the LDAP server container](#run-a-ldap-server-in-a-docker-container) -- the tests usually create users in the OU `TestUsers` with usernames specified in the feature file. If not defined in the feature file, most users have the password `123456`, defined by `regularUserPassword` in `behat.yml`, but other passwords are also used, see [`\FeatureContext::getPasswordForUser()`](https://github.com/owncloud/core/blob/master/tests/acceptance/features/bootstrap/FeatureContext.php#L386) for mapping and [`\FeatureContext::__construct`](https://github.com/owncloud/core/blob/master/tests/acceptance/features/bootstrap/FeatureContext.php#L1668) for the password definitions. diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index bcfe0f49d64..c938a11a67a 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-22T17:10:37+0000" +date: "2020-10-23T07:45:48+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/extensions/webdav @@ -102,6 +102,15 @@ Usage: `webdav server [command options] [arguments...]` --http-root | $WEBDAV_HTTP_ROOT : Root path of http server. Default: `/`. +### webdav health + +Check health status + +Usage: `webdav health [command options] [arguments...]` + +--debug-addr | $WEBDAV_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9119`. + ### webdav version Print the versions of the running instances @@ -114,12 +123,3 @@ Usage: `webdav version [command options] [arguments...]` --service-name | $WEBDAV_SERVICE_NAME : Service name. Default: `webdav`. -### webdav health - -Check health status - -Usage: `webdav health [command options] [arguments...]` - ---debug-addr | $WEBDAV_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9119`. - diff --git a/ocis/development/testing.md b/ocis/development/testing.md index 1006aeaff04..eb5c21150dd 100644 --- a/ocis/development/testing.md +++ b/ocis/development/testing.md @@ -45,8 +45,8 @@ Then run the api acceptance tests with the following command: make test-acceptance-api \ TEST_SERVER_URL=https://localhost:9200 \ TEST_OCIS=true \ -OCIS_REVA_DATA_ROOT=/var/tmp/ocis/owncloud/ \ SKELETON_DIR=apps/testing/data/apiSkeleton \ +DELETE_USER_DATA_CMD='rm -rf /var/tmp/ocis/storage/users/nodes/root/* /var/tmp/ocis/storage/users/nodes/*-*-*-*' \ BEHAT_FILTER_TAGS='~@notToImplementOnOCIS&&~@toImplementOnOCIS' ``` @@ -89,7 +89,7 @@ If you want to work on a specific issue make test-acceptance-api \ TEST_SERVER_URL=https://localhost:9200 \ TEST_OCIS=true \ - OCIS_REVA_DATA_ROOT=/var/tmp/ocis/owncloud/ \ + DELETE_USER_DATA_CMD='rm -rf /var/tmp/ocis/storage/users/nodes/root/* /var/tmp/ocis/storage/users/nodes/*-*-*-*' \ BEHAT_FEATURE='tests/acceptance/features/apiComments/comments.feature:123' ```