adapt docs structure

This commit is contained in:
A.Unger committed 2020-09-21 13:20:14 +02:00
1 parent 696b9a70af
commit c41440e008
87 files changed
+917 -822

No files matched your search

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -1,6 +1,6 @@
---
title: "Configuration"
date: "2020-09-21T12:38:17+0200"
date: "2020-09-21T13:14:47+0200"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis-konnectd
geekdocEditPath: edit/master/docs
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -1,6 +1,6 @@
---
title: "Configuration"
date: "2020-09-21T12:38:30+0200"
date: "2020-09-21T13:14:49+0200"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis-reva
geekdocEditPath: edit/master/docs
@@ -57,6 +57,33 @@ Usage: `ocis-reva [global options] command [command options] [arguments...]`
## Sub Commands
### ocis-reva auth-basic
Start reva authprovider for basic auth
Usage: `ocis-reva auth-basic [command options] [arguments...]`
--debug-addr | $REVA_AUTH_BASIC_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9147`.
--auth-driver | $REVA_AUTH_DRIVER
: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`.
--auth-json | $REVA_AUTH_JSON
: Path to users.json file.
--network | $REVA_AUTH_BASIC_NETWORK
: Network to use for the reva auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $REVA_AUTH_BASIC_PROTOCOL
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $REVA_AUTH_BASIC_ADDR
: Address to bind reva service. Default: `0.0.0.0:9146`.
--url | $REVA_AUTH_BASIC_URL
: URL to use for the reva service. Default: `localhost:9146`.
### ocis-reva frontend
Start reva frontend service
@@ -105,189 +132,6 @@ Usage: `ocis-reva frontend [command options] [arguments...]`
--upload-http-method-override | $REVA_FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE
: Specify an HTTP method (ex: POST) that clients should to use when uploading instead of PATCH.
### ocis-reva sharing
Start reva sharing service
Usage: `ocis-reva sharing [command options] [arguments...]`
--debug-addr | $REVA_SHARING_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9151`.
--network | $REVA_SHARING_NETWORK
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $REVA_SHARING_PROTOCOL
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $REVA_SHARING_ADDR
: Address to bind reva service. Default: `0.0.0.0:9150`.
--url | $REVA_SHARING_URL
: URL to use for the reva service. Default: `localhost:9150`.
--user-driver | $REVA_SHARING_USER_DRIVER
: driver to use for the UserShareProvider. Default: `json`.
--user-json-file | $REVA_SHARING_USER_JSON_FILE
: file used to persist shares for the UserShareProvider. Default: `/var/tmp/reva/shares.json`.
--public-driver | $REVA_SHARING_PUBLIC_DRIVER
: driver to use for the PublicShareProvider. Default: `json`.
### ocis-reva reva-storage-public-link
Start reva storage-public-link service
Usage: `ocis-reva reva-storage-public-link [command options] [arguments...]`
--debug-addr | $REVA_STORAGE_PUBLIC_LINK_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9179`.
--network | $REVA_STORAGE_PUBLIC_LINK_NETWORK
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $REVA_STORAGE_PUBLIC_LINK_PROTOCOL
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $REVA_STORAGE_PUBLIC_LINK_ADDR
: Address to bind reva service. Default: `0.0.0.0:9178`.
--url | $REVA_STORAGE_PUBLIC_LINK_URL
: Address to bind reva service. Default: `localhost:9178`.
--mount-path | $REVA_STORAGE_PUBLIC_LINK_MOUNT_PATH
: mount path. Default: `/public/`.
--gateway-url | $REVA_GATEWAY_URL
: URL to use for the reva gateway service. Default: `localhost:9142`.
### ocis-reva storage-oc-data
Start reva storage-oc-data service
Usage: `ocis-reva storage-oc-data [command options] [arguments...]`
--debug-addr | $REVA_STORAGE_OC_DATA_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9165`.
--network | $REVA_STORAGE_OC_DATA_NETWORK
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $REVA_STORAGE_OC_DATA_PROTOCOL
: protocol for reva service, can be 'http' or 'grpc'. Default: `http`.
--addr | $REVA_STORAGE_OC_DATA_ADDR
: Address to bind reva service. Default: `0.0.0.0:9164`.
--url | $REVA_STORAGE_OC_DATA_URL
: URL to use for the reva service. Default: `localhost:9164`.
--driver | $REVA_STORAGE_OC_DATA_DRIVER
: storage driver for oc data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`.
--prefix | $REVA_STORAGE_OC_DATA_PREFIX
: prefix for the http endpoint, without leading slash. Default: `data`.
--temp-folder | $REVA_STORAGE_OC_DATA_TEMP_FOLDER
: temp folder. Default: `/var/tmp/`.
--gateway-url | $REVA_GATEWAY_URL
: URL to use for the reva gateway service. Default: `localhost:9142`.
--users-url | $REVA_USERS_URL
: URL to use for the reva service. Default: `localhost:9144`.
### ocis-reva users
Start reva users service
Usage: `ocis-reva users [command options] [arguments...]`
--debug-addr | $REVA_SHARING_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9145`.
--network | $REVA_USERS_NETWORK
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $REVA_USERS_PROTOCOL
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $REVA_USERS_ADDR
: Address to bind reva service. Default: `0.0.0.0:9144`.
--url | $REVA_USERS_URL
: URL to use for the reva service. Default: `localhost:9144`.
--driver | $REVA_USERS_DRIVER
: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`.
--json-config | $REVA_USERS_JSON
: Path to users.json file.
--rest-client-id | $REVA_REST_CLIENT_ID
: User rest driver Client ID.
--rest-client-secret | $REVA_REST_CLIENT_SECRET
: User rest driver Client Secret.
--rest-redis-address | $REVA_REST_REDIS_ADDRESS
: Address for redis server. Default: `localhost:6379`.
--rest-redis-username | $REVA_REST_REDIS_USERNAME
: Username for redis server.
--rest-redis-password | $REVA_REST_REDIS_PASSWORD
: Password for redis server.
--rest-id-provider | $REVA_REST_ID_PROVIDER
: The OIDC Provider.
--rest-api-base-url | $REVA_REST_API_BASE_URL
: Base API Endpoint.
--rest-oidc-token-endpoint | $REVA_REST_OIDC_TOKEN_ENDPOINT
: Endpoint to generate token to access the API.
--rest-target-api | $REVA_REST_TARGET_API
: The target application.
### ocis-reva auth-bearer
Start reva authprovider for bearer auth
Usage: `ocis-reva auth-bearer [command options] [arguments...]`
--debug-addr | $REVA_AUTH_BEARER_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9149`.
--oidc-issuer | $REVA_OIDC_ISSUER
: OIDC issuer. Default: `https://localhost:9200`.
--oidc-insecure | $REVA_OIDC_INSECURE
: OIDC allow insecure communication. Default: `true`.
--oidc-id-claim | $REVA_OIDC_ID_CLAIM
: OIDC id claim. Default: `preferred_username`.
--oidc-uid-claim | $REVA_OIDC_UID_CLAIM
: OIDC uid claim.
--oidc-gid-claim | $REVA_OIDC_GID_CLAIM
: OIDC gid claim.
--network | $REVA_AUTH_BEARER_NETWORK
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $REVA_AUTH_BEARER_PROTOCOL
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $REVA_AUTH_BEARER_ADDR
: Address to bind reva service. Default: `0.0.0.0:9148`.
--url | $REVA_AUTH_BEARER_URL
: URL to use for the reva service. Default: `localhost:9148`.
### ocis-reva gateway
Start reva gateway
@@ -390,149 +234,35 @@ Usage: `ocis-reva gateway [command options] [arguments...]`
--storage-public-link-mount-path | $REVA_STORAGE_PUBLIC_LINK_MOUNT_PATH
: mount path. Default: `/public/`.
### ocis-reva storage-oc
### ocis-reva sharing
Start reva storage-oc service
Start reva sharing service
Usage: `ocis-reva storage-oc [command options] [arguments...]`
Usage: `ocis-reva sharing [command options] [arguments...]`
--debug-addr | $REVA_STORAGE_OC_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9163`.
--debug-addr | $REVA_SHARING_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9151`.
--network | $REVA_STORAGE_OC_NETWORK
--network | $REVA_SHARING_NETWORK
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $REVA_STORAGE_OC_PROTOCOL
--protocol | $REVA_SHARING_PROTOCOL
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $REVA_STORAGE_OC_ADDR
: Address to bind reva service. Default: `0.0.0.0:9162`.
--addr | $REVA_SHARING_ADDR
: Address to bind reva service. Default: `0.0.0.0:9150`.
--url | $REVA_STORAGE_OC_URL
: URL to use for the reva service. Default: `localhost:9162`.
--url | $REVA_SHARING_URL
: URL to use for the reva service. Default: `localhost:9150`.
--driver | $REVA_STORAGE_OC_DRIVER
: storage driver for oc mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`.
--user-driver | $REVA_SHARING_USER_DRIVER
: driver to use for the UserShareProvider. Default: `json`.
--mount-path | $REVA_STORAGE_OC_MOUNT_PATH
: mount path. Default: `/oc`.
--user-json-file | $REVA_SHARING_USER_JSON_FILE
: file used to persist shares for the UserShareProvider. Default: `/var/tmp/reva/shares.json`.
--mount-id | $REVA_STORAGE_OC_MOUNT_ID
: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`.
--expose-data-server | $REVA_STORAGE_OC_EXPOSE_DATA_SERVER
: exposes a dedicated data server. Default: `false`.
--data-server-url | $REVA_STORAGE_OC_DATA_SERVER_URL
: data server url. Default: `http://localhost:9164/data`.
--users-url | $REVA_USERS_URL
: URL to use for the reva service. Default: `localhost:9144`.
### ocis-reva auth-basic
Start reva authprovider for basic auth
Usage: `ocis-reva auth-basic [command options] [arguments...]`
--debug-addr | $REVA_AUTH_BASIC_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9147`.
--auth-driver | $REVA_AUTH_DRIVER
: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`.
--auth-json | $REVA_AUTH_JSON
: Path to users.json file.
--network | $REVA_AUTH_BASIC_NETWORK
: Network to use for the reva auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $REVA_AUTH_BASIC_PROTOCOL
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $REVA_AUTH_BASIC_ADDR
: Address to bind reva service. Default: `0.0.0.0:9146`.
--url | $REVA_AUTH_BASIC_URL
: URL to use for the reva service. Default: `localhost:9146`.
### ocis-reva storage-eos-data
Start reva storage-eos-data service
Usage: `ocis-reva storage-eos-data [command options] [arguments...]`
--debug-addr | $REVA_STORAGE_OC_DATA_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9161`.
--network | $REVA_STORAGE_EOS_DATA_NETWORK
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $REVA_STORAGE_EOS_DATA_PROTOCOL
: protocol for reva service, can be 'http' or 'grpc'. Default: `http`.
--addr | $REVA_STORAGE_EOS_DATA_ADDR
: Address to bind reva service. Default: `0.0.0.0:9160`.
--url | $REVA_STORAGE_EOS_DATA_URL
: URL to use for the reva service. Default: `localhost:9160`.
--driver | $REVA_STORAGE_EOS_DATA_DRIVER
: storage driver for eos data mount: eg. local, eos, owncloud, ocis or s3. Default: `eos`.
--prefix | $REVA_STORAGE_EOS_DATA_PREFIX
: prefix for the http endpoint, without leading slash. Default: `data`.
--temp-folder | $REVA_STORAGE_EOS_DATA_TEMP_FOLDER
: temp folder. Default: `/var/tmp/`.
--gateway-url | $REVA_GATEWAY_URL
: URL to use for the reva gateway service. Default: `localhost:9142`.
--users-url | $REVA_USERS_URL
: URL to use for the reva service. Default: `localhost:9144`.
### ocis-reva storage-home
Start reva storage-home service
Usage: `ocis-reva storage-home [command options] [arguments...]`
--debug-addr | $REVA_STORAGE_HOME_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9155`.
--network | $REVA_STORAGE_HOME_NETWORK
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $REVA_STORAGE_HOME_PROTOCOL
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $REVA_STORAGE_HOME_ADDR
: Address to bind reva service. Default: `0.0.0.0:9154`.
--url | $REVA_STORAGE_HOME_URL
: URL to use for the reva service. Default: `localhost:9154`.
--driver | $REVA_STORAGE_HOME_DRIVER
: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`.
--mount-path | $REVA_STORAGE_HOME_MOUNT_PATH
: mount path. Default: `/home`.
--mount-id | $REVA_STORAGE_HOME_MOUNT_ID
: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`.
--expose-data-server | $REVA_STORAGE_HOME_EXPOSE_DATA_SERVER
: exposes a dedicated data server. Default: `false`.
--data-server-url | $REVA_STORAGE_HOME_DATA_SERVER_URL
: data server url. Default: `http://localhost:9156/data`.
--enable-home | $REVA_STORAGE_HOME_ENABLE_HOME
: enable the creation of home directories. Default: `true`.
--users-url | $REVA_USERS_URL
: URL to use for the reva service. Default: `localhost:9144`.
--public-driver | $REVA_SHARING_PUBLIC_DRIVER
: driver to use for the PublicShareProvider. Default: `json`.
### ocis-reva storage-home-data
@@ -582,6 +312,201 @@ Usage: `ocis-reva health [command options] [arguments...]`
--debug-addr | $REVA_DEBUG_ADDR
: Address to debug endpoint. Default: `0.0.0.0:9109`.
### ocis-reva storage-home
Start reva storage-home service
Usage: `ocis-reva storage-home [command options] [arguments...]`
--debug-addr | $REVA_STORAGE_HOME_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9155`.
--network | $REVA_STORAGE_HOME_NETWORK
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $REVA_STORAGE_HOME_PROTOCOL
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $REVA_STORAGE_HOME_ADDR
: Address to bind reva service. Default: `0.0.0.0:9154`.
--url | $REVA_STORAGE_HOME_URL
: URL to use for the reva service. Default: `localhost:9154`.
--driver | $REVA_STORAGE_HOME_DRIVER
: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`.
--mount-path | $REVA_STORAGE_HOME_MOUNT_PATH
: mount path. Default: `/home`.
--mount-id | $REVA_STORAGE_HOME_MOUNT_ID
: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`.
--expose-data-server | $REVA_STORAGE_HOME_EXPOSE_DATA_SERVER
: exposes a dedicated data server. Default: `false`.
--data-server-url | $REVA_STORAGE_HOME_DATA_SERVER_URL
: data server url. Default: `http://localhost:9156/data`.
--enable-home | $REVA_STORAGE_HOME_ENABLE_HOME
: enable the creation of home directories. Default: `true`.
--users-url | $REVA_USERS_URL
: URL to use for the reva service. Default: `localhost:9144`.
### ocis-reva storage-eos-data
Start reva storage-eos-data service
Usage: `ocis-reva storage-eos-data [command options] [arguments...]`
--debug-addr | $REVA_STORAGE_OC_DATA_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9161`.
--network | $REVA_STORAGE_EOS_DATA_NETWORK
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $REVA_STORAGE_EOS_DATA_PROTOCOL
: protocol for reva service, can be 'http' or 'grpc'. Default: `http`.
--addr | $REVA_STORAGE_EOS_DATA_ADDR
: Address to bind reva service. Default: `0.0.0.0:9160`.
--url | $REVA_STORAGE_EOS_DATA_URL
: URL to use for the reva service. Default: `localhost:9160`.
--driver | $REVA_STORAGE_EOS_DATA_DRIVER
: storage driver for eos data mount: eg. local, eos, owncloud, ocis or s3. Default: `eos`.
--prefix | $REVA_STORAGE_EOS_DATA_PREFIX
: prefix for the http endpoint, without leading slash. Default: `data`.
--temp-folder | $REVA_STORAGE_EOS_DATA_TEMP_FOLDER
: temp folder. Default: `/var/tmp/`.
--gateway-url | $REVA_GATEWAY_URL
: URL to use for the reva gateway service. Default: `localhost:9142`.
--users-url | $REVA_USERS_URL
: URL to use for the reva service. Default: `localhost:9144`.
### ocis-reva reva-storage-public-link
Start reva storage-public-link service
Usage: `ocis-reva reva-storage-public-link [command options] [arguments...]`
--debug-addr | $REVA_STORAGE_PUBLIC_LINK_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9179`.
--network | $REVA_STORAGE_PUBLIC_LINK_NETWORK
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $REVA_STORAGE_PUBLIC_LINK_PROTOCOL
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $REVA_STORAGE_PUBLIC_LINK_ADDR
: Address to bind reva service. Default: `0.0.0.0:9178`.
--url | $REVA_STORAGE_PUBLIC_LINK_URL
: Address to bind reva service. Default: `localhost:9178`.
--mount-path | $REVA_STORAGE_PUBLIC_LINK_MOUNT_PATH
: mount path. Default: `/public/`.
--gateway-url | $REVA_GATEWAY_URL
: URL to use for the reva gateway service. Default: `localhost:9142`.
### ocis-reva users
Start reva users service
Usage: `ocis-reva users [command options] [arguments...]`
--debug-addr | $REVA_SHARING_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9145`.
--network | $REVA_USERS_NETWORK
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $REVA_USERS_PROTOCOL
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $REVA_USERS_ADDR
: Address to bind reva service. Default: `0.0.0.0:9144`.
--url | $REVA_USERS_URL
: URL to use for the reva service. Default: `localhost:9144`.
--driver | $REVA_USERS_DRIVER
: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`.
--json-config | $REVA_USERS_JSON
: Path to users.json file.
--rest-client-id | $REVA_REST_CLIENT_ID
: User rest driver Client ID.
--rest-client-secret | $REVA_REST_CLIENT_SECRET
: User rest driver Client Secret.
--rest-redis-address | $REVA_REST_REDIS_ADDRESS
: Address for redis server. Default: `localhost:6379`.
--rest-redis-username | $REVA_REST_REDIS_USERNAME
: Username for redis server.
--rest-redis-password | $REVA_REST_REDIS_PASSWORD
: Password for redis server.
--rest-id-provider | $REVA_REST_ID_PROVIDER
: The OIDC Provider.
--rest-api-base-url | $REVA_REST_API_BASE_URL
: Base API Endpoint.
--rest-oidc-token-endpoint | $REVA_REST_OIDC_TOKEN_ENDPOINT
: Endpoint to generate token to access the API.
--rest-target-api | $REVA_REST_TARGET_API
: The target application.
### ocis-reva auth-bearer
Start reva authprovider for bearer auth
Usage: `ocis-reva auth-bearer [command options] [arguments...]`
--debug-addr | $REVA_AUTH_BEARER_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9149`.
--oidc-issuer | $REVA_OIDC_ISSUER
: OIDC issuer. Default: `https://localhost:9200`.
--oidc-insecure | $REVA_OIDC_INSECURE
: OIDC allow insecure communication. Default: `true`.
--oidc-id-claim | $REVA_OIDC_ID_CLAIM
: OIDC id claim. Default: `preferred_username`.
--oidc-uid-claim | $REVA_OIDC_UID_CLAIM
: OIDC uid claim.
--oidc-gid-claim | $REVA_OIDC_GID_CLAIM
: OIDC gid claim.
--network | $REVA_AUTH_BEARER_NETWORK
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $REVA_AUTH_BEARER_PROTOCOL
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $REVA_AUTH_BEARER_ADDR
: Address to bind reva service. Default: `0.0.0.0:9148`.
--url | $REVA_AUTH_BEARER_URL
: URL to use for the reva service. Default: `localhost:9148`.
### ocis-reva storage-eos
Start reva storage-eos service
@@ -618,6 +543,81 @@ Usage: `ocis-reva storage-eos [command options] [arguments...]`
--data-server-url | $REVA_STORAGE_EOS_DATA_SERVER_URL
: data server url. Default: `http://localhost:9160/data`.
### ocis-reva storage-oc
Start reva storage-oc service
Usage: `ocis-reva storage-oc [command options] [arguments...]`
--debug-addr | $REVA_STORAGE_OC_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9163`.
--network | $REVA_STORAGE_OC_NETWORK
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $REVA_STORAGE_OC_PROTOCOL
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $REVA_STORAGE_OC_ADDR
: Address to bind reva service. Default: `0.0.0.0:9162`.
--url | $REVA_STORAGE_OC_URL
: URL to use for the reva service. Default: `localhost:9162`.
--driver | $REVA_STORAGE_OC_DRIVER
: storage driver for oc mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`.
--mount-path | $REVA_STORAGE_OC_MOUNT_PATH
: mount path. Default: `/oc`.
--mount-id | $REVA_STORAGE_OC_MOUNT_ID
: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`.
--expose-data-server | $REVA_STORAGE_OC_EXPOSE_DATA_SERVER
: exposes a dedicated data server. Default: `false`.
--data-server-url | $REVA_STORAGE_OC_DATA_SERVER_URL
: data server url. Default: `http://localhost:9164/data`.
--users-url | $REVA_USERS_URL
: URL to use for the reva service. Default: `localhost:9144`.
### ocis-reva storage-oc-data
Start reva storage-oc-data service
Usage: `ocis-reva storage-oc-data [command options] [arguments...]`
--debug-addr | $REVA_STORAGE_OC_DATA_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9165`.
--network | $REVA_STORAGE_OC_DATA_NETWORK
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $REVA_STORAGE_OC_DATA_PROTOCOL
: protocol for reva service, can be 'http' or 'grpc'. Default: `http`.
--addr | $REVA_STORAGE_OC_DATA_ADDR
: Address to bind reva service. Default: `0.0.0.0:9164`.
--url | $REVA_STORAGE_OC_DATA_URL
: URL to use for the reva service. Default: `localhost:9164`.
--driver | $REVA_STORAGE_OC_DATA_DRIVER
: storage driver for oc data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`.
--prefix | $REVA_STORAGE_OC_DATA_PREFIX
: prefix for the http endpoint, without leading slash. Default: `data`.
--temp-folder | $REVA_STORAGE_OC_DATA_TEMP_FOLDER
: temp folder. Default: `/var/tmp/`.
--gateway-url | $REVA_GATEWAY_URL
: URL to use for the reva gateway service. Default: `localhost:9142`.
--users-url | $REVA_USERS_URL
: URL to use for the reva service. Default: `localhost:9144`.
### ocis-reva storage-root
Start reva storage-root service
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -1,6 +1,6 @@
---
title: "Configuration"
date: "2020-09-21T12:38:41+0200"
date: "2020-09-21T13:14:51+0200"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis-proxy
geekdocEditPath: edit/master/docs
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
+92 -92
View File
@@ -1,6 +1,6 @@
---
title: "Configuration"
date: "2020-09-21T12:38:19+0200"
date: "2020-09-21T13:14:56+0200"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs
@@ -57,6 +57,15 @@ 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 server
Start fullstack server
@@ -99,106 +108,21 @@ Usage: `ocis server [command options] [arguments...]`
--grpc-addr | $OCIS_GRPC_ADDR
: Address to bind grpc server. Default: `0.0.0.0:9001`.
### ocis health
Check health status
Usage: `ocis health [command options] [arguments...]`
--debug-addr | $OCIS_DEBUG_ADDR
: Address to debug endpoint. Default: `0.0.0.0:9010`.
### 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 reva-users
Start reva users service
#### ocis store
Start a go-micro store
#### ocis thumbnails
Start thumbnails server
#### ocis webdav
Start webdav server
#### ocis reva-storage-home
Start reva storage service for home mount
#### ocis reva-storage-eos-data
Start reva storage data provider for eos mount
#### ocis run
Runs an extension
#### ocis settings
Start settings server
#### ocis reva-frontend
Start reva frontend
#### ocis konnectd
Start konnectd server
#### ocis reva-gateway
#### ocis run
Start reva gateway
Runs an extension
#### ocis reva-storage-eos
#### ocis store
Start reva storage service for eos mount
#### ocis reva-storage-public-link
Start reva public link storage
#### ocis phoenix
Start phoenix server
#### ocis reva-storage-home-data
Start reva storage data provider for home mount
#### ocis reva-storage-oc-data
Start reva storage data provider for oc mount
#### ocis reva-auth-bearer
Start reva auth-bearer service
#### ocis reva-auth-basic
Start reva auth-basic service
#### ocis reva-storage-oc
Start reva storage service for oc mount
#### ocis kill
Kill an extension by name
#### ocis reva-sharing
Start reva sharing service
#### ocis list
Lists running ocis extensions
Start a go-micro store
#### ocis glauth
@@ -208,15 +132,91 @@ Start glauth server
Start ocs server
#### ocis reva-storage-eos-data
Start reva storage data provider for eos mount
#### ocis reva-storage-home-data
Start reva storage data provider for home mount
#### ocis kill
Kill an extension by name
#### ocis proxy
Start proxy server
#### ocis reva-storage-root
#### ocis reva-auth-bearer
Start reva root storage
Start reva auth-bearer service
#### ocis reva-storage-oc-data
Start reva storage data provider for oc mount
#### ocis settings
Start settings server
#### ocis accounts
Start accounts server
#### ocis phoenix
Start phoenix server
#### ocis reva-storage-eos
Start reva storage service for eos mount
#### ocis reva-storage-home
Start reva storage service for home mount
#### ocis reva-storage-oc
Start reva storage service for oc mount
#### ocis reva-storage-root
Start reva root storage
#### ocis reva-gateway
Start reva gateway
#### ocis reva-sharing
Start reva sharing service
#### ocis reva-users
Start reva users service
#### ocis list
Lists running ocis extensions
#### ocis reva-auth-basic
Start reva auth-basic service
#### ocis reva-frontend
Start reva frontend
#### ocis reva-storage-public-link
Start reva public link storage
#### ocis thumbnails
Start thumbnails server
#### ocis webdav
Start webdav server