From 42bf704d7efe7bf521732f1132b2f13a926f1f02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Friedrich=20Dreyer?= Date: Wed, 23 Dec 2020 16:31:42 +0000 Subject: [PATCH] =?UTF-8?q?commit=205689daf8649738dc0756d8c76a98c278cadddc?= =?UTF-8?q?67=20Merge:=20335aa2d5=20652448f5=20Author:=20J=C3=B6rn=20Fried?= =?UTF-8?q?rich=20Dreyer=20=20Date:=20=20=20Wed=20Dec=2023?= =?UTF-8?q?=2017:25:24=202020=20+0100?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Merge pull request #1148 from owncloud/add_ocis_url_env add OCIS_URL env var --- extensions/accounts/configuration.md | 122 +++++++++--------- extensions/glauth/configuration.md | 50 ++++---- extensions/konnectd/configuration.md | 2 +- extensions/ocs/configuration.md | 2 +- extensions/onlyoffice/configuration.md | 20 +-- extensions/proxy/configuration.md | 44 +++---- extensions/settings/configuration.md | 2 +- extensions/storage/configuration.md | 166 ++++++++++++------------- extensions/store/configuration.md | 2 +- extensions/thumbnails/configuration.md | 50 ++++---- extensions/web/configuration.md | 22 ++-- extensions/webdav/configuration.md | 20 +-- ocis/configuration.md | 108 ++++++++-------- ocis/deployment/basic-remote-setup.md | 11 +- 14 files changed, 307 insertions(+), 314 deletions(-) diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 50a442965f3..0979935aa0a 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-23T11:35:50+0000" +date: "2020-12-23T16:30:30+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -33,17 +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 list - -List existing accounts - -Usage: `accounts list [command options] [arguments...]` +### accounts rebuildIndex ---grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. +Rebuilds the service's index, i.e. deleting and then re-adding all existing documents ---name | $ACCOUNTS_NAME -: service name. Default: `accounts`. +Usage: `accounts rebuildIndex [command options] [arguments...]` ### accounts remove @@ -57,56 +51,11 @@ Usage: `accounts remove [command options] [arguments...]` --name | $ACCOUNTS_NAME : service name. Default: `accounts`. -### 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 - -Usage: `accounts version [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 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 rebuildIndex +### accounts update -Rebuilds the service's index, i.e. deleting and then re-adding all existing documents +Make changes to an existing account -Usage: `accounts rebuildIndex [command options] [arguments...]` +Usage: `accounts update [command options] [arguments...]` ### accounts server @@ -174,9 +123,60 @@ Usage: `accounts server [command options] [arguments...]` --service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME : username of the internal service user (required on EOS). -### accounts update +### accounts version -Make changes to an existing account +Print the versions of the running instances -Usage: `accounts update [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`. + +--name | $ACCOUNTS_NAME +: service name. Default: `accounts`. + +### 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 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`. diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index b73d0b1f173..fb46c896df9 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-23T11:35:54+0000" +date: "2020-12-23T16:30:44+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/glauth/templates @@ -33,6 +33,30 @@ 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 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 + +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 @@ -132,27 +156,3 @@ 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`. - -### 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 fb8de30b615..c40005dd926 100644 --- a/extensions/konnectd/configuration.md +++ b/extensions/konnectd/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-23T11:35:56+0000" +date: "2020-12-23T16:30:49+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 42dc5c0da91..dca7ec92e4e 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-23T11:36:02+0000" +date: "2020-12-23T16:30:54+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/templates diff --git a/extensions/onlyoffice/configuration.md b/extensions/onlyoffice/configuration.md index 9e97402ba01..aefd2d7234c 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-23T11:36:12+0000" +date: "2020-12-23T16:31:07+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/onlyoffice/templates @@ -57,15 +57,6 @@ Usage: `onlyoffice [global options] command [command options] [arguments...]` ## Sub Commands -### onlyoffice health - -Check health status - -Usage: `onlyoffice health [command options] [arguments...]` - ---debug-addr | $ONLYOFFICE_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9224`. - ### onlyoffice server Start integrated server @@ -111,3 +102,12 @@ Usage: `onlyoffice server [command options] [arguments...]` --asset-path | $ONLYOFFICE_ASSET_PATH : Path to custom assets. +### onlyoffice health + +Check health status + +Usage: `onlyoffice health [command options] [arguments...]` + +--debug-addr | $ONLYOFFICE_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9224`. + diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index 1582c59f2d8..3b4cc9d15ff 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-23T11:36:03+0000" +date: "2020-12-23T16:30:55+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/proxy/templates @@ -33,6 +33,27 @@ 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 oCIS @@ -135,24 +156,3 @@ Usage: `proxy server [command options] [arguments...]` --account-backend-type | $PROXY_ACCOUNT_BACKEND_TYPE : account-backend-type. Default: `accounts`. -### 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`. - diff --git a/extensions/settings/configuration.md b/extensions/settings/configuration.md index 4fdcb1c3d81..3d9a6eb5846 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-23T11:36:04+0000" +date: "2020-12-23T16:30:58+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 2fb7815ae37..4c1a7f0432f 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-23T11:36:06+0000" +date: "2020-12-23T16:30:59+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -53,27 +53,6 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage storage-public-link - -Start storage-public-link service - -Usage: `storage storage-public-link [command options] [arguments...]` - ---debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9179`. - ---network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9178`. - ---mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `/public`. - ---gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `localhost:9142`. - ### storage auth-bearer Start authprovider for bearer auth @@ -104,57 +83,6 @@ 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 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`. - ---chunk-folder | $STORAGE_CHUNK_FOLDER -: temp directory for chunked uploads. Default: `/var/tmp/ocis/tmp/chunks`. - ---webdav-namespace | $STORAGE_WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `/home/`. - ---dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `/users/`. - ---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`. - ---ocs-share-prefix | $STORAGE_FRONTEND_OCS_Share_PREFIX -: the prefix prepended to the path of shared files. Default: `/Shares`. - ---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 gateway Start gateway @@ -204,7 +132,7 @@ Usage: `storage gateway [command options] [arguments...]` : URL to use for the storage service. Default: `https://localhost:9200`. --datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL -: URL to use for the storage datagateway. Default: `https://localhost:9200/data`. +: URL to use for the storage datagateway, defaults to /data. --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT : endpoint to use for the userprovider. Default: `localhost:9144`. @@ -236,15 +164,6 @@ 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 sharing Start sharing service @@ -323,6 +242,27 @@ Usage: `storage storage-home [command options] [arguments...]` --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT : endpoint to use for the storage service. Default: `localhost:9144`. +### storage storage-public-link + +Start storage-public-link service + +Usage: `storage storage-public-link [command options] [arguments...]` + +--debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9179`. + +--network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9178`. + +--mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `/public`. + +--gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `localhost:9142`. + ### storage users Start users service @@ -395,6 +335,66 @@ Usage: `storage auth-basic [command options] [arguments...]` --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`. + +--chunk-folder | $STORAGE_CHUNK_FOLDER +: temp directory for chunked uploads. Default: `/var/tmp/ocis/tmp/chunks`. + +--webdav-namespace | $STORAGE_WEBDAV_NAMESPACE +: Namespace prefix for the /webdav endpoint. Default: `/home/`. + +--dav-files-namespace | $STORAGE_DAV_FILES_NAMESPACE +: Namespace prefix for the webdav /dav/files endpoint. Default: `/users/`. + +--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`. + +--ocs-share-prefix | $STORAGE_FRONTEND_OCS_Share_PREFIX +: the prefix prepended to the path of shared files. Default: `/Shares`. + +--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 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 diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index 0f23bbd7b65..520f8773b9c 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-23T11:36:07+0000" +date: "2020-12-23T16:31:00+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 a0613396be0..0db89b97ba3 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-23T11:36:09+0000" +date: "2020-12-23T16:31:01+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/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. -### 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 - -Usage: `thumbnails ocis-thumbnails [command options] [arguments...]` - ---log-level | $THUMBNAILS_LOG_LEVEL -: Set logging level. Default: `info`. - ---log-pretty | $THUMBNAILS_LOG_PRETTY -: Enable pretty logging. Default: `true`. - ---log-color | $THUMBNAILS_LOG_COLOR -: Enable colored logging. Default: `true`. - ### thumbnails server Start integrated server @@ -123,3 +99,27 @@ 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`. + +### thumbnails ocis-thumbnails + +Example usage + +Usage: `thumbnails ocis-thumbnails [command options] [arguments...]` + +--log-level | $THUMBNAILS_LOG_LEVEL +: Set logging level. Default: `info`. + +--log-pretty | $THUMBNAILS_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +--log-color | $THUMBNAILS_LOG_COLOR +: Enable colored logging. Default: `true`. + diff --git a/extensions/web/configuration.md b/extensions/web/configuration.md index f4cf205305b..94a2f7925db 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-23T11:36:00+0000" +date: "2020-12-23T16:30:53+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/web/templates @@ -50,6 +50,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 @@ -111,7 +120,7 @@ Usage: `web server [command options] [arguments...]` : Version. Default: `0.1.0`. --oidc-metadata-url | $WEB_OIDC_METADATA_URL -: OpenID Connect metadata URL. Default: `https://localhost:9200/.well-known/openid-configuration`. +: OpenID Connect metadata URL, defaults to /.well-known/openid-configuration. --oidc-authority | $WEB_OIDC_AUTHORITY : OpenID Connect authority. Default: `https://localhost:9200`. @@ -125,12 +134,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 192b4ba1b65..f52057d1cd3 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-23T11:36:11+0000" +date: "2020-12-23T16:31:05+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates @@ -50,15 +50,6 @@ Usage: `webdav [global options] command [command options] [arguments...]` ## Sub Commands -### webdav health - -Check health status - -Usage: `webdav health [command options] [arguments...]` - ---debug-addr | $WEBDAV_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9119`. - ### webdav server Start integrated server @@ -119,3 +110,12 @@ Usage: `webdav version [command options] [arguments...]` --service-name | $WEBDAV_SERVICE_NAME : Service name. Default: `webdav`. +### webdav health + +Check health status + +Usage: `webdav health [command options] [arguments...]` + +--debug-addr | $WEBDAV_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9119`. + diff --git a/ocis/configuration.md b/ocis/configuration.md index f282cec1438..00169f1100c 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-23T11:35:59+0000" +date: "2020-12-23T16:30:52+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -81,14 +81,17 @@ Kill an extension by name Usage: `ocis kill [command options] [arguments...]` -### ocis health +### ocis list -Check health status +Lists running ocis extensions -Usage: `ocis health [command options] [arguments...]` +Usage: `ocis list [command options] [arguments...]` ---debug-addr | $OCIS_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9010`. +### ocis run + +Runs an extension + +Usage: `ocis run [command options] [arguments...]` ### ocis server @@ -117,57 +120,50 @@ Usage: `ocis server [command options] [arguments...]` --grpc-addr | $OCIS_GRPC_ADDR : Address to bind grpc server. Default: `0.0.0.0:9001`. -### ocis list - -Lists running ocis extensions - -Usage: `ocis list [command options] [arguments...]` +### ocis health -### ocis run +Check health status -Runs an extension +Usage: `ocis health [command options] [arguments...]` -Usage: `ocis run [command options] [arguments...]` +--debug-addr | $OCIS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9010`. ### 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 store - -Start a go-micro store - -#### ocis version +#### ocis accounts -Lists running services with version +Start accounts server -#### ocis storage-home +#### ocis settings -Start storage and data provider for /home mount +Start settings server -#### ocis storage-users +#### ocis storage-auth-bearer -Start storage and data provider for /users mount +Start storage auth-bearer service -#### ocis ocs +#### ocis storage-public-link -Start ocs server +Start storage public link storage -#### ocis web +#### ocis store -Start web server +Start a go-micro store -#### ocis settings +#### ocis version -Start settings server +Lists running services with version -#### ocis storage-auth-basic +#### ocis webdav -Start storage auth-basic service +Start webdav server -#### ocis storage-public-link +#### ocis storage-gateway -Start storage public link storage +Start storage gateway #### ocis storage-userprovider @@ -177,47 +173,51 @@ Start storage userprovider service Start konnectd server -#### ocis storage-metadata - -Start storage and data service for metadata - -#### ocis storage-frontend +#### ocis storage-auth-basic -Start storage frontend +Start storage auth-basic service #### ocis glauth Start glauth server +#### ocis ocs + +Start ocs server + #### ocis onlyoffice Start onlyoffice server -#### ocis storage-sharing +#### ocis proxy -Start storage sharing service +Start proxy server -#### ocis accounts +#### ocis storage-home -Start accounts server +Start storage and data provider for /home mount -#### ocis storage-auth-bearer +#### ocis thumbnails -Start storage auth-bearer service +Start thumbnails server -#### ocis storage-gateway +#### ocis web -Start storage gateway +Start web server -#### ocis thumbnails +#### ocis storage-frontend -Start thumbnails server +Start storage frontend -#### ocis webdav +#### ocis storage-metadata -Start webdav server +Start storage and data service for metadata -#### ocis proxy +#### ocis storage-sharing -Start proxy server +Start storage sharing service + +#### ocis storage-users + +Start storage and data provider for /users mount diff --git a/ocis/deployment/basic-remote-setup.md b/ocis/deployment/basic-remote-setup.md index 696e70a466a..14b9cb776ed 100644 --- a/ocis/deployment/basic-remote-setup.md +++ b/ocis/deployment/basic-remote-setup.md @@ -58,13 +58,7 @@ You need to configure `your-host` in some services to provide the needed public ```bash PROXY_HTTP_ADDR=0.0.0.0:9200 \ -KONNECTD_ISS=https://your-server:9200 \ -REVA_OIDC_ISSUER=https://your-server:9200 \ -WEB_OIDC_AUTHORITY=https://your-server:9200 \ -WEB_UI_CONFIG_SERVER=https://your-server:9200 \ -WEB_OIDC_METADATA_URL=https://your-server:9200/.well-known/openid-configuration \ -REVA_DATAGATEWAY_URL=https://your-server:9200/data \ -REVA_FRONTEND_URL=https://your-server:9200 \ +OCIS_URL=https://your-server:9200 \ PROXY_TRANSPORT_TLS_KEY=./certs/your-host.key \ PROXY_TRANSPORT_TLS_CERT=./certs/your-host.crt \ KONNECTD_TLS=0 \ @@ -93,8 +87,7 @@ cd compose-playground/compose/ocis sed -i -e 's/your-url/192.168.103.195/g' config/identifier-registration.yml cat << EOF > .env -OCIS_BASE_URL=192.168.103.195 -OCIS_HTTP_PORT=9200 +OCIS_URL=https://192.168.103.195 OCIS_DOCKER_TAG=latest EOF