diff --git a/_index.md b/_index.md index 7015b202fcb..81065208ac2 100644 --- a/_index.md +++ b/_index.md @@ -1,7 +1,29 @@ --- -title: Documentation +title: ownCloud --- -Developer Docs for ownCloud Infinite Scale +## Developer Documentation + +Welcome to our developer documentation. Here you can find documentation for developers on +- The oCIS server +- oCIS extensions +- All Client, like Android, iOS, and the Desktop Client +- Integrations + +## We love open source + +The oCIS server is Apache v2 licensed. +The lower storage layer of oCIS is defined by the CS3 APIs and implemented in the REVA project. Our goal is to develop the CS3 APIs to an open standard and collaborate on the open source REVA reference implementation for CS3 APIs. + +You can also find all client sources on github. + +## Join us + +The oCIS server repository on github is a good entrypoint for you to join the project. But we also develop clients for iOS, Android, Desktop and Web. + +For communication on development you can join our public chat https://talk.owncloud.com + +If you want to help and improve ownCloud, start coding or open issues on github in the related repositiory. + +We are very happy to hear your feedback and ideas! -{{< figure class="page-image" src="/media/is.png" width="50%" height="auto">}} diff --git a/extensions/accounts/_index.md b/extensions/accounts/_index.md index 3249c0241d6..bcd0f170221 100644 --- a/extensions/accounts/_index.md +++ b/extensions/accounts/_index.md @@ -2,8 +2,8 @@ title: Accounts date: 2018-05-02T00:00:00+00:00 weight: 10 -geekdocRepo: https://github.com/owncloud/ocis-accounts -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/accounts geekdocFilePath: _index.md --- diff --git a/extensions/accounts/building.md b/extensions/accounts/building.md index 2d96c7ceb34..fa96cd0d1b2 100644 --- a/extensions/accounts/building.md +++ b/extensions/accounts/building.md @@ -2,8 +2,8 @@ title: "Building" date: 2018-05-02T00:00:00+00:00 weight: 30 -geekdocRepo: https://github.com/owncloud/ocis-accounts -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/accounts geekdocFilePath: building.md --- diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index f6c3830234b..e33e598f8ce 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -2,8 +2,8 @@ title: "Configuration" date: "2020-07-01T11:10:52+0200" weight: 20 -geekdocRepo: https://github.com/owncloud/ocis-reva -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/accounts geekdocFilePath: configuration.md --- diff --git a/extensions/accounts/getting-started.md b/extensions/accounts/getting-started.md index d389b843caa..42c48962ef0 100644 --- a/extensions/accounts/getting-started.md +++ b/extensions/accounts/getting-started.md @@ -2,8 +2,8 @@ title: "Getting Started" date: 2018-05-02T00:00:00+00:00 weight: 20 -geekdocRepo: https://github.com/owncloud/ocis-accounts -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/accounts geekdocFilePath: getting-started.md --- diff --git a/extensions/glauth/_index.md b/extensions/glauth/_index.md index 25756306d71..1396c62e858 100644 --- a/extensions/glauth/_index.md +++ b/extensions/glauth/_index.md @@ -2,8 +2,8 @@ title: "GLAuth" date: 2018-05-02T00:00:00+00:00 weight: 10 -geekdocRepo: https://github.com/owncloud/ocis-glauth -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/glauth geekdocFilePath: _index.md --- diff --git a/extensions/glauth/building.md b/extensions/glauth/building.md index 7dc26619fb1..bdfdb6b7644 100644 --- a/extensions/glauth/building.md +++ b/extensions/glauth/building.md @@ -2,8 +2,8 @@ title: "Building" date: 2018-05-02T00:00:00+00:00 weight: 30 -geekdocRepo: https://github.com/owncloud/ocis-glauth -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/glauth geekdocFilePath: building.md --- diff --git a/extensions/glauth/getting-started.md b/extensions/glauth/getting-started.md index f28c31e1f29..e060ed5f00c 100644 --- a/extensions/glauth/getting-started.md +++ b/extensions/glauth/getting-started.md @@ -2,8 +2,8 @@ title: "Getting Started" date: 2018-05-02T00:00:00+00:00 weight: 20 -geekdocRepo: https://github.com/owncloud/ocis-glauth -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/glauth geekdocFilePath: getting-started.md --- diff --git a/extensions/glauth/license.md b/extensions/glauth/license.md index 914cd70bdc1..19923026935 100644 --- a/extensions/glauth/license.md +++ b/extensions/glauth/license.md @@ -2,8 +2,8 @@ title: "License" date: 2018-05-02T00:00:00+00:00 weight: 40 -geekdocRepo: https://github.com/owncloud/ocis-glauth -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/glauth geekdocFilePath: license.md --- diff --git a/extensions/konnectd/_index.md b/extensions/konnectd/_index.md index b12cd3b0edc..be2859ce8ea 100644 --- a/extensions/konnectd/_index.md +++ b/extensions/konnectd/_index.md @@ -1,7 +1,7 @@ --- title: Konnectd -geekdocRepo: https://github.com/owncloud/ocis-konnectd -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/konnectd geekdocFilePath: _index.md --- diff --git a/extensions/konnectd/building.md b/extensions/konnectd/building.md index b044dd1d4eb..452cc27ed82 100644 --- a/extensions/konnectd/building.md +++ b/extensions/konnectd/building.md @@ -2,8 +2,8 @@ title: "Building" date: 2020-02-21T00:00:00+00:00 weight: 30 -geekdocRepo: https://github.com/owncloud/ocis-konnectd -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/konnectd geekdocFilePath: building.md --- diff --git a/extensions/konnectd/configuration.md b/extensions/konnectd/configuration.md index 99ef18d0fb0..726dc513c0b 100644 --- a/extensions/konnectd/configuration.md +++ b/extensions/konnectd/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-06T12:37:00+0000" +date: "2020-10-06T13:32:41+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis-konnectd geekdocEditPath: edit/master/docs diff --git a/extensions/konnectd/getting-started.md b/extensions/konnectd/getting-started.md index 96be58e3b04..9806264eef3 100644 --- a/extensions/konnectd/getting-started.md +++ b/extensions/konnectd/getting-started.md @@ -2,8 +2,8 @@ title: "Getting Started" date: 2018-05-02T00:00:00+00:00 weight: 10 -geekdocRepo: https://github.com/owncloud/ocis-konnectd -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/konnectd geekdocFilePath: getting-started.md --- diff --git a/extensions/ocis-phoenix/_index.md b/extensions/ocis-phoenix/_index.md index c48d8bc688c..a1dadd6f98d 100644 --- a/extensions/ocis-phoenix/_index.md +++ b/extensions/ocis-phoenix/_index.md @@ -1,10 +1,12 @@ --- -title: "Phoenix" +title: "oCIS Web" date: 2018-05-02T00:00:00+00:00 weight: 10 -geekdocRepo: https://github.com/owncloud/ocis-phoenix -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/ocis-phoenix geekdocFilePath: _index.md --- +Note: Work in progress to rename Phoenix to oCIS Web. + This service embeds [Phoenix](https://github.com/owncloud/phoenix) to provide a UI for ownCloud Infinite Scale. diff --git a/extensions/ocis-phoenix/building.md b/extensions/ocis-phoenix/building.md index 0063c67f80c..8b8bcf168f4 100644 --- a/extensions/ocis-phoenix/building.md +++ b/extensions/ocis-phoenix/building.md @@ -2,23 +2,15 @@ title: "Building" date: 2018-05-02T00:00:00+00:00 weight: 30 -geekdocRepo: https://github.com/owncloud/ocis-phoenix -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/ocis-phoenix geekdocFilePath: building.md --- -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-phoenix.git -cd ocis-phoenix -{{< / 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 >}} +cd ocis-phoenix make generate make build {{< / highlight >}} diff --git a/extensions/ocis-phoenix/getting-started.md b/extensions/ocis-phoenix/getting-started.md index 2963fd9117e..31eb7bab35f 100644 --- a/extensions/ocis-phoenix/getting-started.md +++ b/extensions/ocis-phoenix/getting-started.md @@ -2,8 +2,8 @@ title: "Getting Started" date: 2018-05-02T00:00:00+00:00 weight: 20 -geekdocRepo: https://github.com/owncloud/ocis-phoenix -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/ocis-phoenix geekdocFilePath: getting-started.md --- diff --git a/extensions/ocis-phoenix/license.md b/extensions/ocis-phoenix/license.md index 1bcdc02c57f..c479a90c9b5 100644 --- a/extensions/ocis-phoenix/license.md +++ b/extensions/ocis-phoenix/license.md @@ -2,8 +2,8 @@ title: "License" date: 2018-05-02T00:00:00+00:00 weight: 50 -geekdocRepo: https://github.com/owncloud/ocis-phoenix -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/ocis-phoenix geekdocFilePath: license.md --- diff --git a/extensions/ocis-phoenix/releasing.md b/extensions/ocis-phoenix/releasing.md index e314c2ba739..4d80122fccc 100644 --- a/extensions/ocis-phoenix/releasing.md +++ b/extensions/ocis-phoenix/releasing.md @@ -1,8 +1,8 @@ --- title: "Releasing" weight: 40 -geekdocRepo: https://github.com/owncloud/ocis-phoenix -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/ocis-phoenix geekdocFilePath: releasing.md --- diff --git a/extensions/ocs/_index.md b/extensions/ocs/_index.md index 4f0c1512693..ae12ce18e77 100644 --- a/extensions/ocs/_index.md +++ b/extensions/ocs/_index.md @@ -2,8 +2,8 @@ title: "Ocs" date: 2018-05-02T00:00:00+00:00 weight: 10 -geekdocRepo: https://github.com/owncloud/ocis-ocs -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/ocs geekdocFilePath: _index.md --- diff --git a/extensions/ocs/building.md b/extensions/ocs/building.md index e01237a50fd..13e6c417c9d 100644 --- a/extensions/ocs/building.md +++ b/extensions/ocs/building.md @@ -2,8 +2,8 @@ title: "Building" date: 2018-05-02T00:00:00+00:00 weight: 30 -geekdocRepo: https://github.com/owncloud/ocis-ocs -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/ocs geekdocFilePath: building.md --- diff --git a/extensions/ocs/getting-started.md b/extensions/ocs/getting-started.md index a082d53dae7..7a740bbc3ff 100644 --- a/extensions/ocs/getting-started.md +++ b/extensions/ocs/getting-started.md @@ -2,8 +2,8 @@ title: "Getting Started" date: 2018-05-02T00:00:00+00:00 weight: 10 -geekdocRepo: https://github.com/owncloud/ocis-ocs -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/ocs geekdocFilePath: getting-started.md --- diff --git a/extensions/ocs/license.md b/extensions/ocs/license.md index ff55edfc6b7..380192a0f2f 100644 --- a/extensions/ocs/license.md +++ b/extensions/ocs/license.md @@ -2,8 +2,8 @@ title: "License" date: 2018-05-02T00:00:00+00:00 weight: 40 -geekdocRepo: https://github.com/owncloud/ocis-ocs -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/ocs geekdocFilePath: license.md --- diff --git a/extensions/proxy/_index.md b/extensions/proxy/_index.md index 5ad1d7b5fd6..71858199e0f 100644 --- a/extensions/proxy/_index.md +++ b/extensions/proxy/_index.md @@ -1,7 +1,7 @@ --- title: Proxy -geekdocRepo: https://github.com/owncloud/ocis-proxy -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/proxy geekdocFilePath: _index.md --- diff --git a/extensions/proxy/about.md b/extensions/proxy/about.md index 2707afefe10..10157aa0871 100644 --- a/extensions/proxy/about.md +++ b/extensions/proxy/about.md @@ -2,8 +2,8 @@ title: "About" date: 2020-02-07T00:00:00+00:00 weight: 10 -geekdocRepo: https://github.com/owncloud/ocis-proxy -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/proxy geekdocFilePath: about.md --- diff --git a/extensions/proxy/building.md b/extensions/proxy/building.md index 8007e899609..62b2519f7ff 100644 --- a/extensions/proxy/building.md +++ b/extensions/proxy/building.md @@ -2,8 +2,8 @@ title: "Building" date: 2018-05-02T00:00:00+00:00 weight: 30 -geekdocRepo: https://github.com/owncloud/ocis-proxy -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/proxy geekdocFilePath: building.md --- diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index 46167f2eb43..6091651b6b8 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-06T12:37:03+0000" +date: "2020-10-06T13:32:44+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis-proxy geekdocEditPath: edit/master/docs diff --git a/extensions/proxy/getting-started.md b/extensions/proxy/getting-started.md index 95f8a185a82..32cfe5f1c38 100644 --- a/extensions/proxy/getting-started.md +++ b/extensions/proxy/getting-started.md @@ -2,8 +2,8 @@ title: "Getting Started" date: 2018-05-02T00:00:00+00:00 weight: 15 -geekdocRepo: https://github.com/owncloud/ocis-proxy -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/proxy geekdocFilePath: getting-started.md --- diff --git a/extensions/settings/_index.md b/extensions/settings/_index.md index 9e70356dd66..a00ebc2cf76 100644 --- a/extensions/settings/_index.md +++ b/extensions/settings/_index.md @@ -2,8 +2,8 @@ title: "Settings" date: 2018-05-02T00:00:00+00:00 weight: 10 -geekdocRepo: https://github.com/owncloud/ocis-settings -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/settings geekdocFilePath: _index.md --- diff --git a/extensions/settings/building.md b/extensions/settings/building.md index 055b2387c51..726258d5942 100644 --- a/extensions/settings/building.md +++ b/extensions/settings/building.md @@ -2,8 +2,8 @@ title: "Building" date: 2018-05-02T00:00:00+00:00 weight: 30 -geekdocRepo: https://github.com/owncloud/ocis-settings -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/settings geekdocFilePath: building.md --- diff --git a/extensions/settings/bundles.md b/extensions/settings/bundles.md index 957c2147800..056b6b374d5 100644 --- a/extensions/settings/bundles.md +++ b/extensions/settings/bundles.md @@ -2,8 +2,8 @@ title: "Settings Bundles" date: 2020-05-04T00:00:00+00:00 weight: 50 -geekdocRepo: https://github.com/owncloud/ocis-settings -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/settings geekdocFilePath: bundles.md --- diff --git a/extensions/settings/getting-started.md b/extensions/settings/getting-started.md index b76a7187344..c662902374a 100644 --- a/extensions/settings/getting-started.md +++ b/extensions/settings/getting-started.md @@ -2,8 +2,8 @@ title: "Getting Started" date: 2018-05-02T00:00:00+00:00 weight: 25 -geekdocRepo: https://github.com/owncloud/ocis-settings -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/settings geekdocFilePath: getting-started.md --- diff --git a/extensions/settings/glossary.md b/extensions/settings/glossary.md index ffc9d8616f2..fe01c773ae0 100644 --- a/extensions/settings/glossary.md +++ b/extensions/settings/glossary.md @@ -2,8 +2,8 @@ title: "Glossary" date: 2020-05-04T12:35:00+01:00 weight: 80 -geekdocRepo: https://github.com/owncloud/ocis-settings -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/oci +geekdocEditPath: edit/master/docs/extensions/settings geekdocFilePath: glossary.md --- diff --git a/extensions/settings/license.md b/extensions/settings/license.md index bce5bddc466..6382020fd40 100644 --- a/extensions/settings/license.md +++ b/extensions/settings/license.md @@ -2,8 +2,8 @@ title: "License" date: 2018-05-02T00:00:00+00:00 weight: 90 -geekdocRepo: https://github.com/owncloud/ocis-settings -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/settings geekdocFilePath: license.md --- diff --git a/extensions/settings/values.md b/extensions/settings/values.md index 9e03c681fb1..3e025d2b063 100644 --- a/extensions/settings/values.md +++ b/extensions/settings/values.md @@ -2,8 +2,8 @@ title: "Settings Values" date: 2020-05-04T00:00:00+00:00 weight: 51 -geekdocRepo: https://github.com/owncloud/ocis-settings -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/settings geekdocFilePath: values.md --- diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index 9a9fcb609e2..769d6dc8eae 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-06T12:37:02+0000" +date: "2020-10-06T13:32:42+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/extensions/storage @@ -57,648 +57,648 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage frontend +### storage storage-root -Start frontend service +Start storage-root service -Usage: `storage frontend [command options] [arguments...]` +Usage: `storage storage-root [command options] [arguments...]` ---debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9141`. +--debug-addr | $STORAGE_STORAGE_ROOT_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9153`. ---transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. +--network | $STORAGE_STORAGE_ROOT_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---webdav-namespace | $WEBDAV_NAMESPACE -: Namespace prefix for the /webdav endpoint. Default: `/home/`. +--protocol | $STORAGE_STORAGE_ROOT_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. ---dav-files-namespace | $DAV_FILES_NAMESPACE -: Namespace prefix for the webdav /dav/files endpoint. Default: `/oc/`. +--addr | $STORAGE_STORAGE_ROOT_ADDR +: Address to bind storage service. Default: `0.0.0.0:9152`. ---network | $STORAGE_FRONTEND_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--url | $STORAGE_STORAGE_ROOT_URL +: URL to use for the storage service. Default: `localhost:9152`. ---protocol | $STORAGE_FRONTEND_PROTOCOL -: protocol for storage service, can be 'http' or 'grpc'. Default: `http`. +--driver | $STORAGE_STORAGE_ROOT_DRIVER +: storage driver for root mount: eg. local, eos, owncloud, ocis or s3. Default: `local`. ---addr | $STORAGE_FRONTEND_ADDR -: Address to bind storage service. Default: `0.0.0.0:9140`. +--mount-path | $STORAGE_STORAGE_ROOT_MOUNT_PATH +: mount path. Default: `/`. ---url | $STORAGE_FRONTEND_URL -: URL to use for the storage service. Default: `https://localhost:9200`. +--mount-id | $STORAGE_STORAGE_ROOT_MOUNT_ID +: mount id. Default: `123e4567-e89b-12d3-a456-426655440001`. ---datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX -: datagateway prefix. Default: `data`. +--expose-data-server | $STORAGE_STORAGE_ROOT_EXPOSE_DATA_SERVER +: exposes a dedicated data server. ---ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX -: owncloud webdav endpoint prefix. +--data-server-url | $STORAGE_STORAGE_ROOT_DATA_SERVER_URL +: data server url. ---ocs-prefix | $STORAGE_FRONTEND_OCS_PREFIX -: open collaboration services endpoint prefix. Default: `ocs`. +### storage storage-metadata ---gateway-url | $STORAGE_GATEWAY_URL -: URL to use for the storage gateway service. Default: `localhost:9142`. +Start storage-metadata service ---upload-disable-tus | $STORAGE_FRONTEND_UPLOAD_DISABLE_TUS -: Disables TUS upload mechanism. Default: `false`. +Usage: `storage storage-metadata [command options] [arguments...]` ---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. +--debug-addr | $STORAGE_STORAGE_METADATA_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9217`. -### storage health +--network | $STORAGE_STORAGE_METADATA_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. -Check health status +--provider-addr | $STORAGE_STORAGE_METADATA_PROVIDER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9215`. -Usage: `storage health [command options] [arguments...]` +--data-server-url | $STORAGE_STORAGE_METADATA_DATA_SERVER_URL +: URL of the data-server the storage-provider uses. Default: `http://localhost:9216`. ---debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `0.0.0.0:9109`. +--data-server-addr | $STORAGE_STORAGE_METADATA_DATA_SERVER_ADDR +: Address to bind the metadata data-server to. Default: `0.0.0.0:9216`. -### storage storage-public-link +--storage-provider-driver | $STORAGE_STORAGE_METADATA_PROVIDER_DRIVER +: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `local`. -Start storage-public-link service +--data-provider-driver | $STORAGE_STORAGE_METADATA_DATA_PROVIDER_DRIVER +: storage driver for data-provider mount: eg. local, eos, owncloud, ocis or s3. Default: `local`. -Usage: `storage storage-public-link [command options] [arguments...]` +--storage-root | $STORAGE_STORAGE_METADATA_ROOT +: the path to the metadata storage root. Default: `/var/tmp/ocis/metadata`. ---debug-addr | $STORAGE_STORAGE_PUBLIC_LINK_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9179`. +### storage sharing ---network | $STORAGE_STORAGE_PUBLIC_LINK_NETWORK +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_STORAGE_PUBLIC_LINK_PROTOCOL +--protocol | $STORAGE_SHARING_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`. +--addr | $STORAGE_SHARING_ADDR +: Address to bind storage service. Default: `0.0.0.0:9150`. ---mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `/public/`. +--url | $STORAGE_SHARING_URL +: URL to use for the storage service. Default: `localhost:9150`. ---gateway-url | $STORAGE_GATEWAY_URL -: URL to use for the storage gateway service. Default: `localhost:9142`. +--user-driver | $STORAGE_SHARING_USER_DRIVER +: driver to use for the UserShareProvider. Default: `json`. -### storage storage-home +--user-json-file | $STORAGE_SHARING_USER_JSON_FILE +: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/shares.json`. -Start storage-home service +--public-driver | $STORAGE_SHARING_PUBLIC_DRIVER +: driver to use for the PublicShareProvider. Default: `json`. -Usage: `storage storage-home [command options] [arguments...]` +### storage storage-eos-data ---debug-addr | $STORAGE_STORAGE_HOME_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9155`. +Start storage-eos-data service ---network | $STORAGE_STORAGE_HOME_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +Usage: `storage storage-eos-data [command options] [arguments...]` ---protocol | $STORAGE_STORAGE_HOME_PROTOCOL -: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. +--debug-addr | $STORAGE_STORAGE_OC_DATA_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9161`. ---addr | $STORAGE_STORAGE_HOME_ADDR -: Address to bind storage service. Default: `0.0.0.0:9154`. +--network | $STORAGE_STORAGE_EOS_DATA_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---url | $STORAGE_STORAGE_HOME_URL -: URL to use for the storage service. Default: `localhost:9154`. +--protocol | $STORAGE_STORAGE_EOS_DATA_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `http`. ---driver | $STORAGE_STORAGE_HOME_DRIVER -: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. +--addr | $STORAGE_STORAGE_EOS_DATA_ADDR +: Address to bind storage service. Default: `0.0.0.0:9160`. ---mount-path | $STORAGE_STORAGE_HOME_MOUNT_PATH -: mount path. Default: `/home`. +--url | $STORAGE_STORAGE_EOS_DATA_URL +: URL to use for the storage service. Default: `localhost:9160`. ---mount-id | $STORAGE_STORAGE_HOME_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. +--driver | $STORAGE_STORAGE_EOS_DATA_DRIVER +: storage driver for eos data mount: eg. local, eos, owncloud, ocis or s3. Default: `eos`. ---expose-data-server | $STORAGE_STORAGE_HOME_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. +--prefix | $STORAGE_STORAGE_EOS_DATA_PREFIX +: prefix for the http endpoint, without leading slash. Default: `data`. ---data-server-url | $STORAGE_STORAGE_HOME_DATA_SERVER_URL -: data server url. Default: `http://localhost:9156/data`. +--temp-folder | $STORAGE_STORAGE_EOS_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-eos +### storage gateway -Start storage-eos service +Start gateway -Usage: `storage storage-eos [command options] [arguments...]` +Usage: `storage gateway [command options] [arguments...]` ---debug-addr | $STORAGE_STORAGE_EOS_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9159`. +--debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9143`. ---network | $STORAGE_STORAGE_EOS_NETWORK +--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_STORAGE_EOS_PROTOCOL +--protocol | $STORAGE_GATEWAY_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`. +--addr | $STORAGE_GATEWAY_ADDR +: Address to bind storage service. Default: `0.0.0.0:9142`. ---driver | $STORAGE_STORAGE_EOS_DRIVER -: storage driver for eos mount: eg. local, eos, owncloud, ocis or s3. Default: `eos`. +--url | $STORAGE_GATEWAY_URL +: URL to use for the storage service. Default: `localhost:9142`. ---mount-path | $STORAGE_STORAGE_EOS_MOUNT_PATH -: mount path. Default: `/eos`. +--commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT +: Commit shares to the share manager. Default: `true`. ---mount-id | $STORAGE_STORAGE_EOS_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009158`. +--commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF +: Commit shares to the storage. Default: `true`. ---expose-data-server | $STORAGE_STORAGE_EOS_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. +--share-folder | $STORAGE_GATEWAY_SHARE_FOLDER +: mount shares in this folder of the home storage provider. Default: `Shares`. ---data-server-url | $STORAGE_STORAGE_EOS_DATA_SERVER_URL -: data server url. Default: `http://localhost:9160/data`. +--disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN +: Disable creation of home folder on login. -### storage storage +--storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER +: driver of the storage registry. Default: `static`. -Storage service for oCIS +--storage-home-provider | $STORAGE_STORAGE_HOME_PROVIDER +: mount point of the storage provider for user homes in the global namespace. Default: `/home`. -Usage: `storage storage [command options] [arguments...]` +--frontend-url | $STORAGE_FRONTEND_URL +: URL to use for the storage service. Default: `https://localhost:9200`. ---config-file | $STORAGE_CONFIG_FILE -: Path to config file. +--datagateway-url | $STORAGE_DATAGATEWAY_URL +: URL to use for the storage datagateway. Default: `https://localhost:9200/data`. ---log-level | $STORAGE_LOG_LEVEL -: Set logging level. Default: `info`. +--users-url | $STORAGE_USERS_URL +: URL to use for the storage service. Default: `localhost:9144`. ---log-pretty | $STORAGE_LOG_PRETTY -: Enable pretty logging. +--auth-basic-url | $STORAGE_AUTH_BASIC_URL +: URL to use for the storage service. Default: `localhost:9146`. ---log-color | $STORAGE_LOG_COLOR -: Enable colored logging. +--auth-bearer-url | $STORAGE_AUTH_BEARER_URL +: URL to use for the storage service. Default: `localhost:9148`. -### storage storage-oc-data +--sharing-url | $STORAGE_SHARING_URL +: URL to use for the storage service. Default: `localhost:9150`. -Start storage-oc-data service +--storage-root-url | $STORAGE_STORAGE_ROOT_URL +: URL to use for the storage service. Default: `localhost:9152`. -Usage: `storage storage-oc-data [command options] [arguments...]` +--storage-root-mount-path | $STORAGE_STORAGE_ROOT_MOUNT_PATH +: mount path. Default: `/`. ---debug-addr | $STORAGE_STORAGE_OC_DATA_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9165`. +--storage-root-mount-id | $STORAGE_STORAGE_ROOT_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009152`. ---network | $STORAGE_STORAGE_OC_DATA_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--storage-home-url | $STORAGE_STORAGE_HOME_URL +: URL to use for the storage service. Default: `localhost:9154`. ---protocol | $STORAGE_STORAGE_OC_DATA_PROTOCOL -: protocol for storage service, can be 'http' or 'grpc'. Default: `http`. +--storage-home-mount-path | $STORAGE_STORAGE_HOME_MOUNT_PATH +: mount path. Default: `/home`. ---addr | $STORAGE_STORAGE_OC_DATA_ADDR -: Address to bind storage service. Default: `0.0.0.0:9164`. +--storage-home-mount-id | $STORAGE_STORAGE_HOME_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009154`. ---url | $STORAGE_STORAGE_OC_DATA_URL -: URL to use for the storage service. Default: `localhost:9164`. +--storage-eos-url | $STORAGE_STORAGE_EOS_URL +: URL to use for the storage service. Default: `localhost:9158`. ---driver | $STORAGE_STORAGE_OC_DATA_DRIVER -: storage driver for oc data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. +--storage-eos-mount-path | $STORAGE_STORAGE_EOS_MOUNT_PATH +: mount path. Default: `/eos`. ---prefix | $STORAGE_STORAGE_OC_DATA_PREFIX -: prefix for the http endpoint, without leading slash. Default: `data`. +--storage-eos-mount-id | $STORAGE_STORAGE_EOS_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009158`. ---temp-folder | $STORAGE_STORAGE_OC_DATA_TEMP_FOLDER -: temp folder. Default: `/var/tmp/`. +--storage-oc-url | $STORAGE_STORAGE_OC_URL +: URL to use for the storage service. Default: `localhost:9162`. ---gateway-url | $STORAGE_GATEWAY_URL -: URL to use for the storage gateway service. Default: `localhost:9142`. +--storage-oc-mount-path | $STORAGE_STORAGE_OC_MOUNT_PATH +: mount path. Default: `/oc`. ---users-url | $STORAGE_USERS_URL -: URL to use for the storage service. Default: `localhost:9144`. +--storage-oc-mount-id | $STORAGE_STORAGE_OC_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. -### storage users +--public-link-url | $STORAGE_STORAGE_PUBLIC_LINK_URL +: URL to use for the public links service. Default: `localhost:9178`. -Start users service +--storage-public-link-mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `/public/`. -Usage: `storage users [command options] [arguments...]` +### storage auth-bearer ---debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9145`. +Start authprovider for bearer auth ---network | $STORAGE_USERS_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +Usage: `storage auth-bearer [command options] [arguments...]` ---protocol | $STORAGE_USERS_PROTOCOL -: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. +--debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9149`. ---addr | $STORAGE_USERS_ADDR -: Address to bind storage service. Default: `0.0.0.0:9144`. +--oidc-issuer | $STORAGE_OIDC_ISSUER +: OIDC issuer. Default: `https://localhost:9200`. ---url | $STORAGE_USERS_URL -: URL to use for the storage service. Default: `localhost:9144`. +--oidc-insecure | $STORAGE_OIDC_INSECURE +: OIDC allow insecure communication. Default: `true`. ---driver | $STORAGE_USERS_DRIVER -: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. +--oidc-id-claim | $STORAGE_OIDC_ID_CLAIM +: OIDC id claim. Default: `preferred_username`. ---json-config | $STORAGE_USERS_JSON -: Path to users.json file. +--oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM +: OIDC uid claim. ---rest-client-id | $STORAGE_REST_CLIENT_ID -: User rest driver Client ID. +--oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM +: OIDC gid claim. ---rest-client-secret | $STORAGE_REST_CLIENT_SECRET -: User rest driver Client Secret. +--network | $STORAGE_AUTH_BEARER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---rest-redis-address | $STORAGE_REST_REDIS_ADDRESS -: Address for redis server. Default: `localhost:6379`. +--protocol | $STORAGE_AUTH_BEARER_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. ---rest-redis-username | $STORAGE_REST_REDIS_USERNAME -: Username for redis server. +--addr | $STORAGE_AUTH_BEARER_ADDR +: Address to bind storage service. Default: `0.0.0.0:9148`. ---rest-redis-password | $STORAGE_REST_REDIS_PASSWORD -: Password for redis server. +--url | $STORAGE_AUTH_BEARER_URL +: URL to use for the storage service. Default: `localhost:9148`. ---rest-id-provider | $STORAGE_REST_ID_PROVIDER -: The OIDC Provider. +### storage health ---rest-api-base-url | $STORAGE_REST_API_BASE_URL -: Base API Endpoint. +Check health status ---rest-oidc-token-endpoint | $STORAGE_REST_OIDC_TOKEN_ENDPOINT -: Endpoint to generate token to access the API. +Usage: `storage health [command options] [arguments...]` ---rest-target-api | $STORAGE_REST_TARGET_API -: The target application. +--debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `0.0.0.0:9109`. -### storage storage-root +### storage storage-public-link -Start storage-root service +Start storage-public-link service -Usage: `storage storage-root [command options] [arguments...]` +Usage: `storage storage-public-link [command options] [arguments...]` ---debug-addr | $STORAGE_STORAGE_ROOT_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9153`. +--debug-addr | $STORAGE_STORAGE_PUBLIC_LINK_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9179`. ---network | $STORAGE_STORAGE_ROOT_NETWORK +--network | $STORAGE_STORAGE_PUBLIC_LINK_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $STORAGE_STORAGE_ROOT_PROTOCOL +--protocol | $STORAGE_STORAGE_PUBLIC_LINK_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`. +--addr | $STORAGE_STORAGE_PUBLIC_LINK_ADDR +: Address to bind storage service. Default: `0.0.0.0:9178`. ---driver | $STORAGE_STORAGE_ROOT_DRIVER -: storage driver for root mount: eg. local, eos, owncloud, ocis or s3. Default: `local`. +--url | $STORAGE_STORAGE_PUBLIC_LINK_URL +: Address to bind storage service. Default: `localhost:9178`. ---mount-path | $STORAGE_STORAGE_ROOT_MOUNT_PATH -: mount path. Default: `/`. +--mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `/public/`. ---mount-id | $STORAGE_STORAGE_ROOT_MOUNT_ID -: mount id. Default: `123e4567-e89b-12d3-a456-426655440001`. +--gateway-url | $STORAGE_GATEWAY_URL +: URL to use for the storage gateway service. Default: `localhost:9142`. ---expose-data-server | $STORAGE_STORAGE_ROOT_EXPOSE_DATA_SERVER -: exposes a dedicated data server. +### storage storage-eos ---data-server-url | $STORAGE_STORAGE_ROOT_DATA_SERVER_URL -: data server url. +Start storage-eos service -### storage storage-metadata +Usage: `storage storage-eos [command options] [arguments...]` -Start storage-metadata service +--debug-addr | $STORAGE_STORAGE_EOS_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9159`. -Usage: `storage storage-metadata [command options] [arguments...]` +--network | $STORAGE_STORAGE_EOS_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---debug-addr | $STORAGE_STORAGE_METADATA_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9217`. +--protocol | $STORAGE_STORAGE_EOS_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. ---network | $STORAGE_STORAGE_METADATA_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--addr | $STORAGE_STORAGE_EOS_ADDR +: Address to bind storage service. Default: `0.0.0.0:9158`. ---provider-addr | $STORAGE_STORAGE_METADATA_PROVIDER_ADDR -: Address to bind storage service. Default: `0.0.0.0:9215`. +--url | $STORAGE_STORAGE_EOS_URL +: URL to use for the storage service. Default: `localhost:9158`. ---data-server-url | $STORAGE_STORAGE_METADATA_DATA_SERVER_URL -: URL of the data-server the storage-provider uses. Default: `http://localhost:9216`. +--driver | $STORAGE_STORAGE_EOS_DRIVER +: storage driver for eos mount: eg. local, eos, owncloud, ocis or s3. Default: `eos`. ---data-server-addr | $STORAGE_STORAGE_METADATA_DATA_SERVER_ADDR -: Address to bind the metadata data-server to. Default: `0.0.0.0:9216`. +--mount-path | $STORAGE_STORAGE_EOS_MOUNT_PATH +: mount path. Default: `/eos`. ---storage-provider-driver | $STORAGE_STORAGE_METADATA_PROVIDER_DRIVER -: storage driver for metadata mount: eg. local, eos, owncloud, ocis or s3. Default: `local`. +--mount-id | $STORAGE_STORAGE_EOS_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009158`. ---data-provider-driver | $STORAGE_STORAGE_METADATA_DATA_PROVIDER_DRIVER -: storage driver for data-provider mount: eg. local, eos, owncloud, ocis or s3. Default: `local`. +--expose-data-server | $STORAGE_STORAGE_EOS_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. ---storage-root | $STORAGE_STORAGE_METADATA_ROOT -: the path to the metadata storage root. Default: `/var/tmp/ocis/metadata`. +--data-server-url | $STORAGE_STORAGE_EOS_DATA_SERVER_URL +: data server url. Default: `http://localhost:9160/data`. -### storage storage-oc +### storage storage-home-data -Start storage-oc service +Start storage-home-data service -Usage: `storage storage-oc [command options] [arguments...]` +Usage: `storage storage-home-data [command options] [arguments...]` ---debug-addr | $STORAGE_STORAGE_OC_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9163`. +--debug-addr | $STORAGE_STORAGE_HOME_DATA_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9157`. ---network | $STORAGE_STORAGE_OC_NETWORK +--network | $STORAGE_STORAGE_HOME_DATA_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`. +--protocol | $STORAGE_STORAGE_HOME_DATA_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `http`. ---addr | $STORAGE_STORAGE_OC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9162`. +--addr | $STORAGE_STORAGE_HOME_DATA_ADDR +: Address to bind storage service. Default: `0.0.0.0:9156`. ---url | $STORAGE_STORAGE_OC_URL -: URL to use for the storage service. Default: `localhost:9162`. +--url | $STORAGE_STORAGE_HOME_DATA_URL +: URL to use for the storage service. Default: `localhost:9156`. ---driver | $STORAGE_STORAGE_OC_DRIVER -: storage driver for oc mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. +--driver | $STORAGE_STORAGE_HOME_DATA_DRIVER +: storage driver for home data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. ---mount-path | $STORAGE_STORAGE_OC_MOUNT_PATH -: mount path. Default: `/oc`. +--prefix | $STORAGE_STORAGE_HOME_DATA_PREFIX +: prefix for the http endpoint, without leading slash. Default: `data`. ---mount-id | $STORAGE_STORAGE_OC_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. +--temp-folder | $STORAGE_STORAGE_HOME_DATA_TEMP_FOLDER +: temp folder. Default: `/var/tmp/`. ---expose-data-server | $STORAGE_STORAGE_OC_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `false`. +--enable-home | $STORAGE_STORAGE_HOME_ENABLE_HOME +: enable the creation of home directories. Default: `true`. ---data-server-url | $STORAGE_STORAGE_OC_DATA_SERVER_URL -: data server url. Default: `http://localhost:9164/data`. +--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 sharing +### storage storage-home -Start sharing service +Start storage-home service -Usage: `storage sharing [command options] [arguments...]` +Usage: `storage storage-home [command options] [arguments...]` ---debug-addr | $STORAGE_SHARING_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9151`. +--debug-addr | $STORAGE_STORAGE_HOME_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9155`. ---network | $STORAGE_SHARING_NETWORK +--network | $STORAGE_STORAGE_HOME_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $STORAGE_SHARING_PROTOCOL +--protocol | $STORAGE_STORAGE_HOME_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`. +--addr | $STORAGE_STORAGE_HOME_ADDR +: Address to bind storage service. Default: `0.0.0.0:9154`. ---user-json-file | $STORAGE_SHARING_USER_JSON_FILE -: file used to persist shares for the UserShareProvider. Default: `/var/tmp/ocis/shares.json`. +--url | $STORAGE_STORAGE_HOME_URL +: URL to use for the storage service. Default: `localhost:9154`. ---public-driver | $STORAGE_SHARING_PUBLIC_DRIVER -: driver to use for the PublicShareProvider. Default: `json`. +--driver | $STORAGE_STORAGE_HOME_DRIVER +: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. -### storage storage-eos-data +--mount-path | $STORAGE_STORAGE_HOME_MOUNT_PATH +: mount path. Default: `/home`. -Start storage-eos-data service +--mount-id | $STORAGE_STORAGE_HOME_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. -Usage: `storage storage-eos-data [command options] [arguments...]` +--expose-data-server | $STORAGE_STORAGE_HOME_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. ---debug-addr | $STORAGE_STORAGE_OC_DATA_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9161`. +--data-server-url | $STORAGE_STORAGE_HOME_DATA_SERVER_URL +: data server url. Default: `http://localhost:9156/data`. ---network | $STORAGE_STORAGE_EOS_DATA_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--enable-home | $STORAGE_STORAGE_HOME_ENABLE_HOME +: enable the creation of home directories. Default: `true`. ---protocol | $STORAGE_STORAGE_EOS_DATA_PROTOCOL -: protocol for storage service, can be 'http' or 'grpc'. Default: `http`. +--users-url | $STORAGE_USERS_URL +: URL to use for the storage service. Default: `localhost:9144`. ---addr | $STORAGE_STORAGE_EOS_DATA_ADDR -: Address to bind storage service. Default: `0.0.0.0:9160`. +### storage storage ---url | $STORAGE_STORAGE_EOS_DATA_URL -: URL to use for the storage service. Default: `localhost:9160`. +Storage service for oCIS ---driver | $STORAGE_STORAGE_EOS_DATA_DRIVER -: storage driver for eos data mount: eg. local, eos, owncloud, ocis or s3. Default: `eos`. +Usage: `storage storage [command options] [arguments...]` ---prefix | $STORAGE_STORAGE_EOS_DATA_PREFIX -: prefix for the http endpoint, without leading slash. Default: `data`. +--config-file | $STORAGE_CONFIG_FILE +: Path to config file. ---temp-folder | $STORAGE_STORAGE_EOS_DATA_TEMP_FOLDER -: temp folder. Default: `/var/tmp/`. +--log-level | $STORAGE_LOG_LEVEL +: Set logging level. Default: `info`. ---gateway-url | $STORAGE_GATEWAY_URL -: URL to use for the storage gateway service. Default: `localhost:9142`. +--log-pretty | $STORAGE_LOG_PRETTY +: Enable pretty logging. ---users-url | $STORAGE_USERS_URL -: URL to use for the storage service. Default: `localhost:9144`. +--log-color | $STORAGE_LOG_COLOR +: Enable colored logging. -### storage storage-home-data +### storage storage-oc-data -Start storage-home-data service +Start storage-oc-data service -Usage: `storage storage-home-data [command options] [arguments...]` +Usage: `storage storage-oc-data [command options] [arguments...]` ---debug-addr | $STORAGE_STORAGE_HOME_DATA_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9157`. +--debug-addr | $STORAGE_STORAGE_OC_DATA_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9165`. ---network | $STORAGE_STORAGE_HOME_DATA_NETWORK +--network | $STORAGE_STORAGE_OC_DATA_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $STORAGE_STORAGE_HOME_DATA_PROTOCOL +--protocol | $STORAGE_STORAGE_OC_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`. +--addr | $STORAGE_STORAGE_OC_DATA_ADDR +: Address to bind storage service. Default: `0.0.0.0:9164`. ---url | $STORAGE_STORAGE_HOME_DATA_URL -: URL to use for the storage service. Default: `localhost:9156`. +--url | $STORAGE_STORAGE_OC_DATA_URL +: URL to use for the storage service. Default: `localhost:9164`. ---driver | $STORAGE_STORAGE_HOME_DATA_DRIVER -: storage driver for home data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. +--driver | $STORAGE_STORAGE_OC_DATA_DRIVER +: storage driver for oc data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. ---prefix | $STORAGE_STORAGE_HOME_DATA_PREFIX +--prefix | $STORAGE_STORAGE_OC_DATA_PREFIX : prefix for the http endpoint, without leading slash. Default: `data`. ---temp-folder | $STORAGE_STORAGE_HOME_DATA_TEMP_FOLDER +--temp-folder | $STORAGE_STORAGE_OC_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 gateway - -Start gateway +### storage storage-oc -Usage: `storage gateway [command options] [arguments...]` +Start storage-oc service ---debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9143`. +Usage: `storage storage-oc [command options] [arguments...]` ---transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. +--debug-addr | $STORAGE_STORAGE_OC_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9163`. ---network | $STORAGE_GATEWAY_NETWORK +--network | $STORAGE_STORAGE_OC_NETWORK : Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---protocol | $STORAGE_GATEWAY_PROTOCOL +--protocol | $STORAGE_STORAGE_OC_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`. +--addr | $STORAGE_STORAGE_OC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9162`. ---url | $STORAGE_GATEWAY_URL -: URL to use for the storage service. Default: `localhost:9142`. +--url | $STORAGE_STORAGE_OC_URL +: URL to use for the storage service. Default: `localhost:9162`. ---commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT -: Commit shares to the share manager. Default: `true`. +--driver | $STORAGE_STORAGE_OC_DRIVER +: storage driver for oc mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`. ---commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF -: Commit shares to the storage. Default: `true`. +--mount-path | $STORAGE_STORAGE_OC_MOUNT_PATH +: mount path. Default: `/oc`. ---share-folder | $STORAGE_GATEWAY_SHARE_FOLDER -: mount shares in this folder of the home storage provider. Default: `Shares`. +--mount-id | $STORAGE_STORAGE_OC_MOUNT_ID +: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. ---disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN -: Disable creation of home folder on login. +--expose-data-server | $STORAGE_STORAGE_OC_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `false`. ---storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER -: driver of the storage registry. Default: `static`. +--data-server-url | $STORAGE_STORAGE_OC_DATA_SERVER_URL +: data server url. Default: `http://localhost:9164/data`. ---storage-home-provider | $STORAGE_STORAGE_HOME_PROVIDER -: mount point of the storage provider for user homes in the global namespace. Default: `/home`. +--users-url | $STORAGE_USERS_URL +: URL to use for the storage service. Default: `localhost:9144`. ---frontend-url | $STORAGE_FRONTEND_URL -: URL to use for the storage service. Default: `https://localhost:9200`. +### storage auth-basic ---datagateway-url | $STORAGE_DATAGATEWAY_URL -: URL to use for the storage datagateway. Default: `https://localhost:9200/data`. +Start authprovider for basic auth ---users-url | $STORAGE_USERS_URL -: URL to use for the storage service. Default: `localhost:9144`. +Usage: `storage auth-basic [command options] [arguments...]` ---auth-basic-url | $STORAGE_AUTH_BASIC_URL -: URL to use for the storage service. Default: `localhost:9146`. +--debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9147`. ---auth-bearer-url | $STORAGE_AUTH_BEARER_URL -: URL to use for the storage service. Default: `localhost:9148`. +--auth-driver | $STORAGE_AUTH_DRIVER +: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. ---sharing-url | $STORAGE_SHARING_URL -: URL to use for the storage service. Default: `localhost:9150`. +--auth-json | $STORAGE_AUTH_JSON +: Path to users.json file. ---storage-root-url | $STORAGE_STORAGE_ROOT_URL -: URL to use for the storage service. Default: `localhost:9152`. +--network | $STORAGE_AUTH_BASIC_NETWORK +: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---storage-root-mount-path | $STORAGE_STORAGE_ROOT_MOUNT_PATH -: mount path. Default: `/`. +--protocol | $STORAGE_AUTH_BASIC_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. ---storage-root-mount-id | $STORAGE_STORAGE_ROOT_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009152`. +--addr | $STORAGE_AUTH_BASIC_ADDR +: Address to bind storage service. Default: `0.0.0.0:9146`. ---storage-home-url | $STORAGE_STORAGE_HOME_URL -: URL to use for the storage service. Default: `localhost:9154`. +--url | $STORAGE_AUTH_BASIC_URL +: URL to use for the storage service. Default: `localhost:9146`. ---storage-home-mount-path | $STORAGE_STORAGE_HOME_MOUNT_PATH -: mount path. Default: `/home`. +### storage users ---storage-home-mount-id | $STORAGE_STORAGE_HOME_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009154`. +Start users service ---storage-eos-url | $STORAGE_STORAGE_EOS_URL -: URL to use for the storage service. Default: `localhost:9158`. +Usage: `storage users [command options] [arguments...]` ---storage-eos-mount-path | $STORAGE_STORAGE_EOS_MOUNT_PATH -: mount path. Default: `/eos`. +--debug-addr | $STORAGE_SHARING_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9145`. ---storage-eos-mount-id | $STORAGE_STORAGE_EOS_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009158`. +--network | $STORAGE_USERS_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---storage-oc-url | $STORAGE_STORAGE_OC_URL -: URL to use for the storage service. Default: `localhost:9162`. +--protocol | $STORAGE_USERS_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. ---storage-oc-mount-path | $STORAGE_STORAGE_OC_MOUNT_PATH -: mount path. Default: `/oc`. +--addr | $STORAGE_USERS_ADDR +: Address to bind storage service. Default: `0.0.0.0:9144`. ---storage-oc-mount-id | $STORAGE_STORAGE_OC_MOUNT_ID -: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`. +--url | $STORAGE_USERS_URL +: URL to use for the storage service. Default: `localhost:9144`. ---public-link-url | $STORAGE_STORAGE_PUBLIC_LINK_URL -: URL to use for the public links service. Default: `localhost:9178`. +--driver | $STORAGE_USERS_DRIVER +: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`. ---storage-public-link-mount-path | $STORAGE_STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `/public/`. +--json-config | $STORAGE_USERS_JSON +: Path to users.json file. -### storage auth-bearer +--rest-client-id | $STORAGE_REST_CLIENT_ID +: User rest driver Client ID. -Start authprovider for bearer auth +--rest-client-secret | $STORAGE_REST_CLIENT_SECRET +: User rest driver Client Secret. -Usage: `storage auth-bearer [command options] [arguments...]` +--rest-redis-address | $STORAGE_REST_REDIS_ADDRESS +: Address for redis server. Default: `localhost:6379`. ---debug-addr | $STORAGE_AUTH_BEARER_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9149`. +--rest-redis-username | $STORAGE_REST_REDIS_USERNAME +: Username for redis server. ---oidc-issuer | $STORAGE_OIDC_ISSUER -: OIDC issuer. Default: `https://localhost:9200`. +--rest-redis-password | $STORAGE_REST_REDIS_PASSWORD +: Password for redis server. ---oidc-insecure | $STORAGE_OIDC_INSECURE -: OIDC allow insecure communication. Default: `true`. +--rest-id-provider | $STORAGE_REST_ID_PROVIDER +: The OIDC Provider. ---oidc-id-claim | $STORAGE_OIDC_ID_CLAIM -: OIDC id claim. Default: `preferred_username`. +--rest-api-base-url | $STORAGE_REST_API_BASE_URL +: Base API Endpoint. ---oidc-uid-claim | $STORAGE_OIDC_UID_CLAIM -: OIDC uid claim. +--rest-oidc-token-endpoint | $STORAGE_REST_OIDC_TOKEN_ENDPOINT +: Endpoint to generate token to access the API. ---oidc-gid-claim | $STORAGE_OIDC_GID_CLAIM -: OIDC gid claim. +--rest-target-api | $STORAGE_REST_TARGET_API +: The target application. ---network | $STORAGE_AUTH_BEARER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +### storage frontend ---protocol | $STORAGE_AUTH_BEARER_PROTOCOL -: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. +Start frontend service ---addr | $STORAGE_AUTH_BEARER_ADDR -: Address to bind storage service. Default: `0.0.0.0:9148`. +Usage: `storage frontend [command options] [arguments...]` ---url | $STORAGE_AUTH_BEARER_URL -: URL to use for the storage service. Default: `localhost:9148`. +--debug-addr | $STORAGE_FRONTEND_DEBUG_ADDR +: Address to bind debug server. Default: `0.0.0.0:9141`. -### storage auth-basic +--transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`. -Start authprovider for basic auth +--webdav-namespace | $WEBDAV_NAMESPACE +: Namespace prefix for the /webdav endpoint. Default: `/home/`. -Usage: `storage auth-basic [command options] [arguments...]` +--dav-files-namespace | $DAV_FILES_NAMESPACE +: Namespace prefix for the webdav /dav/files endpoint. Default: `/oc/`. ---debug-addr | $STORAGE_AUTH_BASIC_DEBUG_ADDR -: Address to bind debug server. Default: `0.0.0.0:9147`. +--network | $STORAGE_FRONTEND_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. ---auth-driver | $STORAGE_AUTH_DRIVER -: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`. +--protocol | $STORAGE_FRONTEND_PROTOCOL +: protocol for storage service, can be 'http' or 'grpc'. Default: `http`. ---auth-json | $STORAGE_AUTH_JSON -: Path to users.json file. +--addr | $STORAGE_FRONTEND_ADDR +: Address to bind storage service. Default: `0.0.0.0:9140`. ---network | $STORAGE_AUTH_BASIC_NETWORK -: Network to use for the storage auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`. +--url | $STORAGE_FRONTEND_URL +: URL to use for the storage service. Default: `https://localhost:9200`. ---protocol | $STORAGE_AUTH_BASIC_PROTOCOL -: protocol for storage service, can be 'http' or 'grpc'. Default: `grpc`. +--datagateway-prefix | $STORAGE_FRONTEND_DATAGATEWAY_PREFIX +: datagateway prefix. Default: `data`. ---addr | $STORAGE_AUTH_BASIC_ADDR -: Address to bind storage service. Default: `0.0.0.0:9146`. +--ocdav-prefix | $STORAGE_FRONTEND_OCDAV_PREFIX +: owncloud webdav endpoint prefix. ---url | $STORAGE_AUTH_BASIC_URL -: URL to use for the storage service. Default: `localhost:9146`. +--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. diff --git a/extensions/store/_index.md b/extensions/store/_index.md index 3eec45a1d2f..b1de3b501fd 100644 --- a/extensions/store/_index.md +++ b/extensions/store/_index.md @@ -2,8 +2,8 @@ title: "Store" date: 2018-05-02T00:00:00+00:00 weight: 10 -geekdocRepo: https://github.com/owncloud/ocis-store -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/store geekdocFilePath: _index.md --- diff --git a/extensions/store/building.md b/extensions/store/building.md index c8f2de2c048..2dd085713a9 100644 --- a/extensions/store/building.md +++ b/extensions/store/building.md @@ -2,8 +2,8 @@ title: "Building" date: 2018-05-02T00:00:00+00:00 weight: 30 -geekdocRepo: https://github.com/owncloud/ocis-store -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/store geekdocFilePath: building.md --- diff --git a/extensions/store/getting-started.md b/extensions/store/getting-started.md index e9724f7f30a..c806fd489ac 100644 --- a/extensions/store/getting-started.md +++ b/extensions/store/getting-started.md @@ -2,8 +2,8 @@ title: "Getting Started" date: 2018-05-02T00:00:00+00:00 weight: 20 -geekdocRepo: https://github.com/owncloud/ocis-store -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/store geekdocFilePath: getting-started.md --- diff --git a/extensions/store/license.md b/extensions/store/license.md index a551d61f205..b9fbea3ef58 100644 --- a/extensions/store/license.md +++ b/extensions/store/license.md @@ -2,8 +2,8 @@ title: "License" date: 2018-05-02T00:00:00+00:00 weight: 40 -geekdocRepo: https://github.com/owncloud/ocis-store -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/store geekdocFilePath: license.md --- diff --git a/extensions/thumbnails/_index.md b/extensions/thumbnails/_index.md index 1007ebc39b3..d0ca7f2e6af 100644 --- a/extensions/thumbnails/_index.md +++ b/extensions/thumbnails/_index.md @@ -2,8 +2,8 @@ title: "Thumbnails" date: 2018-05-02T00:00:00+00:00 weight: 10 -geekdocRepo: https://github.com/owncloud/ocis-thumbnails -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/thumbnails geekdocFilePath: _index.md --- diff --git a/extensions/thumbnails/building.md b/extensions/thumbnails/building.md index 4c0c3dac016..0cb8ce3d1e5 100644 --- a/extensions/thumbnails/building.md +++ b/extensions/thumbnails/building.md @@ -2,8 +2,8 @@ title: "Building" date: 2018-05-02T00:00:00+00:00 weight: 30 -geekdocRepo: https://github.com/owncloud/ocis-thumbnails -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/thumbnails geekdocFilePath: building.md --- diff --git a/extensions/thumbnails/getting-started.md b/extensions/thumbnails/getting-started.md index 2bcbd07e45c..e867637775a 100644 --- a/extensions/thumbnails/getting-started.md +++ b/extensions/thumbnails/getting-started.md @@ -2,8 +2,8 @@ title: "Getting Started" date: 2018-05-02T00:00:00+00:00 weight: 20 -geekdocRepo: https://github.com/owncloud/ocis-thumbnails -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/thumbnails geekdocFilePath: getting-started.md --- diff --git a/extensions/thumbnails/grpc.md b/extensions/thumbnails/grpc.md index 27d9c2376c6..868a5dea57e 100644 --- a/extensions/thumbnails/grpc.md +++ b/extensions/thumbnails/grpc.md @@ -2,8 +2,8 @@ title: "GRPC API" date: 2018-05-02T00:00:00+00:00 weight: 50 -geekdocRepo: https://github.com/owncloud/ocis-thumbnails -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/thumbnails geekdocFilePath: grpc.md --- diff --git a/extensions/thumbnails/license.md b/extensions/thumbnails/license.md index 69cda13beb5..8aaf0470208 100644 --- a/extensions/thumbnails/license.md +++ b/extensions/thumbnails/license.md @@ -2,8 +2,8 @@ title: "License" date: 2018-05-02T00:00:00+00:00 weight: 60 -geekdocRepo: https://github.com/owncloud/ocis-thumbnails -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/thumbnails geekdocFilePath: license.md --- diff --git a/extensions/thumbnails/releasing.md b/extensions/thumbnails/releasing.md index b3bc0c19aeb..da0fc028d83 100644 --- a/extensions/thumbnails/releasing.md +++ b/extensions/thumbnails/releasing.md @@ -2,8 +2,8 @@ title: "Releasing" date: 2018-05-02T00:00:00+00:00 weight: 40 -geekdocRepo: https://github.com/owncloud/ocis-thumbnails -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/thumbnails geekdocFilePath: releasing.md --- diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index 065ecc461d6..9f69f55e7d7 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2020-10-06T12:37:05+0000" +date: "2020-10-06T13:32:46+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/extensions/webdav diff --git a/ocis/_index.md b/ocis/_index.md index bafdc6e27b4..59d02847f3a 100644 --- a/ocis/_index.md +++ b/ocis/_index.md @@ -1,5 +1,5 @@ --- -title: "Infinite Scale" +title: "oCIS" date: 2020-02-27T20:35:00+01:00 weight: -10 geekdocRepo: https://github.com/owncloud/ocis @@ -7,7 +7,19 @@ geekdocEditPath: edit/master/docs geekdocFilePath: _index.md --- -This tool provides a single entrypoint for the whole ownCloud Infinite Scale stack. +{{< figure class="floatright" src="/media/is.png" width="70%" height="auto" >}} + +## ownCloud Infinite Scale + +Welcome to oCIS! We develop a modern file-sync and share plattform, based on our knowledge and experience with the PHP ownCloud server project. + +### oCIS Server + +The oCIS server implementation follows go-lang best practices and is based on the [go-micro](https://go-micro.dev/) framework and [REVA](https://reva.link/). We love and stick to [12 Factor](https://12factor.net/). +oCIS is a micro-service based server, which allows scale-out of individual services to meet your specific performance requirements. +We run a huge test suite, which was originated in ownCloud 10 and continues to grow. + +### Architecture Overview {{< mermaid class="text-center">}} graph TD diff --git a/ocis/building.md b/ocis/building.md deleted file mode 100644 index 29e67ac29a9..00000000000 --- a/ocis/building.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "Building" -date: 2020-02-27T20:35:00+01:00 -weight: 50 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs -geekdocFilePath: building.md ---- - -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.13. After the installation of the required tools you need to get the sources: - -{{< highlight txt >}} -git clone https://github.com/owncloud/ocis.git -cd ocis -{{< / highlight >}} - -All required tools 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`. To build the `ocis` binary run: - -{{< highlight txt >}} -make generate -make build -{{< / highlight >}} - -Finally, you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis -h` to see all available options. - - -## Simple Ocis fo extonsions example - -Currently, we are using a go build tag to allow building a more simple set of the binary. It was intended to let extension developers focus on only the necessary services. - -{{< hint info >}} -While it the tag based simple build demonstrates how to use ocis as a framework for a micro service architecture, we may change to an approach that uses an explicit command to run only a subset of the services. -{{< / hint >}} - -```console -TAGS=simple make build -``` - -The artifact lives in `/bin/ocis` - -The generated simple ocis binary is a subset of the ocis command with a restricted set of services meant for ease up development. The services included are - -``` -ocis-hello -ocis-phoenix -ocis-konnectd -ocis-glauth -micro's own services -``` diff --git a/ocis/deployment/_index.md b/ocis/deployment/_index.md new file mode 100644 index 00000000000..a09f6ecc9b4 --- /dev/null +++ b/ocis/deployment/_index.md @@ -0,0 +1,29 @@ +--- +title: "Deployment" +date: 2020-10-01T20:35:00+01:00 +weight: -10 +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/deployment +geekdocFilePath: _index.md +--- + +{{< toc >}} + +## Deployments Scenarios and Examples +This section handles deployments and operations for admins. If you are looking for a development setup, start with + +### Setup oCIS +oCIS deployments are super simple, yet there are many configrations possible for advanced setups. + +- Basic setup - download and run +- Pick services and manage them individually +- SSL offloading with Traefik +- Use an external IDP + +### Migrate an existing ownCloud 10 +You can run ownCloud 10 and oCIS together. This allows you to use new parts of oCIS already with ownCloud 10 and also to have a smooth transition for users from ownCloud 10 to oCIS. + +- ownCloud 10 with oCIS IDP +- Switch on the new front end "oCIS web" with ownCloud 10 +- Run ownCloud 10 and oCIS in parallel - together +- Migrate users from ownCloud 10 to oCIS diff --git a/ocis/basic-remote-setup.md b/ocis/deployment/basic-remote-setup.md similarity index 100% rename from ocis/basic-remote-setup.md rename to ocis/deployment/basic-remote-setup.md diff --git a/ocis/bridge.md b/ocis/deployment/bridge.md similarity index 100% rename from ocis/bridge.md rename to ocis/deployment/bridge.md diff --git a/ocis/development/_index.md b/ocis/development/_index.md new file mode 100644 index 00000000000..c67391e50a4 --- /dev/null +++ b/ocis/development/_index.md @@ -0,0 +1,12 @@ +--- +title: "Development" +date: 2020-10-01T20:35:00+01:00 +weight: -12 +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/development +geekdocFilePath: _index.md +--- + +{{< toc >}} + +## Deployments Scenarios and Examples diff --git a/ocis/building-docs.md b/ocis/development/building-docs.md similarity index 66% rename from ocis/building-docs.md rename to ocis/development/building-docs.md index 5167657b161..fbe3b67a942 100644 --- a/ocis/building-docs.md +++ b/ocis/development/building-docs.md @@ -1,14 +1,12 @@ --- -title: "Building the documentation" +title: "Build the documentation" date: 2020-07-27T08:39:38+00:00 weight: 99 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs +geekdocEditPath: edit/master/docs/development geekdocFilePath: building-docs.md --- -{{< toc >}} - ## Buildling the documentation Following steps can be applied for every oCIS extension repository. @@ -28,9 +26,15 @@ hugo -D server Then open "http://localhost:1313/" -When making changes to the docs, run `make docs` again and the server will pick up the changes and reload the page automatically +When making changes to the docs, run + +```bash +rsync -ax --delete ../docs/ content/ +``` + +in the hugo folder and the server will pick up the changes and reload the page automatically. ### Deploying the documentation -The documentation is automatically deployed from the master branch to https://owncloud.github.io/phoenix/ +The documentation is automatically deployed from the master branch to https://owncloud.github.io diff --git a/ocis/development/building.md b/ocis/development/building.md new file mode 100644 index 00000000000..7177f101f4a --- /dev/null +++ b/ocis/development/building.md @@ -0,0 +1,46 @@ +--- +title: "Build ocis" +date: 2020-02-27T20:35:00+01:00 +weight: 30 +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/development +geekdocFilePath: building.md +--- + +## Build requirements + +All required tools besides `go` and `make` are bundled or getting automatically installed within the `GOPATH`. All commands to build this project are part of our `Makefile`. + +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.13. + +## Get the sources + +{{< highlight txt >}} +git clone https://github.com/owncloud/ocis.git +cd ocis +{{< / highlight >}} + +## Build the ocis binary + +The ocis binary source is in the ocis/ocis folder. In this folder you can build the ocis binary: + +{{< highlight txt >}} +make generate +make build +{{< / highlight >}} + +Finally, you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis -h` to see all available options. + +## Build a local ocis docker image + +If you are developing on a local branch based on docker / docker-compose setup, here is how to build a new ocis image. In the root folder: + +{{< highlight txt >}} +docker build -t owncloud/ocis:dev . +{{< / highlight >}} + +Then you can test as usual via + +{{< highlight txt >}} +docker run --rm -ti owncloud/ocis:dev +{{< / highlight >}} diff --git a/ocis/debugging.md b/ocis/development/debugging.md similarity index 99% rename from ocis/debugging.md rename to ocis/development/debugging.md index 4e443aa272a..94905fd588b 100644 --- a/ocis/debugging.md +++ b/ocis/development/debugging.md @@ -3,7 +3,7 @@ title: "Debugging" date: 2020-03-19T08:21:00+01:00 weight: 50 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs +geekdocEditPath: edit/master/docs/development geekdocFilePath: debugging.md --- diff --git a/ocis/development.md b/ocis/development/getting-started.md similarity index 96% rename from ocis/development.md rename to ocis/development/getting-started.md index bffe8805280..a52d3142e1e 100644 --- a/ocis/development.md +++ b/ocis/development/getting-started.md @@ -3,8 +3,8 @@ title: "Getting Started with Development" date: 2020-07-07T20:35:00+01:00 weight: 15 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs -geekdocFilePath: development.md +geekdocEditPath: edit/master/docs/development +geekdocFilePath: getting-started.md --- {{< toc >}} diff --git a/ocis/testing.md b/ocis/development/testing.md similarity index 99% rename from ocis/testing.md rename to ocis/development/testing.md index c19dacc69aa..28337a1324a 100644 --- a/ocis/testing.md +++ b/ocis/development/testing.md @@ -3,7 +3,7 @@ title: "Testing" date: 2018-05-02T00:00:00+00:00 weight: 37 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs +geekdocEditPath: edit/master/docs/development geekdocFilePath: testing.md --- diff --git a/ocis/tracing.md b/ocis/development/tracing.md similarity index 97% rename from ocis/tracing.md rename to ocis/development/tracing.md index 80b037d262f..39a3ab81d1a 100644 --- a/ocis/tracing.md +++ b/ocis/development/tracing.md @@ -3,7 +3,7 @@ title: "Tracing" date: 2020-05-13T12:09:00+01:00 weight: 55 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs +geekdocEditPath: edit/master/docs/development geekdocFilePath: tracing.md --- diff --git a/ocis/getting-started.md b/ocis/getting-started.md index 5c241aa7585..fd47222125c 100644 --- a/ocis/getting-started.md +++ b/ocis/getting-started.md @@ -1,7 +1,7 @@ --- title: "Getting Started" date: 2020-02-27T20:35:00+01:00 -weight: 15 +weight: -15 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs geekdocFilePath: getting-started.md