diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index eb4e5015be0..f99c0e27c04 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-11-24T12:20:21+0000" +date: "2020-11-24T18:33:23+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -37,11 +37,11 @@ If you prefer to configure the service with environment variables you can see th 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 list +### accounts version -List existing accounts +Print the versions of the running instances -Usage: `accounts list [command options] [arguments...]` +Usage: `accounts version [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. @@ -49,6 +49,12 @@ Usage: `accounts list [command options] [arguments...]` --name | $ACCOUNTS_NAME : service name. Default: `accounts`. +### accounts add + +Create a new account + +Usage: `accounts add [command options] [arguments...]` + ### accounts server Start ocis accounts service @@ -115,11 +121,11 @@ Usage: `accounts remove [command options] [arguments...]` --name | $ACCOUNTS_NAME : service name. Default: `accounts`. -### accounts version +### accounts inspect -Print the versions of the running instances +Show detailed data on an existing account -Usage: `accounts version [command options] [arguments...]` +Usage: `accounts inspect [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. @@ -127,17 +133,20 @@ Usage: `accounts version [command options] [arguments...]` --name | $ACCOUNTS_NAME : service name. Default: `accounts`. -### accounts inspect +### accounts ocis-accounts -Show detailed data on an existing account +Provide accounts and groups for oCIS -Usage: `accounts inspect [command options] [arguments...]` +Usage: `accounts ocis-accounts [command options] [arguments...]` ---grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. +--log-level | $ACCOUNTS_LOG_LEVEL +: Set logging level. Default: `info`. ---name | $ACCOUNTS_NAME -: service name. Default: `accounts`. +--log-pretty | $ACCOUNTS_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +--log-color | $ACCOUNTS_LOG_COLOR +: Enable colored logging. Default: `true`. ### accounts rebuildIndex @@ -151,24 +160,15 @@ 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 ocis-accounts - -Provide accounts and groups for oCIS +### accounts list -Usage: `accounts ocis-accounts [command options] [arguments...]` +List existing accounts ---log-level | $ACCOUNTS_LOG_LEVEL -: Set logging level. Default: `info`. +Usage: `accounts list [command options] [arguments...]` ---log-pretty | $ACCOUNTS_LOG_PRETTY -: Enable pretty logging. Default: `true`. +--grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. ---log-color | $ACCOUNTS_LOG_COLOR -: Enable colored logging. Default: `true`. +--name | $ACCOUNTS_NAME +: service name. Default: `accounts`. diff --git a/extensions/konnectd/configuration.md b/extensions/konnectd/configuration.md index cec6032f4b4..cf96ae24c6c 100644 --- a/extensions/konnectd/configuration.md +++ b/extensions/konnectd/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-11-24T12:20:24+0000" +date: "2020-11-24T18:33:27+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/konnectd/templates diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index 99a32d98fdb..5fb72d44d78 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-11-24T12:20:29+0000" +date: "2020-11-24T18:33:32+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/proxy/templates @@ -37,6 +37,42 @@ If you prefer to configure the service with environment variables you can see th 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 version + +Print the versions of the running instances + +Usage: `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`. + +### 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 Reva/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 @@ -118,39 +154,3 @@ Usage: `proxy server [command options] [arguments...]` --enable-basic-auth | $PROXY_ENABLE_BASIC_AUTH : enable basic authentication. Default: `false`. -### proxy version - -Print the versions of the running instances - -Usage: `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`. - -### 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 Reva/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/storage/configuration.md b/extensions/storage/configuration.md index 439514a7d2f..2cfc61cd7d1 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-11-24T12:20:27+0000" +date: "2020-11-24T18:33:30+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -57,68 +57,29 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage health - -Check health status - -Usage: `storage health [command options] [arguments...]` - ---debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9109`. - -### storage storage - -Storage service for oCIS - -Usage: `storage storage [command options] [arguments...]` - ---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-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`. +### storage sharing ---grpc-network | $STORAGE_METADATA_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +Start sharing service ---grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR -: Address to bind storage service. Default: `0.0.0.0:9215`. +Usage: `storage sharing [command options] [arguments...]` ---data-server-url | $STORAGE_METADATA_DATA_SERVER_URL -: URL of the data-provider the storage-provider uses. Default: `http://localhost:9216`. +--debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9151`. ---http-network | $STORAGE_METADATA_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_METADATA_HTTP_ADDR -: Address to bind storage service. Default: `0.0.0.0:9216`. - ---driver | $STORAGE_METADATA_DRIVER -: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. +--addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9150`. ---gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the gateway service. Default: `localhost:9142`. +--user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `json`. ---userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider service. Default: `localhost:9144`. +--user-json-file | $STORAGE_SHARING_USER_JSON_FILE +: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/shares.json`. ---storage-root | $STORAGE_METADATA_ROOT -: the path to the metadata storage root. Default: `/var/tmp/ocis/metadata`. +--public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `json`. ### storage auth-bearer @@ -150,95 +111,35 @@ Usage: `storage auth-bearer [command options] [arguments...]` --addr | $STORAGE_AUTH_BEARER_GRPC_ADDR : Address to bind storage service. Default: `0.0.0.0:9148`. -### storage storage-users - -Start storage-users service - -Usage: `storage storage-users [command options] [arguments...]` - ---debug-addr | $STORAGE_USERS_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9159`. - ---grpc-network | $STORAGE_USERS_GRPC_NETWORK -: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---grpc-addr | $STORAGE_USERS_GRPC_ADDR -: GRPC Address to bind users storage. Default: `0.0.0.0:9157`. - ---http-network | $STORAGE_USERS_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---http-addr | $STORAGE_USERS_HTTP_ADDR -: HTTP Address to bind users storage. Default: `0.0.0.0:9158`. - ---driver | $STORAGE_USERS_DRIVER -: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. - ---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 frontend - -Start frontend service - -Usage: `storage frontend [command options] [arguments...]` - ---debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9141`. - ---transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. +### storage auth-basic ---webdav-namespace | $WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `/home/`. +Start authprovider for basic auth ---dav-files-namespace | $DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `/users/`. +Usage: `storage auth-basic [command options] [arguments...]` ---network | $STORAGE_FRONTEND_HTTP_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_FRONTEND_HTTP_ADDR -: Address to bind storage service. Default: `0.0.0.0:9140`. +--auth-driver | $STORAGE_AUTH_DRIVER +: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. ---public-url | $STORAGE_FRONTEND_PUBLIC_URL -: URL to use for the storage service. Default: `https://localhost:9200`. +--auth-json | $STORAGE_AUTH_JSON +: Path to users.json file. ---datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `data`. +--network | $STORAGE_AUTH_BASIC_GRPC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. +--addr | $STORAGE_AUTH_BASIC_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9146`. ---ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX -: open collaboration services endpoint prefix. Default: `ocs`. +### storage health ---gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `localhost:9142`. +Check health status ---upload-disable-tus | $STORAGE_FRONTEND_UPLOAD_DISABLE_TUS -: Disables TUS upload mechanism. Default: `false`. +Usage: `storage health [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. +--debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9109`. ### storage storage-public-link @@ -441,50 +342,149 @@ Usage: `storage gateway [command options] [arguments...]` --storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH : mount path. Default: `/public`. -### storage sharing +### storage storage-metadata -Start sharing service +Start storage-metadata service -Usage: `storage sharing [command options] [arguments...]` +Usage: `storage storage-metadata [command options] [arguments...]` ---debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9151`. +--debug-addr | $STORAGE_METADATA_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9217`. ---network | $STORAGE_SHARING_GRPC_NETWORK +--grpc-network | $STORAGE_METADATA_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`. +--grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9215`. ---user-driver | $STORAGE_SHARING_USER_DRIVER -: driver to use for the UserShareProvider. Default: `json`. +--data-server-url | $STORAGE_METADATA_DATA_SERVER_URL +: URL of the data-provider the storage-provider uses. Default: `http://localhost:9216`. ---user-json-file | $STORAGE_SHARING_USER_JSON_FILE -: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/shares.json`. +--http-network | $STORAGE_METADATA_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`. +--http-addr | $STORAGE_METADATA_HTTP_ADDR +: Address to bind storage service. Default: `0.0.0.0:9216`. -### storage auth-basic +--driver | $STORAGE_METADATA_DRIVER +: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. -Start authprovider for basic auth +--gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the gateway service. Default: `localhost:9142`. -Usage: `storage auth-basic [command options] [arguments...]` +--userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider service. Default: `localhost:9144`. ---debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9147`. +--storage-root | $STORAGE_METADATA_ROOT +: the path to the metadata storage root. Default: `/var/tmp/ocis/metadata`. ---auth-driver | $STORAGE_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. +### storage frontend ---auth-json | $STORAGE_AUTH_JSON -: Path to users.json file. +Start frontend service ---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 frontend [command options] [arguments...]` ---addr | $STORAGE_AUTH_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9146`. +--debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9141`. + +--transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. + +--webdav-namespace | $WEBDAV_NAMESPACE +: Namespace prefix for the /webdav endpoint. Default: `/home/`. + +--dav-files-namespace | $DAV_FILES_NAMESPACE +: Namespace prefix for the webdav /dav/files endpoint. Default: `/users/`. + +--network | $STORAGE_FRONTEND_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--addr | $STORAGE_FRONTEND_HTTP_ADDR +: Address to bind storage service. Default: `0.0.0.0:9140`. + +--public-url | $STORAGE_FRONTEND_PUBLIC_URL +: URL to use for the storage service. Default: `https://localhost:9200`. + +--datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX +: datagateway prefix. Default: `data`. + +--ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX +: owncloud webdav endpoint prefix. + +--ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX +: open collaboration services endpoint prefix. Default: `ocs`. + +--gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `localhost:9142`. + +--upload-disable-tus | $STORAGE_FRONTEND_UPLOAD_DISABLE_TUS +: Disables TUS upload mechanism. Default: `false`. + +--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 storage-users + +Start storage-users service + +Usage: `storage storage-users [command options] [arguments...]` + +--debug-addr | $STORAGE_USERS_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9159`. + +--grpc-network | $STORAGE_USERS_GRPC_NETWORK +: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--grpc-addr | $STORAGE_USERS_GRPC_ADDR +: GRPC Address to bind users storage. Default: `0.0.0.0:9157`. + +--http-network | $STORAGE_USERS_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--http-addr | $STORAGE_USERS_HTTP_ADDR +: HTTP Address to bind users storage. Default: `0.0.0.0:9158`. + +--driver | $STORAGE_USERS_DRIVER +: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. + +--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. ## Config for the different Storage Drivers diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index 63c72195624..b8b5bb5f97a 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-11-24T12:20:33+0000" +date: "2020-11-24T18:33:37+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates