From 52a89eb4a1c8a1d56560c5fa88132a1d9523fed8 Mon Sep 17 00:00:00 2001 From: Jannik Stehle <50302941+JammingBen@users.noreply.github.com> Date: Thu, 11 Mar 2021 07:39:54 +0000 Subject: [PATCH] commit 8f9e1dd5d803b76aad1494c7bedf69159af6bdea Merge: 6f9df983 cdeda5c0 Author: Jannik Stehle <50302941+JammingBen@users.noreply.github.com> Date: Thu Mar 11 08:37:20 2021 +0100 Merge pull request #1792 from owncloud/issues/web-4322 Add focus to input elements on login page --- extensions/accounts/configuration.md | 104 +++---- extensions/glauth/configuration.md | 2 +- extensions/graph-explorer/configuration.md | 2 +- extensions/graph/configuration.md | 2 +- extensions/idp/configuration.md | 50 +-- extensions/ocs/configuration.md | 2 +- extensions/onlyoffice/configuration.md | 2 +- extensions/proxy/configuration.md | 2 +- extensions/settings/configuration.md | 26 +- extensions/storage/configuration.md | 334 ++++++++++----------- extensions/store/configuration.md | 56 ++-- extensions/thumbnails/configuration.md | 20 +- extensions/web/configuration.md | 2 +- extensions/webdav/configuration.md | 2 +- ocis/configuration.md | 136 ++++----- 15 files changed, 371 insertions(+), 371 deletions(-) diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 591c784debb..4ed2d53a8f4 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-10T13:32:17+0000" +date: "2021-03-11T07:37:42+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -35,6 +35,12 @@ 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 @@ -47,17 +53,11 @@ Usage: `accounts inspect [command options] [arguments...]` -name | $ACCOUNTS_NAME : service name. Default: `accounts`. -### accounts remove - -Removes an existing account - -Usage: `accounts remove [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 ocis-accounts @@ -74,6 +74,48 @@ Usage: `accounts ocis-accounts [command options] [arguments...]` -log-color | $ACCOUNTS_LOG_COLOR : Enable colored logging. Default: `true`. +### accounts update + +Make changes to an existing account + +Usage: `accounts update [command options] [arguments...]` + +### 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 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 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`. + +-name | $ACCOUNTS_NAME +: service name. Default: `accounts`. + ### accounts server Start ocis accounts service @@ -140,45 +182,3 @@ 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 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 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...]` - diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index a16d9e658a0..eeac0c0b3c0 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-10T13:33:10+0000" +date: "2021-03-11T07:38:41+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/glauth/templates diff --git a/extensions/graph-explorer/configuration.md b/extensions/graph-explorer/configuration.md index c4c1ba8fae3..761ae2c933d 100644 --- a/extensions/graph-explorer/configuration.md +++ b/extensions/graph-explorer/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-10T13:33:10+0000" +date: "2021-03-11T07:38:41+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph-explorer/templates diff --git a/extensions/graph/configuration.md b/extensions/graph/configuration.md index 46e88679e6c..df6ad9821fe 100644 --- a/extensions/graph/configuration.md +++ b/extensions/graph/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-10T13:33:10+0000" +date: "2021-03-11T07:38:41+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph/templates diff --git a/extensions/idp/configuration.md b/extensions/idp/configuration.md index f4f2a38b8d8..c9a36f8c936 100644 --- a/extensions/idp/configuration.md +++ b/extensions/idp/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-10T13:33:10+0000" +date: "2021-03-11T07:38:41+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/idp/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. -### idp health - -Check health status - -Usage: `idp health [command options] [arguments...]` - --debug-addr | $IDP_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9134`. - -### idp ocis-idp - -Serve IDP API for oCIS - -Usage: `idp ocis-idp [command options] [arguments...]` - --log-level | $IDP_LOG_LEVEL -: Set logging level. Default: `info`. - --log-pretty | $IDP_LOG_PRETTY -: Enable pretty logging. Default: `true`. - --log-color | $IDP_LOG_COLOR -: Enable colored logging. Default: `true`. - ### idp server Start integrated server @@ -218,3 +194,27 @@ Usage: `idp version [command options] [arguments...]` -name | $IDP_NAME : Service name. Default: `idp`. +### idp health + +Check health status + +Usage: `idp health [command options] [arguments...]` + +-debug-addr | $IDP_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9134`. + +### idp ocis-idp + +Serve IDP API for oCIS + +Usage: `idp ocis-idp [command options] [arguments...]` + +-log-level | $IDP_LOG_LEVEL +: Set logging level. Default: `info`. + +-log-pretty | $IDP_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +-log-color | $IDP_LOG_COLOR +: Enable colored logging. Default: `true`. + diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index b68f431f3e9..c983dc69210 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-10T13:33:11+0000" +date: "2021-03-11T07:38:42+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 78105dff53c..a64fc6a7150 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-10T13:33:11+0000" +date: "2021-03-11T07:38:42+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 184da8de79b..3efa00c88b1 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-10T13:33:11+0000" +date: "2021-03-11T07:38:42+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 647c0a9b2b9..af5116a8522 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-10T13:33:11+0000" +date: "2021-03-11T07:38:42+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/settings/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. -### settings version - -Print the versions of the running instances - -Usage: `settings version [command options] [arguments...]` - --grpc-namespace | $SETTINGS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. - --name | $SETTINGS_NAME -: service name. Default: `settings`. - ### settings health Check health status @@ -134,3 +122,15 @@ Usage: `settings server [command options] [arguments...]` -jwt-secret | $SETTINGS_JWT_SECRET , $OCIS_JWT_SECRET : Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `Pive-Fumkiu4`. +### settings version + +Print the versions of the running instances + +Usage: `settings version [command options] [arguments...]` + +-grpc-namespace | $SETTINGS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. + +-name | $SETTINGS_NAME +: service name. Default: `settings`. + diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index 132c95c55d5..f3e432cdadd 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-10T13:33:11+0000" +date: "2021-03-11T07:38:42+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -55,95 +55,50 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### 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`. +### storage storage --enable-home | $STORAGE_HOME_ENABLE_HOME -: enable the creation of home directories. Default: `true`. +Storage service for oCIS --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `localhost:9142`. +Usage: `storage storage [command options] [arguments...]` --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `localhost:9144`. +-config-file | $STORAGE_CONFIG_FILE +: Path to config file. -### storage storage-metadata +-log-level | $STORAGE_LOG_LEVEL +: Set logging level. Default: `info`. -Start storage-metadata service +-log-pretty | $STORAGE_LOG_PRETTY +: Enable pretty logging. -Usage: `storage storage-metadata [command options] [arguments...]` +-log-color | $STORAGE_LOG_COLOR +: Enable colored logging. --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`. - --tmp-folder | $STORAGE_METADATA_TMP_FOLDER -: path to tmp folder. Default: `/var/tmp/ocis/tmp/metadata`. +-addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9150`. --driver | $STORAGE_METADATA_DRIVER -: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. +-user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `json`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the gateway service. Default: `localhost:9142`. +-user-json-file | $STORAGE_SHARING_USER_JSON_FILE +: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/storage/shares.json`. --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider service. Default: `localhost:9144`. +-public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `json`. --storage-root | $STORAGE_METADATA_ROOT -: the path to the metadata storage root. Default: `/var/tmp/ocis/storage/metadata`. +-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-public-link @@ -166,30 +121,6 @@ Usage: `storage storage-public-link [command options] [arguments...]` -gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT : endpoint to use for the storage gateway service. Default: `localhost:9142`. -### 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`. - --network | $STORAGE_USERPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - --addr | $STORAGE_USERPROVIDER_ADDR -: Address to bind storage service. Default: `0.0.0.0:9144`. - --endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `localhost:9144`. - --driver | $STORAGE_USERPROVIDER_DRIVER -: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. - --json-config | $STORAGE_USERPROVIDER_JSON -: Path to users.json file. - ### storage auth-basic Start authprovider for basic auth @@ -214,6 +145,54 @@ Usage: `storage auth-basic [command options] [arguments...]` -gateway-url | $STORAGE_GATEWAY_ENDPOINT : URL to use for the storage gateway service. Default: `localhost:9142`. +### 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-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 gateway Start gateway @@ -301,83 +280,80 @@ Usage: `storage gateway [command options] [arguments...]` -storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH : mount path. Default: `/public`. -### storage storage - -Storage service for oCIS - -Usage: `storage storage [command options] [arguments...]` +### storage groups --config-file | $STORAGE_CONFIG_FILE -: Path to config file. +Start groups service --log-level | $STORAGE_LOG_LEVEL -: Set logging level. Default: `info`. +Usage: `storage groups [command options] [arguments...]` --log-pretty | $STORAGE_LOG_PRETTY -: Enable pretty logging. +-debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9161`. --log-color | $STORAGE_LOG_COLOR -: Enable colored logging. +-network | $STORAGE_GROUPPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. -### storage sharing +-addr | $STORAGE_GROUPPROVIDER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9160`. -Start sharing service +-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `localhost:9160`. -Usage: `storage sharing [command options] [arguments...]` +-driver | $STORAGE_GROUPPROVIDER_DRIVER +: group driver: 'json', 'ldap', or 'rest'. Default: `ldap`. --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9151`. +-json-config | $STORAGE_GROUPPROVIDER_JSON +: Path to groups.json file. --network | $STORAGE_SHARING_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +### storage storage-home --addr | $STORAGE_SHARING_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9150`. +Start storage-home service --user-driver | $STORAGE_SHARING_USER_DRIVER -: driver to use for the UserShareProvider. Default: `json`. +Usage: `storage storage-home [command options] [arguments...]` --user-json-file | $STORAGE_SHARING_USER_JSON_FILE -: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/storage/shares.json`. +-debug-addr | $STORAGE_HOME_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9156`. --public-driver | $STORAGE_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `json`. +-grpc-network | $STORAGE_HOME_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. --public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE -: file used to persist shares for the PublicShareProvider. Default: `/var/tmp/ocis/storage/publicshares.json`. +-grpc-addr | $STORAGE_HOME_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9154`. -### storage auth-bearer +-http-network | $STORAGE_HOME_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. -Start authprovider for bearer auth +-http-addr | $STORAGE_HOME_HTTP_ADDR +: Address to bind storage service. Default: `0.0.0.0:9155`. -Usage: `storage auth-bearer [command options] [arguments...]` +-driver | $STORAGE_HOME_DRIVER +: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. --debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9149`. +-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `/home`. --oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL -: OIDC issuer. Default: `https://localhost:9200`. +-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009157`. --oidc-insecure | $STORAGE_OIDC_INSECURE -: OIDC allow insecure communication. Default: `true`. +-expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. --oidc-id-claim | $STORAGE_OIDC_ID_CLAIM -: OIDC id claim. Default: `preferred_username`. +-data-server-url | $STORAGE_HOME_DATA_SERVER_URL +: data server url. Default: `http://localhost:9155/data`. --oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM -: OIDC uid claim. +-http-prefix | $STORAGE_HOME_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `data`. --oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM -: OIDC gid claim. +-tmp-folder | $STORAGE_HOME_TMP_FOLDER +: path to tmp folder. Default: `/var/tmp/ocis/tmp/home`. --network | $STORAGE_AUTH_BEARER_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +-enable-home | $STORAGE_HOME_ENABLE_HOME +: enable the creation of home directories. Default: `true`. --addr | $STORAGE_AUTH_BEARER_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9148`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `localhost:9142`. --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL 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-users @@ -427,14 +403,38 @@ Usage: `storage storage-users [command options] [arguments...]` -users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT : endpoint to use for the storage service. Default: `localhost:9144`. -### storage health +### storage auth-bearer -Check health status +Start authprovider for bearer auth -Usage: `storage health [command options] [arguments...]` +Usage: `storage auth-bearer [command options] [arguments...]` --debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9109`. +-debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9149`. + +-oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL +: 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`. + +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `localhost:9142`. ### storage frontend @@ -490,29 +490,29 @@ Usage: `storage frontend [command options] [arguments...]` -checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE : Specify the preferred checksum algorithm used for uploads. -### storage groups +### storage users -Start groups service +Start users service -Usage: `storage groups [command options] [arguments...]` +Usage: `storage users [command options] [arguments...]` --debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9161`. +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9145`. --network | $STORAGE_GROUPPROVIDER_NETWORK +-network | $STORAGE_USERPROVIDER_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. --addr | $STORAGE_GROUPPROVIDER_ADDR -: Address to bind storage service. Default: `0.0.0.0:9160`. +-addr | $STORAGE_USERPROVIDER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9144`. --endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `localhost:9160`. +-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `localhost:9144`. --driver | $STORAGE_GROUPPROVIDER_DRIVER -: group driver: 'json', 'ldap', or 'rest'. Default: `ldap`. +-driver | $STORAGE_USERPROVIDER_DRIVER +: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. --json-config | $STORAGE_GROUPPROVIDER_JSON -: Path to groups.json file. +-json-config | $STORAGE_USERPROVIDER_JSON +: Path to users.json file. ## Config for the different Storage Drivers diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index 758ec660e5f..439b51e3c4a 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-10T13:33:11+0000" +date: "2021-03-11T07:38:42+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates @@ -35,6 +35,33 @@ 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. +### 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 @@ -89,30 +116,3 @@ Usage: `store version [command options] [arguments...]` -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 d38948ce42d..40196aebe5a 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-10T13:33:12+0000" +date: "2021-03-11T07:38:43+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/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. -### 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 @@ -125,3 +116,12 @@ 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/web/configuration.md b/extensions/web/configuration.md index af817a3fe38..b93a9941801 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-10T13:33:13+0000" +date: "2021-03-11T07:38:43+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/web/templates diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index 247f99c44aa..0fc461c3eb2 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-10T13:33:13+0000" +date: "2021-03-11T07:38:43+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 1134cf0fd8d..37d53596fd6 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-10T13:33:11+0000" +date: "2021-03-11T07:38:42+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -74,6 +74,33 @@ Usage: `ocis [global options] command [command options] [arguments...]` ## Sub Commands +### ocis health + +Check health status + +Usage: `ocis health [command options] [arguments...]` + +-debug-addr | $OCIS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9010`. + +### 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 run + +Runs an extension + +Usage: `ocis run [command options] [arguments...]` + ### ocis server Start fullstack server @@ -101,126 +128,99 @@ Usage: `ocis server [command options] [arguments...]` -grpc-addr | $OCIS_GRPC_ADDR : Address to bind grpc server. Default: `0.0.0.0:9001`. -### ocis kill - -Kill an extension by name - -Usage: `ocis kill [command options] [arguments...]` - -### ocis health - -Check health status - -Usage: `ocis health [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 list - -Lists running ocis extensions - -Usage: `ocis list [command options] [arguments...]` - ### 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 settings +#### ocis accounts -Start settings server +Start accounts server -#### ocis storage-groupprovider +#### ocis storage-gateway -Start storage groupprovider service +Start storage gateway -#### ocis storage-public-link +#### ocis web -Start storage public link storage +Start web server -#### ocis storage-users +#### ocis webdav -Start storage and data provider for /users mount +Start webdav server -#### ocis glauth +#### ocis ocs -Start glauth server +Start ocs server #### ocis proxy Start proxy server -#### ocis storage-sharing +#### ocis thumbnails -Start storage sharing service +Start thumbnails server -#### ocis storage-userprovider +#### ocis version -Start storage userprovider service +Lists running services with version -#### ocis accounts +#### ocis glauth -Start accounts server +Start glauth server #### ocis idp Start idp server -#### ocis storage-auth-bearer +#### ocis storage-metadata -Start storage auth-bearer service +Start storage and data service for metadata -#### ocis storage-home +#### ocis storage-userprovider -Start storage and data provider for /home mount +Start storage userprovider service -#### ocis storage-gateway +#### ocis storage-auth-bearer -Start storage gateway +Start storage auth-bearer service -#### ocis storage-metadata +#### ocis storage-frontend -Start storage and data service for metadata +Start storage frontend -#### ocis version +#### ocis storage-home -Lists running services with version +Start storage and data provider for /home mount #### ocis store Start a go-micro store -#### ocis webdav - -Start webdav server - #### ocis onlyoffice Start onlyoffice server -#### ocis storage-frontend +#### ocis settings -Start storage frontend +Start settings server -#### ocis storage-auth-basic +#### ocis storage-public-link -Start storage auth-basic service +Start storage public link storage -#### ocis web +#### ocis storage-sharing -Start web server +Start storage sharing service -#### ocis ocs +#### ocis storage-auth-basic -Start ocs server +Start storage auth-basic service -#### ocis thumbnails +#### ocis storage-groupprovider -Start thumbnails server +Start storage groupprovider service + +#### ocis storage-users + +Start storage and data provider for /users mount