diff --git a/docs/_index.md b/docs/_index.md index 7015b202fcb..81065208ac2 100644 --- a/docs/_index.md +++ b/docs/_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/docs/extensions/accounts/_index.md b/docs/extensions/accounts/_index.md index 3249c0241d6..bcd0f170221 100644 --- a/docs/extensions/accounts/_index.md +++ b/docs/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/docs/extensions/accounts/building.md b/docs/extensions/accounts/building.md index 2d96c7ceb34..fa96cd0d1b2 100644 --- a/docs/extensions/accounts/building.md +++ b/docs/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/docs/extensions/accounts/configuration.md b/docs/extensions/accounts/configuration.md index f6c3830234b..e33e598f8ce 100644 --- a/docs/extensions/accounts/configuration.md +++ b/docs/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/docs/extensions/accounts/getting-started.md b/docs/extensions/accounts/getting-started.md index d389b843caa..42c48962ef0 100644 --- a/docs/extensions/accounts/getting-started.md +++ b/docs/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/docs/extensions/glauth/_index.md b/docs/extensions/glauth/_index.md index 25756306d71..1396c62e858 100644 --- a/docs/extensions/glauth/_index.md +++ b/docs/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/docs/extensions/glauth/building.md b/docs/extensions/glauth/building.md index 7dc26619fb1..bdfdb6b7644 100644 --- a/docs/extensions/glauth/building.md +++ b/docs/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/docs/extensions/glauth/getting-started.md b/docs/extensions/glauth/getting-started.md index f28c31e1f29..e060ed5f00c 100644 --- a/docs/extensions/glauth/getting-started.md +++ b/docs/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/docs/extensions/glauth/license.md b/docs/extensions/glauth/license.md index 914cd70bdc1..19923026935 100644 --- a/docs/extensions/glauth/license.md +++ b/docs/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/docs/extensions/konnectd/_index.md b/docs/extensions/konnectd/_index.md index b12cd3b0edc..be2859ce8ea 100644 --- a/docs/extensions/konnectd/_index.md +++ b/docs/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/docs/extensions/konnectd/building.md b/docs/extensions/konnectd/building.md index b044dd1d4eb..452cc27ed82 100644 --- a/docs/extensions/konnectd/building.md +++ b/docs/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/docs/extensions/konnectd/configuration.md b/docs/extensions/konnectd/configuration.md index 281b64fde38..85d83dabbc1 100644 --- a/docs/extensions/konnectd/configuration.md +++ b/docs/extensions/konnectd/configuration.md @@ -2,8 +2,8 @@ title: "Configuration" date: "2020-09-21T13:14:47+0200" weight: 20 -geekdocRepo: https://github.com/owncloud/ocis-konnectd -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/konnectd geekdocFilePath: configuration.md --- diff --git a/docs/extensions/konnectd/getting-started.md b/docs/extensions/konnectd/getting-started.md index 96be58e3b04..9806264eef3 100644 --- a/docs/extensions/konnectd/getting-started.md +++ b/docs/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/docs/extensions/ocis-phoenix/_index.md b/docs/extensions/ocis-phoenix/_index.md index c48d8bc688c..a1dadd6f98d 100644 --- a/docs/extensions/ocis-phoenix/_index.md +++ b/docs/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/docs/extensions/ocis-phoenix/building.md b/docs/extensions/ocis-phoenix/building.md index 0063c67f80c..8b8bcf168f4 100644 --- a/docs/extensions/ocis-phoenix/building.md +++ b/docs/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/docs/extensions/ocis-phoenix/getting-started.md b/docs/extensions/ocis-phoenix/getting-started.md index 2963fd9117e..31eb7bab35f 100644 --- a/docs/extensions/ocis-phoenix/getting-started.md +++ b/docs/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/docs/extensions/ocis-phoenix/license.md b/docs/extensions/ocis-phoenix/license.md index 1bcdc02c57f..c479a90c9b5 100644 --- a/docs/extensions/ocis-phoenix/license.md +++ b/docs/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/docs/extensions/ocis-phoenix/releasing.md b/docs/extensions/ocis-phoenix/releasing.md index e314c2ba739..4d80122fccc 100644 --- a/docs/extensions/ocis-phoenix/releasing.md +++ b/docs/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/docs/extensions/ocs/_index.md b/docs/extensions/ocs/_index.md index 4f0c1512693..ae12ce18e77 100644 --- a/docs/extensions/ocs/_index.md +++ b/docs/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/docs/extensions/ocs/building.md b/docs/extensions/ocs/building.md index e01237a50fd..13e6c417c9d 100644 --- a/docs/extensions/ocs/building.md +++ b/docs/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/docs/extensions/ocs/getting-started.md b/docs/extensions/ocs/getting-started.md index a082d53dae7..7a740bbc3ff 100644 --- a/docs/extensions/ocs/getting-started.md +++ b/docs/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/docs/extensions/ocs/license.md b/docs/extensions/ocs/license.md index ff55edfc6b7..380192a0f2f 100644 --- a/docs/extensions/ocs/license.md +++ b/docs/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/docs/extensions/proxy/_index.md b/docs/extensions/proxy/_index.md index 5ad1d7b5fd6..71858199e0f 100644 --- a/docs/extensions/proxy/_index.md +++ b/docs/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/docs/extensions/proxy/about.md b/docs/extensions/proxy/about.md index 2707afefe10..10157aa0871 100644 --- a/docs/extensions/proxy/about.md +++ b/docs/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/docs/extensions/proxy/building.md b/docs/extensions/proxy/building.md index 8007e899609..62b2519f7ff 100644 --- a/docs/extensions/proxy/building.md +++ b/docs/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/docs/extensions/proxy/configuration.md b/docs/extensions/proxy/configuration.md index 75e1fe63b55..56098fb1dce 100644 --- a/docs/extensions/proxy/configuration.md +++ b/docs/extensions/proxy/configuration.md @@ -2,8 +2,8 @@ title: "Configuration" date: "2020-09-21T13:14:51+0200" weight: 20 -geekdocRepo: https://github.com/owncloud/ocis-proxy -geekdocEditPath: edit/master/docs +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/proxy geekdocFilePath: configuration.md --- diff --git a/docs/extensions/proxy/getting-started.md b/docs/extensions/proxy/getting-started.md index 95f8a185a82..32cfe5f1c38 100644 --- a/docs/extensions/proxy/getting-started.md +++ b/docs/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/docs/extensions/settings/_index.md b/docs/extensions/settings/_index.md index 9e70356dd66..a00ebc2cf76 100644 --- a/docs/extensions/settings/_index.md +++ b/docs/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/docs/extensions/settings/building.md b/docs/extensions/settings/building.md index 055b2387c51..726258d5942 100644 --- a/docs/extensions/settings/building.md +++ b/docs/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/docs/extensions/settings/bundles.md b/docs/extensions/settings/bundles.md index 957c2147800..056b6b374d5 100644 --- a/docs/extensions/settings/bundles.md +++ b/docs/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/docs/extensions/settings/getting-started.md b/docs/extensions/settings/getting-started.md index b76a7187344..c662902374a 100644 --- a/docs/extensions/settings/getting-started.md +++ b/docs/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/docs/extensions/settings/glossary.md b/docs/extensions/settings/glossary.md index ffc9d8616f2..fe01c773ae0 100644 --- a/docs/extensions/settings/glossary.md +++ b/docs/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/docs/extensions/settings/license.md b/docs/extensions/settings/license.md index bce5bddc466..6382020fd40 100644 --- a/docs/extensions/settings/license.md +++ b/docs/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/docs/extensions/settings/values.md b/docs/extensions/settings/values.md index 9e03c681fb1..3e025d2b063 100644 --- a/docs/extensions/settings/values.md +++ b/docs/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/docs/extensions/store/_index.md b/docs/extensions/store/_index.md index 3eec45a1d2f..b1de3b501fd 100644 --- a/docs/extensions/store/_index.md +++ b/docs/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/docs/extensions/store/building.md b/docs/extensions/store/building.md index c8f2de2c048..2dd085713a9 100644 --- a/docs/extensions/store/building.md +++ b/docs/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/docs/extensions/store/getting-started.md b/docs/extensions/store/getting-started.md index e9724f7f30a..c806fd489ac 100644 --- a/docs/extensions/store/getting-started.md +++ b/docs/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/docs/extensions/store/license.md b/docs/extensions/store/license.md index a551d61f205..b9fbea3ef58 100644 --- a/docs/extensions/store/license.md +++ b/docs/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/docs/extensions/thumbnails/_index.md b/docs/extensions/thumbnails/_index.md index 1007ebc39b3..d0ca7f2e6af 100644 --- a/docs/extensions/thumbnails/_index.md +++ b/docs/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/docs/extensions/thumbnails/building.md b/docs/extensions/thumbnails/building.md index 4c0c3dac016..0cb8ce3d1e5 100644 --- a/docs/extensions/thumbnails/building.md +++ b/docs/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/docs/extensions/thumbnails/getting-started.md b/docs/extensions/thumbnails/getting-started.md index 2bcbd07e45c..e867637775a 100644 --- a/docs/extensions/thumbnails/getting-started.md +++ b/docs/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/docs/extensions/thumbnails/grpc.md b/docs/extensions/thumbnails/grpc.md index 27d9c2376c6..868a5dea57e 100644 --- a/docs/extensions/thumbnails/grpc.md +++ b/docs/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/docs/extensions/thumbnails/license.md b/docs/extensions/thumbnails/license.md index 69cda13beb5..8aaf0470208 100644 --- a/docs/extensions/thumbnails/license.md +++ b/docs/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/docs/extensions/thumbnails/releasing.md b/docs/extensions/thumbnails/releasing.md index b3bc0c19aeb..da0fc028d83 100644 --- a/docs/extensions/thumbnails/releasing.md +++ b/docs/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/docs/ocis/_index.md b/docs/ocis/_index.md index bafdc6e27b4..59d02847f3a 100644 --- a/docs/ocis/_index.md +++ b/docs/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/docs/ocis/building.md b/docs/ocis/building.md deleted file mode 100644 index 29e67ac29a9..00000000000 --- a/docs/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/docs/ocis/deployment/_index.md b/docs/ocis/deployment/_index.md new file mode 100644 index 00000000000..a09f6ecc9b4 --- /dev/null +++ b/docs/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/docs/ocis/basic-remote-setup.md b/docs/ocis/deployment/basic-remote-setup.md similarity index 100% rename from docs/ocis/basic-remote-setup.md rename to docs/ocis/deployment/basic-remote-setup.md diff --git a/docs/ocis/bridge.md b/docs/ocis/deployment/bridge.md similarity index 100% rename from docs/ocis/bridge.md rename to docs/ocis/deployment/bridge.md diff --git a/docs/ocis/development/_index.md b/docs/ocis/development/_index.md new file mode 100644 index 00000000000..c67391e50a4 --- /dev/null +++ b/docs/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/docs/ocis/building-docs.md b/docs/ocis/development/building-docs.md similarity index 66% rename from docs/ocis/building-docs.md rename to docs/ocis/development/building-docs.md index 5167657b161..fbe3b67a942 100644 --- a/docs/ocis/building-docs.md +++ b/docs/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/docs/ocis/development/building.md b/docs/ocis/development/building.md new file mode 100644 index 00000000000..7177f101f4a --- /dev/null +++ b/docs/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/docs/ocis/debugging.md b/docs/ocis/development/debugging.md similarity index 99% rename from docs/ocis/debugging.md rename to docs/ocis/development/debugging.md index 4e443aa272a..94905fd588b 100644 --- a/docs/ocis/debugging.md +++ b/docs/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/docs/ocis/development.md b/docs/ocis/development/getting-started.md similarity index 96% rename from docs/ocis/development.md rename to docs/ocis/development/getting-started.md index bffe8805280..a52d3142e1e 100644 --- a/docs/ocis/development.md +++ b/docs/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/docs/ocis/testing.md b/docs/ocis/development/testing.md similarity index 99% rename from docs/ocis/testing.md rename to docs/ocis/development/testing.md index c19dacc69aa..28337a1324a 100644 --- a/docs/ocis/testing.md +++ b/docs/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/docs/ocis/tracing.md b/docs/ocis/development/tracing.md similarity index 97% rename from docs/ocis/tracing.md rename to docs/ocis/development/tracing.md index 80b037d262f..39a3ab81d1a 100644 --- a/docs/ocis/tracing.md +++ b/docs/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/docs/ocis/getting-started.md b/docs/ocis/getting-started.md index 5c241aa7585..fd47222125c 100644 --- a/docs/ocis/getting-started.md +++ b/docs/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