diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 7d55bffedae..d74110b1538 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-12T14:58:15+0000" +date: "2021-03-12T15:46:44+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -35,75 +35,12 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### accounts 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 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 add Create a new account Usage: `accounts add [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 list - -List existing accounts - -Usage: `accounts list [command options] [arguments...]` - --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. - --name | $ACCOUNTS_NAME -: service name. Default: `accounts`. - -### accounts rebuildIndex - -Rebuilds the service's index, i.e. deleting and then re-adding all existing documents - -Usage: `accounts rebuildIndex [command options] [arguments...]` - ### accounts remove Removes an existing account @@ -182,3 +119,66 @@ Usage: `accounts server [command options] [arguments...]` -service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME : username of the internal service user (required on EOS). +### accounts version + +Print the versions of the running instances + +Usage: `accounts version [command options] [arguments...]` + +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. + +-name | $ACCOUNTS_NAME +: service name. Default: `accounts`. + +### accounts inspect + +Show detailed data on an existing account + +Usage: `accounts inspect [command options] [arguments...]` + +-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. + +-name | $ACCOUNTS_NAME +: service name. Default: `accounts`. + +### accounts list + +List existing accounts + +Usage: `accounts list [command options] [arguments...]` + +-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 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...]` + diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index 488997533a9..63bf68a8ceb 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-12T14:59:11+0000" +date: "2021-03-12T15:47:32+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/glauth/templates @@ -35,30 +35,6 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### 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 @@ -158,3 +134,27 @@ 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/graph-explorer/configuration.md b/extensions/graph-explorer/configuration.md index 52646f1e36d..7752b69a7a8 100644 --- a/extensions/graph-explorer/configuration.md +++ b/extensions/graph-explorer/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-12T14:59:11+0000" +date: "2021-03-12T15:47:32+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph-explorer/templates diff --git a/extensions/graph/configuration.md b/extensions/graph/configuration.md index 6c3f8098e7d..bb4d0a1355b 100644 --- a/extensions/graph/configuration.md +++ b/extensions/graph/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-12T14:59:11+0000" +date: "2021-03-12T15:47:32+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph/templates @@ -55,15 +55,6 @@ Usage: `graph [global options] command [command options] [arguments...]` ## Sub Commands -### graph health - -Check health status - -Usage: `graph health [command options] [arguments...]` - --debug-addr | $GRAPH_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9124`. - ### graph server Start integrated server @@ -136,3 +127,12 @@ Usage: `graph server [command options] [arguments...]` -reva-gateway-addr | $REVA_GATEWAY_ADDR : REVA Gateway Endpoint. Default: `127.0.0.1:9142`. +### graph health + +Check health status + +Usage: `graph health [command options] [arguments...]` + +-debug-addr | $GRAPH_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9124`. + diff --git a/extensions/idp/configuration.md b/extensions/idp/configuration.md index b088d3b72ee..f1ca330cd06 100644 --- a/extensions/idp/configuration.md +++ b/extensions/idp/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-12T14:59:11+0000" +date: "2021-03-12T15:47:32+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/idp/templates diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index 3e4c8873e30..4ba3c732145 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-12T14:59:12+0000" +date: "2021-03-12T15:47:32+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 7b3194106c0..08ba2334264 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-12T14:59:12+0000" +date: "2021-03-12T15:47:32+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/onlyoffice/templates @@ -59,15 +59,6 @@ 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 @@ -113,3 +104,12 @@ 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 4a51472ae71..59e04769561 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-12T14:59:12+0000" +date: "2021-03-12T15:47:32+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/proxy/templates @@ -35,30 +35,6 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. -### proxy health - -Check health status - -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 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 @@ -158,3 +134,27 @@ Usage: `proxy version [command options] [arguments...]` --service-name | $PROXY_SERVICE_NAME : Service name. Default: `proxy`. +### proxy health + +Check health status + +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 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 fa9b772a164..675565456ce 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-12T14:59:12+0000" +date: "2021-03-12T15:47:32+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 becab8c4ed4..34ed2dc6cb7 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-12T14:59:12+0000" +date: "2021-03-12T15:47:33+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -55,51 +55,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 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/storage/shares.json`. - --public-driver | $STORAGE_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `json`. - --public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE -: file used to persist shares for the PublicShareProvider. Default: `/var/tmp/ocis/storage/publicshares.json`. - ### storage frontend Start frontend service @@ -241,95 +196,152 @@ Usage: `storage gateway [command options] [arguments...]` -storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH : mount path. Default: `/public`. -### storage storage-home +### storage groups -Start storage-home service +Start groups service -Usage: `storage storage-home [command options] [arguments...]` +Usage: `storage groups [command options] [arguments...]` --debug-addr | $STORAGE_HOME_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9156`. +-debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9161`. --grpc-network | $STORAGE_HOME_GRPC_NETWORK +-network | $STORAGE_GROUPPROVIDER_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`. +-addr | $STORAGE_GROUPPROVIDER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9160`. --http-network | $STORAGE_HOME_HTTP_NETWORK +-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `localhost:9160`. + +-driver | $STORAGE_GROUPPROVIDER_DRIVER +: group driver: 'json', 'ldap', or 'rest'. Default: `ldap`. + +-json-config | $STORAGE_GROUPPROVIDER_JSON +: Path to groups.json file. + +### 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`. --http-addr | $STORAGE_HOME_HTTP_ADDR -: Address to bind storage service. Default: `0.0.0.0:9155`. +-addr | $STORAGE_SHARING_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9150`. --driver | $STORAGE_HOME_DRIVER -: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. +-user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `json`. --mount-path | $STORAGE_HOME_MOUNT_PATH -: mount path. Default: `/home`. +-user-json-file | $STORAGE_SHARING_USER_JSON_FILE +: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/storage/shares.json`. --mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009157`. +-public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `json`. --expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. +-public-json-file | $STORAGE_SHARING_PUBLIC_JSON_FILE +: file used to persist shares for the PublicShareProvider. Default: `/var/tmp/ocis/storage/publicshares.json`. --data-server-url | $STORAGE_HOME_DATA_SERVER_URL -: data server url. Default: `http://localhost:9155/data`. +### storage storage-public-link --http-prefix | $STORAGE_HOME_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `data`. +Start storage-public-link service --tmp-folder | $STORAGE_HOME_TMP_FOLDER -: path to tmp folder. Default: `/var/tmp/ocis/tmp/home`. +Usage: `storage storage-public-link [command options] [arguments...]` --enable-home | $STORAGE_HOME_ENABLE_HOME -: enable the creation of home directories. Default: `true`. +-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`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `localhost:9144`. +### storage health -### storage storage-metadata +Check health status -Start storage-metadata service +Usage: `storage health [command options] [arguments...]` -Usage: `storage storage-metadata [command options] [arguments...]` +-debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9109`. --debug-addr | $STORAGE_METADATA_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9217`. +### storage storage --grpc-network | $STORAGE_METADATA_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +Storage service for oCIS --grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR -: Address to bind storage service. Default: `0.0.0.0:9215`. +Usage: `storage storage [command options] [arguments...]` --data-server-url | $STORAGE_METADATA_DATA_SERVER_URL -: URL of the data-provider the storage-provider uses. Default: `http://localhost:9216`. +-config-file | $STORAGE_CONFIG_FILE +: Path to config file. --http-network | $STORAGE_METADATA_HTTP_NETWORK +-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 storage-users + +Start storage-users service + +Usage: `storage storage-users [command options] [arguments...]` + +-debug-addr | $STORAGE_USERS_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9159`. + +-grpc-network | $STORAGE_USERS_GRPC_NETWORK +: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. + +-grpc-addr | $STORAGE_USERS_GRPC_ADDR +: GRPC Address to bind users storage. Default: `0.0.0.0:9157`. + +-http-network | $STORAGE_USERS_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_USERS_HTTP_ADDR +: HTTP Address to bind users storage. Default: `0.0.0.0:9158`. --tmp-folder | $STORAGE_METADATA_TMP_FOLDER -: path to tmp folder. Default: `/var/tmp/ocis/tmp/metadata`. +-driver | $STORAGE_USERS_DRIVER +: storage driver for users 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_USERS_MOUNT_PATH +: mount path. Default: `/users`. --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the gateway service. Default: `localhost:9142`. +-mount-id | $STORAGE_USERS_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_USERS_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_USERS_DATA_SERVER_URL +: data server url. Default: `http://localhost:9158/data`. + +-http-prefix | $STORAGE_USERS_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `data`. + +-tmp-folder | $STORAGE_USERS_TMP_FOLDER +: path to tmp folder. Default: `/var/tmp/ocis/tmp/users`. + +-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 auth-basic @@ -388,131 +400,119 @@ Usage: `storage auth-bearer [command options] [arguments...]` -gateway-url | $STORAGE_GATEWAY_ENDPOINT : URL to use for the storage gateway service. Default: `localhost:9142`. -### storage health - -Check health status - -Usage: `storage health [command options] [arguments...]` - --debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9109`. - -### storage groups +### storage storage-home -Start groups service +Start storage-home service -Usage: `storage groups [command options] [arguments...]` +Usage: `storage storage-home [command options] [arguments...]` --debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9161`. +-debug-addr | $STORAGE_HOME_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9156`. --network | $STORAGE_GROUPPROVIDER_NETWORK +-grpc-network | $STORAGE_HOME_GRPC_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. --addr | $STORAGE_GROUPPROVIDER_ADDR -: Address to bind storage service. Default: `0.0.0.0:9160`. +-grpc-addr | $STORAGE_HOME_GRPC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9154`. --endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `localhost:9160`. +-http-network | $STORAGE_HOME_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. --driver | $STORAGE_GROUPPROVIDER_DRIVER -: group driver: 'json', 'ldap', or 'rest'. Default: `ldap`. +-http-addr | $STORAGE_HOME_HTTP_ADDR +: Address to bind storage service. Default: `0.0.0.0:9155`. --json-config | $STORAGE_GROUPPROVIDER_JSON -: Path to groups.json file. +-driver | $STORAGE_HOME_DRIVER +: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. -### storage users +-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `/home`. -Start users service +-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009157`. -Usage: `storage users [command options] [arguments...]` +-expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. --debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9145`. +-data-server-url | $STORAGE_HOME_DATA_SERVER_URL +: data server url. Default: `http://localhost:9155/data`. --network | $STORAGE_USERPROVIDER_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`. --addr | $STORAGE_USERPROVIDER_ADDR -: Address to bind storage service. Default: `0.0.0.0:9144`. +-tmp-folder | $STORAGE_HOME_TMP_FOLDER +: path to tmp folder. Default: `/var/tmp/ocis/tmp/home`. --endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `localhost:9144`. +-enable-home | $STORAGE_HOME_ENABLE_HOME +: enable the creation of home directories. Default: `true`. --driver | $STORAGE_USERPROVIDER_DRIVER -: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `localhost:9142`. --json-config | $STORAGE_USERPROVIDER_JSON -: Path to users.json file. +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `localhost:9144`. -### storage storage-public-link +### storage storage-metadata -Start storage-public-link service +Start storage-metadata service -Usage: `storage storage-public-link [command options] [arguments...]` +Usage: `storage storage-metadata [command options] [arguments...]` --debug-addr | $STORAGE_PUBLIC_LINK_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9179`. +-debug-addr | $STORAGE_METADATA_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9217`. --network | $STORAGE_PUBLIC_LINK_GRPC_NETWORK +-grpc-network | $STORAGE_METADATA_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`. +-grpc-addr | $STORAGE_METADATA_GRPC_PROVIDER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9215`. -### storage storage-users +-data-server-url | $STORAGE_METADATA_DATA_SERVER_URL +: URL of the data-provider the storage-provider uses. Default: `http://localhost:9216`. -Start storage-users service +-http-network | $STORAGE_METADATA_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. -Usage: `storage storage-users [command options] [arguments...]` +-http-addr | $STORAGE_METADATA_HTTP_ADDR +: Address to bind storage service. Default: `0.0.0.0:9216`. --debug-addr | $STORAGE_USERS_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9159`. +-tmp-folder | $STORAGE_METADATA_TMP_FOLDER +: path to tmp folder. Default: `/var/tmp/ocis/tmp/metadata`. --grpc-network | $STORAGE_USERS_GRPC_NETWORK -: Network to use for the users storage, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +-driver | $STORAGE_METADATA_DRIVER +: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `ocis`. --grpc-addr | $STORAGE_USERS_GRPC_ADDR -: GRPC Address to bind users storage. Default: `0.0.0.0:9157`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the gateway service. Default: `localhost:9142`. --http-network | $STORAGE_USERS_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider service. Default: `localhost:9144`. --http-addr | $STORAGE_USERS_HTTP_ADDR -: HTTP Address to bind users storage. Default: `0.0.0.0:9158`. +-storage-root | $STORAGE_METADATA_ROOT +: the path to the metadata storage root. Default: `/var/tmp/ocis/storage/metadata`. --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. Default: `/users`. +Start users service --mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009157`. +Usage: `storage users [command options] [arguments...]` --expose-data-server | $STORAGE_USERS_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. +-debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9145`. --data-server-url | $STORAGE_USERS_DATA_SERVER_URL -: data server url. Default: `http://localhost:9158/data`. +-network | $STORAGE_USERPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. --http-prefix | $STORAGE_USERS_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `data`. +-addr | $STORAGE_USERPROVIDER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9144`. --tmp-folder | $STORAGE_USERS_TMP_FOLDER -: path to tmp folder. Default: `/var/tmp/ocis/tmp/users`. +-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`. --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `localhost:9144`. +-json-config | $STORAGE_USERPROVIDER_JSON +: Path to users.json file. ## Config for the different Storage Drivers diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index e1497345666..59c1f4305ff 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-12T14:59:12+0000" +date: "2021-03-12T15:47:33+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates @@ -35,6 +35,27 @@ If multiple variables are listed for one option, they are in order of precedence If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. +### store version + +Print the versions of the running instances + +Usage: `store version [command options] [arguments...]` + +-grpc-namespace | $STORE_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. + +-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 @@ -95,24 +116,3 @@ Usage: `store server [command options] [arguments...]` -data-path | $STORE_DATA_PATH : location of the store data path. Default: `/var/tmp/ocis/store`. -### store version - -Print the versions of the running instances - -Usage: `store version [command options] [arguments...]` - --grpc-namespace | $STORE_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`. - --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 692cc2bf8df..0e84aa5869a 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-12T14:59:13+0000" +date: "2021-03-12T15:47:33+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 6f32ea4ebd5..940714b92b0 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-12T14:59:13+0000" +date: "2021-03-12T15:47:34+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/web/templates @@ -52,6 +52,15 @@ Usage: `web [global options] command [command options] [arguments...]` ## Sub Commands +### web health + +Check health status + +Usage: `web health [command options] [arguments...]` + +-debug-addr | $WEB_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9104`. + ### web server Start integrated server @@ -127,12 +136,3 @@ Usage: `web server [command options] [arguments...]` -oidc-scope | $WEB_OIDC_SCOPE : OpenID Connect scope. Default: `openid profile email`. -### web health - -Check health status - -Usage: `web health [command options] [arguments...]` - --debug-addr | $WEB_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9104`. - diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index c84a28bc600..14cb1b44cf7 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-12T14:59:13+0000" +date: "2021-03-12T15:47:34+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates @@ -52,6 +52,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 @@ -109,15 +121,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 d2f33776c2c..c350e224a12 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-03-12T14:59:11+0000" +date: "2021-03-12T15:47:32+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -74,33 +74,6 @@ 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 - -Usage: `ocis kill [command options] [arguments...]` - -### ocis list - -Lists running ocis extensions - -Usage: `ocis list [command options] [arguments...]` - ### ocis server Start fullstack server @@ -128,33 +101,44 @@ 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 +### ocis list -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. +Lists running ocis extensions -#### ocis storage-users +Usage: `ocis list [command options] [arguments...]` -Start storage and data provider for /users mount +### ocis kill -#### ocis webdav +Kill an extension by name -Start webdav server +Usage: `ocis kill [command options] [arguments...]` -#### ocis storage-public-link +### ocis health -Start storage public link storage +Check health status -#### ocis version +Usage: `ocis health [command options] [arguments...]` -Lists running services with version +-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 glauth Start glauth server -#### ocis storage-userprovider +#### ocis proxy -Start storage userprovider service +Start proxy server #### ocis storage-metadata @@ -164,63 +148,79 @@ Start storage and data service for metadata Start storage auth-bearer service -#### ocis storage-frontend +#### ocis storage-groupprovider -Start storage frontend +Start storage groupprovider service + +#### ocis thumbnails + +Start thumbnails server + +#### ocis ocs + +Start ocs server + +#### ocis onlyoffice + +Start onlyoffice server + +#### ocis settings + +Start settings server #### ocis storage-sharing Start storage sharing service -#### ocis store +#### ocis storage-userprovider -Start a go-micro store +Start storage userprovider service -#### ocis idp +#### ocis web -Start idp server +Start web server -#### ocis onlyoffice +#### ocis storage-auth-basic -Start onlyoffice server +Start storage auth-basic service -#### ocis storage-gateway +#### ocis storage-users -Start storage gateway +Start storage and data provider for /users mount -#### ocis accounts +#### ocis webdav -Start accounts server +Start webdav server -#### ocis storage-home +#### ocis version -Start storage and data provider for /home mount +Lists running services with version -#### ocis settings +#### ocis idp -Start settings server +Start idp server -#### ocis storage-groupprovider +#### ocis storage-frontend -Start storage groupprovider service +Start storage frontend -#### ocis web +#### ocis storage-gateway -Start web server +Start storage gateway -#### ocis storage-auth-basic +#### ocis accounts -Start storage auth-basic service +Start accounts server -#### ocis thumbnails +#### ocis storage-public-link -Start thumbnails server +Start storage public link storage -#### ocis ocs +#### ocis store -Start ocs server +Start a go-micro store -#### ocis proxy +#### ocis storage-home -Start proxy server +Start storage and data provider for /home mount