From 85b6531a1c7a96158e5cb1cf89b3f02ceec79eb4 Mon Sep 17 00:00:00 2001 From: Phil Davis Date: Tue, 2 Mar 2021 11:18:32 +0000 Subject: [PATCH] commit 0719d1858694dae4297993ef9fb7e0288233681f Merge: 4943fed2 b841cd78 Author: Phil Davis Date: Tue Mar 2 14:15:49 2021 +0300 Merge pull request #1746 from owncloud/bumpCommitIdAPI [tests-only] Bump commit id for API tests --- extensions/accounts/configuration.md | 74 ++-- extensions/glauth/configuration.md | 2 +- extensions/graph-explorer/configuration.md | 20 +- extensions/graph/configuration.md | 20 +- extensions/idp/configuration.md | 50 +-- extensions/ocs/configuration.md | 20 +- extensions/onlyoffice/configuration.md | 2 +- extensions/proxy/configuration.md | 2 +- extensions/settings/configuration.md | 2 +- extensions/storage/configuration.md | 412 ++++++++++----------- extensions/store/configuration.md | 56 +-- extensions/thumbnails/configuration.md | 50 +-- extensions/web/configuration.md | 20 +- extensions/webdav/configuration.md | 2 +- ocis/configuration.md | 124 +++---- 15 files changed, 428 insertions(+), 428 deletions(-) diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index e65fc42ac52..7179fc36ffa 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-02T10:47:13+0000" +date: "2021-03-02T11:16:10+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -41,11 +41,29 @@ Create a new account Usage: `accounts add [command options] [arguments...]` -### accounts rebuildIndex +### accounts inspect -Rebuilds the service's index, i.e. deleting and then re-adding all existing documents +Show detailed data on an existing account -Usage: `accounts rebuildIndex [command options] [arguments...]` +Usage: `accounts inspect [command options] [arguments...]` + +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. + +-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 @@ -68,41 +86,11 @@ 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 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...]` +### 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 @@ -182,3 +170,15 @@ Usage: `accounts server [command options] [arguments...]` -service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME : username of the internal service user (required on EOS). +### 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`. + diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index e299c46a4eb..df2df8cda23 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-02T10:48:17+0000" +date: "2021-03-02T11:17:18+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 ee7832d9f06..2a0ead201ec 100644 --- a/extensions/graph-explorer/configuration.md +++ b/extensions/graph-explorer/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-02T10:48:17+0000" +date: "2021-03-02T11:17:18+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph-explorer/templates @@ -52,15 +52,6 @@ Usage: `graph-explorer [global options] command [command options] [arguments...] ## Sub Commands -### graph-explorer health - -Check health status - -Usage: `graph-explorer health [command options] [arguments...]` - --debug-addr | $GRAPH_EXPLORER_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9136`. - ### graph-explorer server Start integrated server @@ -112,3 +103,12 @@ Usage: `graph-explorer server [command options] [arguments...]` -graph-url | $GRAPH_EXPLORER_GRAPH_URL : Set the url to the graph api service. Default: `http://localhost:9120`. +### graph-explorer health + +Check health status + +Usage: `graph-explorer health [command options] [arguments...]` + +-debug-addr | $GRAPH_EXPLORER_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9136`. + diff --git a/extensions/graph/configuration.md b/extensions/graph/configuration.md index 98c56398fed..c7066ba2a2f 100644 --- a/extensions/graph/configuration.md +++ b/extensions/graph/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-02T10:48:17+0000" +date: "2021-03-02T11:17:18+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph/templates @@ -55,15 +55,6 @@ Usage: `graph [global options] command [command options] [arguments...]` ## Sub Commands -### graph health - -Check health status - -Usage: `graph health [command options] [arguments...]` - --debug-addr | $GRAPH_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9124`. - ### graph server Start integrated server @@ -136,3 +127,12 @@ Usage: `graph server [command options] [arguments...]` -reva-gateway-addr | $REVA_GATEWAY_ADDR : REVA Gateway Endpoint. Default: `127.0.0.1:9142`. +### graph health + +Check health status + +Usage: `graph health [command options] [arguments...]` + +-debug-addr | $GRAPH_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9124`. + diff --git a/extensions/idp/configuration.md b/extensions/idp/configuration.md index 5824ff845d3..1405ce78da7 100644 --- a/extensions/idp/configuration.md +++ b/extensions/idp/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-02T10:48:17+0000" +date: "2021-03-02T11:17:18+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 92b45bff3bc..060c583f8b6 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-02T10:48:17+0000" +date: "2021-03-02T11:17:18+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/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. -### ocs health - -Check health status - -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 @@ -122,3 +113,12 @@ Usage: `ocs version [command options] [arguments...]` -name | $OCS_NAME : Service name. Default: `ocs`. +### ocs health + +Check health status + +Usage: `ocs health [command options] [arguments...]` + +-debug-addr | $OCS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9114`. + diff --git a/extensions/onlyoffice/configuration.md b/extensions/onlyoffice/configuration.md index b80eb0f1cf6..ec667fe5022 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-02T10:48:17+0000" +date: "2021-03-02T11:17:18+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 4cd6987b3bd..d99d4a92a55 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-02T10:48:17+0000" +date: "2021-03-02T11:17:18+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 cd594c7ee42..247a867bd3c 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-02T10:48:18+0000" +date: "2021-03-02T11:17:18+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 3f60ef846ae..c63cd3daa21 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-02T10:48:18+0000" +date: "2021-03-02T11:17:19+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -55,173 +55,98 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### 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 , $OCIS_URL -: OIDC issuer. Default: `https://localhost:9200`. - --oidc-insecure | $STORAGE_OIDC_INSECURE -: OIDC allow insecure communication. Default: `true`. +### storage storage-home --oidc-id-claim | $STORAGE_OIDC_ID_CLAIM -: OIDC id claim. Default: `preferred_username`. +Start storage-home service --oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM -: OIDC uid claim. +Usage: `storage storage-home [command options] [arguments...]` --oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM -: OIDC gid claim. +-debug-addr | $STORAGE_HOME_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9156`. --network | $STORAGE_AUTH_BEARER_GRPC_NETWORK +-grpc-network | $STORAGE_HOME_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 gateway - -Start gateway - -Usage: `storage gateway [command options] [arguments...]` - --debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9143`. - --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. +-grpc-addr | $STORAGE_HOME_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9154`. --network | $STORAGE_GATEWAY_GRPC_NETWORK +-http-network | $STORAGE_HOME_HTTP_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. --addr | $STORAGE_GATEWAY_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9142`. - --endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage service. Default: `localhost:9142`. - --commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT -: Commit shares to the share manager. Default: `true`. - --commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF -: Commit shares to the storage. Default: `true`. - --share-folder | $STORAGE_GATEWAY_SHARE_FOLDER -: mount shares in this folder of the home storage provider. Default: `Shares`. - --disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN -: Disable creation of home folder on login. - --storage-home-mapping | $STORAGE_GATEWAY_HOME_MAPPING -: mapping template for user home paths to user-specific mount points, e.g. /home/{{substr 0 1 .Username}}. - --auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT -: endpoint to use for the basic auth provider. Default: `localhost:9146`. - --auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT -: endpoint to use for the bearer auth provider. Default: `localhost:9148`. - --storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER -: driver of the storage registry. Default: `static`. - --storage-home-provider | $STORAGE_REGISTRY_HOME_PROVIDER -: mount point of the storage provider for user homes in the global namespace. Default: `/home`. - --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `https://localhost:9200`. - --datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL -: URL to use for the storage datagateway, defaults to /data. - --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider. Default: `localhost:9144`. - --groupprovider-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: endpoint to use for the groupprovider. Default: `localhost:9160`. - --sharing-endpoint | $STORAGE_SHARING_ENDPOINT -: endpoint to use for the storage service. Default: `localhost:9150`. +-http-addr | $STORAGE_HOME_HTTP_ADDR +: Address to bind storage service. Default: `0.0.0.0:9155`. --storage-home-endpoint | $STORAGE_HOME_ENDPOINT -: endpoint to use for the home storage. Default: `localhost:9154`. +-driver | $STORAGE_HOME_DRIVER +: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. --storage-home-mount-path | $STORAGE_HOME_MOUNT_PATH +-mount-path | $STORAGE_HOME_MOUNT_PATH : mount path. Default: `/home`. --storage-home-mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009154`. +-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009157`. --storage-users-endpoint | $STORAGE_USERS_ENDPOINT -: endpoint to use for the users storage. Default: `localhost:9157`. +-expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. --storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH -: mount path. Default: `/users`. +-data-server-url | $STORAGE_HOME_DATA_SERVER_URL +: data server url. Default: `http://localhost:9155/data`. --storage-users-mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009157`. +-http-prefix | $STORAGE_HOME_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `data`. --public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT -: endpoint to use for the public links service. Default: `localhost:9178`. +-tmp-folder | $STORAGE_HOME_TMP_FOLDER +: path to tmp folder. Default: `/var/tmp/ocis/tmp/home`. --storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `/public`. +-enable-home | $STORAGE_HOME_ENABLE_HOME +: enable the creation of home directories. Default: `true`. -### storage sharing +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `localhost:9142`. -Start sharing service +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `localhost:9144`. -Usage: `storage sharing [command options] [arguments...]` +### storage auth-bearer --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9151`. +Start authprovider for bearer auth --network | $STORAGE_SHARING_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +Usage: `storage auth-bearer [command options] [arguments...]` --addr | $STORAGE_SHARING_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9150`. +-debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9149`. --user-driver | $STORAGE_SHARING_USER_DRIVER -: driver to use for the UserShareProvider. Default: `json`. +-oidc-issuer | $STORAGE_OIDC_ISSUER , $OCIS_URL +: OIDC issuer. Default: `https://localhost:9200`. --user-json-file | $STORAGE_SHARING_USER_JSON_FILE -: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/storage/shares.json`. +-oidc-insecure | $STORAGE_OIDC_INSECURE +: OIDC allow insecure communication. Default: `true`. --public-driver | $STORAGE_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `json`. +-oidc-id-claim | $STORAGE_OIDC_ID_CLAIM +: OIDC id claim. Default: `preferred_username`. --public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE -: file used to persist shares for the PublicShareProvider. Default: `/var/tmp/ocis/storage/publicshares.json`. +-oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM +: OIDC uid claim. -### storage storage-public-link +-oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM +: OIDC gid claim. -Start storage-public-link service +-network | $STORAGE_AUTH_BEARER_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. -Usage: `storage storage-public-link [command options] [arguments...]` +-addr | $STORAGE_AUTH_BEARER_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9148`. --debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9179`. +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `localhost:9142`. --network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +### storage health --addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9178`. +Check health status --mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `/public`. +Usage: `storage health [command options] [arguments...]` --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `localhost:9142`. +-debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9109`. ### storage storage-metadata @@ -262,38 +187,50 @@ Usage: `storage storage-metadata [command options] [arguments...]` -storage-root | $STORAGE_METADATA_ROOT : the path to the metadata storage root. Default: `/var/tmp/ocis/storage/metadata`. -### storage auth-basic +### storage groups -Start authprovider for basic auth +Start groups service -Usage: `storage auth-basic [command options] [arguments...]` +Usage: `storage groups [command options] [arguments...]` --debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9147`. +-debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9161`. --auth-driver | $STORAGE_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. +-network | $STORAGE_GROUPPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. --auth-json | $STORAGE_AUTH_JSON -: Path to users.json file. +-addr | $STORAGE_GROUPPROVIDER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9160`. --network | $STORAGE_AUTH_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `localhost:9160`. --addr | $STORAGE_AUTH_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9146`. +-driver | $STORAGE_GROUPPROVIDER_DRIVER +: group driver: 'json', 'ldap', or 'rest'. Default: `ldap`. --gateway-url | $STORAGE_GATEWAY_ENDPOINT -: URL to use for the storage gateway service. Default: `localhost:9142`. +-json-config | $STORAGE_GROUPPROVIDER_JSON +: Path to groups.json file. -### storage health +### storage storage-public-link -Check health status +Start storage-public-link service -Usage: `storage health [command options] [arguments...]` +Usage: `storage storage-public-link [command options] [arguments...]` --debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9109`. +-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 storage-users @@ -367,6 +304,30 @@ Usage: `storage users [command options] [arguments...]` -json-config | $STORAGE_USERPROVIDER_JSON : Path to users.json file. +### 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`. + +-gateway-url | $STORAGE_GATEWAY_ENDPOINT +: URL to use for the storage gateway service. Default: `localhost:9142`. + ### storage frontend Start frontend service @@ -421,29 +382,92 @@ 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 gateway -Start groups service +Start gateway -Usage: `storage groups [command options] [arguments...]` +Usage: `storage gateway [command options] [arguments...]` --debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9161`. +-debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9143`. --network | $STORAGE_GROUPPROVIDER_NETWORK +-transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. + +-network | $STORAGE_GATEWAY_GRPC_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_GATEWAY_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9142`. --endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `localhost:9160`. +-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage service. Default: `localhost:9142`. --driver | $STORAGE_GROUPPROVIDER_DRIVER -: group driver: 'json', 'ldap', or 'rest'. Default: `ldap`. +-commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT +: Commit shares to the share manager. Default: `true`. --json-config | $STORAGE_GROUPPROVIDER_JSON -: Path to groups.json file. +-commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF +: Commit shares to the storage. Default: `true`. + +-share-folder | $STORAGE_GATEWAY_SHARE_FOLDER +: mount shares in this folder of the home storage provider. Default: `Shares`. + +-disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN +: Disable creation of home folder on login. + +-storage-home-mapping | $STORAGE_GATEWAY_HOME_MAPPING +: mapping template for user home paths to user-specific mount points, e.g. /home/{{substr 0 1 .Username}}. + +-auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT +: endpoint to use for the basic auth provider. Default: `localhost:9146`. + +-auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT +: endpoint to use for the bearer auth provider. Default: `localhost:9148`. + +-storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER +: driver of the storage registry. Default: `static`. + +-storage-home-provider | $STORAGE_REGISTRY_HOME_PROVIDER +: mount point of the storage provider for user homes in the global namespace. Default: `/home`. + +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `https://localhost:9200`. + +-datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL +: URL to use for the storage datagateway, defaults to /data. + +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider. Default: `localhost:9144`. + +-groupprovider-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: endpoint to use for the groupprovider. Default: `localhost:9160`. + +-sharing-endpoint | $STORAGE_SHARING_ENDPOINT +: endpoint to use for the storage service. Default: `localhost:9150`. + +-storage-home-endpoint | $STORAGE_HOME_ENDPOINT +: endpoint to use for the home storage. Default: `localhost:9154`. + +-storage-home-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `/home`. + +-storage-home-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009154`. + +-storage-users-endpoint | $STORAGE_USERS_ENDPOINT +: endpoint to use for the users storage. Default: `localhost:9157`. + +-storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH +: mount path. Default: `/users`. + +-storage-users-mount-id | $STORAGE_USERS_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009157`. + +-public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT +: endpoint to use for the public links service. Default: `localhost:9178`. + +-storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `/public`. ### storage storage @@ -463,56 +487,32 @@ Usage: `storage storage [command options] [arguments...]` -log-color | $STORAGE_LOG_COLOR : Enable colored logging. -### storage storage-home - -Start storage-home service - -Usage: `storage storage-home [command options] [arguments...]` +### storage sharing --debug-addr | $STORAGE_HOME_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9156`. +Start sharing service --grpc-network | $STORAGE_HOME_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +Usage: `storage sharing [command options] [arguments...]` --grpc-addr | $STORAGE_HOME_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9154`. +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9151`. --http-network | $STORAGE_HOME_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_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`. +-addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9150`. --tmp-folder | $STORAGE_HOME_TMP_FOLDER -: path to tmp folder. Default: `/var/tmp/ocis/tmp/home`. +-user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `json`. --enable-home | $STORAGE_HOME_ENABLE_HOME -: enable the creation of home directories. Default: `true`. +-user-json-file | $STORAGE_SHARING_USER_JSON_FILE +: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/storage/shares.json`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `localhost:9142`. +-public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `json`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `localhost:9144`. +-public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE +: file used to persist shares for the PublicShareProvider. Default: `/var/tmp/ocis/storage/publicshares.json`. ## Config for the different Storage Drivers diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index d24293ab66f..2adf07ce252 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-02T10:48:18+0000" +date: "2021-03-02T11:17:19+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 2ce23e4664c..1a38f39ef6c 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-02T10:48:19+0000" +date: "2021-03-02T11:17:19+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/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. -### 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 @@ -125,3 +101,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 1f996b09c8c..4810c898653 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-02T10:48:19+0000" +date: "2021-03-02T11:17:20+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/web/templates @@ -52,6 +52,15 @@ Usage: `web [global options] command [command options] [arguments...]` ## Sub Commands +### web health + +Check health status + +Usage: `web health [command options] [arguments...]` + +-debug-addr | $WEB_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9104`. + ### web server Start integrated server @@ -127,12 +136,3 @@ Usage: `web server [command options] [arguments...]` -oidc-scope | $WEB_OIDC_SCOPE : OpenID Connect scope. Default: `openid profile email`. -### web health - -Check health status - -Usage: `web health [command options] [arguments...]` - --debug-addr | $WEB_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9104`. - diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index 930209d1ecb..f75e7f3972c 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-02T10:48:19+0000" +date: "2021-03-02T11:17:20+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 afa14ff3b98..656131070d6 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-02T10:48:17+0000" +date: "2021-03-02T11:17:18+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -74,6 +74,27 @@ Usage: `ocis [global options] command [command options] [arguments...]` ## Sub Commands +### ocis list + +Lists running ocis extensions + +Usage: `ocis list [command options] [arguments...]` + +### ocis run + +Runs an extension + +Usage: `ocis run [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 server Start fullstack server @@ -101,126 +122,105 @@ Usage: `ocis server [command options] [arguments...]` -grpc-addr | $OCIS_GRPC_ADDR : Address to bind grpc server. Default: `0.0.0.0:9001`. -### 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 kill Kill an extension by name Usage: `ocis kill [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 storage-sharing +#### ocis storage-users -Start storage sharing service +Start storage and data provider for /users mount -#### ocis storage-userprovider +#### ocis glauth -Start storage userprovider service +Start glauth server -#### ocis thumbnails +#### ocis settings -Start thumbnails server +Start settings server -#### ocis accounts +#### ocis storage-userprovider -Start accounts server +Start storage userprovider service -#### ocis idp +#### ocis web -Start idp server +Start web server #### ocis storage-gateway Start storage gateway -#### ocis web - -Start web server - -#### ocis version +#### ocis accounts -Lists running services with version +Start accounts server -#### ocis glauth +#### ocis ocs -Start glauth server +Start ocs server #### ocis storage-public-link Start storage public link storage -#### ocis storage-metadata - -Start storage and data service for metadata - -#### ocis webdav - -Start webdav server - #### ocis storage-auth-bearer Start storage auth-bearer service -#### ocis storage-users +#### ocis storage-groupprovider -Start storage and data provider for /users mount +Start storage groupprovider service #### ocis store Start a go-micro store -#### ocis onlyoffice +#### ocis storage-auth-basic -Start onlyoffice server +Start storage auth-basic service -#### ocis settings +#### ocis storage-metadata -Start settings server +Start storage and data service for metadata -#### ocis storage-auth-basic +#### ocis storage-home -Start storage auth-basic service +Start storage and data provider for /home mount -#### ocis ocs +#### ocis thumbnails -Start ocs server +Start thumbnails server + +#### ocis idp + +Start idp server + +#### ocis onlyoffice + +Start onlyoffice server #### ocis proxy Start proxy server +#### ocis webdav + +Start webdav server + #### ocis storage-frontend Start storage frontend -#### ocis storage-groupprovider +#### ocis storage-sharing -Start storage groupprovider service +Start storage sharing service -#### ocis storage-home +#### ocis version -Start storage and data provider for /home mount +Lists running services with version