diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 7dbee15cd50..040577bb5c8 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-17T16:13:47+0000" +date: "2020-12-17T17:07:34+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -33,32 +33,11 @@ If you prefer to configure the service with environment variables you can see th If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### accounts rebuildIndex - -Rebuilds the service's index, i.e. deleting and then re-adding all existing documents - -Usage: `accounts rebuildIndex [command options] [arguments...]` - -### accounts ocis-accounts - -Provide accounts and groups for oCIS - -Usage: `accounts ocis-accounts [command options] [arguments...]` - ---log-level | $ACCOUNTS_LOG_LEVEL -: Set logging level. Default: `info`. - ---log-pretty | $ACCOUNTS_LOG_PRETTY -: Enable pretty logging. Default: `true`. - ---log-color | $ACCOUNTS_LOG_COLOR -: Enable colored logging. Default: `true`. - -### accounts inspect +### accounts remove -Show detailed data on an existing account +Removes an existing account -Usage: `accounts inspect [command options] [arguments...]` +Usage: `accounts remove [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. @@ -66,11 +45,11 @@ Usage: `accounts inspect [command options] [arguments...]` --name | $ACCOUNTS_NAME : service name. Default: `accounts`. -### accounts version +### accounts list -Print the versions of the running instances +List existing accounts -Usage: `accounts version [command options] [arguments...]` +Usage: `accounts list [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. @@ -78,11 +57,17 @@ Usage: `accounts version [command options] [arguments...]` --name | $ACCOUNTS_NAME : service name. Default: `accounts`. -### accounts remove +### accounts rebuildIndex -Removes an existing account +Rebuilds the service's index, i.e. deleting and then re-adding all existing documents -Usage: `accounts remove [command options] [arguments...]` +Usage: `accounts rebuildIndex [command options] [arguments...]` + +### accounts inspect + +Show detailed data on an existing account + +Usage: `accounts inspect [command options] [arguments...]` --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. @@ -90,6 +75,12 @@ Usage: `accounts remove [command options] [arguments...]` --name | $ACCOUNTS_NAME : service name. Default: `accounts`. +### accounts update + +Make changes to an existing account + +Usage: `accounts update [command options] [arguments...]` + ### accounts server Start ocis accounts service @@ -156,27 +147,36 @@ Usage: `accounts server [command options] [arguments...]` --service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME : username of the internal service user (required on EOS). -### accounts list +### accounts add -List existing accounts +Create a new account -Usage: `accounts list [command options] [arguments...]` +Usage: `accounts add [command options] [arguments...]` ---grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. +### accounts ocis-accounts ---name | $ACCOUNTS_NAME -: service name. Default: `accounts`. +Provide accounts and groups for oCIS -### accounts add +Usage: `accounts ocis-accounts [command options] [arguments...]` -Create a new account +--log-level | $ACCOUNTS_LOG_LEVEL +: Set logging level. Default: `info`. -Usage: `accounts add [command options] [arguments...]` +--log-pretty | $ACCOUNTS_LOG_PRETTY +: Enable pretty logging. Default: `true`. -### accounts update +--log-color | $ACCOUNTS_LOG_COLOR +: Enable colored logging. Default: `true`. -Make changes to an existing account +### accounts version -Usage: `accounts update [command options] [arguments...]` +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 76be93e9c23..bafe2961931 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-17T16:13:49+0000" +date: "2020-12-17T17:07:36+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/glauth/templates diff --git a/extensions/konnectd/configuration.md b/extensions/konnectd/configuration.md index 35683166e3b..bac1ae1f6bf 100644 --- a/extensions/konnectd/configuration.md +++ b/extensions/konnectd/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-17T16:13:51+0000" +date: "2020-12-17T17:07:38+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/konnectd/templates @@ -33,33 +33,6 @@ If you prefer to configure the service with environment variables you can see th If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### konnectd 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 version - -Print the versions of the running instances - -Usage: `konnectd version [command options] [arguments...]` - ---http-namespace | $KONNECTD_HTTP_NAMESPACE -: Set the base namespace for service discovery. Default: `com.owncloud.web`. - ---name | $KONNECTD_NAME -: Service name. Default: `konnectd`. - ### konnectd health Check health status @@ -183,3 +156,30 @@ Usage: `konnectd server [command options] [arguments...]` --disable-identifier-webapp | $KONNECTD_DISABLE_IDENTIFIER_WEBAPP : Disable built-in identifier-webapp to use a frontend hosted elsewhere.. Default: `true`. +### 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 version + +Print the versions of the running instances + +Usage: `konnectd version [command options] [arguments...]` + +--http-namespace | $KONNECTD_HTTP_NAMESPACE +: Set the base namespace for service discovery. Default: `com.owncloud.web`. + +--name | $KONNECTD_NAME +: Service name. Default: `konnectd`. + diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index 7873b1163a0..3f1d0afad6d 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-17T16:13:55+0000" +date: "2020-12-17T17:07:42+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/templates @@ -33,21 +33,6 @@ If you prefer to configure the service with environment variables you can see th If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### ocs ocis-ocs - -Serve OCS API for oCIS - -Usage: `ocs ocis-ocs [command options] [arguments...]` - ---log-level | $OCS_LOG_LEVEL -: Set logging level. Default: `info`. - ---log-pretty | $OCS_LOG_PRETTY -: Enable pretty logging. Default: `true`. - ---log-color | $OCS_LOG_COLOR -: Enable colored logging. Default: `true`. - ### ocs version Print the versions of the running instances @@ -120,3 +105,18 @@ Usage: `ocs server [command options] [arguments...]` --jwt-secret | $OCS_JWT_SECRET : Used to dismantle the access token, should equal reva's jwt-secret. Default: `Pive-Fumkiu4`. +### ocs ocis-ocs + +Serve OCS API for oCIS + +Usage: `ocs ocis-ocs [command options] [arguments...]` + +--log-level | $OCS_LOG_LEVEL +: Set logging level. Default: `info`. + +--log-pretty | $OCS_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +--log-color | $OCS_LOG_COLOR +: Enable colored logging. Default: `true`. + diff --git a/extensions/onlyoffice/configuration.md b/extensions/onlyoffice/configuration.md index 5e07e864af3..5146ef334e7 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-17T16:14:02+0000" +date: "2020-12-17T17:07:48+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 9ace0272bc7..f054d010fa8 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-17T16:13:56+0000" +date: "2020-12-17T17:07:43+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 d440918dc73..f9eebb7a42b 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-17T16:13:57+0000" +date: "2020-12-17T17:07:44+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/settings/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. -### settings ocis-settings - -Provide settings and permissions for oCIS - -Usage: `settings ocis-settings [command options] [arguments...]` - ---log-level | $SETTINGS_LOG_LEVEL -: Set logging level. Default: `info`. - ---log-pretty | $SETTINGS_LOG_PRETTY -: Enable pretty logging. Default: `true`. - ---log-color | $SETTINGS_LOG_COLOR -: Enable colored logging. Default: `true`. - ### settings version Print the versions of the running instances @@ -132,3 +117,18 @@ 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 ocis-settings + +Provide settings and permissions for oCIS + +Usage: `settings ocis-settings [command options] [arguments...]` + +--log-level | $SETTINGS_LOG_LEVEL +: Set logging level. Default: `info`. + +--log-pretty | $SETTINGS_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +--log-color | $SETTINGS_LOG_COLOR +: Enable colored logging. Default: `true`. + diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index 1984972968c..5b2272caa65 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-17T16:13:58+0000" +date: "2020-12-17T17:07:45+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -53,6 +53,27 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands +### storage storage-public-link + +Start storage-public-link service + +Usage: `storage storage-public-link [command options] [arguments...]` + +--debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9179`. + +--network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--addr | $STORAGE_PUBLIC_LINK_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9178`. + +--mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `/public`. + +--gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `localhost:9142`. + ### storage gateway Start gateway @@ -134,56 +155,26 @@ Usage: `storage gateway [command options] [arguments...]` --storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH : mount path. Default: `/public`. -### 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`. +### storage auth-basic ---network | $STORAGE_USERPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +Start authprovider for basic auth ---addr | $STORAGE_USERPROVIDER_ADDR -: Address to bind storage service. Default: `0.0.0.0:9144`. +Usage: `storage auth-basic [command options] [arguments...]` ---endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `localhost:9144`. +--debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9147`. ---driver | $STORAGE_USERPROVIDER_DRIVER -: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. +--auth-driver | $STORAGE_AUTH_DRIVER +: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. ---json-config | $STORAGE_USERPROVIDER_JSON +--auth-json | $STORAGE_AUTH_JSON : Path to users.json file. ---rest-client-id | $STORAGE_REST_CLIENT_ID -: User rest driver Client ID. - ---rest-client-secret | $STORAGE_REST_CLIENT_SECRET -: User rest driver Client Secret. - ---rest-redis-address | $STORAGE_REST_REDIS_ADDRESS -: Address for redis server. Default: `localhost:6379`. - ---rest-redis-username | $STORAGE_REST_REDIS_USERNAME -: Username for redis server. - ---rest-redis-password | $STORAGE_REST_REDIS_PASSWORD -: Password for redis server. - ---rest-id-provider | $STORAGE_REST_ID_PROVIDER -: The OIDC Provider. - ---rest-api-base-url | $STORAGE_REST_API_BASE_URL -: Base API Endpoint. - ---rest-oidc-token-endpoint | $STORAGE_REST_OIDC_TOKEN_ENDPOINT -: Endpoint to generate token to access the API. +--network | $STORAGE_AUTH_BASIC_GRPC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---rest-target-api | $STORAGE_REST_TARGET_API -: The target application. +--addr | $STORAGE_AUTH_BASIC_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9146`. ### storage frontend @@ -281,56 +272,44 @@ 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`. ---tmp-folder | $STORAGE_HOME_TMP_FOLDER -: path to tmp folder. Default: `/var/tmp/ocis/tmp/home`. +--tmp-folder | $STORAGE_METADATA_TMP_FOLDER +: path to tmp folder. Default: `/var/tmp/ocis/tmp/metadata`. ---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/storage/metadata`. ### storage health @@ -341,47 +320,56 @@ Usage: `storage health [command options] [arguments...]` --debug-addr | $STORAGE_DEBUG_ADDR : Address to debug endpoint. Default: `0.0.0.0:9109`. -### storage storage-public-link +### storage users -Start storage-public-link service +Start users service -Usage: `storage storage-public-link [command options] [arguments...]` +Usage: `storage users [command options] [arguments...]` ---debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9179`. +--debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9145`. ---network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK +--network | $STORAGE_USERPROVIDER_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`. +--addr | $STORAGE_USERPROVIDER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9144`. ---mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `/public`. +--endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `localhost:9144`. ---gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `localhost:9142`. +--driver | $STORAGE_USERPROVIDER_DRIVER +: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. -### storage auth-basic +--json-config | $STORAGE_USERPROVIDER_JSON +: Path to users.json file. -Start authprovider for basic auth +--rest-client-id | $STORAGE_REST_CLIENT_ID +: User rest driver Client ID. -Usage: `storage auth-basic [command options] [arguments...]` +--rest-client-secret | $STORAGE_REST_CLIENT_SECRET +: User rest driver Client Secret. ---debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9147`. +--rest-redis-address | $STORAGE_REST_REDIS_ADDRESS +: Address for redis server. Default: `localhost:6379`. ---auth-driver | $STORAGE_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. +--rest-redis-username | $STORAGE_REST_REDIS_USERNAME +: Username for redis server. ---auth-json | $STORAGE_AUTH_JSON -: Path to users.json file. +--rest-redis-password | $STORAGE_REST_REDIS_PASSWORD +: Password for redis server. ---network | $STORAGE_AUTH_BASIC_GRPC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--rest-id-provider | $STORAGE_REST_ID_PROVIDER +: The OIDC Provider. ---addr | $STORAGE_AUTH_BASIC_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9146`. +--rest-api-base-url | $STORAGE_REST_API_BASE_URL +: Base API Endpoint. + +--rest-oidc-token-endpoint | $STORAGE_REST_OIDC_TOKEN_ENDPOINT +: Endpoint to generate token to access the API. + +--rest-target-api | $STORAGE_REST_TARGET_API +: The target application. ### storage auth-bearer @@ -413,44 +401,56 @@ Usage: `storage auth-bearer [command options] [arguments...]` --addr | $STORAGE_AUTH_BEARER_GRPC_ADDR : Address to bind storage service. Default: `0.0.0.0:9148`. -### storage storage-metadata +### storage storage-home -Start storage-metadata service +Start storage-home service -Usage: `storage storage-metadata [command options] [arguments...]` +Usage: `storage storage-home [command options] [arguments...]` ---debug-addr | $STORAGE_METADATA_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9217`. +--debug-addr | $STORAGE_HOME_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9156`. ---grpc-network | $STORAGE_METADATA_GRPC_NETWORK +--grpc-network | $STORAGE_HOME_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`. +--grpc-addr | $STORAGE_HOME_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9154`. ---http-network | $STORAGE_METADATA_HTTP_NETWORK +--http-network | $STORAGE_HOME_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`. +--http-addr | $STORAGE_HOME_HTTP_ADDR +: Address to bind storage service. Default: `0.0.0.0:9155`. ---tmp-folder | $STORAGE_METADATA_TMP_FOLDER -: path to tmp folder. Default: `/var/tmp/ocis/tmp/metadata`. +--driver | $STORAGE_HOME_DRIVER +: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. ---driver | $STORAGE_METADATA_DRIVER -: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. +--mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `/home`. ---gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the gateway service. Default: `localhost:9142`. +--mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009157`. ---userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider service. Default: `localhost:9144`. +--expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. ---storage-root | $STORAGE_METADATA_ROOT -: the path to the metadata storage root. Default: `/var/tmp/ocis/storage/metadata`. +--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`. + +--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 storage-users diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index ce076f12a41..c8ee98cbc93 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-17T16:13:59+0000" +date: "2020-12-17T17:07:45+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates @@ -33,15 +33,6 @@ If you prefer to configure the service with environment variables you can see th If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### store 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 server Start integrated server @@ -114,3 +105,12 @@ 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`. + diff --git a/extensions/thumbnails/configuration.md b/extensions/thumbnails/configuration.md index 4c0c41c5f1c..6520bfb51ae 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-17T16:14:00+0000" +date: "2020-12-17T17:07:46+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates diff --git a/extensions/web/configuration.md b/extensions/web/configuration.md index cad17ac3a6e..13ff59a0e56 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-17T16:13:54+0000" +date: "2020-12-17T17:07:40+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 17a4bbafcba..a6c04a8df9a 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-17T16:14:01+0000" +date: "2020-12-17T17:07:47+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 7bef42ca7e3..40bba40cc84 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-17T16:13:53+0000" +date: "2020-12-17T17:07:39+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -75,12 +75,6 @@ Usage: `ocis [global options] command [command options] [arguments...]` ## Sub Commands -### ocis list - -Lists running ocis extensions - -Usage: `ocis list [command options] [arguments...]` - ### ocis kill Kill an extension by name @@ -96,6 +90,18 @@ 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...]` + ### ocis server Start fullstack server @@ -123,101 +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 run +### List of available Extension subcommands -Runs an extension +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. -Usage: `ocis run [command options] [arguments...]` +#### ocis glauth -### List of available Extension subcommands +Start glauth server -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 web + +Start web server #### ocis storage-sharing Start storage sharing service -#### ocis accounts - -Start accounts server - -#### ocis settings +#### ocis version -Start settings server +Lists running services with version -#### ocis storage-users +#### ocis storage-auth-bearer -Start storage and data provider for /users mount +Start storage auth-bearer service #### ocis proxy Start proxy server -#### ocis web - -Start web server - -#### ocis webdav +#### ocis storage-frontend -Start webdav server +Start storage frontend #### ocis storage-gateway Start storage gateway -#### ocis store +#### ocis onlyoffice -Start a go-micro store +Start onlyoffice server -#### ocis konnectd +#### ocis webdav -Start konnectd server +Start webdav server #### ocis storage-public-link Start storage public link storage -#### ocis onlyoffice +#### ocis storage-auth-basic -Start onlyoffice server +Start storage auth-basic service #### ocis ocs Start ocs server -#### ocis version +#### ocis settings -Lists running services with version +Start settings server -#### ocis glauth +#### ocis storage-metadata -Start glauth server +Start storage and data service for metadata -#### ocis storage-auth-basic +#### ocis store -Start storage auth-basic service +Start a go-micro store -#### ocis thumbnails +#### ocis accounts -Start thumbnails server +Start accounts server -#### ocis storage-frontend +#### ocis konnectd -Start storage frontend +Start konnectd server -#### ocis storage-home +#### ocis storage-userprovider -Start storage and data provider for /home mount +Start storage userprovider service -#### ocis storage-metadata +#### ocis thumbnails -Start storage and data service for metadata +Start thumbnails server -#### ocis storage-auth-bearer +#### ocis storage-home -Start storage auth-bearer service +Start storage and data provider for /home mount -#### ocis storage-userprovider +#### ocis storage-users -Start storage userprovider service +Start storage and data provider for /users mount