diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index c1c05efa3f9..794641c6e2f 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T12:49:44+0000" +date: "2020-12-03T16:10:21+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -51,6 +51,33 @@ Create a new account Usage: `accounts add [command options] [arguments...]` +### 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 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 server Start ocis accounts service @@ -105,33 +132,6 @@ Usage: `accounts server [command options] [arguments...]` --service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME : username of the internal service user (required on EOS). -### accounts ocis-accounts - -Provide accounts and groups for oCIS - -Usage: `accounts ocis-accounts [command options] [arguments...]` - ---log-level | $ACCOUNTS_LOG_LEVEL -: Set logging level. Default: `info`. - ---log-pretty | $ACCOUNTS_LOG_PRETTY -: Enable pretty logging. Default: `true`. - ---log-color | $ACCOUNTS_LOG_COLOR -: Enable colored logging. Default: `true`. - -### accounts remove - -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 version Print the versions of the running instances diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index 40b5f69e2cb..d3925825079 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T12:49:46+0000" +date: "2020-12-03T16:10:23+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 25a3e98b3ff..d070895f764 100644 --- a/extensions/konnectd/configuration.md +++ b/extensions/konnectd/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T12:49:48+0000" +date: "2020-12-03T16:10:25+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/konnectd/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. +### konnectd health + +Check health status + +Usage: `konnectd health [command options] [arguments...]` + +--debug-addr | $KONNECTD_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9134`. + +### konnectd ocis-konnectd + +Serve Konnectd API for oCIS + +Usage: `konnectd ocis-konnectd [command options] [arguments...]` + +--log-level | $KONNECTD_LOG_LEVEL +: Set logging level. Default: `info`. + +--log-pretty | $KONNECTD_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +--log-color | $KONNECTD_LOG_COLOR +: Enable colored logging. Default: `true`. + ### konnectd server Start integrated server @@ -159,27 +183,3 @@ Usage: `konnectd version [command options] [arguments...]` --name | $KONNECTD_NAME : Service name. Default: `konnectd`. -### konnectd health - -Check health status - -Usage: `konnectd health [command options] [arguments...]` - ---debug-addr | $KONNECTD_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9134`. - -### konnectd ocis-konnectd - -Serve Konnectd API for oCIS - -Usage: `konnectd ocis-konnectd [command options] [arguments...]` - ---log-level | $KONNECTD_LOG_LEVEL -: Set logging level. Default: `info`. - ---log-pretty | $KONNECTD_LOG_PRETTY -: Enable pretty logging. Default: `true`. - ---log-color | $KONNECTD_LOG_COLOR -: Enable colored logging. Default: `true`. - diff --git a/extensions/ocis-phoenix/configuration.md b/extensions/ocis-phoenix/configuration.md index feefe46ad15..c0e35a9a41b 100644 --- a/extensions/ocis-phoenix/configuration.md +++ b/extensions/ocis-phoenix/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T12:49:51+0000" +date: "2020-12-03T16:10:28+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/phoenix/templates diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index a0441853d33..32e7f08973e 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T12:49:52+0000" +date: "2020-12-03T16:10:29+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 fb8a45bbcc0..5d658bbad80 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T12:49:59+0000" +date: "2020-12-03T16:10:36+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/onlyoffice/templates @@ -57,6 +57,15 @@ 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 @@ -102,12 +111,3 @@ 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 0339fa8010d..3c8a7dc73a1 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T12:49:53+0000" +date: "2020-12-03T16:10:30+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/proxy/templates @@ -33,21 +33,6 @@ If you prefer to configure the service with environment variables you can see th If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### proxy ocis-proxy - -proxy for Reva/oCIS - -Usage: `proxy ocis-proxy [command options] [arguments...]` - ---log-level | $PROXY_LOG_LEVEL -: Set logging level. Default: `info`. - ---log-pretty | $PROXY_LOG_PRETTY -: Enable pretty logging. Default: `true`. - ---log-color | $PROXY_LOG_COLOR -: Enable colored logging. Default: `true`. - ### proxy server Start integrated server @@ -150,3 +135,18 @@ Usage: `proxy health [command options] [arguments...]` --debug-addr | $PROXY_DEBUG_ADDR : Address to debug endpoint. Default: `0.0.0.0:9109`. +### proxy ocis-proxy + +proxy for Reva/oCIS + +Usage: `proxy ocis-proxy [command options] [arguments...]` + +--log-level | $PROXY_LOG_LEVEL +: Set logging level. Default: `info`. + +--log-pretty | $PROXY_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +--log-color | $PROXY_LOG_COLOR +: Enable colored logging. Default: `true`. + diff --git a/extensions/settings/configuration.md b/extensions/settings/configuration.md index 0ad68b3df9a..faba9c8f41e 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T12:49:54+0000" +date: "2020-12-03T16:10:31+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/settings/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. +### 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 + +Usage: `settings health [command options] [arguments...]` + +--debug-addr | $SETTINGS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9194`. + ### settings ocis-settings Provide settings and permissions for oCIS @@ -111,24 +132,3 @@ Usage: `settings server [command options] [arguments...]` --jwt-secret | $SETTINGS_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`. - -### settings health - -Check health status - -Usage: `settings health [command options] [arguments...]` - ---debug-addr | $SETTINGS_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9194`. - diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index 18a68b73cfb..8c88cc2d40d 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T12:49:55+0000" +date: "2020-12-03T16:10:32+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -53,50 +53,56 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage storage-users +### storage auth-bearer -Start storage-users service +Start authprovider for bearer auth -Usage: `storage storage-users [command options] [arguments...]` +Usage: `storage auth-bearer [command options] [arguments...]` ---debug-addr | $STORAGE_USERS_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9159`. +--debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9149`. ---grpc-network | $STORAGE_USERS_GRPC_NETWORK -: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--oidc-issuer | $STORAGE_OIDC_ISSUER +: OIDC issuer. Default: `https://localhost:9200`. ---grpc-addr | $STORAGE_USERS_GRPC_ADDR -: GRPC Address to bind users storage. Default: `0.0.0.0:9157`. +--oidc-insecure | $STORAGE_OIDC_INSECURE +: OIDC allow insecure communication. Default: `true`. ---http-network | $STORAGE_USERS_HTTP_NETWORK +--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`. ---http-addr | $STORAGE_USERS_HTTP_ADDR -: HTTP Address to bind users storage. Default: `0.0.0.0:9158`. +--addr | $STORAGE_AUTH_BEARER_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9148`. ---driver | $STORAGE_USERS_DRIVER -: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. +### storage auth-basic ---mount-path | $STORAGE_USERS_MOUNT_PATH -: mount path. Default: `/users`. +Start authprovider for basic auth ---mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009157`. +Usage: `storage auth-basic [command options] [arguments...]` ---expose-data-server | $STORAGE_USERS_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. +--debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9147`. ---data-server-url | $STORAGE_USERS_DATA_SERVER_URL -: data server url. Default: `http://localhost:9158/data`. +--auth-driver | $STORAGE_AUTH_DRIVER +: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. ---http-prefix | $STORAGE_USERS_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `data`. +--auth-json | $STORAGE_AUTH_JSON +: Path to users.json file. ---gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `localhost:9142`. +--network | $STORAGE_AUTH_BASIC_GRPC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `localhost:9144`. +--addr | $STORAGE_AUTH_BASIC_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9146`. ### storage health @@ -107,6 +113,87 @@ Usage: `storage health [command options] [arguments...]` --debug-addr | $STORAGE_DEBUG_ADDR : Address to debug endpoint. Default: `0.0.0.0:9109`. +### 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`. + +--network | $STORAGE_GATEWAY_GRPC_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. + +--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 +: 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`. + +--userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider. Default: `localhost:9144`. + +--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-public-link Start storage-public-link service @@ -128,6 +215,54 @@ 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 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`. + +--enable-home | $STORAGE_HOME_ENABLE_HOME +: enable the creation of home directories. Default: `true`. + +--gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `localhost:9142`. + +--users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `localhost:9144`. + ### storage users Start users service @@ -179,56 +314,29 @@ Usage: `storage users [command options] [arguments...]` --rest-target-api | $STORAGE_REST_TARGET_API : The target application. -### storage auth-bearer - -Start authprovider for bearer auth - -Usage: `storage auth-bearer [command options] [arguments...]` - ---debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9149`. - ---oidc-issuer | $STORAGE_OIDC_ISSUER -: OIDC issuer. Default: `https://localhost:9200`. - ---oidc-insecure | $STORAGE_OIDC_INSECURE -: OIDC allow insecure communication. Default: `true`. +### storage sharing ---oidc-id-claim | $STORAGE_OIDC_ID_CLAIM -: OIDC id claim. Default: `preferred_username`. +Start sharing service ---oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM -: OIDC uid claim. +Usage: `storage sharing [command options] [arguments...]` ---oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM -: OIDC gid claim. +--debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9151`. ---network | $STORAGE_AUTH_BEARER_GRPC_NETWORK +--network | $STORAGE_SHARING_GRPC_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---addr | $STORAGE_AUTH_BEARER_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9148`. - -### storage auth-basic - -Start authprovider for basic auth - -Usage: `storage auth-basic [command options] [arguments...]` - ---debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9147`. - ---auth-driver | $STORAGE_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. +--addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9150`. ---auth-json | $STORAGE_AUTH_JSON -: Path to users.json file. +--user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `json`. ---network | $STORAGE_AUTH_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--user-json-file | $STORAGE_SHARING_USER_JSON_FILE +: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/shares.json`. ---addr | $STORAGE_AUTH_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9146`. +--public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `json`. ### storage frontend @@ -266,6 +374,9 @@ Usage: `storage frontend [command options] [arguments...]` --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`. @@ -275,146 +386,50 @@ Usage: `storage frontend [command options] [arguments...]` --upload-http-method-override | $STORAGE_FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE : Specify an HTTP method (ex: POST) that clients should to use when uploading instead of PATCH. -### storage storage-metadata - -Start storage-metadata service - -Usage: `storage storage-metadata [command options] [arguments...]` - ---debug-addr | $STORAGE_METADATA_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9217`. - ---grpc-network | $STORAGE_METADATA_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR -: Address to bind storage service. Default: `0.0.0.0:9215`. - ---data-server-url | $STORAGE_METADATA_DATA_SERVER_URL -: URL of the data-provider the storage-provider uses. Default: `http://localhost:9216`. - ---http-network | $STORAGE_METADATA_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---http-addr | $STORAGE_METADATA_HTTP_ADDR -: Address to bind storage service. Default: `0.0.0.0:9216`. - ---driver | $STORAGE_METADATA_DRIVER -: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. - ---gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the gateway service. Default: `localhost:9142`. - ---userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider service. Default: `localhost:9144`. - ---storage-root | $STORAGE_METADATA_ROOT -: the path to the metadata storage root. Default: `/var/tmp/ocis/metadata`. +### storage storage-users -### storage gateway +Start storage-users service -Start gateway +Usage: `storage storage-users [command options] [arguments...]` -Usage: `storage gateway [command options] [arguments...]` +--debug-addr | $STORAGE_USERS_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9159`. ---debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9143`. +--grpc-network | $STORAGE_USERS_GRPC_NETWORK +: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. +--grpc-addr | $STORAGE_USERS_GRPC_ADDR +: GRPC Address to bind users storage. Default: `0.0.0.0:9157`. ---network | $STORAGE_GATEWAY_GRPC_NETWORK +--http-network | $STORAGE_USERS_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. - ---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 -: 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`. - ---userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider. Default: `localhost:9144`. - ---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`. +--http-addr | $STORAGE_USERS_HTTP_ADDR +: HTTP Address to bind users storage. Default: `0.0.0.0:9158`. ---storage-users-endpoint | $STORAGE_USERS_ENDPOINT -: endpoint to use for the users storage. Default: `localhost:9157`. +--driver | $STORAGE_USERS_DRIVER +: storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. ---storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH +--mount-path | $STORAGE_USERS_MOUNT_PATH : mount path. Default: `/users`. ---storage-users-mount-id | $STORAGE_USERS_MOUNT_ID +--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 sharing - -Start sharing service - -Usage: `storage sharing [command options] [arguments...]` - ---debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9151`. - ---network | $STORAGE_SHARING_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--expose-data-server | $STORAGE_USERS_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. ---addr | $STORAGE_SHARING_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9150`. +--data-server-url | $STORAGE_USERS_DATA_SERVER_URL +: data server url. Default: `http://localhost:9158/data`. ---user-driver | $STORAGE_SHARING_USER_DRIVER -: driver to use for the UserShareProvider. Default: `json`. +--http-prefix | $STORAGE_USERS_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `data`. ---user-json-file | $STORAGE_SHARING_USER_JSON_FILE -: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/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`. ### storage storage @@ -434,53 +449,41 @@ 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 storage-metadata ---debug-addr | $STORAGE_HOME_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9156`. +Start storage-metadata service ---grpc-network | $STORAGE_HOME_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +Usage: `storage storage-metadata [command options] [arguments...]` ---grpc-addr | $STORAGE_HOME_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9154`. +--debug-addr | $STORAGE_METADATA_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9217`. ---http-network | $STORAGE_HOME_HTTP_NETWORK +--grpc-network | $STORAGE_METADATA_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`. +--grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9215`. ---expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. +--data-server-url | $STORAGE_METADATA_DATA_SERVER_URL +: URL of the data-provider the storage-provider uses. Default: `http://localhost:9216`. ---data-server-url | $STORAGE_HOME_DATA_SERVER_URL -: data server url. Default: `http://localhost:9155/data`. +--http-network | $STORAGE_METADATA_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---http-prefix | $STORAGE_HOME_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `data`. +--http-addr | $STORAGE_METADATA_HTTP_ADDR +: Address to bind storage service. Default: `0.0.0.0:9216`. ---enable-home | $STORAGE_HOME_ENABLE_HOME -: enable the creation of home directories. Default: `true`. +--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 storage gateway service. Default: `localhost:9142`. +: endpoint to use for the gateway service. Default: `localhost:9142`. ---users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `localhost:9144`. +--userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider service. Default: `localhost:9144`. + +--storage-root | $STORAGE_METADATA_ROOT +: the path to the metadata storage root. Default: `/var/tmp/ocis/metadata`. ## Config for the different Storage Drivers diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index 6141d18ef15..0e78a074592 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T12:49:56+0000" +date: "2020-12-03T16:10:33+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates @@ -33,6 +33,33 @@ If you prefer to configure the service with environment variables you can see th If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. +### store 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 @@ -87,30 +114,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 47c1a66ca88..00364974c1d 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T12:49:57+0000" +date: "2020-12-03T16:10:34+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index 502ed5c3415..a1c6a8ed32b 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T12:49:59+0000" +date: "2020-12-03T16:10:35+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates @@ -50,6 +50,15 @@ 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 @@ -110,12 +119,3 @@ 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 f8f8ae562bb..178e33a6ae1 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-03T12:49:50+0000" +date: "2020-12-03T16:10:27+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -75,6 +75,21 @@ Usage: `ocis [global options] command [command options] [arguments...]` ## Sub Commands +### 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 kill Kill an extension by name @@ -114,110 +129,95 @@ 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...]` - ### List of available Extension subcommands There are more subcommands to start the individual extensions. Please check the documentation about their usage and options in the dedicated section of the documentation. -#### ocis webdav - -Start webdav server - -#### ocis storage-gateway +#### ocis storage-home -Start storage gateway +Start storage and data provider for /home mount -#### ocis storage-sharing +#### ocis storage-users -Start storage sharing service +Start storage and data provider for /users mount -#### ocis glauth +#### ocis storage-public-link -Start glauth server +Start storage public link storage -#### ocis accounts +#### ocis storage-metadata -Start accounts server +Start storage and data service for metadata #### ocis storage-auth-bearer Start storage auth-bearer service +#### ocis storage-userprovider + +Start storage userprovider service + #### ocis store Start a go-micro store -#### ocis storage-auth-basic +#### ocis glauth -Start storage auth-basic service +Start glauth server -#### ocis onlyoffice +#### ocis webdav -Start onlyoffice server +Start webdav server -#### ocis storage-home +#### ocis settings -Start storage and data provider for /home mount +Start settings server -#### ocis storage-public-link +#### ocis konnectd -Start storage public link storage +Start konnectd server + +#### ocis thumbnails + +Start thumbnails server #### ocis phoenix Start phoenix server -#### ocis version +#### ocis storage-gateway -Lists running services with version +Start storage gateway -#### ocis settings +#### ocis version -Start settings server +Lists running services with version -#### ocis storage-metadata +#### ocis onlyoffice -Start storage and data service for metadata +Start onlyoffice server #### ocis ocs Start ocs server -#### ocis thumbnails - -Start thumbnails server - -#### ocis storage-users +#### ocis storage-sharing -Start storage and data provider for /users mount +Start storage sharing service -#### ocis proxy +#### ocis accounts -Start proxy server +Start accounts server -#### ocis storage-userprovider +#### ocis storage-frontend -Start storage userprovider service +Start storage frontend -#### ocis konnectd +#### ocis storage-auth-basic -Start konnectd server +Start storage auth-basic service -#### ocis storage-frontend +#### ocis proxy -Start storage frontend +Start proxy server