mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-04-23 04:28:48 -05:00
Code Issues Packages Projects Releases Wiki Activity

remove autogenerated files and add to gitignore

Browse Source
This commit is contained in:
Willy Kloucek
2020-11-12 13:20:03 +01:00
parent b90a6b9a48
commit 8df6d2dc90
8 changed files with 4 additions and 1139 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/extensions/konnectd/.gitignore
+1
View File
@@ -0,0 +1 @@
configuration.md
docs/extensions/konnectd/configuration.md
-176
View File
@@ -1,176 +0,0 @@
---
title: "Configuration"
date: "2020-09-21T13:14:47+0200"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/konnectd
geekdocFilePath: configuration.md
---
{{< toc >}}
## Configuration
oCIS Single Binary is not responsible for configuring extensions. Instead, each extension could either be configured by environment variables, cli flags or config files.
Each extension has its dedicated documentation page (e.g. https://owncloud.github.io/extensions/ocis_proxy/configuration) which lists all possible configurations. Config files and environment variables are picked up if you use the `./bin/ocis server` command within the oCIS single binary. Command line flags must be set explicitly on the extensions subcommands.
### Configuration using config files
Out of the box extensions will attempt to read configuration details from:
```console
/etc/ocis
$HOME/.ocis
./config
```
For this configuration to be picked up, have a look at your extension `root` command and look for which default config name it has assigned. *i.e: ocis-proxy reads `proxy.json | yaml | toml ...`*.
So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis/tree/master/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/ocis.yml`, `${HOME}/.ocis/ocis.yml` or `$(pwd)/config/ocis.yml`.
### Envrionment variables
If you prefer to configure the service with environment variables you can see the available variables below.
### Commandline flags
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.
## Root Command
Serve Konnectd API for oCIS
Usage: `ocis-konnectd [global options] command [command options] [arguments...]`
--config-file | $KONNECTD_CONFIG_FILE
: Path to config file.
--log-level | $KONNECTD_LOG_LEVEL
: Set logging level. Default: `info`.
--log-pretty | $KONNECTD_LOG_PRETTY
: Enable pretty logging. Default: `true`.
--log-color | $KONNECTD_LOG_COLOR
: Enable colored logging. Default: `true`.
## Sub Commands
### ocis-konnectd health
Check health status
Usage: `ocis-konnectd health [command options] [arguments...]`
--debug-addr | $KONNECTD_DEBUG_ADDR
: Address to debug endpoint. Default: `0.0.0.0:9134`.
### ocis-konnectd server
Start integrated server
Usage: `ocis-konnectd server [command options] [arguments...]`
--tracing-enabled | $KONNECTD_TRACING_ENABLED
: Enable sending traces.
--tracing-type | $KONNECTD_TRACING_TYPE
: Tracing backend type. Default: `jaeger`.
--tracing-endpoint | $KONNECTD_TRACING_ENDPOINT
: Endpoint for the agent.
--tracing-collector | $KONNECTD_TRACING_COLLECTOR
: Endpoint for the collector.
--tracing-service | $KONNECTD_TRACING_SERVICE
: Service name for tracing. Default: `konnectd`.
--debug-addr | $KONNECTD_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9134`.
--debug-token | $KONNECTD_DEBUG_TOKEN
: Token to grant metrics access.
--debug-pprof | $KONNECTD_DEBUG_PPROF
: Enable pprof debugging.
--debug-zpages | $KONNECTD_DEBUG_ZPAGES
: Enable zpages debugging.
--http-addr | $KONNECTD_HTTP_ADDR
: Address to bind http server. Default: `0.0.0.0:9130`.
--http-root | $KONNECTD_HTTP_ROOT
: Root path of http server. Default: `/`.
--http-namespace | $KONNECTD_HTTP_NAMESPACE
: Set the base namespace for service discovery. Default: `com.owncloud.web`.
--identity-manager | $KONNECTD_IDENTITY_MANAGER
: Identity manager (one of ldap,kc,cookie,dummy). Default: `ldap`.
--transport-tls-cert | $KONNECTD_TRANSPORT_TLS_CERT
: Certificate file for transport encryption.
--transport-tls-key | $KONNECTD_TRANSPORT_TLS_KEY
: Secret file for transport encryption.
--iss | $KONNECTD_ISS
: OIDC issuer URL. Default: `https://localhost:9200`.
--signing-kid | $KONNECTD_SIGNING_KID
: Value of kid field to use in created tokens (uniquely identifying the signing-private-key).
--validation-keys-path | $KONNECTD_VALIDATION_KEYS_PATH
: Full path to a folder containg PEM encoded private or public key files used for token validaton (file name without extension is used as kid).
--encryption-secret | $KONNECTD_ENCRYPTION_SECRET
: Full path to a file containing a %d bytes secret key.
--signing-method | $KONNECTD_SIGNING_METHOD
: JWT default signing method. Default: `PS256`.
--uri-base-path | $KONNECTD_URI_BASE_PATH
: Custom base path for URI endpoints.
--sign-in-uri | $KONNECTD_SIGN_IN_URI
: Custom redirection URI to sign-in form.
--signed-out-uri | $KONNECTD_SIGN_OUT_URI
: Custom redirection URI to signed-out goodbye page.
--authorization-endpoint-uri | $KONNECTD_ENDPOINT_URI
: Custom authorization endpoint URI.
--endsession-endpoint-uri | $KONNECTD_ENDSESSION_ENDPOINT_URI
: Custom endsession endpoint URI.
--asset-path | $KONNECTD_ASSET_PATH
: Path to custom assets.
--identifier-client-path | $KONNECTD_IDENTIFIER_CLIENT_PATH
: Path to the identifier web client base folder. Default: `/var/tmp/konnectd`.
--identifier-registration-conf | $KONNECTD_IDENTIFIER_REGISTRATION_CONF
: Path to a identifier-registration.yaml configuration file. Default: `./config/identifier-registration.yaml`.
--identifier-scopes-conf | $KONNECTD_IDENTIFIER_SCOPES_CONF
: Path to a scopes.yaml configuration file.
--insecure | $KONNECTD_INSECURE
: Disable TLS certificate and hostname validation.
--tls | $KONNECTD_TLS
: Use TLS (disable only if konnectd is behind a TLS-terminating reverse-proxy).. Default: `false`.
--allow-client-guests | $KONNECTD_ALLOW_CLIENT_GUESTS
: Allow sign in of client controlled guest users.
--allow-dynamic-client-registration | $KONNECTD_ALLOW_DYNAMIC_CLIENT_REGISTRATION
: Allow dynamic OAuth2 client registration.
--disable-identifier-webapp | $KONNECTD_DISABLE_IDENTIFIER_WEBAPP
: Disable built-in identifier-webapp to use a frontend hosted elsewhere.. Default: `true`.
docs/extensions/proxy/.gitignore
+1
View File
@@ -0,0 +1 @@
configuration.md
docs/extensions/proxy/configuration.md
-134
View File
@@ -1,134 +0,0 @@
---
title: "Configuration"
date: "2020-09-21T13:14:51+0200"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/proxy
geekdocFilePath: configuration.md
---
{{< toc >}}
## Configuration
oCIS Single Binary is not responsible for configuring extensions. Instead, each extension could either be configured by environment variables, cli flags or config files.
Each extension has its dedicated documentation page (e.g. https://owncloud.github.io/extensions/ocis_proxy/configuration) which lists all possible configurations. Config files and environment variables are picked up if you use the `./bin/ocis server` command within the oCIS single binary. Command line flags must be set explicitly on the extensions subcommands.
### Configuration using config files
Out of the box extensions will attempt to read configuration details from:
```console
/etc/ocis
$HOME/.ocis
./config
```
For this configuration to be picked up, have a look at your extension `root` command and look for which default config name it has assigned. *i.e: ocis-proxy reads `proxy.json | yaml | toml ...`*.
So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis/tree/master/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/ocis.yml`, `${HOME}/.ocis/ocis.yml` or `$(pwd)/config/ocis.yml`.
### Envrionment variables
If you prefer to configure the service with environment variables you can see the available variables below.
### Commandline flags
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.
## Root Command
proxy for Reva/oCIS
Usage: `ocis-proxy [global options] command [command options] [arguments...]`
--config-file | $PROXY_CONFIG_FILE
: Path to config file.
--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`.
## Sub Commands
### ocis-proxy health
Check health status
Usage: `ocis-proxy health [command options] [arguments...]`
--debug-addr | $PROXY_DEBUG_ADDR
: Address to debug endpoint. Default: `0.0.0.0:9109`.
### ocis-proxy server
Start integrated server
Usage: `ocis-proxy server [command options] [arguments...]`
--tracing-enabled | $PROXY_TRACING_ENABLED
: Enable sending traces.
--tracing-type | $PROXY_TRACING_TYPE
: Tracing backend type. Default: `jaeger`.
--tracing-endpoint | $PROXY_TRACING_ENDPOINT
: Endpoint for the agent.
--tracing-collector | $PROXY_TRACING_COLLECTOR
: Endpoint for the collector. Default: `http://localhost:14268/api/traces`.
--tracing-service | $PROXY_TRACING_SERVICE
: Service name for tracing. Default: `proxy`.
--debug-addr | $PROXY_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9205`.
--debug-token | $PROXY_DEBUG_TOKEN
: Token to grant metrics access.
--debug-pprof | $PROXY_DEBUG_PPROF
: Enable pprof debugging.
--debug-zpages | $PROXY_DEBUG_ZPAGES
: Enable zpages debugging.
--http-addr | $PROXY_HTTP_ADDR
: Address to bind http server. Default: `0.0.0.0:9200`.
--http-root | $PROXY_HTTP_ROOT
: Root path of http server. Default: `/`.
--asset-path | $PROXY_ASSET_PATH
: Path to custom assets.
--http-namespace | $PROXY_HTTP_NAMESPACE
: Set the base namespace for the http namespace. Default: `com.owncloud`.
--transport-tls-cert | $PROXY_TRANSPORT_TLS_CERT
: Certificate file for transport encryption.
--transport-tls-key | $PROXY_TRANSPORT_TLS_KEY
: Secret file for transport encryption.
--tls | $PROXY_TLS
: Use TLS (disable only if proxy is behind a TLS-terminating reverse-proxy).. Default: `true`.
--jwt-secret | $PROXY_JWT_SECRET
: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `Pive-Fumkiu4`.
--reva-gateway-addr | $PROXY_REVA_GATEWAY_ADDR
: REVA Gateway Endpoint. Default: `127.0.0.1:9142`.
--oidc-issuer | $PROXY_OIDC_ISSUER
: OIDC issuer. Default: `https://localhost:9200`.
--oidc-insecure | $PROXY_OIDC_INSECURE
: OIDC allow insecure communication. Default: `true`.
docs/extensions/storage/.gitignore
+1
View File
@@ -0,0 +1 @@
configuration.md
docs/extensions/storage/configuration.md
-704
View File
@@ -1,704 +0,0 @@
---
title: "Configuration"
date: "2020-10-05T21:57:18+0200"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/storage
geekdocFilePath: configuration.md
---
{{< toc >}}
## Configuration
oCIS Single Binary is not responsible for configuring extensions. Instead, each extension could either be configured by environment variables, cli flags or config files.
Each extension has its dedicated documentation page (e.g. https://owncloud.github.io/extensions/ocis_proxy/configuration) which lists all possible configurations. Config files and environment variables are picked up if you use the `./bin/ocis server` command within the oCIS single binary. Command line flags must be set explicitly on the extensions subcommands.
### Configuration using config files
Out of the box extensions will attempt to read configuration details from:
```console
/etc/ocis
$HOME/.ocis
./config
```
For this configuration to be picked up, have a look at your extension `root` command and look for which default config name it has assigned. *i.e: ocis-proxy reads `proxy.json | yaml | toml ...`*.
So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis/tree/master/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/ocis.yml`, `${HOME}/.ocis/ocis.yml` or `$(pwd)/config/ocis.yml`.
### Envrionment variables
If you prefer to configure the service with environment variables you can see the available variables below.
### Commandline flags
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.
## Root Command
Storage service for oCIS
Usage: `storage [global options] command [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.
## Sub Commands
### 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_NETWORK
: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $STORAGE_SHARING_PROTOCOL
: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $STORAGE_SHARING_ADDR
: Address to bind storage service. Default: `0.0.0.0:9150`.
--url | $STORAGE_SHARING_URL
: URL to use for the storage service. Default: `localhost: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-eos
Start storage-eos service
Usage: `storage storage-eos [command options] [arguments...]`
--debug-addr | $STORAGE_STORAGE_EOS_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9159`.
--network | $STORAGE_STORAGE_EOS_NETWORK
: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $STORAGE_STORAGE_EOS_PROTOCOL
: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $STORAGE_STORAGE_EOS_ADDR
: Address to bind storage service. Default: `0.0.0.0:9158`.
--url | $STORAGE_STORAGE_EOS_URL
: URL to use for the storage service. Default: `localhost:9158`.
--driver | $STORAGE_STORAGE_EOS_DRIVER
: storage driver for eos mount: eg. local, eos, owncloud, ocis or s3. Default: `eos`.
--mount-path | $STORAGE_STORAGE_EOS_MOUNT_PATH
: mount path. Default: `/eos`.
--mount-id | $STORAGE_STORAGE_EOS_MOUNT_ID
: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009158`.
--expose-data-server | $STORAGE_STORAGE_EOS_EXPOSE_DATA_SERVER
: exposes a dedicated data server. Default: `false`.
--data-server-url | $STORAGE_STORAGE_EOS_DATA_SERVER_URL
: data server url. Default: `http://localhost:9160/data`.
### 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_USERS_NETWORK
: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $STORAGE_USERS_PROTOCOL
: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $STORAGE_USERS_ADDR
: Address to bind storage service. Default: `0.0.0.0:9144`.
--url | $STORAGE_USERS_URL
: URL to use for the storage service. Default: `localhost:9144`.
--driver | $STORAGE_USERS_DRIVER
: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`.
--json-config | $STORAGE_USERS_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 gateway
Start gateway
Usage: `storage gateway [command options] [arguments...]`
--debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9143`.
--transfer-secret | $STORAGE_TRANSFER_SECRET
: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`.
--network | $STORAGE_GATEWAY_NETWORK
: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $STORAGE_GATEWAY_PROTOCOL
: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $STORAGE_GATEWAY_ADDR
: Address to bind storage service. Default: `0.0.0.0:9142`.
--url | $STORAGE_GATEWAY_URL
: URL to use for the storage service. Default: `localhost:9142`.
--commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT
: Commit shares to the share manager. Default: `true`.
--commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF
: Commit shares to the storage. Default: `true`.
--share-folder | $STORAGE_GATEWAY_SHARE_FOLDER
: mount shares in this folder of the home storage provider. Default: `Shares`.
--disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN
: Disable creation of home folder on login.
--storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER
: driver of the storage registry. Default: `static`.
--storage-home-provider | $STORAGE_STORAGE_HOME_PROVIDER
: mount point of the storage provider for user homes in the global namespace. Default: `/home`.
--frontend-url | $STORAGE_FRONTEND_URL
: URL to use for the storage service. Default: `https://localhost:9200`.
--datagateway-url | $STORAGE_DATAGATEWAY_URL
: URL to use for the storage datagateway. Default: `https://localhost:9200/data`.
--users-url | $STORAGE_USERS_URL
: URL to use for the storage service. Default: `localhost:9144`.
--auth-basic-url | $STORAGE_AUTH_BASIC_URL
: URL to use for the storage service. Default: `localhost:9146`.
--auth-bearer-url | $STORAGE_AUTH_BEARER_URL
: URL to use for the storage service. Default: `localhost:9148`.
--sharing-url | $STORAGE_SHARING_URL
: URL to use for the storage service. Default: `localhost:9150`.
--storage-root-url | $STORAGE_STORAGE_ROOT_URL
: URL to use for the storage service. Default: `localhost:9152`.
--storage-root-mount-path | $STORAGE_STORAGE_ROOT_MOUNT_PATH
: mount path. Default: `/`.
--storage-root-mount-id | $STORAGE_STORAGE_ROOT_MOUNT_ID
: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009152`.
--storage-home-url | $STORAGE_STORAGE_HOME_URL
: URL to use for the storage service. Default: `localhost:9154`.
--storage-home-mount-path | $STORAGE_STORAGE_HOME_MOUNT_PATH
: mount path. Default: `/home`.
--storage-home-mount-id | $STORAGE_STORAGE_HOME_MOUNT_ID
: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009154`.
--storage-eos-url | $STORAGE_STORAGE_EOS_URL
: URL to use for the storage service. Default: `localhost:9158`.
--storage-eos-mount-path | $STORAGE_STORAGE_EOS_MOUNT_PATH
: mount path. Default: `/eos`.
--storage-eos-mount-id | $STORAGE_STORAGE_EOS_MOUNT_ID
: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009158`.
--storage-oc-url | $STORAGE_STORAGE_OC_URL
: URL to use for the storage service. Default: `localhost:9162`.
--storage-oc-mount-path | $STORAGE_STORAGE_OC_MOUNT_PATH
: mount path. Default: `/oc`.
--storage-oc-mount-id | $STORAGE_STORAGE_OC_MOUNT_ID
: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`.
--public-link-url | $STORAGE_STORAGE_PUBLIC_LINK_URL
: URL to use for the public links service. Default: `localhost:9178`.
--storage-public-link-mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH
: mount path. Default: `/public/`.
### 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 storage-home
Start storage-home service
Usage: `storage storage-home [command options] [arguments...]`
--debug-addr | $STORAGE_STORAGE_HOME_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9155`.
--network | $STORAGE_STORAGE_HOME_NETWORK
: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $STORAGE_STORAGE_HOME_PROTOCOL
: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $STORAGE_STORAGE_HOME_ADDR
: Address to bind storage service. Default: `0.0.0.0:9154`.
--url | $STORAGE_STORAGE_HOME_URL
: URL to use for the storage service. Default: `localhost:9154`.
--driver | $STORAGE_STORAGE_HOME_DRIVER
: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`.
--mount-path | $STORAGE_STORAGE_HOME_MOUNT_PATH
: mount path. Default: `/home`.
--mount-id | $STORAGE_STORAGE_HOME_MOUNT_ID
: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`.
--expose-data-server | $STORAGE_STORAGE_HOME_EXPOSE_DATA_SERVER
: exposes a dedicated data server. Default: `false`.
--data-server-url | $STORAGE_STORAGE_HOME_DATA_SERVER_URL
: data server url. Default: `http://localhost:9156/data`.
--enable-home | $STORAGE_STORAGE_HOME_ENABLE_HOME
: enable the creation of home directories. Default: `true`.
--users-url | $STORAGE_USERS_URL
: URL 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_STORAGE_METADATA_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9217`.
--network | $STORAGE_STORAGE_METADATA_NETWORK
: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--provider-addr | $STORAGE_STORAGE_METADATA_PROVIDER_ADDR
: Address to bind storage service. Default: `0.0.0.0:9215`.
--data-server-url | $STORAGE_STORAGE_METADATA_DATA_SERVER_URL
: URL of the data-server the storage-provider uses. Default: `http://localhost:9216`.
--data-server-addr | $STORAGE_STORAGE_METADATA_DATA_SERVER_ADDR
: Address to bind the metadata data-server to. Default: `0.0.0.0:9216`.
--storage-provider-driver | $STORAGE_STORAGE_METADATA_PROVIDER_DRIVER
: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `local`.
--data-provider-driver | $STORAGE_STORAGE_METADATA_DATA_PROVIDER_DRIVER
: storage driver for data-provider mount: eg. local, eos, owncloud, ocis or s3. Default: `local`.
--storage-root | $STORAGE_STORAGE_METADATA_ROOT
: the path to the metadata storage root. Default: `/var/tmp/ocis/metadata`.
### storage storage-oc
Start storage-oc service
Usage: `storage storage-oc [command options] [arguments...]`
--debug-addr | $STORAGE_STORAGE_OC_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9163`.
--network | $STORAGE_STORAGE_OC_NETWORK
: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $STORAGE_STORAGE_OC_PROTOCOL
: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $STORAGE_STORAGE_OC_ADDR
: Address to bind storage service. Default: `0.0.0.0:9162`.
--url | $STORAGE_STORAGE_OC_URL
: URL to use for the storage service. Default: `localhost:9162`.
--driver | $STORAGE_STORAGE_OC_DRIVER
: storage driver for oc mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`.
--mount-path | $STORAGE_STORAGE_OC_MOUNT_PATH
: mount path. Default: `/oc`.
--mount-id | $STORAGE_STORAGE_OC_MOUNT_ID
: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`.
--expose-data-server | $STORAGE_STORAGE_OC_EXPOSE_DATA_SERVER
: exposes a dedicated data server. Default: `false`.
--data-server-url | $STORAGE_STORAGE_OC_DATA_SERVER_URL
: data server url. Default: `http://localhost:9164/data`.
--users-url | $STORAGE_USERS_URL
: URL to use for the storage service. Default: `localhost:9144`.
### storage storage-oc-data
Start storage-oc-data service
Usage: `storage storage-oc-data [command options] [arguments...]`
--debug-addr | $STORAGE_STORAGE_OC_DATA_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9165`.
--network | $STORAGE_STORAGE_OC_DATA_NETWORK
: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $STORAGE_STORAGE_OC_DATA_PROTOCOL
: protocol for storage service, can be 'http' or 'grpc'. Default: `http`.
--addr | $STORAGE_STORAGE_OC_DATA_ADDR
: Address to bind storage service. Default: `0.0.0.0:9164`.
--url | $STORAGE_STORAGE_OC_DATA_URL
: URL to use for the storage service. Default: `localhost:9164`.
--driver | $STORAGE_STORAGE_OC_DATA_DRIVER
: storage driver for oc data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`.
--prefix | $STORAGE_STORAGE_OC_DATA_PREFIX
: prefix for the http endpoint, without leading slash. Default: `data`.
--temp-folder | $STORAGE_STORAGE_OC_DATA_TEMP_FOLDER
: temp folder. Default: `/var/tmp/`.
--gateway-url | $STORAGE_GATEWAY_URL
: URL to use for the storage gateway service. Default: `localhost:9142`.
--users-url | $STORAGE_USERS_URL
: URL to use for the storage service. Default: `localhost:9144`.
### storage storage-public-link
Start storage-public-link service
Usage: `storage storage-public-link [command options] [arguments...]`
--debug-addr | $STORAGE_STORAGE_PUBLIC_LINK_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9179`.
--network | $STORAGE_STORAGE_PUBLIC_LINK_NETWORK
: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $STORAGE_STORAGE_PUBLIC_LINK_PROTOCOL
: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $STORAGE_STORAGE_PUBLIC_LINK_ADDR
: Address to bind storage service. Default: `0.0.0.0:9178`.
--url | $STORAGE_STORAGE_PUBLIC_LINK_URL
: Address to bind storage service. Default: `localhost:9178`.
--mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH
: mount path. Default: `/public/`.
--gateway-url | $STORAGE_GATEWAY_URL
: URL to use for the storage gateway service. Default: `localhost:9142`.
### 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_NETWORK
: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $STORAGE_AUTH_BEARER_PROTOCOL
: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $STORAGE_AUTH_BEARER_ADDR
: Address to bind storage service. Default: `0.0.0.0:9148`.
--url | $STORAGE_AUTH_BEARER_URL
: URL to use for the storage service. Default: `localhost:9148`.
### storage frontend
Start frontend service
Usage: `storage frontend [command options] [arguments...]`
--debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9141`.
--transfer-secret | $STORAGE_TRANSFER_SECRET
: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`.
--webdav-namespace | $WEBDAV_NAMESPACE
: Namespace prefix for the /webdav endpoint. Default: `/home/`.
--dav-files-namespace | $DAV_FILES_NAMESPACE
: Namespace prefix for the webdav /dav/files endpoint. Default: `/oc/`.
--network | $STORAGE_FRONTEND_NETWORK
: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $STORAGE_FRONTEND_PROTOCOL
: protocol for storage service, can be 'http' or 'grpc'. Default: `http`.
--addr | $STORAGE_FRONTEND_ADDR
: Address to bind storage service. Default: `0.0.0.0:9140`.
--url | $STORAGE_FRONTEND_URL
: URL to use for the storage service. Default: `https://localhost:9200`.
--datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX
: datagateway prefix. Default: `data`.
--ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX
: owncloud webdav endpoint prefix.
--ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX
: open collaboration services endpoint prefix. Default: `ocs`.
--gateway-url | $STORAGE_GATEWAY_URL
: URL to use for the storage gateway service. Default: `localhost:9142`.
--upload-disable-tus | $STORAGE_FRONTEND_UPLOAD_DISABLE_TUS
: Disables TUS upload mechanism. Default: `false`.
--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 auth-basic
Start authprovider for basic auth
Usage: `storage auth-basic [command options] [arguments...]`
--debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9147`.
--auth-driver | $STORAGE_AUTH_DRIVER
: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`.
--auth-json | $STORAGE_AUTH_JSON
: Path to users.json file.
--network | $STORAGE_AUTH_BASIC_NETWORK
: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $STORAGE_AUTH_BASIC_PROTOCOL
: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $STORAGE_AUTH_BASIC_ADDR
: Address to bind storage service. Default: `0.0.0.0:9146`.
--url | $STORAGE_AUTH_BASIC_URL
: URL to use for the storage service. Default: `localhost:9146`.
### 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 storage-eos-data
Start storage-eos-data service
Usage: `storage storage-eos-data [command options] [arguments...]`
--debug-addr | $STORAGE_STORAGE_OC_DATA_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9161`.
--network | $STORAGE_STORAGE_EOS_DATA_NETWORK
: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $STORAGE_STORAGE_EOS_DATA_PROTOCOL
: protocol for storage service, can be 'http' or 'grpc'. Default: `http`.
--addr | $STORAGE_STORAGE_EOS_DATA_ADDR
: Address to bind storage service. Default: `0.0.0.0:9160`.
--url | $STORAGE_STORAGE_EOS_DATA_URL
: URL to use for the storage service. Default: `localhost:9160`.
--driver | $STORAGE_STORAGE_EOS_DATA_DRIVER
: storage driver for eos data mount: eg. local, eos, owncloud, ocis or s3. Default: `eos`.
--prefix | $STORAGE_STORAGE_EOS_DATA_PREFIX
: prefix for the http endpoint, without leading slash. Default: `data`.
--temp-folder | $STORAGE_STORAGE_EOS_DATA_TEMP_FOLDER
: temp folder. Default: `/var/tmp/`.
--gateway-url | $STORAGE_GATEWAY_URL
: URL to use for the storage gateway service. Default: `localhost:9142`.
--users-url | $STORAGE_USERS_URL
: URL to use for the storage service. Default: `localhost:9144`.
### storage storage-home-data
Start storage-home-data service
Usage: `storage storage-home-data [command options] [arguments...]`
--debug-addr | $STORAGE_STORAGE_HOME_DATA_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9157`.
--network | $STORAGE_STORAGE_HOME_DATA_NETWORK
: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $STORAGE_STORAGE_HOME_DATA_PROTOCOL
: protocol for storage service, can be 'http' or 'grpc'. Default: `http`.
--addr | $STORAGE_STORAGE_HOME_DATA_ADDR
: Address to bind storage service. Default: `0.0.0.0:9156`.
--url | $STORAGE_STORAGE_HOME_DATA_URL
: URL to use for the storage service. Default: `localhost:9156`.
--driver | $STORAGE_STORAGE_HOME_DATA_DRIVER
: storage driver for home data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`.
--prefix | $STORAGE_STORAGE_HOME_DATA_PREFIX
: prefix for the http endpoint, without leading slash. Default: `data`.
--temp-folder | $STORAGE_STORAGE_HOME_DATA_TEMP_FOLDER
: temp folder. Default: `/var/tmp/`.
--enable-home | $STORAGE_STORAGE_HOME_ENABLE_HOME
: enable the creation of home directories. Default: `true`.
--gateway-url | $STORAGE_GATEWAY_URL
: URL to use for the storage gateway service. Default: `localhost:9142`.
--users-url | $STORAGE_USERS_URL
: URL to use for the storage service. Default: `localhost:9144`.
### storage storage-root
Start storage-root service
Usage: `storage storage-root [command options] [arguments...]`
--debug-addr | $STORAGE_STORAGE_ROOT_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9153`.
--network | $STORAGE_STORAGE_ROOT_NETWORK
: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
--protocol | $STORAGE_STORAGE_ROOT_PROTOCOL
: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`.
--addr | $STORAGE_STORAGE_ROOT_ADDR
: Address to bind storage service. Default: `0.0.0.0:9152`.
--url | $STORAGE_STORAGE_ROOT_URL
: URL to use for the storage service. Default: `localhost:9152`.
--driver | $STORAGE_STORAGE_ROOT_DRIVER
: storage driver for root mount: eg. local, eos, owncloud, ocis or s3. Default: `local`.
--mount-path | $STORAGE_STORAGE_ROOT_MOUNT_PATH
: mount path. Default: `/`.
--mount-id | $STORAGE_STORAGE_ROOT_MOUNT_ID
: mount id. Default: `123e4567-e89b-12d3-a456-426655440001`.
--expose-data-server | $STORAGE_STORAGE_ROOT_EXPOSE_DATA_SERVER
: exposes a dedicated data server.
--data-server-url | $STORAGE_STORAGE_ROOT_DATA_SERVER_URL
: data server url.
docs/extensions/webdav/.gitignore
+1
View File
@@ -0,0 +1 @@
configuration.md
docs/extensions/webdav/configuration.md
-125
View File
@@ -1,125 +0,0 @@
---
title: "Configuration"
date: "2020-09-30T22:51:03+0200"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/webdav
geekdocFilePath: configuration.md
---
{{< toc >}}
## Configuration
oCIS Single Binary is not responsible for configuring extensions. Instead, each extension could either be configured by environment variables, cli flags or config files.
Each extension has its dedicated documentation page (e.g. https://owncloud.github.io/extensions/ocis_proxy/configuration) which lists all possible configurations. Config files and environment variables are picked up if you use the `./bin/ocis server` command within the oCIS single binary. Command line flags must be set explicitly on the extensions subcommands.
### Configuration using config files
Out of the box extensions will attempt to read configuration details from:
```console
/etc/ocis
$HOME/.ocis
./config
```
For this configuration to be picked up, have a look at your extension `root` command and look for which default config name it has assigned. *i.e: ocis-proxy reads `proxy.json | yaml | toml ...`*.
So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis/tree/master/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/ocis.yml`, `${HOME}/.ocis/ocis.yml` or `$(pwd)/config/ocis.yml`.
### Envrionment variables
If you prefer to configure the service with environment variables you can see the available variables below.
### Commandline flags
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.
## Root Command
Serve WebDAV API for oCIS
Usage: `webdav [global options] command [command options] [arguments...]`
--config-file | $WEBDAV_CONFIG_FILE
: Path to config file.
--log-level | $WEBDAV_LOG_LEVEL
: Set logging level. Default: `info`.
--log-pretty | $WEBDAV_LOG_PRETTY
: Enable pretty logging. Default: `true`.
--log-color | $WEBDAV_LOG_COLOR
: Enable colored logging. Default: `true`.
## Sub Commands
### webdav health
Check health status
Usage: `webdav health [command options] [arguments...]`
--debug-addr | $WEBDAV_DEBUG_ADDR
: Address to debug endpoint. Default: `0.0.0.0:9119`.
### webdav server
Start integrated server
Usage: `webdav server [command options] [arguments...]`
--tracing-enabled | $WEBDAV_TRACING_ENABLED
: Enable sending traces.
--tracing-type | $WEBDAV_TRACING_TYPE
: Tracing backend type. Default: `jaeger`.
--tracing-endpoint | $WEBDAV_TRACING_ENDPOINT
: Endpoint for the agent.
--tracing-collector | $WEBDAV_TRACING_COLLECTOR
: Endpoint for the collector.
--tracing-service | $WEBDAV_TRACING_SERVICE
: Service name for tracing. Default: `webdav`.
--debug-addr | $WEBDAV_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9119`.
--debug-token | $WEBDAV_DEBUG_TOKEN
: Token to grant metrics access.
--debug-pprof | $WEBDAV_DEBUG_PPROF
: Enable pprof debugging.
--debug-zpages | $WEBDAV_DEBUG_ZPAGES
: Enable zpages debugging.
--http-addr | $WEBDAV_HTTP_ADDR
: Address to bind http server. Default: `0.0.0.0:9115`.
--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`.
--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`.