diff --git a/.drone.star b/.drone.star index 5315f4fc4..54724ed0d 100644 --- a/.drone.star +++ b/.drone.star @@ -1400,7 +1400,6 @@ def notify(ctx): def ocisServer(storage, accounts_hash_difficulty = 4, volumes = []): environment = { "OCIS_URL": "https://ocis-server:9200", - "STORAGE_HOME_DRIVER": "%s" % (storage), "STORAGE_USERS_DRIVER": "%s" % (storage), "STORAGE_USERS_DRIVER_LOCAL_ROOT": "/srv/app/tmp/ocis/local/root", "STORAGE_USERS_DRIVER_OWNCLOUD_DATADIR": "/srv/app/tmp/ocis/owncloud/data", @@ -2082,7 +2081,6 @@ def latestOcisServer(): "STORAGE_LDAP_USERFILTER": "(&(objectclass=posixAccount)(objectclass=owncloud)(|(ownclouduuid={{.OpaqueId}})(uid={{.OpaqueId}})))", "STORAGE_LDAP_USERFINDFILTER": "(&(objectclass=posixAccount)(objectclass=owncloud)(|(cn={{query}}*)(displayname={{query}}*)(mail={{query}}*)))", # ownCloud storage driver - "STORAGE_HOME_DRIVER": "owncloudsql", "STORAGE_USERS_DRIVER": "owncloudsql", "STORAGE_METADATA_DRIVER": "ocis", "STORAGE_USERS_DRIVER_OWNCLOUDSQL_DATADIR": "/mnt/data/files", diff --git a/accounts/templates/CONFIGURATION.tmpl b/accounts/templates/CONFIGURATION.tmpl deleted file mode 100644 index c180d7a56..000000000 --- a/accounts/templates/CONFIGURATION.tmpl +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Configuration" -date: "{{ date "2006-01-02T15:04:05-0700" now }}" -weight: 20 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/accounts/templates -geekdocFilePath: CONFIGURATION.tmpl ---- -{{- define "options"}} -{{ $fnNames := (last . ).Flags -}} -{{ range $opt := first . }} -{{ range $fnName := $fnNames }}{{ with list $fnName $opt -}} -{{ $o := last . -}} -{{ if eq $o.FnName $fnName -}} --{{ $o.Name }} | {{ range $i, $e := $o.Env }} {{ if $i }}, {{ end }}${{ $e }}{{ end }} -: {{ $o.Usage }}. {{- if $o.Default }} Default: `{{ $o.Default }}`.{{ end }} - -{{ end -}} -{{ end -}} -{{ end -}} -{{ end -}} -{{ end }} - -{{`{{< toc >}}`}} - -## Configuration - -### 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-accounts reads `accounts.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/accounts/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`. - -### Environment variables - -If you prefer to configure the service with environment variables you can see the available variables below. - -If multiple variables are listed for one option, they are in order of precedence. This means the leftmost variable will always win if given. - -### Command-line flags - -If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -{{ $options := .Options -}} -{{ range $com := .Commands }}{{ with (list $options $com) -}} -{{ $c := last . -}} -{{ if eq $c.Name "accounts" -}} -## Root Command - -{{ $c.Usage }} - -Usage: `accounts [global options] command [command options] [arguments...]` -{{ template "options" . -}} -## Sub Commands - -{{ end -}} -{{ end -}} -{{ end -}} -{{- range $com := .Commands }}{{ with (list $options $com) -}} -{{- $c := last . }} -{{- if ne $c.Name "accounts" -}} -### accounts {{ $c.Name }} - -{{ $c.Usage }} - -Usage: `accounts {{ $c.Name }} [command options] [arguments...]` -{{ template "options" . }} -{{- end -}} -{{- end -}} -{{- end -}} diff --git a/deployments/examples/oc10_ocis_parallel/docker-compose.yml b/deployments/examples/oc10_ocis_parallel/docker-compose.yml index ec5185b86..3d7622e04 100644 --- a/deployments/examples/oc10_ocis_parallel/docker-compose.yml +++ b/deployments/examples/oc10_ocis_parallel/docker-compose.yml @@ -91,7 +91,6 @@ services: STORAGE_LDAP_USERFILTER: "(&(objectclass=posixAccount)(objectclass=owncloud)(|(ownclouduuid={{.OpaqueId}})(uid={{.OpaqueId}})))" STORAGE_LDAP_USERFINDFILTER: "(&(objectclass=posixAccount)(objectclass=owncloud)(|(cn={{query}}*)(displayname={{query}}*)(mail={{query}}*)))" # ownCloud storage driver - STORAGE_HOME_DRIVER: owncloudsql STORAGE_USERS_DRIVER: owncloudsql STORAGE_METADATA_DRIVER: ocis # keep metadata on ocis storage since this are only small files atm STORAGE_USERS_DRIVER_OWNCLOUDSQL_DATADIR: /mnt/data/files diff --git a/deployments/examples/oc10_ocis_parallel/monitoring_tracing/docker-compose-additions.yml b/deployments/examples/oc10_ocis_parallel/monitoring_tracing/docker-compose-additions.yml index 8abdf4e83..705cfccd9 100644 --- a/deployments/examples/oc10_ocis_parallel/monitoring_tracing/docker-compose-additions.yml +++ b/deployments/examples/oc10_ocis_parallel/monitoring_tracing/docker-compose-additions.yml @@ -23,7 +23,6 @@ services: STORAGE_FRONTEND_DEBUG_ADDR: 0.0.0.0:9141 STORAGE_GATEWAY_DEBUG_ADDR: 0.0.0.0:9143 STORAGE_GROUPPROVIDER_DEBUG_ADDR: 0.0.0.0:9161 - STORAGE_HOME_DEBUG_ADDR: 0.0.0.0:9156 STORAGE_METADATA_DEBUG_ADDR: 0.0.0.0:9217 STORAGE_PUBLIC_LINK_DEBUG_ADDR: 0.0.0.0:9179 STORAGE_USERPROVIDER_DEBUG_ADDR: 0.0.0.0:9145 diff --git a/deployments/examples/ocis_hello/monitoring_tracing/docker-compose-additions.yml b/deployments/examples/ocis_hello/monitoring_tracing/docker-compose-additions.yml index 8abdf4e83..705cfccd9 100644 --- a/deployments/examples/ocis_hello/monitoring_tracing/docker-compose-additions.yml +++ b/deployments/examples/ocis_hello/monitoring_tracing/docker-compose-additions.yml @@ -23,7 +23,6 @@ services: STORAGE_FRONTEND_DEBUG_ADDR: 0.0.0.0:9141 STORAGE_GATEWAY_DEBUG_ADDR: 0.0.0.0:9143 STORAGE_GROUPPROVIDER_DEBUG_ADDR: 0.0.0.0:9161 - STORAGE_HOME_DEBUG_ADDR: 0.0.0.0:9156 STORAGE_METADATA_DEBUG_ADDR: 0.0.0.0:9217 STORAGE_PUBLIC_LINK_DEBUG_ADDR: 0.0.0.0:9179 STORAGE_USERPROVIDER_DEBUG_ADDR: 0.0.0.0:9145 diff --git a/deployments/examples/ocis_keycloak/monitoring_tracing/docker-compose-additions.yml b/deployments/examples/ocis_keycloak/monitoring_tracing/docker-compose-additions.yml index 8abdf4e83..705cfccd9 100644 --- a/deployments/examples/ocis_keycloak/monitoring_tracing/docker-compose-additions.yml +++ b/deployments/examples/ocis_keycloak/monitoring_tracing/docker-compose-additions.yml @@ -23,7 +23,6 @@ services: STORAGE_FRONTEND_DEBUG_ADDR: 0.0.0.0:9141 STORAGE_GATEWAY_DEBUG_ADDR: 0.0.0.0:9143 STORAGE_GROUPPROVIDER_DEBUG_ADDR: 0.0.0.0:9161 - STORAGE_HOME_DEBUG_ADDR: 0.0.0.0:9156 STORAGE_METADATA_DEBUG_ADDR: 0.0.0.0:9217 STORAGE_PUBLIC_LINK_DEBUG_ADDR: 0.0.0.0:9179 STORAGE_USERPROVIDER_DEBUG_ADDR: 0.0.0.0:9145 diff --git a/deployments/examples/ocis_ldap/monitoring_tracing/docker-compose-additions.yml b/deployments/examples/ocis_ldap/monitoring_tracing/docker-compose-additions.yml index 8abdf4e83..705cfccd9 100644 --- a/deployments/examples/ocis_ldap/monitoring_tracing/docker-compose-additions.yml +++ b/deployments/examples/ocis_ldap/monitoring_tracing/docker-compose-additions.yml @@ -23,7 +23,6 @@ services: STORAGE_FRONTEND_DEBUG_ADDR: 0.0.0.0:9141 STORAGE_GATEWAY_DEBUG_ADDR: 0.0.0.0:9143 STORAGE_GROUPPROVIDER_DEBUG_ADDR: 0.0.0.0:9161 - STORAGE_HOME_DEBUG_ADDR: 0.0.0.0:9156 STORAGE_METADATA_DEBUG_ADDR: 0.0.0.0:9217 STORAGE_PUBLIC_LINK_DEBUG_ADDR: 0.0.0.0:9179 STORAGE_USERPROVIDER_DEBUG_ADDR: 0.0.0.0:9145 diff --git a/deployments/examples/ocis_s3/docker-compose.yml b/deployments/examples/ocis_s3/docker-compose.yml index aed2b45f4..a8a168273 100644 --- a/deployments/examples/ocis_s3/docker-compose.yml +++ b/deployments/examples/ocis_s3/docker-compose.yml @@ -60,7 +60,6 @@ services: STORAGE_TRANSFER_SECRET: ${STORAGE_TRANSFER_SECRET:-replace-me-with-a-transfer-secret} OCIS_MACHINE_AUTH_API_KEY: ${OCIS_MACHINE_AUTH_API_KEY:-change-me-please} # activate s3ng storage driver - STORAGE_HOME_DRIVER: s3ng STORAGE_USERS_DRIVER: s3ng STORAGE_METADATA_DRIVER: ocis # keep metadata on ocis storage since this are only small files atm # s3ng specific settings diff --git a/deployments/examples/ocis_s3/monitoring_tracing/docker-compose-additions.yml b/deployments/examples/ocis_s3/monitoring_tracing/docker-compose-additions.yml index 8abdf4e83..705cfccd9 100644 --- a/deployments/examples/ocis_s3/monitoring_tracing/docker-compose-additions.yml +++ b/deployments/examples/ocis_s3/monitoring_tracing/docker-compose-additions.yml @@ -23,7 +23,6 @@ services: STORAGE_FRONTEND_DEBUG_ADDR: 0.0.0.0:9141 STORAGE_GATEWAY_DEBUG_ADDR: 0.0.0.0:9143 STORAGE_GROUPPROVIDER_DEBUG_ADDR: 0.0.0.0:9161 - STORAGE_HOME_DEBUG_ADDR: 0.0.0.0:9156 STORAGE_METADATA_DEBUG_ADDR: 0.0.0.0:9217 STORAGE_PUBLIC_LINK_DEBUG_ADDR: 0.0.0.0:9179 STORAGE_USERPROVIDER_DEBUG_ADDR: 0.0.0.0:9145 diff --git a/deployments/examples/ocis_traefik/monitoring_tracing/docker-compose-additions.yml b/deployments/examples/ocis_traefik/monitoring_tracing/docker-compose-additions.yml index 8abdf4e83..705cfccd9 100644 --- a/deployments/examples/ocis_traefik/monitoring_tracing/docker-compose-additions.yml +++ b/deployments/examples/ocis_traefik/monitoring_tracing/docker-compose-additions.yml @@ -23,7 +23,6 @@ services: STORAGE_FRONTEND_DEBUG_ADDR: 0.0.0.0:9141 STORAGE_GATEWAY_DEBUG_ADDR: 0.0.0.0:9143 STORAGE_GROUPPROVIDER_DEBUG_ADDR: 0.0.0.0:9161 - STORAGE_HOME_DEBUG_ADDR: 0.0.0.0:9156 STORAGE_METADATA_DEBUG_ADDR: 0.0.0.0:9217 STORAGE_PUBLIC_LINK_DEBUG_ADDR: 0.0.0.0:9179 STORAGE_USERPROVIDER_DEBUG_ADDR: 0.0.0.0:9145 diff --git a/deployments/examples/ocis_wopi/monitoring_tracing/docker-compose-additions.yml b/deployments/examples/ocis_wopi/monitoring_tracing/docker-compose-additions.yml index 8abdf4e83..705cfccd9 100644 --- a/deployments/examples/ocis_wopi/monitoring_tracing/docker-compose-additions.yml +++ b/deployments/examples/ocis_wopi/monitoring_tracing/docker-compose-additions.yml @@ -23,7 +23,6 @@ services: STORAGE_FRONTEND_DEBUG_ADDR: 0.0.0.0:9141 STORAGE_GATEWAY_DEBUG_ADDR: 0.0.0.0:9143 STORAGE_GROUPPROVIDER_DEBUG_ADDR: 0.0.0.0:9161 - STORAGE_HOME_DEBUG_ADDR: 0.0.0.0:9156 STORAGE_METADATA_DEBUG_ADDR: 0.0.0.0:9217 STORAGE_PUBLIC_LINK_DEBUG_ADDR: 0.0.0.0:9179 STORAGE_USERPROVIDER_DEBUG_ADDR: 0.0.0.0:9145 diff --git a/docs/extensions/storage/storagedrivers.md b/docs/extensions/storage/storagedrivers.md index 936dd9f96..375ffa330 100644 --- a/docs/extensions/storage/storagedrivers.md +++ b/docs/extensions/storage/storagedrivers.md @@ -168,7 +168,6 @@ For a simple docker-compose setup, you can create a volume which will be used by The CERN eos storage has evolved with ownCloud and natively supports id based lookup, ETag propagation, subtree size accounting, sharing, trash and versions. To use it you need to change the default configuration of the `storage storage-home` command (or have a look at the Makefile ̀ eos-start` target): ``` -export STORAGE_HOME_DRIVER=eos export STORAGE_DRIVER_EOS_NAMESPACE=/eos export STORAGE_DRIVER_EOS_MASTER_URL="root://eos-mgm1.eoscluster.cern.ch:1094" export STORAGE_DRIVER_EOS_ENABLE_HOME=true diff --git a/glauth/templates/CONFIGURATION.tmpl b/glauth/templates/CONFIGURATION.tmpl deleted file mode 100644 index ac2fd7974..000000000 --- a/glauth/templates/CONFIGURATION.tmpl +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Configuration" -date: "{{ date "2006-01-02T15:04:05-0700" now }}" -weight: 20 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/glauth/templates -geekdocFilePath: CONFIGURATION.tmpl ---- -{{- define "options"}} -{{ $fnNames := (last . ).Flags -}} -{{ range $opt := first . }} -{{ range $fnName := $fnNames }}{{ with list $fnName $opt -}} -{{ $o := last . -}} -{{ if eq $o.FnName $fnName -}} --{{ $o.Name }} | {{ range $i, $e := $o.Env }} {{ if $i }}, {{ end }}${{ $e }}{{ end }} -: {{ $o.Usage }}. {{- if $o.Default }} Default: `{{ $o.Default }}`.{{ end }} - -{{ end -}} -{{ end -}} -{{ end -}} -{{ end -}} -{{ end }} - -{{`{{< toc >}}`}} - -## Configuration - -### 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-glauth reads `glauth.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/glauth/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`. - -### Environment variables - -If you prefer to configure the service with environment variables you can see the available variables below. - -If multiple variables are listed for one option, they are in order of precedence. This means the leftmost variable will always win if given. - -### Command-line flags - -If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -{{ $options := .Options -}} -{{ range $com := .Commands }}{{ with (list $options $com) -}} -{{ $c := last . -}} -{{ if eq $c.Name "glauth" -}} -## Root Command - -{{ $c.Usage }} - -Usage: `glauth [global options] command [command options] [arguments...]` -{{ template "options" . -}} -## Sub Commands - -{{ end -}} -{{ end -}} -{{ end -}} -{{- range $com := .Commands }}{{ with (list $options $com) -}} -{{- $c := last . }} -{{- if ne $c.Name "glauth" -}} -### glauth {{ $c.Name }} - -{{ $c.Usage }} - -Usage: `glauth {{ $c.Name }} [command options] [arguments...]` -{{ template "options" . }} -{{- end -}} -{{- end -}} -{{- end -}} diff --git a/graph-explorer/templates/CONFIGURATION.tmpl b/graph-explorer/templates/CONFIGURATION.tmpl deleted file mode 100644 index ba9282bc2..000000000 --- a/graph-explorer/templates/CONFIGURATION.tmpl +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Configuration" -date: "{{ date "2006-01-02T15:04:05-0700" now }}" -weight: 20 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/graph-explorer/templates -geekdocFilePath: CONFIGURATION.tmpl ---- -{{- define "options"}} -{{ $fnNames := (last . ).Flags -}} -{{ range $opt := first . }} -{{ range $fnName := $fnNames }}{{ with list $fnName $opt -}} -{{ $o := last . -}} -{{ if eq $o.FnName $fnName -}} --{{ $o.Name }} | {{ range $i, $e := $o.Env }} {{ if $i }}, {{ end }}${{ $e }}{{ end }} -: {{ $o.Usage }}. {{- if $o.Default }} Default: `{{ $o.Default }}`.{{ end }} - -{{ end -}} -{{ end -}} -{{ end -}} -{{ end -}} -{{ end }} - -{{`{{< toc >}}`}} - -## Configuration - -### 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/graph-explorer/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`. - -### Environment variables - -If you prefer to configure the service with environment variables you can see the available variables below. - -If multiple variables are listed for one option, they are in order of precedence. This means the leftmost variable will always win if given. - -### Command-line flags - -If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -{{ $options := .Options -}} -{{ range $com := .Commands }}{{ with (list $options $com) -}} -{{ $c := last . -}} -{{ if eq $c.Name "graph-explorer" -}} -## Root Command - -{{ $c.Usage }} - -Usage: `graph-explorer [global options] command [command options] [arguments...]` -{{ template "options" . -}} -## Sub Commands - -{{ end -}} -{{ end -}} -{{ end -}} -{{- range $com := .Commands }}{{ with (list $options $com) -}} -{{- $c := last . }} -{{- if ne $c.Name "graph-explorer" -}} -### graph-explorer {{ $c.Name }} - -{{ $c.Usage }} - -Usage: `graph-explorer {{ $c.Name }} [command options] [arguments...]` -{{ template "options" . }} -{{- end -}} -{{- end -}} -{{- end -}} diff --git a/graph/templates/CONFIGURATION.tmpl b/graph/templates/CONFIGURATION.tmpl deleted file mode 100644 index 24c1c4a99..000000000 --- a/graph/templates/CONFIGURATION.tmpl +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Configuration" -date: "{{ date "2006-01-02T15:04:05-0700" now }}" -weight: 20 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/graph/templates -geekdocFilePath: CONFIGURATION.tmpl ---- -{{- define "options"}} -{{ $fnNames := (last . ).Flags -}} -{{ range $opt := first . }} -{{ range $fnName := $fnNames }}{{ with list $fnName $opt -}} -{{ $o := last . -}} -{{ if eq $o.FnName $fnName -}} --{{ $o.Name }} | {{ range $i, $e := $o.Env }} {{ if $i }}, {{ end }}${{ $e }}{{ end }} -: {{ $o.Usage }}. {{- if $o.Default }} Default: `{{ $o.Default }}`.{{ end }} - -{{ end -}} -{{ end -}} -{{ end -}} -{{ end -}} -{{ end }} - -{{`{{< toc >}}`}} - -## Configuration - -### 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/graph/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`. - -### Environment variables - -If you prefer to configure the service with environment variables you can see the available variables below. - -If multiple variables are listed for one option, they are in order of precedence. This means the leftmost variable will always win if given. - -### Command-line flags - -If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -{{ $options := .Options -}} -{{ range $com := .Commands }}{{ with (list $options $com) -}} -{{ $c := last . -}} -{{ if eq $c.Name "graph" -}} -## Root Command - -{{ $c.Usage }} - -Usage: `graph [global options] command [command options] [arguments...]` -{{ template "options" . -}} -## Sub Commands - -{{ end -}} -{{ end -}} -{{ end -}} -{{- range $com := .Commands }}{{ with (list $options $com) -}} -{{- $c := last . }} -{{- if ne $c.Name "graph" -}} -### graph {{ $c.Name }} - -{{ $c.Usage }} - -Usage: `graph {{ $c.Name }} [command options] [arguments...]` -{{ template "options" . }} -{{- end -}} -{{- end -}} -{{- end -}} diff --git a/idp/templates/CONFIGURATION.tmpl b/idp/templates/CONFIGURATION.tmpl deleted file mode 100644 index a2fbcdad1..000000000 --- a/idp/templates/CONFIGURATION.tmpl +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Configuration" -date: "{{ date "2006-01-02T15:04:05-0700" now }}" -weight: 20 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/idp/templates -geekdocFilePath: CONFIGURATION.tmpl ---- -{{- define "options"}} -{{ $fnNames := (last . ).Flags -}} -{{ range $opt := first . }} -{{ range $fnName := $fnNames }}{{ with list $fnName $opt -}} -{{ $o := last . -}} -{{ if eq $o.FnName $fnName -}} --{{ $o.Name }} | {{ range $i, $e := $o.Env }} {{ if $i }}, {{ end }}${{ $e }}{{ end }} -: {{ $o.Usage }}. {{- if $o.Default }} Default: `{{ $o.Default }}`.{{ end }} - -{{ end -}} -{{ end -}} -{{ end -}} -{{ end -}} -{{ end }} - -{{`{{< toc >}}`}} - -## Configuration - -### 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-idp reads `idp.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/idp/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`. - -### Environment variables - -If you prefer to configure the service with environment variables you can see the available variables below. - -If multiple variables are listed for one option, they are in order of precedence. This means the leftmost variable will always win if given. - -### Command-line flags - -If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -{{ $options := .Options -}} -{{ range $com := .Commands }}{{ with (list $options $com) -}} -{{ $c := last . -}} -{{ if eq $c.Name "idp" -}} -## Root Command - -{{ $c.Usage }} - -Usage: `idp [global options] command [command options] [arguments...]` -{{ template "options" . -}} -## Sub Commands - -{{ end -}} -{{ end -}} -{{ end -}} -{{- range $com := .Commands }}{{ with (list $options $com) -}} -{{- $c := last . }} -{{- if ne $c.Name "idp" -}} -### idp {{ $c.Name }} - -{{ $c.Usage }} - -Usage: `idp {{ $c.Name }} [command options] [arguments...]` -{{ template "options" . }} -{{- end -}} -{{- end -}} -{{- end -}} diff --git a/ocis/templates/CONFIGURATION.tmpl b/ocis/templates/CONFIGURATION.tmpl deleted file mode 100644 index 465d32e27..000000000 --- a/ocis/templates/CONFIGURATION.tmpl +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: "Configuration" -date: "{{ date "2006-01-02T15:04:05-0700" now }}" -weight: 2 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/ocis/templates -geekdocFilePath: CONFIGURATION.tmpl ---- -{{- define "options"}} -{{ $fnNames := (last . ).Flags -}} -{{ range $opt := first . }} -{{ range $fnName := $fnNames }}{{ with list $fnName $opt -}} -{{ $o := last . -}} -{{ if eq $o.FnName $fnName -}} --{{ $o.Name }} | {{ range $i, $e := $o.Env }} {{ if $i }}, {{ end }}${{ $e }}{{ end }} -: {{ $o.Usage }}. {{- if $o.Default }} Default: `{{ $o.Default }}`.{{ end }} - -{{ end -}} -{{ end -}} -{{ end -}} -{{ end -}} -{{ end }} - -{{`{{< 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. [proxy configuration]({{"{{"}}< relref "../extensions/accounts/configuration.md" >{{"}}"}})) 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/ocis/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`. - -### Environment variables - -If you prefer to configure the service with environment variables you can see the available variables below. - -If multiple variables are listed for one option, they are in order of precedence. This means the leftmost variable will always win if given. - -### Command-line flags - -If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -{{ $options := .Options -}} -{{ range $com := .Commands }}{{ with (list $options $com) -}} -{{ $c := last . -}} -{{ if eq $c.Name "ocis" -}} -## Root Command - -{{ $c.Usage }} - -Usage: `ocis [global options] command [command options] [arguments...]` -{{ template "options" . -}} -## Sub Commands - -{{ end -}} -{{ end -}} -{{ end -}} -{{- range $com := .Commands }}{{ with (list $options $com) -}} -{{- $c := last . }} -{{- if eq $c.Name "server" "health" "kill" "list" "run" -}} -{{- if ne $c.FnName "Simple" -}} -### ocis {{ $c.Name }} - -{{ $c.Usage }} - -Usage: `ocis {{ $c.Name }} [command options] [arguments...]` -{{ template "options" . }} -{{- end -}} -{{- end -}} -{{- end -}} -{{- end -}} - -### 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. - -{{ range $com := .Commands }}{{ with $com -}} -{{ if and (ne .Name "health") (ne .Name "server") (ne .Name "ocis") (ne .Name "kill") (ne .Name "list") (ne .Name "run") -}} -#### ocis {{ .Name }} - -{{ .Usage }} - -{{ end -}} -{{- end -}} -{{- end -}} diff --git a/ocs/templates/CONFIGURATION.tmpl b/ocs/templates/CONFIGURATION.tmpl deleted file mode 100644 index 5b58de073..000000000 --- a/ocs/templates/CONFIGURATION.tmpl +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Configuration" -date: "{{ date "2006-01-02T15:04:05-0700" now }}" -weight: 20 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/ocs/templates -geekdocFilePath: CONFIGURATION.tmpl ---- -{{- define "options"}} -{{ $fnNames := (last . ).Flags -}} -{{ range $opt := first . }} -{{ range $fnName := $fnNames }}{{ with list $fnName $opt -}} -{{ $o := last . -}} -{{ if eq $o.FnName $fnName -}} --{{ $o.Name }} | {{ range $i, $e := $o.Env }} {{ if $i }}, {{ end }}${{ $e }}{{ end }} -: {{ $o.Usage }}. {{- if $o.Default }} Default: `{{ $o.Default }}`.{{ end }} - -{{ end -}} -{{ end -}} -{{ end -}} -{{ end -}} -{{ end }} - -{{`{{< toc >}}`}} - -## Configuration - -### 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-ocs reads `ocs.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/ocs/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`. - -### Environment variables - -If you prefer to configure the service with environment variables you can see the available variables below. - -If multiple variables are listed for one option, they are in order of precedence. This means the leftmost variable will always win if given. - -### Command-line flags - -If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -{{ $options := .Options -}} -{{ range $com := .Commands }}{{ with (list $options $com) -}} -{{ $c := last . -}} -{{ if eq $c.Name "ocs" -}} -## Root Command - -{{ $c.Usage }} - -Usage: `ocs [global options] command [command options] [arguments...]` -{{ template "options" . -}} -## Sub Commands - -{{ end -}} -{{ end -}} -{{ end -}} -{{- range $com := .Commands }}{{ with (list $options $com) -}} -{{- $c := last . }} -{{- if ne $c.Name "ocs" -}} -### ocs {{ $c.Name }} - -{{ $c.Usage }} - -Usage: `ocs {{ $c.Name }} [command options] [arguments...]` -{{ template "options" . }} -{{- end -}} -{{- end -}} -{{- end -}} diff --git a/proxy/templates/CONFIGURATION.tmpl b/proxy/templates/CONFIGURATION.tmpl deleted file mode 100644 index b944a5892..000000000 --- a/proxy/templates/CONFIGURATION.tmpl +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Configuration" -date: "{{ date "2006-01-02T15:04:05-0700" now }}" -weight: 20 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/proxy/templates -geekdocFilePath: CONFIGURATION.tmpl ---- -{{- define "options"}} -{{ $fnNames := (last . ).Flags -}} -{{ range $opt := first . }} -{{ range $fnName := $fnNames }}{{ with list $fnName $opt -}} -{{ $o := last . -}} -{{ if eq $o.FnName $fnName -}} --{{ $o.Name }} | {{ range $i, $e := $o.Env }} {{ if $i }}, {{ end }}${{ $e }}{{ end }} -: {{ $o.Usage }}. {{- if $o.Default }} Default: `{{ $o.Default }}`.{{ end }} - -{{ end -}} -{{ end -}} -{{ end -}} -{{ end -}} -{{ end }} - -{{`{{< toc >}}`}} - -## Configuration - -### 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/proxy/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`. - -### Environment variables - -If you prefer to configure the service with environment variables you can see the available variables below. - -If multiple variables are listed for one option, they are in order of precedence. This means the leftmost variable will always win if given. - -### Command-line flags - -If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -{{ $options := .Options -}} -{{ range $com := .Commands }}{{ with (list $options $com) -}} -{{ $c := last . -}} -{{ if eq $c.Name "proxy" -}} -## Root Command - -{{ $c.Usage }} - -Usage: `proxy [global options] command [command options] [arguments...]` -{{ template "options" . -}} -## Sub Commands - -{{ end -}} -{{ end -}} -{{ end -}} -{{- range $com := .Commands }}{{ with (list $options $com) -}} -{{- $c := last . }} -{{- if ne $c.Name "proxy" -}} -### proxy {{ $c.Name }} - -{{ $c.Usage }} - -Usage: `proxy {{ $c.Name }} [command options] [arguments...]` -{{ template "options" . }} -{{- end -}} -{{- end -}} -{{- end -}} diff --git a/settings/templates/CONFIGURATION.tmpl b/settings/templates/CONFIGURATION.tmpl deleted file mode 100644 index 0bbef699e..000000000 --- a/settings/templates/CONFIGURATION.tmpl +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Configuration" -date: "{{ date "2006-01-02T15:04:05-0700" now }}" -weight: 20 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/settings/templates -geekdocFilePath: CONFIGURATION.tmpl ---- -{{- define "options"}} -{{ $fnNames := (last . ).Flags -}} -{{ range $opt := first . }} -{{ range $fnName := $fnNames }}{{ with list $fnName $opt -}} -{{ $o := last . -}} -{{ if eq $o.FnName $fnName -}} --{{ $o.Name }} | {{ range $i, $e := $o.Env }} {{ if $i }}, {{ end }}${{ $e }}{{ end }} -: {{ $o.Usage }}. {{- if $o.Default }} Default: `{{ $o.Default }}`.{{ end }} - -{{ end -}} -{{ end -}} -{{ end -}} -{{ end -}} -{{ end }} - -{{`{{< toc >}}`}} - -## Configuration - -### 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/settings/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`. - -### Environment variables - -If you prefer to configure the service with environment variables you can see the available variables below. - -If multiple variables are listed for one option, they are in order of precedence. This means the leftmost variable will always win if given. - -### Command-line flags - -If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -{{ $options := .Options -}} -{{ range $com := .Commands }}{{ with (list $options $com) -}} -{{ $c := last . -}} -{{ if eq $c.Name "settings" -}} -## Root Command - -{{ $c.Usage }} - -Usage: `settings [global options] command [command options] [arguments...]` -{{ template "options" . -}} -## Sub Commands - -{{ end -}} -{{ end -}} -{{ end -}} -{{- range $com := .Commands }}{{ with (list $options $com) -}} -{{- $c := last . }} -{{- if ne $c.Name "settings" -}} -### settings {{ $c.Name }} - -{{ $c.Usage }} - -Usage: `settings {{ $c.Name }} [command options] [arguments...]` -{{ template "options" . }} -{{- end -}} -{{- end -}} -{{- end -}} diff --git a/storage/templates/CONFIGURATION.tmpl b/storage/templates/CONFIGURATION.tmpl deleted file mode 100644 index ad41b82c7..000000000 --- a/storage/templates/CONFIGURATION.tmpl +++ /dev/null @@ -1,123 +0,0 @@ ---- -title: "Configuration" -date: "{{ date "2006-01-02T15:04:05-0700" now }}" -weight: 20 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/storage/templates -geekdocFilePath: CONFIGURATION.tmpl ---- -{{- define "options"}} -{{ $fnNames := (last . ).Flags -}} -{{ range $opt := first . }} -{{ range $fnName := $fnNames }}{{ with list $fnName $opt -}} -{{ $o := last . -}} -{{ if eq $o.FnName $fnName -}} --{{ $o.Name }} | {{ range $i, $e := $o.Env }} {{ if $i }}, {{ end }}${{ $e }}{{ end }} -: {{ $o.Usage }}. {{- if $o.Default }} Default: `{{ $o.Default }}`.{{ end }} - -{{ end -}} -{{ end -}} -{{ end -}} -{{ end -}} -{{ end }} -{{- define "option"}} -{{- $options := first . }} -{{- $oName := last . }} -{{- range $o := $options }}{{ with (list $o $oName) -}} -{{- $o := first . }} -{{- if eq $o.FnName (last .) -}} --{{ $o.Name }} | {{ range $i, $e := $o.Env }} {{ if $i }}, {{ end }}${{ $e }}{{ end }} -: {{ $o.Usage }}. {{- if $o.Default }} Default: `{{ $o.Default }}`.{{ end }} - -{{ end -}} -{{- end -}} -{{- end -}} -{{ end }} - -{{`{{< toc >}}`}} - -## Configuration - -### 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/storage/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`. - -### Environment variables - -If you prefer to configure the service with environment variables you can see the available variables below. - -If multiple variables are listed for one option, they are in order of precedence. This means the leftmost variable will always win if given. - -### Command-line flags - -If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -{{ $options := .Options -}} -{{ range $com := .Commands }}{{ with (list $options $com) -}} -{{ $c := last . -}} -{{ if eq $c.Name "storage" -}} -## Root Command - -{{ $c.Usage }} - -Usage: `storage [global options] command [command options] [arguments...]` -{{ template "options" . -}} -## Sub Commands - -{{ end -}} -{{ end -}} -{{ end -}} -{{- range $com := .Commands }}{{ with (list $options $com) -}} -{{- $c := last . }} -{{- if ne $c.Name "ocis-reva" -}} -### storage {{ $c.Name }} - -{{ $c.Usage }} - -Usage: `storage {{ $c.Name }} [command options] [arguments...]` -{{ template "options" . }} -{{- end -}} -{{- end -}} -{{- end -}} -## Config for the different Storage Drivers - -You can set different storage drivers for the Storage Providers. Please check the storage provider configuration. - -Example: Set the home and users Storage Provider to `ocis` - -`STORAGE_HOME_DRIVER=ocis` -`STORAGE_USERS_DRIVER=ocis` - -### Local Driver - -{{ template "option" (list .Options "DriverLocalWithConfig") -}} - -### Eos Driver - -{{ template "option" (list .Options "DriverEOSWithConfig") -}} - -### owCloud Driver - -{{ template "option" (list .Options "DriverOwnCloudWithConfig") -}} - -### ownCloudSQL Driver - -{{ template "option" (list .Options "DriverOwnCloudSQLWithConfig") -}} - -### Ocis Driver - -{{ template "option" (list .Options "DriverOCISWithConfig") -}} - -### S3ng Driver - -{{ template "option" (list .Options "DriverS3NGWithConfig") -}} diff --git a/store/templates/CONFIGURATION.tmpl b/store/templates/CONFIGURATION.tmpl deleted file mode 100644 index b783d239b..000000000 --- a/store/templates/CONFIGURATION.tmpl +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Configuration" -date: "{{ date "2006-01-02T15:04:05-0700" now }}" -weight: 20 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/store/templates -geekdocFilePath: CONFIGURATION.tmpl ---- -{{- define "options"}} -{{ $fnNames := (last . ).Flags -}} -{{ range $opt := first . }} -{{ range $fnName := $fnNames }}{{ with list $fnName $opt -}} -{{ $o := last . -}} -{{ if eq $o.FnName $fnName -}} --{{ $o.Name }} | {{ range $i, $e := $o.Env }} {{ if $i }}, {{ end }}${{ $e }}{{ end }} -: {{ $o.Usage }}. {{- if $o.Default }} Default: `{{ $o.Default }}`.{{ end }} - -{{ end -}} -{{ end -}} -{{ end -}} -{{ end -}} -{{ end }} - -{{`{{< toc >}}`}} - -## Configuration - -### 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/store/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`. - -### Environment variables - -If you prefer to configure the service with environment variables you can see the available variables below. - -If multiple variables are listed for one option, they are in order of precedence. This means the leftmost variable will always win if given. - -### Command-line flags - -If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -{{ $options := .Options -}} -{{ range $com := .Commands }}{{ with (list $options $com) -}} -{{ $c := last . -}} -{{ if eq $c.Name "store" -}} -## Root Command - -{{ $c.Usage }} - -Usage: `store [global options] command [command options] [arguments...]` -{{ template "options" . -}} -## Sub Commands - -{{ end -}} -{{ end -}} -{{ end -}} -{{- range $com := .Commands }}{{ with (list $options $com) -}} -{{- $c := last . }} -{{- if ne $c.Name "store" -}} -### store {{ $c.Name }} - -{{ $c.Usage }} - -Usage: `store {{ $c.Name }} [command options] [arguments...]` -{{ template "options" . }} -{{- end -}} -{{- end -}} -{{- end -}} diff --git a/tests/acceptance/docker/src/ocis-base.yml b/tests/acceptance/docker/src/ocis-base.yml index 837921b58..94e26e0cd 100644 --- a/tests/acceptance/docker/src/ocis-base.yml +++ b/tests/acceptance/docker/src/ocis-base.yml @@ -4,7 +4,6 @@ services: user: root environment: OCIS_URL: "https://ocis-server:9200" - STORAGE_HOME_DRIVER: $STORAGE_DRIVER STORAGE_USERS_DRIVER: $STORAGE_DRIVER STORAGE_USERS_DRIVER_LOCAL_ROOT: /srv/app/tmp/ocis/local/root STORAGE_USERS_DRIVER_OWNCLOUD_DATADIR: /srv/app/tmp/ocis/owncloud/data diff --git a/thumbnails/templates/CONFIGURATION.tmpl b/thumbnails/templates/CONFIGURATION.tmpl deleted file mode 100644 index 02a7f7843..000000000 --- a/thumbnails/templates/CONFIGURATION.tmpl +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Configuration" -date: "{{ date "2006-01-02T15:04:05-0700" now }}" -weight: 20 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/thumbnails/templates -geekdocFilePath: CONFIGURATION.tmpl ---- -{{- define "options"}} -{{ $fnNames := (last . ).Flags -}} -{{ range $opt := first . }} -{{ range $fnName := $fnNames }}{{ with list $fnName $opt -}} -{{ $o := last . -}} -{{ if eq $o.FnName $fnName -}} --{{ $o.Name }} | {{ range $i, $e := $o.Env }} {{ if $i }}, {{ end }}${{ $e }}{{ end }} -: {{ $o.Usage }}. {{- if $o.Default }} Default: `{{ $o.Default }}`.{{ end }} - -{{ end -}} -{{ end -}} -{{ end -}} -{{ end -}} -{{ end }} - -{{`{{< toc >}}`}} - -## Configuration - -### 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/thumbnails/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`. - -### Environment variables - -If you prefer to configure the service with environment variables you can see the available variables below. - -If multiple variables are listed for one option, they are in order of precedence. This means the leftmost variable will always win if given. - -### Command-line flags - -If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -{{ $options := .Options -}} -{{ range $com := .Commands }}{{ with (list $options $com) -}} -{{ $c := last . -}} -{{ if eq $c.Name "thumbnails" -}} -## Root Command - -{{ $c.Usage }} - -Usage: `thumbnails [global options] command [command options] [arguments...]` -{{ template "options" . -}} -## Sub Commands - -{{ end -}} -{{ end -}} -{{ end -}} -{{- range $com := .Commands }}{{ with (list $options $com) -}} -{{- $c := last . }} -{{- if ne $c.Name "thumbnails" -}} -### thumbnails {{ $c.Name }} - -{{ $c.Usage }} - -Usage: `thumbnails {{ $c.Name }} [command options] [arguments...]` -{{ template "options" . }} -{{- end -}} -{{- end -}} -{{- end -}} diff --git a/web/templates/CONFIGURATION.tmpl b/web/templates/CONFIGURATION.tmpl deleted file mode 100644 index 066be9045..000000000 --- a/web/templates/CONFIGURATION.tmpl +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Configuration" -date: "{{ date "2006-01-02T15:04:05-0700" now }}" -weight: 20 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/web/templates -geekdocFilePath: CONFIGURATION.tmpl ---- -{{- define "options"}} -{{ $fnNames := (last . ).Flags -}} -{{ range $opt := first . }} -{{ range $fnName := $fnNames }}{{ with list $fnName $opt -}} -{{ $o := last . -}} -{{ if eq $o.FnName $fnName -}} --{{ $o.Name }} | {{ range $i, $e := $o.Env }} {{ if $i }}, {{ end }}${{ $e }}{{ end }} -: {{ $o.Usage }}. {{- if $o.Default }} Default: `{{ $o.Default }}`.{{ end }} - -{{ end -}} -{{ end -}} -{{ end -}} -{{ end -}} -{{ end }} - -{{`{{< toc >}}`}} - -## Configuration - -### 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-web reads `web.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/web/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`. - -### Environment variables - -If you prefer to configure the service with environment variables you can see the available variables below. - -If multiple variables are listed for one option, they are in order of precedence. This means the leftmost variable will always win if given. - -### Command-line flags - -If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -{{ $options := .Options -}} -{{ range $com := .Commands }}{{ with (list $options $com) -}} -{{ $c := last . -}} -{{ if eq $c.Name "web" -}} -## Root Command - -{{ $c.Usage }} - -Usage: `web [global options] command [command options] [arguments...]` -{{ template "options" . -}} -## Sub Commands - -{{ end -}} -{{ end -}} -{{ end -}} -{{- range $com := .Commands }}{{ with (list $options $com) -}} -{{- $c := last . }} -{{- if ne $c.Name "web" -}} -### web {{ $c.Name }} - -{{ $c.Usage }} - -Usage: `web {{ $c.Name }} [command options] [arguments...]` -{{ template "options" . }} -{{- end -}} -{{- end -}} -{{- end -}} diff --git a/webdav/templates/CONFIGURATION.tmpl b/webdav/templates/CONFIGURATION.tmpl deleted file mode 100644 index 6533998dc..000000000 --- a/webdav/templates/CONFIGURATION.tmpl +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Configuration" -date: "{{ date "2006-01-02T15:04:05-0700" now }}" -weight: 20 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/webdav/templates -geekdocFilePath: CONFIGURATION.tmpl ---- -{{- define "options"}} -{{ $fnNames := (last . ).Flags -}} -{{ range $opt := first . }} -{{ range $fnName := $fnNames }}{{ with list $fnName $opt -}} -{{ $o := last . -}} -{{ if eq $o.FnName $fnName -}} --{{ $o.Name }} | {{ range $i, $e := $o.Env }} {{ if $i }}, {{ end }}${{ $e }}{{ end }} -: {{ $o.Usage }}. {{- if $o.Default }} Default: `{{ $o.Default }}`.{{ end }} - -{{ end -}} -{{ end -}} -{{ end -}} -{{ end -}} -{{ end }} - -{{`{{< toc >}}`}} - -## Configuration - -### 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/webdav/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`. - -### Environment variables - -If you prefer to configure the service with environment variables you can see the available variables below. - -If multiple variables are listed for one option, they are in order of precedence. This means the leftmost variable will always win if given. - -### Command-line flags - -If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -{{ $options := .Options -}} -{{ range $com := .Commands }}{{ with (list $options $com) -}} -{{ $c := last . -}} -{{ if eq $c.Name "webdav" -}} -## Root Command - -{{ $c.Usage }} - -Usage: `webdav [global options] command [command options] [arguments...]` -{{ template "options" . -}} -## Sub Commands - -{{ end -}} -{{ end -}} -{{ end -}} -{{- range $com := .Commands }}{{ with (list $options $com) -}} -{{- $c := last . }} -{{- if ne $c.Name "webdav" -}} -### webdav {{ $c.Name }} - -{{ $c.Usage }} - -Usage: `webdav {{ $c.Name }} [command options] [arguments...]` -{{ template "options" . }} -{{- end -}} -{{- end -}} -{{- end -}}