diff --git a/.drone.star b/.drone.star
index f022140dde..a765ab4891 100644
--- a/.drone.star
+++ b/.drone.star
@@ -987,6 +987,11 @@ def badges(ctx):
}
def docs(ctx):
+ generateConfigDocs = []
+
+ for module in config['modules']:
+ generateConfigDocs += ['cd /drone/src/%s' % (module), 'make config-docs-generate']
+
return {
'kind': 'pipeline',
'type': 'docker',
@@ -1003,6 +1008,17 @@ def docs(ctx):
'make docs-copy'
],
},
+ {
+ 'name': 'generate-config-docs',
+ 'image': 'webhippie/golang:1.13',
+ 'commands': generateConfigDocs,
+ 'volumes': [
+ {
+ 'name': 'gopath',
+ 'path': '/srv/app',
+ },
+ ],
+ },
{
'name': 'test',
'image': 'owncloudci/hugo:0.71.0',
@@ -1064,6 +1080,12 @@ def docs(ctx):
'depends_on': [
'badges',
],
+ 'volumes': [
+ {
+ 'name': 'gopath',
+ 'temp': {},
+ },
+ ],
'trigger': {
'ref': [
'refs/heads/master',
diff --git a/docs/extensions/konnectd/configuration.md b/docs/extensions/konnectd/configuration.md
index 0eb5e9886d..281b64fde3 100644
--- a/docs/extensions/konnectd/configuration.md
+++ b/docs/extensions/konnectd/configuration.md
@@ -1,6 +1,6 @@
---
title: "Configuration"
-date: "2020-09-30T17:30:16+0200"
+date: "2020-09-21T13:14:47+0200"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis-konnectd
geekdocEditPath: edit/master/docs
@@ -108,9 +108,6 @@ Usage: `ocis-konnectd server [command options] [arguments...]`
--http-namespace | $KONNECTD_HTTP_NAMESPACE
: Set the base namespace for service discovery. Default: `com.owncloud.web`.
---name | $KONNECTD_NAME
-: Service name. Default: `konnectd`.
-
--identity-manager | $KONNECTD_IDENTITY_MANAGER
: Identity manager (one of ldap,kc,cookie,dummy). Default: `ldap`.
@@ -177,15 +174,3 @@ Usage: `ocis-konnectd server [command options] [arguments...]`
--disable-identifier-webapp | $KONNECTD_DISABLE_IDENTIFIER_WEBAPP
: Disable built-in identifier-webapp to use a frontend hosted elsewhere.. Default: `true`.
-### ocis-konnectd version
-
-Print the versions of the running instances
-
-Usage: `ocis-konnectd version [command options] [arguments...]`
-
---http-namespace | $KONNECTD_HTTP_NAMESPACE
-: Set the base namespace for service discovery. Default: `com.owncloud.web`.
-
---name | $KONNECTD_NAME
-: Service name. Default: `konnectd`.
-
diff --git a/docs/extensions/webdav/_index.md b/docs/extensions/webdav/_index.md
new file mode 100644
index 0000000000..77fd49925a
--- /dev/null
+++ b/docs/extensions/webdav/_index.md
@@ -0,0 +1,10 @@
+---
+title: WebDaV
+date: 2018-05-02T00:00:00+00:00
+weight: 10
+geekdocRepo: https://github.com/owncloud/ocis
+geekdocEditPath: edit/master/docs/extensions/webdav
+geekdocFilePath: _index.md
+---
+
+This service provides the WebDAV API which is required by some ownCloud clients.
diff --git a/webdav/docs/content/building.md b/docs/extensions/webdav/building.md
similarity index 86%
rename from webdav/docs/content/building.md
rename to docs/extensions/webdav/building.md
index 98c0b31c83..f4087d7326 100644
--- a/webdav/docs/content/building.md
+++ b/docs/extensions/webdav/building.md
@@ -1,10 +1,14 @@
---
title: "Building"
date: 2018-05-02T00:00:00+00:00
-anchor: "building"
weight: 30
+geekdocRepo: https://github.com/owncloud/ocis
+geekdocEditPath: edit/master/docs/extensions/webdav
+geekdocFilePath: building.md
---
+{{< toc >}}
+
As this project is built with Go, so you need to install that first. The installation of Go is out of the scope of this document, please follow the official documentation for [Go](https://golang.org/doc/install), to build this project you have to install Go >= v1.12. After the installation of the required tools you need to get the sources:
{{< highlight txt >}}
diff --git a/docs/extensions/webdav/configuration.md b/docs/extensions/webdav/configuration.md
new file mode 100644
index 0000000000..c415f1a9f7
--- /dev/null
+++ b/docs/extensions/webdav/configuration.md
@@ -0,0 +1,125 @@
+---
+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`.
+
diff --git a/webdav/docs/content/getting-started.md b/docs/extensions/webdav/getting-started.md
similarity index 98%
rename from webdav/docs/content/getting-started.md
rename to docs/extensions/webdav/getting-started.md
index ba330a6ee6..66f274c508 100644
--- a/webdav/docs/content/getting-started.md
+++ b/docs/extensions/webdav/getting-started.md
@@ -1,10 +1,14 @@
---
title: "Getting Started"
date: 2018-05-02T00:00:00+00:00
-anchor: "getting-started"
weight: 20
+geekdocRepo: https://github.com/owncloud/ocis
+geekdocEditPath: edit/master/docs/extensions/webdav
+geekdocFilePath: getting-started.md
---
+{{< toc >}}
+
### Installation
So far we are offering two different variants for the installation. You can choose between [Docker](https://www.docker.com/) or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.
diff --git a/docs/ocis/configuration.md b/docs/ocis/configuration.md
index 3876e12209..807f92149e 100644
--- a/docs/ocis/configuration.md
+++ b/docs/ocis/configuration.md
@@ -1,6 +1,6 @@
---
title: "Configuration"
-date: "2020-09-30T17:35:29+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,114 +108,69 @@ 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 list
-
-Lists running ocis extensions
-
-#### ocis phoenix
-
-Start phoenix server
-
-#### ocis reva-gateway
-
-Start reva gateway
-
-#### ocis reva-storage-public-link
-
-Start reva public link storage
-
-#### ocis kill
-
-Kill an extension by name
-
-#### ocis ocs
-
-Start ocs server
-
-#### ocis reva-frontend
-
-Start reva frontend
-
-#### ocis reva-storage-eos-data
-
-Start reva storage data provider for eos mount
-
-#### ocis glauth
-
-Start glauth server
-
-#### ocis reva-storage-eos
-
-Start reva storage service for eos mount
-
-#### ocis reva-users
-
-Start reva users service
-
#### ocis konnectd
Start konnectd server
-#### ocis reva-storage-home-data
-
-Start reva storage data provider for home mount
-
-#### ocis reva-storage-root
-
-Start reva root storage
-
#### ocis run
Runs an extension
-#### ocis settings
-
-Start settings server
-
-#### ocis thumbnails
-
-Start thumbnails server
-
-#### ocis webdav
-
-Start webdav server
-
-#### ocis reva-auth-basic
-
-Start reva auth-basic service
-
-#### ocis accounts
-
-Start accounts server
-
-#### ocis proxy
-
-Start proxy server
-
#### ocis store
Start a go-micro store
+#### ocis glauth
+
+Start glauth server
+
+#### ocis ocs
+
+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-auth-bearer
Start reva auth-bearer service
-#### ocis reva-sharing
+#### ocis reva-storage-oc-data
-Start reva sharing service
+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
@@ -216,7 +180,43 @@ Start reva storage service for home mount
Start reva storage service for oc mount
-#### ocis reva-storage-oc-data
+#### ocis reva-storage-root
-Start reva storage data provider for oc mount
+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
diff --git a/webdav/Makefile b/webdav/Makefile
index 8a7bf4ab65..3a44111a47 100644
--- a/webdav/Makefile
+++ b/webdav/Makefile
@@ -130,9 +130,9 @@ release-check:
.PHONY: release-finish
release-finish: release-copy release-check
-.PHONY: docs
-docs:
- cd docs; hugo
+.PHONY: config-docs-generate
+config-docs-generate:
+ go run github.com/owncloud/flaex >| ../docs/extensions/$(NAME)/configuration.md
.PHONY: watch
watch:
diff --git a/webdav/docs/.gitignore b/webdav/docs/.gitignore
deleted file mode 100644
index 364fdec1aa..0000000000
--- a/webdav/docs/.gitignore
+++ /dev/null
@@ -1 +0,0 @@
-public/
diff --git a/webdav/docs/archetypes/default.md b/webdav/docs/archetypes/default.md
deleted file mode 100644
index 4e777bee13..0000000000
--- a/webdav/docs/archetypes/default.md
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: "{{ replace .TranslationBaseName "-" " " | title }}"
-date: {{ .Date }}
-anchor: "{{ replace .TranslationBaseName "-" " " | title | urlize }}"
-weight:
----
diff --git a/webdav/docs/config.toml b/webdav/docs/config.toml
deleted file mode 100644
index 94f1456082..0000000000
--- a/webdav/docs/config.toml
+++ /dev/null
@@ -1,18 +0,0 @@
-baseURL = "https://owncloud.github.io/ocis-webdav/"
-languageCode = "en-us"
-title = "ownCloud Infinite Scale: WebDAV"
-pygmentsUseClasses = true
-
-disableKinds = ["taxonomy", "taxonomyTerm", "RSS", "sitemap"]
-
-[blackfriday]
- angledQuotes = true
- fractions = false
- plainIDAnchors = true
- smartlists = true
- extensions = ["hardLineBreak"]
-
-[params]
- author = "ownCloud GmbH"
- description = "Serve WebDAV API for oCIS"
- keywords = "reva, ocis"
diff --git a/webdav/docs/content/about.md b/webdav/docs/content/about.md
deleted file mode 100644
index da72010f08..0000000000
--- a/webdav/docs/content/about.md
+++ /dev/null
@@ -1,8 +0,0 @@
----
-title: "About"
-date: 2018-05-02T00:00:00+00:00
-anchor: "about"
-weight: 10
----
-
-This service provides the WebDAV API which is required by some ownCloud clients.
diff --git a/webdav/docs/content/license.md b/webdav/docs/content/license.md
deleted file mode 100644
index e6bd9a08ee..0000000000
--- a/webdav/docs/content/license.md
+++ /dev/null
@@ -1,8 +0,0 @@
----
-title: "License"
-date: 2018-05-02T00:00:00+00:00
-anchor: "license"
-weight: 40
----
-
-This project is licensed under the [Apache 2.0](https://github.com/owncloud/ocis/webdav/blob/master/LICENSE) license. For the license of the used libraries you have to check the respective sources.
diff --git a/webdav/docs/layouts/_default/list.html b/webdav/docs/layouts/_default/list.html
deleted file mode 100644
index e69de29bb2..0000000000
diff --git a/webdav/docs/layouts/_default/single.html b/webdav/docs/layouts/_default/single.html
deleted file mode 100644
index e69de29bb2..0000000000
diff --git a/webdav/docs/layouts/index.html b/webdav/docs/layouts/index.html
deleted file mode 100644
index 27db113acd..0000000000
--- a/webdav/docs/layouts/index.html
+++ /dev/null
@@ -1,57 +0,0 @@
-
-
-
-
-
-
-
-
- {{ .Site.Title }}
-
-
-
-
-
- {{ partial "style.html" . }}
-
-
-
-
-
-