From eb62e70b41bddc93855bf9a4ff20941717540192 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Weigert?= Date: Thu, 3 Dec 2020 12:50:20 +0000 Subject: [PATCH] =?UTF-8?q?commit=20a2cba4631f947fc50481ad267a47b3a0ca7a35?= =?UTF-8?q?6d=20Merge:=20e0e45851=2030cb1658=20Author:=20J=C3=BCrgen=20Wei?= =?UTF-8?q?gert=20=20Date:=20=20=20Thu=20Dec=203=2013:?= =?UTF-8?q?17:27=202020=20+0100?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Merge pull request #1014 from owncloud/update-eos-base update eos-base image --- extensions/accounts/configuration.md | 80 +++--- extensions/glauth/configuration.md | 32 +-- extensions/konnectd/configuration.md | 50 ++-- extensions/ocis-phoenix/configuration.md | 32 +-- extensions/ocs/configuration.md | 32 +-- extensions/onlyoffice/configuration.md | 2 +- extensions/proxy/configuration.md | 2 +- extensions/settings/configuration.md | 2 +- extensions/storage/configuration.md | 352 +++++++++++------------ extensions/store/configuration.md | 80 +++--- extensions/thumbnails/configuration.md | 20 +- extensions/webdav/configuration.md | 2 +- ocis/configuration.md | 122 ++++---- 13 files changed, 404 insertions(+), 404 deletions(-) diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index e1c7fefdcff..c1c05efa3f9 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T11:34:32+0000" +date: "2020-12-03T12:49:44+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -33,38 +33,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 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 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 remove +### accounts list -Removes an existing account +List existing accounts -Usage: `accounts remove [command options] [arguments...]` +Usage: `accounts list [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. @@ -72,6 +45,12 @@ Usage: `accounts remove [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 @@ -126,11 +105,26 @@ Usage: `accounts server [command options] [arguments...]` --service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME : username of the internal service user (required on EOS). -### accounts list +### accounts ocis-accounts -List existing accounts +Provide accounts and groups for oCIS -Usage: `accounts list [command options] [arguments...]` +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 remove + +Removes an existing account + +Usage: `accounts remove [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. @@ -150,12 +144,6 @@ Usage: `accounts version [command options] [arguments...]` --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 inspect Show detailed data on an existing account @@ -168,3 +156,15 @@ Usage: `accounts inspect [command options] [arguments...]` --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 update + +Make changes to an existing account + +Usage: `accounts update [command options] [arguments...]` + diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index ad087bb4a68..40b5f69e2cb 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T11:34:35+0000" +date: "2020-12-03T12:49:46+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/glauth/templates @@ -33,21 +33,6 @@ 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. -### glauth ocis-glauth - -Serve GLAuth API for oCIS - -Usage: `glauth ocis-glauth [command options] [arguments...]` - ---log-level | $GLAUTH_LOG_LEVEL -: Set logging level. Default: `info`. - ---log-pretty | $GLAUTH_LOG_PRETTY -: Enable pretty logging. Default: `true`. - ---log-color | $GLAUTH_LOG_COLOR -: Enable colored logging. Default: `true`. - ### glauth server Start integrated server @@ -156,3 +141,18 @@ 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 + +Usage: `glauth ocis-glauth [command options] [arguments...]` + +--log-level | $GLAUTH_LOG_LEVEL +: Set logging level. Default: `info`. + +--log-pretty | $GLAUTH_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +--log-color | $GLAUTH_LOG_COLOR +: Enable colored logging. Default: `true`. + diff --git a/extensions/konnectd/configuration.md b/extensions/konnectd/configuration.md index 4edfc9e812f..25a3e98b3ff 100644 --- a/extensions/konnectd/configuration.md +++ b/extensions/konnectd/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T11:34:37+0000" +date: "2020-12-03T12:49:48+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/konnectd/templates @@ -33,30 +33,6 @@ 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. -### konnectd health - -Check health status - -Usage: `konnectd health [command options] [arguments...]` - ---debug-addr | $KONNECTD_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9134`. - -### konnectd ocis-konnectd - -Serve Konnectd API for oCIS - -Usage: `konnectd ocis-konnectd [command options] [arguments...]` - ---log-level | $KONNECTD_LOG_LEVEL -: Set logging level. Default: `info`. - ---log-pretty | $KONNECTD_LOG_PRETTY -: Enable pretty logging. Default: `true`. - ---log-color | $KONNECTD_LOG_COLOR -: Enable colored logging. Default: `true`. - ### konnectd server Start integrated server @@ -183,3 +159,27 @@ Usage: `konnectd version [command options] [arguments...]` --name | $KONNECTD_NAME : Service name. Default: `konnectd`. +### konnectd health + +Check health status + +Usage: `konnectd health [command options] [arguments...]` + +--debug-addr | $KONNECTD_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9134`. + +### konnectd ocis-konnectd + +Serve Konnectd API for oCIS + +Usage: `konnectd ocis-konnectd [command options] [arguments...]` + +--log-level | $KONNECTD_LOG_LEVEL +: Set logging level. Default: `info`. + +--log-pretty | $KONNECTD_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +--log-color | $KONNECTD_LOG_COLOR +: Enable colored logging. Default: `true`. + diff --git a/extensions/ocis-phoenix/configuration.md b/extensions/ocis-phoenix/configuration.md index 9cb87bdb328..feefe46ad15 100644 --- a/extensions/ocis-phoenix/configuration.md +++ b/extensions/ocis-phoenix/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T11:34:41+0000" +date: "2020-12-03T12:49:51+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/phoenix/templates @@ -33,21 +33,6 @@ 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. -### phoenix ocis-phoenix - -Serve Phoenix for oCIS - -Usage: `phoenix ocis-phoenix [command options] [arguments...]` - ---log-level | $PHOENIX_LOG_LEVEL -: Set logging level. Default: `info`. - ---log-pretty | $PHOENIX_LOG_PRETTY -: Enable pretty logging. Default: `true`. - ---log-color | $PHOENIX_LOG_COLOR -: Enable colored logging. Default: `true`. - ### phoenix server Start integrated server @@ -132,3 +117,18 @@ Usage: `phoenix health [command options] [arguments...]` --debug-addr | $PHOENIX_DEBUG_ADDR : Address to debug endpoint. Default: `0.0.0.0:9104`. +### phoenix ocis-phoenix + +Serve Phoenix for oCIS + +Usage: `phoenix ocis-phoenix [command options] [arguments...]` + +--log-level | $PHOENIX_LOG_LEVEL +: Set logging level. Default: `info`. + +--log-pretty | $PHOENIX_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +--log-color | $PHOENIX_LOG_COLOR +: Enable colored logging. Default: `true`. + diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index 7485ce2750f..a0441853d33 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T11:34:42+0000" +date: "2020-12-03T12:49:52+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/templates @@ -33,21 +33,6 @@ 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. -### ocs ocis-ocs - -Serve OCS API for oCIS - -Usage: `ocs ocis-ocs [command options] [arguments...]` - ---log-level | $OCS_LOG_LEVEL -: Set logging level. Default: `info`. - ---log-pretty | $OCS_LOG_PRETTY -: Enable pretty logging. Default: `true`. - ---log-color | $OCS_LOG_COLOR -: Enable colored logging. Default: `true`. - ### ocs server Start integrated server @@ -120,3 +105,18 @@ Usage: `ocs health [command options] [arguments...]` --debug-addr | $OCS_DEBUG_ADDR : Address to debug endpoint. Default: `0.0.0.0:9114`. +### ocs ocis-ocs + +Serve OCS API for oCIS + +Usage: `ocs ocis-ocs [command options] [arguments...]` + +--log-level | $OCS_LOG_LEVEL +: Set logging level. Default: `info`. + +--log-pretty | $OCS_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +--log-color | $OCS_LOG_COLOR +: Enable colored logging. Default: `true`. + diff --git a/extensions/onlyoffice/configuration.md b/extensions/onlyoffice/configuration.md index f99187e1009..fb8a45bbcc0 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T11:34:51+0000" +date: "2020-12-03T12:49:59+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 a00044c1e37..0339fa8010d 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T11:34:43+0000" +date: "2020-12-03T12:49:53+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 91c7544ea61..0ad68b3df9a 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T11:34:44+0000" +date: "2020-12-03T12:49:54+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 7d3dd8b95a5..18a68b73cfb 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T11:34:45+0000" +date: "2020-12-03T12:49:55+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -53,24 +53,6 @@ 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 storage-users Start storage-users service @@ -116,86 +98,35 @@ Usage: `storage storage-users [command options] [arguments...]` --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`. - ---driver | $STORAGE_METADATA_DRIVER -: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. +### storage health ---gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the gateway service. Default: `localhost:9142`. +Check health status ---userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider service. Default: `localhost:9144`. +Usage: `storage health [command options] [arguments...]` ---storage-root | $STORAGE_METADATA_ROOT -: the path to the metadata storage root. Default: `/var/tmp/ocis/metadata`. +--debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9109`. -### storage sharing +### storage storage-public-link -Start sharing service +Start storage-public-link service -Usage: `storage sharing [command options] [arguments...]` +Usage: `storage storage-public-link [command options] [arguments...]` ---debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9151`. +--debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9179`. ---network | $STORAGE_SHARING_GRPC_NETWORK +--network | $STORAGE_PUBLIC_LINK_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/shares.json`. - ---public-driver | $STORAGE_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `json`. - -### storage auth-basic - -Start authprovider for basic auth - -Usage: `storage auth-basic [command options] [arguments...]` - ---debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9147`. - ---auth-driver | $STORAGE_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. - ---auth-json | $STORAGE_AUTH_JSON -: Path to users.json file. +--addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9178`. ---network | $STORAGE_AUTH_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `/public`. ---addr | $STORAGE_AUTH_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9146`. +--gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `localhost:9142`. ### storage users @@ -248,6 +179,138 @@ Usage: `storage users [command options] [arguments...]` --rest-target-api | $STORAGE_REST_TARGET_API : The target application. +### 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 auth-basic + +Start authprovider for basic auth + +Usage: `storage auth-basic [command options] [arguments...]` + +--debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9147`. + +--auth-driver | $STORAGE_AUTH_DRIVER +: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. + +--auth-json | $STORAGE_AUTH_JSON +: Path to users.json file. + +--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 frontend + +Start frontend service + +Usage: `storage frontend [command options] [arguments...]` + +--debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9141`. + +--transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. + +--webdav-namespace | $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-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`. + +--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/metadata`. + ### storage gateway Start gateway @@ -329,59 +392,47 @@ Usage: `storage gateway [command options] [arguments...]` --storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH : mount path. Default: `/public`. -### storage health - -Check health status - -Usage: `storage health [command options] [arguments...]` - ---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`. ---webdav-namespace | $WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `/home/`. +--addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9150`. ---dav-files-namespace | $DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `/users/`. +--user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `json`. ---network | $STORAGE_FRONTEND_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--user-json-file | $STORAGE_SHARING_USER_JSON_FILE +: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/shares.json`. ---addr | $STORAGE_FRONTEND_HTTP_ADDR -: Address to bind storage service. Default: `0.0.0.0:9140`. +--public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `json`. ---public-url | $STORAGE_FRONTEND_PUBLIC_URL -: URL to use for the storage service. Default: `https://localhost:9200`. +### storage storage ---datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `data`. +Storage service for oCIS ---ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. +Usage: `storage storage [command options] [arguments...]` ---ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX -: open collaboration services endpoint prefix. Default: `ocs`. +--config-file | $STORAGE_CONFIG_FILE +: Path to config file. ---gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `localhost:9142`. +--log-level | $STORAGE_LOG_LEVEL +: Set logging level. Default: `info`. ---upload-disable-tus | $STORAGE_FRONTEND_UPLOAD_DISABLE_TUS -: Disables TUS upload mechanism. Default: `false`. +--log-pretty | $STORAGE_LOG_PRETTY +: Enable pretty logging. ---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. +--log-color | $STORAGE_LOG_COLOR +: Enable colored logging. ### storage storage-home @@ -431,57 +482,6 @@ Usage: `storage storage-home [command options] [arguments...]` --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT : endpoint to use for the storage service. Default: `localhost:9144`. -### 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-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`. - ## Config for the different Storage Drivers You can set different storage drivers for the Storage Providers. Please check the storage provider configuration. diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index 04244543d5b..6141d18ef15 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T11:34:46+0000" +date: "2020-12-03T12:49:56+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates @@ -33,45 +33,6 @@ 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. -### 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 - -Usage: `store health [command options] [arguments...]` - ---debug-addr | $STORE_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9460`. - -### store ocis-store - -Service to store values for ocis extensions - -Usage: `store ocis-store [command options] [arguments...]` - ---config-file | $STORE_CONFIG_FILE -: Path to config file. - ---log-level | $STORE_LOG_LEVEL -: Set logging level. Default: `info`. - ---log-pretty | $STORE_LOG_PRETTY -: Enable pretty logging. Default: `true`. - ---log-color | $STORE_LOG_COLOR -: Enable colored logging. Default: `true`. - ### store server Start integrated server @@ -114,3 +75,42 @@ Usage: `store server [command options] [arguments...]` --data-path | $STORE_DATA_PATH : location of the store data path. Default: `/var/tmp/ocis-store`. +### 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 + +Usage: `store health [command options] [arguments...]` + +--debug-addr | $STORE_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9460`. + +### store ocis-store + +Service to store values for ocis extensions + +Usage: `store ocis-store [command options] [arguments...]` + +--config-file | $STORE_CONFIG_FILE +: Path to config file. + +--log-level | $STORE_LOG_LEVEL +: Set logging level. Default: `info`. + +--log-pretty | $STORE_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +--log-color | $STORE_LOG_COLOR +: Enable colored logging. Default: `true`. + diff --git a/extensions/thumbnails/configuration.md b/extensions/thumbnails/configuration.md index fffab6acbc4..47c1a66ca88 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T11:34:48+0000" +date: "2020-12-03T12:49:57+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates @@ -33,6 +33,15 @@ 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. +### thumbnails health + +Check health status + +Usage: `thumbnails health [command options] [arguments...]` + +--debug-addr | $THUMBNAILS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9189`. + ### thumbnails ocis-thumbnails Example usage @@ -114,12 +123,3 @@ Usage: `thumbnails version [command options] [arguments...]` --grpc-namespace | $THUMBNAILS_GRPC_NAMESPACE : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. -### thumbnails health - -Check health status - -Usage: `thumbnails health [command options] [arguments...]` - ---debug-addr | $THUMBNAILS_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9189`. - diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index 6ede0d0394a..502ed5c3415 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T11:34:49+0000" +date: "2020-12-03T12:49:59+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 da7a40950a2..f8f8ae562bb 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T11:34:40+0000" +date: "2020-12-03T12:49:50+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -75,32 +75,17 @@ Usage: `ocis [global options] command [command options] [arguments...]` ## Sub Commands -### ocis run - -Runs an extension - -Usage: `ocis run [command options] [arguments...]` - -### ocis list - -Lists running ocis extensions - -Usage: `ocis list [command options] [arguments...]` - ### ocis kill Kill an extension by name Usage: `ocis kill [command options] [arguments...]` -### ocis health - -Check health status +### ocis list -Usage: `ocis health [command options] [arguments...]` +Lists running ocis extensions ---debug-addr | $OCIS_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9010`. +Usage: `ocis list [command options] [arguments...]` ### ocis server @@ -129,26 +114,49 @@ Usage: `ocis server [command options] [arguments...]` --grpc-addr | $OCIS_GRPC_ADDR : Address to bind grpc server. Default: `0.0.0.0:9001`. -### List of available Extension subcommands +### ocis health -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. +Check health status -#### ocis version +Usage: `ocis health [command options] [arguments...]` -Lists running services with version +--debug-addr | $OCIS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9010`. -#### ocis storage-frontend +### ocis run -Start storage frontend +Runs an extension -#### ocis storage-userprovider +Usage: `ocis run [command options] [arguments...]` -Start storage userprovider service +### List of available Extension subcommands + +There are more subcommands to start the individual extensions. Please check the documentation about their usage and options in the dedicated section of the documentation. #### ocis webdav Start webdav server +#### ocis storage-gateway + +Start storage gateway + +#### ocis storage-sharing + +Start storage sharing service + +#### ocis glauth + +Start glauth server + +#### ocis accounts + +Start accounts server + +#### ocis storage-auth-bearer + +Start storage auth-bearer service + #### ocis store Start a go-micro store @@ -157,67 +165,59 @@ Start a go-micro store Start storage auth-basic service -#### ocis storage-users +#### ocis onlyoffice -Start storage and data provider for /users mount +Start onlyoffice server -#### ocis glauth +#### ocis storage-home -Start glauth server +Start storage and data provider for /home mount -#### ocis ocs +#### ocis storage-public-link -Start ocs server +Start storage public link storage -#### ocis konnectd +#### ocis phoenix -Start konnectd server +Start phoenix server -#### ocis accounts +#### ocis version -Start accounts server +Lists running services with version #### ocis settings Start settings server -#### ocis proxy - -Start proxy server - -#### ocis thumbnails - -Start thumbnails server - -#### ocis storage-gateway +#### ocis storage-metadata -Start storage gateway +Start storage and data service for metadata -#### ocis storage-sharing +#### ocis ocs -Start storage sharing service +Start ocs server -#### ocis onlyoffice +#### ocis thumbnails -Start onlyoffice server +Start thumbnails server -#### ocis storage-auth-bearer +#### ocis storage-users -Start storage auth-bearer service +Start storage and data provider for /users mount -#### ocis storage-home +#### ocis proxy -Start storage and data provider for /home mount +Start proxy server -#### ocis storage-metadata +#### ocis storage-userprovider -Start storage and data service for metadata +Start storage userprovider service -#### ocis storage-public-link +#### ocis konnectd -Start storage public link storage +Start konnectd server -#### ocis phoenix +#### ocis storage-frontend -Start phoenix server +Start storage frontend