From cf6288198a3016b355f2bf695386ec48c145d3ec Mon Sep 17 00:00:00 2001 From: Phil Davis Date: Thu, 21 Jan 2021 15:52:29 +0000 Subject: [PATCH] commit 90cfa1e03181587a6e14429443b87aaaae4d0e5f Merge: afe098e5 833d0e4d Author: Phil Davis Date: Thu Jan 21 21:35:06 2021 +0545 Merge pull request #1375 from owncloud/add_volume_docker_image add volume to docker image --- extensions/accounts/configuration.md | 116 +++--- extensions/glauth/configuration.md | 20 +- extensions/konnectd/configuration.md | 2 +- extensions/ocs/configuration.md | 26 +- extensions/onlyoffice/configuration.md | 2 +- extensions/proxy/configuration.md | 50 +-- extensions/settings/configuration.md | 2 +- extensions/storage/configuration.md | 468 ++++++++++++------------- extensions/store/configuration.md | 2 +- extensions/thumbnails/configuration.md | 26 +- extensions/web/configuration.md | 20 +- extensions/webdav/configuration.md | 2 +- ocis/configuration.md | 106 +++--- 13 files changed, 421 insertions(+), 421 deletions(-) diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 77febc42fb1..ec0465e3949 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-21T14:38:12+0000" +date: "2021-01-21T15:50:36+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -35,6 +35,24 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. +### accounts add + +Create a new account + +Usage: `accounts add [command options] [arguments...]` + +### accounts inspect + +Show detailed data on an existing account + +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`. + ### accounts remove Removes an existing account @@ -47,6 +65,45 @@ Usage: `accounts remove [command options] [arguments...]` -name | $ACCOUNTS_NAME : service name. Default: `accounts`. +### accounts update + +Make changes to an existing account + +Usage: `accounts update [command options] [arguments...]` + +### accounts list + +List existing accounts + +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 rebuildIndex + +Rebuilds the service's index, i.e. deleting and then re-adding all existing documents + +Usage: `accounts rebuildIndex [command options] [arguments...]` + +### accounts ocis-accounts + +Provide accounts and groups for oCIS + +Usage: `accounts ocis-accounts [command options] [arguments...]` + +-log-level | $ACCOUNTS_LOG_LEVEL +: Set logging level. Default: `info`. + +-log-pretty | $ACCOUNTS_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +-log-color | $ACCOUNTS_LOG_COLOR +: Enable colored logging. Default: `true`. + ### accounts server Start ocis accounts service @@ -113,63 +170,6 @@ Usage: `accounts server [command options] [arguments...]` -service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME : username of the internal service user (required on EOS). -### accounts update - -Make changes to an existing account - -Usage: `accounts update [command options] [arguments...]` - -### accounts add - -Create a new account - -Usage: `accounts add [command options] [arguments...]` - -### accounts inspect - -Show detailed data on an existing account - -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`. - -### accounts list - -List existing accounts - -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 rebuildIndex - -Rebuilds the service's index, i.e. deleting and then re-adding all existing documents - -Usage: `accounts rebuildIndex [command options] [arguments...]` - -### accounts ocis-accounts - -Provide accounts and groups for oCIS - -Usage: `accounts ocis-accounts [command options] [arguments...]` - --log-level | $ACCOUNTS_LOG_LEVEL -: Set logging level. Default: `info`. - --log-pretty | $ACCOUNTS_LOG_PRETTY -: Enable pretty logging. Default: `true`. - --log-color | $ACCOUNTS_LOG_COLOR -: Enable colored logging. Default: `true`. - ### accounts version Print the versions of the running instances diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index 0978c763c8a..ca5caeed865 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-21T14:38:14+0000" +date: "2021-01-21T15:50:38+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/glauth/templates @@ -35,15 +35,6 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### glauth health - -Check health status - -Usage: `glauth health [command options] [arguments...]` - --debug-addr | $GLAUTH_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9129`. - ### glauth ocis-glauth Serve GLAuth API for oCIS @@ -158,3 +149,12 @@ Usage: `glauth server [command options] [arguments...]` -fallback-use-graphapi | $GLAUTH_FALLBACK_USE_GRAPHAPI : use Graph API, only for owncloud datastore. Default: `true`. +### glauth health + +Check health status + +Usage: `glauth health [command options] [arguments...]` + +-debug-addr | $GLAUTH_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9129`. + diff --git a/extensions/konnectd/configuration.md b/extensions/konnectd/configuration.md index 73ac81c7915..67573b63a3d 100644 --- a/extensions/konnectd/configuration.md +++ b/extensions/konnectd/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-21T14:38:16+0000" +date: "2021-01-21T15:50:40+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/konnectd/templates diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index a1c010f5f66..7a373e712d0 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-21T14:38:20+0000" +date: "2021-01-21T15:50:44+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/templates @@ -35,18 +35,6 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### 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 @@ -122,3 +110,15 @@ Usage: `ocs server [command options] [arguments...]` -jwt-secret | $OCS_JWT_SECRET : Used to dismantle the access token, should equal reva's jwt-secret. Default: `Pive-Fumkiu4`. +### 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/onlyoffice/configuration.md b/extensions/onlyoffice/configuration.md index cc429d3888f..ad7344df938 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-21T14:38:29+0000" +date: "2021-01-21T15:50:52+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/onlyoffice/templates diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index 0ac298954ce..44a8dfc4dfe 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-21T14:38:21+0000" +date: "2021-01-21T15:50:45+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/proxy/templates @@ -35,30 +35,6 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### proxy health - -Check health status - -Usage: `proxy health [command options] [arguments...]` - ---debug-addr | $PROXY_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9109`. - -### proxy ocis-proxy - -proxy for oCIS - -Usage: `proxy ocis-proxy [command options] [arguments...]` - ---log-level | $PROXY_LOG_LEVEL -: Set logging level. Default: `info`. - ---log-pretty | $PROXY_LOG_PRETTY -: Enable pretty logging. Default: `true`. - ---log-color | $PROXY_LOG_COLOR -: Enable colored logging. Default: `true`. - ### proxy server Start integrated server @@ -158,3 +134,27 @@ Usage: `proxy version [command options] [arguments...]` --service-name | $PROXY_SERVICE_NAME : Service name. Default: `proxy`. +### proxy health + +Check health status + +Usage: `proxy health [command options] [arguments...]` + +--debug-addr | $PROXY_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9109`. + +### proxy ocis-proxy + +proxy for oCIS + +Usage: `proxy ocis-proxy [command options] [arguments...]` + +--log-level | $PROXY_LOG_LEVEL +: Set logging level. Default: `info`. + +--log-pretty | $PROXY_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +--log-color | $PROXY_LOG_COLOR +: Enable colored logging. Default: `true`. + diff --git a/extensions/settings/configuration.md b/extensions/settings/configuration.md index 9abda722a08..d792f837842 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-21T14:38:23+0000" +date: "2021-01-21T15:50:46+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 77e971b4379..3eee28766a2 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-21T14:38:24+0000" +date: "2021-01-21T15:50:47+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -55,191 +55,107 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### 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 sharing +### storage users -Start sharing service +Start users service -Usage: `storage sharing [command options] [arguments...]` +Usage: `storage users [command options] [arguments...]` -debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9151`. - --network | $STORAGE_SHARING_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - --addr | $STORAGE_SHARING_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9150`. - --user-driver | $STORAGE_SHARING_USER_DRIVER -: driver to use for the UserShareProvider. Default: `json`. - --user-json-file | $STORAGE_SHARING_USER_JSON_FILE -: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/storage/shares.json`. - --public-driver | $STORAGE_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `json`. - --public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE -: file used to persist shares for the PublicShareProvider. Default: `/var/tmp/ocis/storage/publicshares.json`. - -### storage storage-home - -Start storage-home service - -Usage: `storage storage-home [command options] [arguments...]` - --debug-addr | $STORAGE_HOME_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9156`. - --grpc-network | $STORAGE_HOME_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - --grpc-addr | $STORAGE_HOME_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9154`. +: Address to bind debug server. Default: `0.0.0.0:9145`. --http-network | $STORAGE_HOME_HTTP_NETWORK +-network | $STORAGE_USERPROVIDER_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. --http-addr | $STORAGE_HOME_HTTP_ADDR -: Address to bind storage service. Default: `0.0.0.0:9155`. - --driver | $STORAGE_HOME_DRIVER -: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. - --mount-path | $STORAGE_HOME_MOUNT_PATH -: mount path. Default: `/home`. - --mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009157`. - --expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. - --data-server-url | $STORAGE_HOME_DATA_SERVER_URL -: data server url. Default: `http://localhost:9155/data`. - --http-prefix | $STORAGE_HOME_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `data`. - --tmp-folder | $STORAGE_HOME_TMP_FOLDER -: path to tmp folder. Default: `/var/tmp/ocis/tmp/home`. - --enable-home | $STORAGE_HOME_ENABLE_HOME -: enable the creation of home directories. Default: `true`. +-addr | $STORAGE_USERPROVIDER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9144`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `localhost:9142`. +-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `localhost:9144`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `localhost:9144`. +-driver | $STORAGE_USERPROVIDER_DRIVER +: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. -### storage storage-metadata +-json-config | $STORAGE_USERPROVIDER_JSON +: Path to users.json file. -Start storage-metadata service +-rest-client-id | $STORAGE_REST_CLIENT_ID +: User rest driver Client ID. -Usage: `storage storage-metadata [command options] [arguments...]` +-rest-client-secret | $STORAGE_REST_CLIENT_SECRET +: User rest driver Client Secret. --debug-addr | $STORAGE_METADATA_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9217`. +-rest-redis-address | $STORAGE_REST_REDIS_ADDRESS +: Address for redis server. Default: `localhost:6379`. --grpc-network | $STORAGE_METADATA_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +-rest-redis-username | $STORAGE_REST_REDIS_USERNAME +: Username for redis server. --grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR -: Address to bind storage service. Default: `0.0.0.0:9215`. +-rest-redis-password | $STORAGE_REST_REDIS_PASSWORD +: Password for redis server. --data-server-url | $STORAGE_METADATA_DATA_SERVER_URL -: URL of the data-provider the storage-provider uses. Default: `http://localhost:9216`. +-rest-id-provider | $STORAGE_REST_ID_PROVIDER +: The OIDC Provider. --http-network | $STORAGE_METADATA_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +-rest-api-base-url | $STORAGE_REST_API_BASE_URL +: Base API Endpoint. --http-addr | $STORAGE_METADATA_HTTP_ADDR -: Address to bind storage service. Default: `0.0.0.0:9216`. +-rest-oidc-token-endpoint | $STORAGE_REST_OIDC_TOKEN_ENDPOINT +: Endpoint to generate token to access the API. --tmp-folder | $STORAGE_METADATA_TMP_FOLDER -: path to tmp folder. Default: `/var/tmp/ocis/tmp/metadata`. +-rest-target-api | $STORAGE_REST_TARGET_API +: The target application. --driver | $STORAGE_METADATA_DRIVER -: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. +### storage frontend --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the gateway service. Default: `localhost:9142`. +Start frontend service --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider service. Default: `localhost:9144`. +Usage: `storage frontend [command options] [arguments...]` --storage-root | $STORAGE_METADATA_ROOT -: the path to the metadata storage root. Default: `/var/tmp/ocis/storage/metadata`. +-debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9141`. -### storage storage-public-link +-transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. -Start storage-public-link service +-chunk-folder | $STORAGE_CHUNK_FOLDER +: temp directory for chunked uploads. Default: `/var/tmp/ocis/tmp/chunks`. -Usage: `storage storage-public-link [command options] [arguments...]` +-webdav-namespace | $STORAGE_WEBDAV_NAMESPACE +: Namespace prefix for the /webdav endpoint. Default: `/home/`. --debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9179`. +-dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE +: Namespace prefix for the webdav /dav/files endpoint. Default: `/users/`. --network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK +-network | $STORAGE_FRONTEND_HTTP_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 auth-bearer - -Start authprovider for bearer auth - -Usage: `storage auth-bearer [command options] [arguments...]` +-addr | $STORAGE_FRONTEND_HTTP_ADDR +: Address to bind storage service. Default: `0.0.0.0:9140`. --debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9149`. +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `https://localhost:9200`. --oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL -: OIDC issuer. Default: `https://localhost:9200`. +-datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX +: datagateway prefix. Default: `data`. --oidc-insecure | $STORAGE_OIDC_INSECURE -: OIDC allow insecure communication. Default: `true`. +-ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX +: owncloud webdav endpoint prefix. --oidc-id-claim | $STORAGE_OIDC_ID_CLAIM -: OIDC id claim. Default: `preferred_username`. +-ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX +: open collaboration services endpoint prefix. Default: `ocs`. --oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM -: OIDC uid claim. +-ocs-share-prefix | $STORAGE_FRONTEND_OCS_Share_PREFIX +: the prefix prepended to the path of shared files. Default: `/Shares`. --oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM -: OIDC gid claim. +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `localhost:9142`. --network | $STORAGE_AUTH_BEARER_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +-upload-disable-tus | $STORAGE_FRONTEND_UPLOAD_DISABLE_TUS +: Disables TUS upload mechanism. Default: `false`. --addr | $STORAGE_AUTH_BEARER_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9148`. +-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 gateway @@ -322,14 +238,113 @@ Usage: `storage gateway [command options] [arguments...]` -storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH : mount path. Default: `/public`. -### storage health +### storage storage -Check health status +Storage service for oCIS -Usage: `storage health [command options] [arguments...]` +Usage: `storage storage [command options] [arguments...]` --debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9109`. +-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 storage-home + +Start storage-home service + +Usage: `storage storage-home [command options] [arguments...]` + +-debug-addr | $STORAGE_HOME_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9156`. + +-grpc-network | $STORAGE_HOME_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +-grpc-addr | $STORAGE_HOME_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9154`. + +-http-network | $STORAGE_HOME_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +-http-addr | $STORAGE_HOME_HTTP_ADDR +: Address to bind storage service. Default: `0.0.0.0:9155`. + +-driver | $STORAGE_HOME_DRIVER +: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. + +-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `/home`. + +-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009157`. + +-expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. + +-data-server-url | $STORAGE_HOME_DATA_SERVER_URL +: data server url. Default: `http://localhost:9155/data`. + +-http-prefix | $STORAGE_HOME_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `data`. + +-tmp-folder | $STORAGE_HOME_TMP_FOLDER +: path to tmp folder. Default: `/var/tmp/ocis/tmp/home`. + +-enable-home | $STORAGE_HOME_ENABLE_HOME +: enable the creation of home directories. Default: `true`. + +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `localhost:9142`. + +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `localhost:9144`. + +### storage storage-metadata + +Start storage-metadata service + +Usage: `storage storage-metadata [command options] [arguments...]` + +-debug-addr | $STORAGE_METADATA_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9217`. + +-grpc-network | $STORAGE_METADATA_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +-grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9215`. + +-data-server-url | $STORAGE_METADATA_DATA_SERVER_URL +: URL of the data-provider the storage-provider uses. Default: `http://localhost:9216`. + +-http-network | $STORAGE_METADATA_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +-http-addr | $STORAGE_METADATA_HTTP_ADDR +: Address to bind storage service. Default: `0.0.0.0:9216`. + +-tmp-folder | $STORAGE_METADATA_TMP_FOLDER +: path to tmp folder. Default: `/var/tmp/ocis/tmp/metadata`. + +-driver | $STORAGE_METADATA_DRIVER +: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. + +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the gateway service. Default: `localhost:9142`. + +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider service. Default: `localhost:9144`. + +-storage-root | $STORAGE_METADATA_ROOT +: the path to the metadata storage root. Default: `/var/tmp/ocis/storage/metadata`. ### storage storage-users @@ -379,128 +394,113 @@ Usage: `storage storage-users [command options] [arguments...]` -users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT : endpoint to use for the storage service. Default: `localhost:9144`. -### storage users - -Start users service - -Usage: `storage users [command options] [arguments...]` - --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9145`. +### storage auth-basic --network | $STORAGE_USERPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +Start authprovider for basic auth --addr | $STORAGE_USERPROVIDER_ADDR -: Address to bind storage service. Default: `0.0.0.0:9144`. +Usage: `storage auth-basic [command options] [arguments...]` --endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `localhost:9144`. +-debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9147`. --driver | $STORAGE_USERPROVIDER_DRIVER -: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. +-auth-driver | $STORAGE_AUTH_DRIVER +: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. --json-config | $STORAGE_USERPROVIDER_JSON +-auth-json | $STORAGE_AUTH_JSON : Path to users.json file. --rest-client-id | $STORAGE_REST_CLIENT_ID -: User rest driver Client ID. +-network | $STORAGE_AUTH_BASIC_GRPC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. --rest-client-secret | $STORAGE_REST_CLIENT_SECRET -: User rest driver Client Secret. +-addr | $STORAGE_AUTH_BASIC_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9146`. --rest-redis-address | $STORAGE_REST_REDIS_ADDRESS -: Address for redis server. Default: `localhost:6379`. +### storage auth-bearer --rest-redis-username | $STORAGE_REST_REDIS_USERNAME -: Username for redis server. +Start authprovider for bearer auth --rest-redis-password | $STORAGE_REST_REDIS_PASSWORD -: Password for redis server. +Usage: `storage auth-bearer [command options] [arguments...]` --rest-id-provider | $STORAGE_REST_ID_PROVIDER -: The OIDC Provider. +-debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9149`. --rest-api-base-url | $STORAGE_REST_API_BASE_URL -: Base API Endpoint. +-oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL +: OIDC issuer. Default: `https://localhost:9200`. --rest-oidc-token-endpoint | $STORAGE_REST_OIDC_TOKEN_ENDPOINT -: Endpoint to generate token to access the API. +-oidc-insecure | $STORAGE_OIDC_INSECURE +: OIDC allow insecure communication. Default: `true`. --rest-target-api | $STORAGE_REST_TARGET_API -: The target application. +-oidc-id-claim | $STORAGE_OIDC_ID_CLAIM +: OIDC id claim. Default: `preferred_username`. -### storage auth-basic +-oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM +: OIDC uid claim. -Start authprovider for basic auth +-oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM +: OIDC gid claim. -Usage: `storage auth-basic [command options] [arguments...]` +-network | $STORAGE_AUTH_BEARER_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. --debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9147`. +-addr | $STORAGE_AUTH_BEARER_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9148`. --auth-driver | $STORAGE_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. +### storage health --auth-json | $STORAGE_AUTH_JSON -: Path to users.json file. +Check health status --network | $STORAGE_AUTH_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +Usage: `storage health [command options] [arguments...]` --addr | $STORAGE_AUTH_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9146`. +-debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9109`. -### storage frontend +### storage sharing -Start frontend service +Start sharing service -Usage: `storage frontend [command options] [arguments...]` +Usage: `storage sharing [command options] [arguments...]` --debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9141`. +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9151`. --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. +-network | $STORAGE_SHARING_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. --chunk-folder | $STORAGE_CHUNK_FOLDER -: temp directory for chunked uploads. Default: `/var/tmp/ocis/tmp/chunks`. +-addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9150`. --webdav-namespace | $STORAGE_WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `/home/`. +-user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `json`. --dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `/users/`. +-user-json-file | $STORAGE_SHARING_USER_JSON_FILE +: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/storage/shares.json`. --network | $STORAGE_FRONTEND_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +-public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `json`. --addr | $STORAGE_FRONTEND_HTTP_ADDR -: Address to bind storage service. Default: `0.0.0.0:9140`. +-public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE +: file used to persist shares for the PublicShareProvider. Default: `/var/tmp/ocis/storage/publicshares.json`. --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `https://localhost:9200`. +### storage storage-public-link --datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `data`. +Start storage-public-link service --ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. +Usage: `storage storage-public-link [command options] [arguments...]` --ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX -: open collaboration services endpoint prefix. Default: `ocs`. +-debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9179`. --ocs-share-prefix | $STORAGE_FRONTEND_OCS_Share_PREFIX -: the prefix prepended to the path of shared files. Default: `/Shares`. +-network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `localhost:9142`. +-addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9178`. --upload-disable-tus | $STORAGE_FRONTEND_UPLOAD_DISABLE_TUS -: Disables TUS upload mechanism. Default: `false`. +-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `/public`. --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. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `localhost:9142`. ## Config for the different Storage Drivers diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index 6a0e7f6745c..80d27803048 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-21T14:38:25+0000" +date: "2021-01-21T15:50:48+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates diff --git a/extensions/thumbnails/configuration.md b/extensions/thumbnails/configuration.md index 68037da3a0e..a70f7c5eb5e 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-21T14:38:26+0000" +date: "2021-01-21T15:50:50+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates @@ -35,6 +35,18 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. +### thumbnails version + +Print the versions of the running instances + +Usage: `thumbnails version [command options] [arguments...]` + +-grpc-name | $THUMBNAILS_GRPC_NAME +: Name of the service. Default: `thumbnails`. + +-grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. + ### thumbnails health Check health status @@ -113,15 +125,3 @@ Usage: `thumbnails server [command options] [arguments...]` -webdavsource-insecure | $THUMBNAILS_WEBDAVSOURCE_INSECURE : Whether to skip certificate checks. Default: `true`. -### thumbnails version - -Print the versions of the running instances - -Usage: `thumbnails version [command options] [arguments...]` - --grpc-name | $THUMBNAILS_GRPC_NAME -: Name of the service. Default: `thumbnails`. - --grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. - diff --git a/extensions/web/configuration.md b/extensions/web/configuration.md index 48bab82509e..2f764178226 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-21T14:38:19+0000" +date: "2021-01-21T15:50:43+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/web/templates @@ -52,6 +52,15 @@ Usage: `web [global options] command [command options] [arguments...]` ## Sub Commands +### web health + +Check health status + +Usage: `web health [command options] [arguments...]` + +-debug-addr | $WEB_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9104`. + ### web server Start integrated server @@ -127,12 +136,3 @@ Usage: `web server [command options] [arguments...]` -oidc-scope | $WEB_OIDC_SCOPE : OpenID Connect scope. Default: `openid profile email`. -### web health - -Check health status - -Usage: `web health [command options] [arguments...]` - --debug-addr | $WEB_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9104`. - diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index 237bdb612e6..920fcf3d6a9 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-21T14:38:28+0000" +date: "2021-01-21T15:50:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates diff --git a/ocis/configuration.md b/ocis/configuration.md index 2499f6f0bff..84327936997 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-01-21T14:38:18+0000" +date: "2021-01-21T15:50:42+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -77,18 +77,6 @@ Usage: `ocis [global options] command [command options] [arguments...]` ## Sub Commands -### ocis kill - -Kill an extension by name - -Usage: `ocis kill [command options] [arguments...]` - -### ocis run - -Runs an extension - -Usage: `ocis run [command options] [arguments...]` - ### ocis server Start fullstack server @@ -122,6 +110,18 @@ Lists running ocis extensions Usage: `ocis list [command options] [arguments...]` +### ocis kill + +Kill an extension by name + +Usage: `ocis kill [command options] [arguments...]` + +### ocis run + +Runs an extension + +Usage: `ocis run [command options] [arguments...]` + ### ocis health Check health status @@ -135,13 +135,17 @@ Usage: `ocis health [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 settings +#### ocis thumbnails -Start settings server +Start thumbnails server -#### ocis version +#### ocis glauth -Lists running services with version +Start glauth server + +#### ocis konnectd + +Start konnectd server #### ocis proxy @@ -151,75 +155,71 @@ Start proxy server Start storage auth-basic service -#### ocis storage-gateway - -Start storage gateway - -#### ocis storage-userprovider +#### ocis storage-auth-bearer -Start storage userprovider service +Start storage auth-bearer service -#### ocis webdav +#### ocis storage-users -Start webdav server +Start storage and data provider for /users mount -#### ocis onlyoffice +#### ocis web -Start onlyoffice server +Start web server -#### ocis storage-metadata +#### ocis webdav -Start storage and data service for metadata +Start webdav server -#### ocis storage-public-link +#### ocis ocs -Start storage public link storage +Start ocs server -#### ocis store +#### ocis storage-home -Start a go-micro store +Start storage and data provider for /home mount -#### ocis web +#### ocis settings -Start web server +Start settings server -#### ocis glauth +#### ocis version -Start glauth server +Lists running services with version #### ocis accounts Start accounts server -#### ocis ocs +#### ocis storage-gateway -Start ocs server +Start storage gateway -#### ocis storage-frontend +#### ocis onlyoffice -Start storage frontend +Start onlyoffice server -#### ocis storage-auth-bearer +#### ocis storage-sharing -Start storage auth-bearer service +Start storage sharing service -#### ocis storage-home +#### ocis storage-userprovider -Start storage and data provider for /home mount +Start storage userprovider service -#### ocis storage-users +#### ocis storage-frontend -Start storage and data provider for /users mount +Start storage frontend -#### ocis konnectd +#### ocis storage-metadata -Start konnectd server +Start storage and data service for metadata -#### ocis storage-sharing +#### ocis storage-public-link -Start storage sharing service +Start storage public link storage -#### ocis thumbnails +#### ocis store -Start thumbnails server +Start a go-micro store