commit 0fa1d57

Merge: 45de881 dbecc7d Author: Lukas Hirt <lhirt@owncloud.com> Date: Tue Dec 1 11:50:33 2020 +0100 Merge pull request #857 from owncloud/onlyoffice-ext
owncloud · Dec 1, 2020 · 4f13fab · 4f13fab
1 parent f0af875
commit 4f13fab
Show file tree

Hide file tree

Showing 10 changed files with 625 additions and 173 deletions.
diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2020-12-01T04:27:01+0000"
+date: "2020-12-01T11:18:23+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/accounts/templates
@@ -37,6 +37,18 @@ If you prefer to configure the service with environment variables you can see th
 
 If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly.
 
+### accounts remove
+
+Removes an existing account
+
+Usage: `accounts remove [command options] [arguments...]`
+
+--grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE  
+: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`.
+
+--name | $ACCOUNTS_NAME  
+: service name. Default: `accounts`.
+
 ### accounts ocis-accounts
 
 Provide accounts and groups for oCIS
@@ -52,30 +64,6 @@ Usage: `accounts ocis-accounts [command options] [arguments...]`
 --log-color | $ACCOUNTS_LOG_COLOR  
 : Enable colored logging. Default: `true`.
 
-### accounts update
-
-Make changes to an existing account
-
-Usage: `accounts update [command options] [arguments...]`
-
-### accounts inspect
-
-Show detailed data on an existing account
-
-Usage: `accounts inspect [command options] [arguments...]`
-
---grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE  
-: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`.
-
---name | $ACCOUNTS_NAME  
-: service name. Default: `accounts`.
-
-### accounts add
-
-Create a new account
-
-Usage: `accounts add [command options] [arguments...]`
-
 ### accounts server
 
 Start ocis accounts service
@@ -130,23 +118,29 @@ Usage: `accounts server [command options] [arguments...]`
 --service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME  
 : username of the internal service user (required on EOS).
 
-### accounts remove
+### accounts add
 
-Removes an existing account
+Create a new account
 
-Usage: `accounts remove [command options] [arguments...]`
+Usage: `accounts add [command options] [arguments...]`
+
+### accounts version
+
+Print the versions of the running instances
+
+Usage: `accounts version [command options] [arguments...]`
 
 --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE  
 : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`.
 
 --name | $ACCOUNTS_NAME  
 : service name. Default: `accounts`.
 
-### accounts version
+### accounts inspect
 
-Print the versions of the running instances
+Show detailed data on an existing account
 
-Usage: `accounts version [command options] [arguments...]`
+Usage: `accounts inspect [command options] [arguments...]`
 
 --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE  
 : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`.
@@ -160,6 +154,12 @@ Rebuilds the service's index, i.e. deleting and then re-adding all existing docu
 
 Usage: `accounts rebuildIndex [command options] [arguments...]`
 
+### accounts update
+
+Make changes to an existing account
+
+Usage: `accounts update [command options] [arguments...]`
+
 ### accounts list
 
 List existing accounts

diff --git a/extensions/konnectd/configuration.md b/extensions/konnectd/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2020-12-01T04:27:04+0000"
+date: "2020-12-01T11:18:27+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/konnectd/templates
@@ -37,6 +37,30 @@ If you prefer to configure the service with environment variables you can see th
 
 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.
 
