diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index e13819dbf83..12a09065e06 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-11T12:29:35+0000" +date: "2020-12-11T14:23:57+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -33,6 +33,75 @@ 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 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 update + +Make changes to an existing account + +Usage: `accounts update [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 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 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 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,78 +174,9 @@ Create a new account Usage: `accounts add [command options] [arguments...]` -### accounts list - -List existing accounts - -Usage: `accounts list [command options] [arguments...]` - ---grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. - ---name | $ACCOUNTS_NAME -: service name. Default: `accounts`. - -### accounts 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 update - -Make changes to an existing account - -Usage: `accounts update [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 rebuildIndex Rebuilds the service's index, i.e. deleting and then re-adding all existing documents 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`. - ---name | $ACCOUNTS_NAME -: service name. Default: `accounts`. - -### 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 da602fb6751..56b7abdf259 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-11T12:29:39+0000" +date: "2020-12-11T14:24:00+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 6cfc37a4ec2..c48a1ff5e9e 100644 --- a/extensions/konnectd/configuration.md +++ b/extensions/konnectd/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-11T12:29:41+0000" +date: "2020-12-11T14:24:02+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/konnectd/templates @@ -33,6 +33,15 @@ 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 server Start integrated server @@ -174,12 +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`. - diff --git a/extensions/ocis-phoenix/configuration.md b/extensions/ocis-phoenix/configuration.md index eda94ae9eee..342930b1841 100644 --- a/extensions/ocis-phoenix/configuration.md +++ b/extensions/ocis-phoenix/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-11T12:29:45+0000" +date: "2020-12-11T14:24:05+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/phoenix/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. -### phoenix ocis-phoenix - -Serve Phoenix for oCIS - -Usage: `phoenix ocis-phoenix [command options] [arguments...]` - ---log-level | $PHOENIX_LOG_LEVEL -: Set logging level. Default: `info`. - ---log-pretty | $PHOENIX_LOG_PRETTY -: Enable pretty logging. Default: `true`. - ---log-color | $PHOENIX_LOG_COLOR -: Enable colored logging. Default: `true`. - ### phoenix health Check health status @@ -132,3 +117,18 @@ Usage: `phoenix server [command options] [arguments...]` --oidc-scope | $PHOENIX_OIDC_SCOPE : OpenID Connect scope. Default: `openid profile email`. +### phoenix ocis-phoenix + +Serve Phoenix for oCIS + +Usage: `phoenix ocis-phoenix [command options] [arguments...]` + +--log-level | $PHOENIX_LOG_LEVEL +: Set logging level. Default: `info`. + +--log-pretty | $PHOENIX_LOG_PRETTY +: Enable pretty logging. Default: `true`. + +--log-color | $PHOENIX_LOG_COLOR +: Enable colored logging. Default: `true`. + diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index d64521ecacc..87b371a3315 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-11T12:29:48+0000" +date: "2020-12-11T14:24:07+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 65a8122ab3b..9bbfcf4e8e1 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-11T12:29:58+0000" +date: "2020-12-11T14:24:16+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 8d6a3711088..0d79be7da78 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-11T12:29:49+0000" +date: "2020-12-11T14:24:08+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 78819815aa1..f64f5b3b208 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-11T12:29:51+0000" +date: "2020-12-11T14:24:10+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 924e073eb34..c6264bde791 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-11T12:29:52+0000" +date: "2020-12-11T14:24:11+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -53,90 +53,6 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage storage - -Storage service for oCIS - -Usage: `storage storage [command options] [arguments...]` - ---config-file | $STORAGE_CONFIG_FILE -: Path to config file. - ---log-level | $STORAGE_LOG_LEVEL -: Set logging level. Default: `info`. - ---log-pretty | $STORAGE_LOG_PRETTY -: Enable pretty logging. - ---log-color | $STORAGE_LOG_COLOR -: Enable colored logging. - -### 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`. - ---oidc-id-claim | $STORAGE_OIDC_ID_CLAIM -: OIDC id claim. Default: `preferred_username`. - ---oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM -: OIDC uid claim. - ---oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM -: OIDC gid claim. - ---network | $STORAGE_AUTH_BEARER_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---addr | $STORAGE_AUTH_BEARER_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9148`. - -### 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 auth-basic Start authprovider for basic auth @@ -158,57 +74,6 @@ Usage: `storage auth-basic [command options] [arguments...]` --addr | $STORAGE_AUTH_BASIC_GRPC_ADDR : Address to bind storage service. Default: `0.0.0.0:9146`. -### storage users - -Start users service - -Usage: `storage users [command options] [arguments...]` - ---debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9145`. - ---network | $STORAGE_USERPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. - ---addr | $STORAGE_USERPROVIDER_ADDR -: Address to bind storage service. Default: `0.0.0.0:9144`. - ---endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `localhost:9144`. - ---driver | $STORAGE_USERPROVIDER_DRIVER -: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. - ---json-config | $STORAGE_USERPROVIDER_JSON -: Path to users.json file. - ---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. - ---rest-target-api | $STORAGE_REST_TARGET_API -: The target application. - ### storage frontend Start frontend service @@ -257,78 +122,6 @@ 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 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`. - ---addr | $STORAGE_SHARING_GRPC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9150`. - ---user-driver | $STORAGE_SHARING_USER_DRIVER -: driver to use for the UserShareProvider. Default: `json`. - ---user-json-file | $STORAGE_SHARING_USER_JSON_FILE -: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/shares.json`. - ---public-driver | $STORAGE_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `json`. - -### 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 storage-users Start storage-users service @@ -485,6 +278,213 @@ Usage: `storage gateway [command options] [arguments...]` --storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH : mount path. Default: `/public`. +### 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`. + +--oidc-id-claim | $STORAGE_OIDC_ID_CLAIM +: OIDC id claim. Default: `preferred_username`. + +--oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM +: OIDC uid claim. + +--oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM +: OIDC gid claim. + +--network | $STORAGE_AUTH_BEARER_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--addr | $STORAGE_AUTH_BEARER_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9148`. + +### 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 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 users + +Start users service + +Usage: `storage users [command options] [arguments...]` + +--debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9145`. + +--network | $STORAGE_USERPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +--addr | $STORAGE_USERPROVIDER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9144`. + +--endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `localhost:9144`. + +--driver | $STORAGE_USERPROVIDER_DRIVER +: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. + +--json-config | $STORAGE_USERPROVIDER_JSON +: Path to users.json file. + +--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. + +--rest-target-api | $STORAGE_REST_TARGET_API +: The target application. + +### 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`. + +--addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9150`. + +--user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `json`. + +--user-json-file | $STORAGE_SHARING_USER_JSON_FILE +: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/shares.json`. + +--public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `json`. + +### storage storage + +Storage service for oCIS + +Usage: `storage storage [command options] [arguments...]` + +--config-file | $STORAGE_CONFIG_FILE +: Path to config file. + +--log-level | $STORAGE_LOG_LEVEL +: Set logging level. Default: `info`. + +--log-pretty | $STORAGE_LOG_PRETTY +: Enable pretty logging. + +--log-color | $STORAGE_LOG_COLOR +: Enable colored logging. + ## Config for the different Storage Drivers You can set different storage drivers for the Storage Providers. Please check the storage provider configuration. diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index 4a9dfa8c684..22fe7c18b95 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-11T12:29:54+0000" +date: "2020-12-11T14:24:12+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates diff --git a/extensions/thumbnails/configuration.md b/extensions/thumbnails/configuration.md index 0d7903c9c99..7fecb6bc327 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-11T12:29:55+0000" +date: "2020-12-11T14:24:14+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 5f47afe940d..dabe2d092fb 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-11T12:29:57+0000" +date: "2020-12-11T14:24:15+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates @@ -50,6 +50,18 @@ Usage: `webdav [global options] command [command options] [arguments...]` ## Sub Commands +### webdav version + +Print the versions of the running instances + +Usage: `webdav version [command options] [arguments...]` + +--http-namespace | $WEBDAV_HTTP_NAMESPACE +: Set the base namespace for service discovery. Default: `com.owncloud.web`. + +--service-name | $WEBDAV_SERVICE_NAME +: Service name. Default: `webdav`. + ### webdav health Check health status @@ -107,15 +119,3 @@ Usage: `webdav server [command options] [arguments...]` --http-root | $WEBDAV_HTTP_ROOT : Root path of http server. Default: `/`. -### webdav version - -Print the versions of the running instances - -Usage: `webdav version [command options] [arguments...]` - ---http-namespace | $WEBDAV_HTTP_NAMESPACE -: Set the base namespace for service discovery. Default: `com.owncloud.web`. - ---service-name | $WEBDAV_SERVICE_NAME -: Service name. Default: `webdav`. - diff --git a/ocis/configuration.md b/ocis/configuration.md index 61424edd0ed..fd9fe6167e3 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-12-11T12:29:43+0000" +date: "2020-12-11T14:24:04+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -75,32 +75,20 @@ Usage: `ocis [global options] command [command options] [arguments...]` ## Sub Commands -### ocis health - -Check health status - -Usage: `ocis health [command options] [arguments...]` - ---debug-addr | $OCIS_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9010`. - -### ocis 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 +### ocis health -Lists running ocis extensions +Check health status -Usage: `ocis list [command options] [arguments...]` +Usage: `ocis health [command options] [arguments...]` + +--debug-addr | $OCIS_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9010`. ### ocis server @@ -129,33 +117,29 @@ Usage: `ocis server [command options] [arguments...]` --grpc-addr | $OCIS_GRPC_ADDR : Address to bind grpc server. Default: `0.0.0.0:9001`. -### 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 onlyoffice +### ocis run -Start onlyoffice server +Runs an extension -#### ocis storage-userprovider +Usage: `ocis run [command options] [arguments...]` -Start storage userprovider service +### ocis list -#### ocis storage-sharing +Lists running ocis extensions -Start storage sharing service +Usage: `ocis list [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 store +#### ocis storage-users -Start a go-micro store +Start storage and data provider for /users mount -#### ocis settings +#### ocis konnectd -Start settings server +Start konnectd server #### ocis phoenix @@ -165,59 +149,75 @@ Start phoenix server Start storage frontend -#### ocis storage-gateway +#### ocis storage-public-link -Start storage gateway +Start storage public link storage -#### ocis storage-metadata +#### ocis webdav -Start storage and data service for metadata +Start webdav server -#### ocis ocs +#### ocis storage-gateway -Start ocs server +Start storage gateway -#### ocis storage-users +#### ocis settings -Start storage and data provider for /users mount +Start settings server -#### ocis version +#### ocis storage-userprovider -Lists running services with version +Start storage userprovider service -#### ocis storage-public-link +#### ocis storage-home -Start storage public link storage +Start storage and data provider for /home mount + +#### ocis storage-sharing + +Start storage sharing service #### ocis storage-auth-basic Start storage auth-basic service -#### ocis webdav +#### ocis onlyoffice -Start webdav server +Start onlyoffice server -#### ocis accounts +#### ocis glauth -Start accounts server +Start glauth server -#### ocis storage-auth-bearer +#### ocis store -Start storage auth-bearer service +Start a go-micro store -#### ocis thumbnails +#### ocis ocs -Start thumbnails server +Start ocs server -#### ocis storage-home +#### ocis version -Start storage and data provider for /home mount +Lists running services with version -#### ocis konnectd +#### ocis thumbnails -Start konnectd server +Start thumbnails server #### ocis proxy Start proxy server +#### ocis accounts + +Start accounts server + +#### ocis storage-metadata + +Start storage and data service for metadata + +#### ocis storage-auth-bearer + +Start storage auth-bearer service +