+### konnectd health
+
+Check health status
+
+Usage: `konnectd health [command options] [arguments...]`
+
+--debug-addr | $KONNECTD_DEBUG_ADDR  
+: Address to debug endpoint. Default: `0.0.0.0:9134`.
+
+### konnectd ocis-konnectd
+
+Serve Konnectd API for oCIS
+
+Usage: `konnectd ocis-konnectd [command options] [arguments...]`
+
+--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`.
+
 ### konnectd server
 
 Start integrated server
@@ -163,27 +187,3 @@ Usage: `konnectd version [command options] [arguments...]`
 --name | $KONNECTD_NAME  
 : Service name. Default: `konnectd`.
 
-### konnectd health
-
-Check health status
-
-Usage: `konnectd health [command options] [arguments...]`
-
---debug-addr | $KONNECTD_DEBUG_ADDR  
-: Address to debug endpoint. Default: `0.0.0.0:9134`.
-
-### konnectd ocis-konnectd
-
-Serve Konnectd API for oCIS
-
-Usage: `konnectd ocis-konnectd [command options] [arguments...]`
-
---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`.
-
diff --git a/extensions/onlyoffice/_index.md b/extensions/onlyoffice/_index.md
@@ -0,0 +1,10 @@
+---
+title: "OnlyFffice"
+date: 2018-05-02T00:00:00+00:00
+weight: 10
+geekdocRepo: https://github.com/owncloud/ocis/onlyoffice
+geekdocEditPath: edit/master/docs
+geekdocFilePath: _index.md
+---
+
+This service enables users open documents, spreadsheets and presentations in the OnlyOffice app installed in ownCloud 10.
diff --git a/extensions/onlyoffice/building.md b/extensions/onlyoffice/building.md
@@ -0,0 +1,28 @@
+---
+title: "Building"
+date: 2018-05-02T00:00:00+00:00
+weight: 30
+geekdocRepo: https://github.com/owncloud/ocis/onlyoffice
+geekdocEditPath: edit/master/docs
+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 >}}
+git clone https://github.com/owncloud/ocis/onlyoffice.git
+cd ocis-onlyoffice
+{{< / highlight >}}
+
+All required tool besides Go itself and make are bundled or getting automatically installed within the `GOPATH`. All commands to build this project are part of our `Makefile`.
+
+## Backend
+
+{{< highlight txt >}}
+make generate
+make build
+{{< / highlight >}}
+
+Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/onlyoffice -h` to see all available options.
diff --git a/extensions/onlyoffice/configuration.md b/extensions/onlyoffice/configuration.md
@@ -0,0 +1,113 @@
+---
+title: "Configuration"
+date: "2020-12-01T11:18:36+0000"
+weight: 20
+geekdocRepo: https://github.com/owncloud/ocis
+geekdocEditPath: edit/master/onlyoffice/templates
+geekdocFilePath: CONFIGURATION.tmpl
+---
+
+{{< 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/onlyoffice/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: onlyoffice reads `onlyoffice.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`.
+
+### Environment 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
+
+OnlyOffice oCIS extension
+
+Usage: `onlyoffice [global options] command [command options] [arguments...]`
+
+--config-file | $ONLYOFFICE_CONFIG_FILE  
+: Path to config file.
+
+--log-level | $ONLYOFFICE_LOG_LEVEL  
+: Set logging level. Default: `info`.
+
+--log-pretty | $ONLYOFFICE_LOG_PRETTY  
+: Enable pretty logging. Default: `true`.
+
+--log-color | $ONLYOFFICE_LOG_COLOR  
+: Enable colored logging. Default: `true`.
+
+## Sub Commands
+
+### onlyoffice server
+
+Start integrated server
+
+Usage: `onlyoffice server [command options] [arguments...]`
+
+--tracing-enabled | $ONLYOFFICE_TRACING_ENABLED  
+: Enable sending traces.
+
+--tracing-type | $ONLYOFFICE_TRACING_TYPE  
+: Tracing backend type. Default: `jaeger`.
+
+--tracing-endpoint | $ONLYOFFICE_TRACING_ENDPOINT  
+: Endpoint for the agent.
+
+--tracing-collector | $ONLYOFFICE_TRACING_COLLECTOR  
+: Endpoint for the collector.
+
+--tracing-service | $ONLYOFFICE_TRACING_SERVICE  
+: Service name for tracing. Default: `onlyoffice`.
+
+--debug-addr | $ONLYOFFICE_DEBUG_ADDR  
+: Address to bind debug server. Default: `0.0.0.0:9224`.
+
+--debug-token | $ONLYOFFICE_DEBUG_TOKEN  
+: Token to grant metrics access.
+
+--debug-pprof | $ONLYOFFICE_DEBUG_PPROF  
+: Enable pprof debugging.
+
+--debug-zpages | $ONLYOFFICE_DEBUG_ZPAGES  
+: Enable zpages debugging.
+
+--http-addr | $ONLYOFFICE_HTTP_ADDR  
+: Address to bind http server. Default: `0.0.0.0:9220`.
+
+--http-namespace | $ONLYOFFICE_HTTP_NAMESPACE  
+: Set the base namespace for the http namespace. Default: `com.owncloud.web`.
+
+--http-root | $ONLYOFFICE_HTTP_ROOT  
+: Root path of http server. Default: `/`.
+
+--asset-path | $ONLYOFFICE_ASSET_PATH  
+: Path to custom assets.
+
+### onlyoffice health
+
+Check health status
+
+Usage: `onlyoffice health [command options] [arguments...]`
+
+--debug-addr | $ONLYOFFICE_DEBUG_ADDR  
+: Address to debug endpoint. Default: `0.0.0.0:9224`.
+