update pathes to monorepo. init development and depolyment section.

This commit is contained in:
felixboehm
2020-10-06 14:46:22 +02:00
committed by Michael Barz
parent 0eba04bab2
commit e9a6f8b4cf
58 changed files with 236 additions and 172 deletions
+25 -3
View File
@@ -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">}}
+2 -2
View File
@@ -2,8 +2,8 @@
title: Accounts title: Accounts
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 10 weight: 10
geekdocRepo: https://github.com/owncloud/ocis-accounts geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/accounts
geekdocFilePath: _index.md geekdocFilePath: _index.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Building" title: "Building"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 30 weight: 30
geekdocRepo: https://github.com/owncloud/ocis-accounts geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/accounts
geekdocFilePath: building.md geekdocFilePath: building.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Configuration" title: "Configuration"
date: "2020-07-01T11:10:52+0200" date: "2020-07-01T11:10:52+0200"
weight: 20 weight: 20
geekdocRepo: https://github.com/owncloud/ocis-reva geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/accounts
geekdocFilePath: configuration.md geekdocFilePath: configuration.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Getting Started" title: "Getting Started"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 20 weight: 20
geekdocRepo: https://github.com/owncloud/ocis-accounts geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/accounts
geekdocFilePath: getting-started.md geekdocFilePath: getting-started.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "GLAuth" title: "GLAuth"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 10 weight: 10
geekdocRepo: https://github.com/owncloud/ocis-glauth geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/glauth
geekdocFilePath: _index.md geekdocFilePath: _index.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Building" title: "Building"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 30 weight: 30
geekdocRepo: https://github.com/owncloud/ocis-glauth geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/glauth
geekdocFilePath: building.md geekdocFilePath: building.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Getting Started" title: "Getting Started"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 20 weight: 20
geekdocRepo: https://github.com/owncloud/ocis-glauth geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/glauth
geekdocFilePath: getting-started.md geekdocFilePath: getting-started.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "License" title: "License"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 40 weight: 40
geekdocRepo: https://github.com/owncloud/ocis-glauth geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/glauth
geekdocFilePath: license.md geekdocFilePath: license.md
--- ---
+2 -2
View File
@@ -1,7 +1,7 @@
--- ---
title: Konnectd title: Konnectd
geekdocRepo: https://github.com/owncloud/ocis-konnectd geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/konnectd
geekdocFilePath: _index.md geekdocFilePath: _index.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Building" title: "Building"
date: 2020-02-21T00:00:00+00:00 date: 2020-02-21T00:00:00+00:00
weight: 30 weight: 30
geekdocRepo: https://github.com/owncloud/ocis-konnectd geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/konnectd
geekdocFilePath: building.md geekdocFilePath: building.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Configuration" title: "Configuration"
date: "2020-09-21T13:14:47+0200" date: "2020-09-21T13:14:47+0200"
weight: 20 weight: 20
geekdocRepo: https://github.com/owncloud/ocis-konnectd geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/konnectd
geekdocFilePath: configuration.md geekdocFilePath: configuration.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Getting Started" title: "Getting Started"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 10 weight: 10
geekdocRepo: https://github.com/owncloud/ocis-konnectd geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/konnectd
geekdocFilePath: getting-started.md geekdocFilePath: getting-started.md
--- ---
-26
View File
@@ -1,26 +0,0 @@
---
title: "Building"
date: 2018-05-02T00:00:00+00:00
weight: 30
geekdocRepo: https://github.com/owncloud/ocis-phoenix
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.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 >}}
make generate
make build
{{< / highlight >}}
The above commands will download a [Phoenix](https://github.com/owncloud/phoenix) release and embed it into the binary. Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis-phoenix -h` to see all available options.
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Ocs" title: "Ocs"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 10 weight: 10
geekdocRepo: https://github.com/owncloud/ocis-ocs geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/ocs
geekdocFilePath: _index.md geekdocFilePath: _index.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Building" title: "Building"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 30 weight: 30
geekdocRepo: https://github.com/owncloud/ocis-ocs geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/ocs
geekdocFilePath: building.md geekdocFilePath: building.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Getting Started" title: "Getting Started"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 10 weight: 10
geekdocRepo: https://github.com/owncloud/ocis-ocs geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/ocs
geekdocFilePath: getting-started.md geekdocFilePath: getting-started.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "License" title: "License"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 40 weight: 40
geekdocRepo: https://github.com/owncloud/ocis-ocs geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/ocs
geekdocFilePath: license.md geekdocFilePath: license.md
--- ---
+2 -2
View File
@@ -1,7 +1,7 @@
--- ---
title: Proxy title: Proxy
geekdocRepo: https://github.com/owncloud/ocis-proxy geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/proxy
geekdocFilePath: _index.md geekdocFilePath: _index.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "About" title: "About"
date: 2020-02-07T00:00:00+00:00 date: 2020-02-07T00:00:00+00:00
weight: 10 weight: 10
geekdocRepo: https://github.com/owncloud/ocis-proxy geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/proxy
geekdocFilePath: about.md geekdocFilePath: about.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Building" title: "Building"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 30 weight: 30
geekdocRepo: https://github.com/owncloud/ocis-proxy geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/proxy
geekdocFilePath: building.md geekdocFilePath: building.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Configuration" title: "Configuration"
date: "2020-09-21T13:14:51+0200" date: "2020-09-21T13:14:51+0200"
weight: 20 weight: 20
geekdocRepo: https://github.com/owncloud/ocis-proxy geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/proxy
geekdocFilePath: configuration.md geekdocFilePath: configuration.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Getting Started" title: "Getting Started"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 15 weight: 15
geekdocRepo: https://github.com/owncloud/ocis-proxy geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/proxy
geekdocFilePath: getting-started.md geekdocFilePath: getting-started.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Settings" title: "Settings"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 10 weight: 10
geekdocRepo: https://github.com/owncloud/ocis-settings geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/settings
geekdocFilePath: _index.md geekdocFilePath: _index.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Building" title: "Building"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 30 weight: 30
geekdocRepo: https://github.com/owncloud/ocis-settings geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/settings
geekdocFilePath: building.md geekdocFilePath: building.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Settings Bundles" title: "Settings Bundles"
date: 2020-05-04T00:00:00+00:00 date: 2020-05-04T00:00:00+00:00
weight: 50 weight: 50
geekdocRepo: https://github.com/owncloud/ocis-settings geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/settings
geekdocFilePath: bundles.md geekdocFilePath: bundles.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Getting Started" title: "Getting Started"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 25 weight: 25
geekdocRepo: https://github.com/owncloud/ocis-settings geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/settings
geekdocFilePath: getting-started.md geekdocFilePath: getting-started.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Glossary" title: "Glossary"
date: 2020-05-04T12:35:00+01:00 date: 2020-05-04T12:35:00+01:00
weight: 80 weight: 80
geekdocRepo: https://github.com/owncloud/ocis-settings geekdocRepo: https://github.com/owncloud/oci
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/settings
geekdocFilePath: glossary.md geekdocFilePath: glossary.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "License" title: "License"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 90 weight: 90
geekdocRepo: https://github.com/owncloud/ocis-settings geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/settings
geekdocFilePath: license.md geekdocFilePath: license.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Settings Values" title: "Settings Values"
date: 2020-05-04T00:00:00+00:00 date: 2020-05-04T00:00:00+00:00
weight: 51 weight: 51
geekdocRepo: https://github.com/owncloud/ocis-settings geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/settings
geekdocFilePath: values.md geekdocFilePath: values.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Store" title: "Store"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 10 weight: 10
geekdocRepo: https://github.com/owncloud/ocis-store geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/store
geekdocFilePath: _index.md geekdocFilePath: _index.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Building" title: "Building"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 30 weight: 30
geekdocRepo: https://github.com/owncloud/ocis-store geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/store
geekdocFilePath: building.md geekdocFilePath: building.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Getting Started" title: "Getting Started"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 20 weight: 20
geekdocRepo: https://github.com/owncloud/ocis-store geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/store
geekdocFilePath: getting-started.md geekdocFilePath: getting-started.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "License" title: "License"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 40 weight: 40
geekdocRepo: https://github.com/owncloud/ocis-store geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/store
geekdocFilePath: license.md geekdocFilePath: license.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Thumbnails" title: "Thumbnails"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 10 weight: 10
geekdocRepo: https://github.com/owncloud/ocis-thumbnails geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/thumbnails
geekdocFilePath: _index.md geekdocFilePath: _index.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Building" title: "Building"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 30 weight: 30
geekdocRepo: https://github.com/owncloud/ocis-thumbnails geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/thumbnails
geekdocFilePath: building.md geekdocFilePath: building.md
--- ---
@@ -2,8 +2,8 @@
title: "Getting Started" title: "Getting Started"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 20 weight: 20
geekdocRepo: https://github.com/owncloud/ocis-thumbnails geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/thumbnails
geekdocFilePath: getting-started.md geekdocFilePath: getting-started.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "GRPC API" title: "GRPC API"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 50 weight: 50
geekdocRepo: https://github.com/owncloud/ocis-thumbnails geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/thumbnails
geekdocFilePath: grpc.md geekdocFilePath: grpc.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "License" title: "License"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 60 weight: 60
geekdocRepo: https://github.com/owncloud/ocis-thumbnails geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/thumbnails
geekdocFilePath: license.md geekdocFilePath: license.md
--- ---
+2 -2
View File
@@ -2,8 +2,8 @@
title: "Releasing" title: "Releasing"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 40 weight: 40
geekdocRepo: https://github.com/owncloud/ocis-thumbnails geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/thumbnails
geekdocFilePath: releasing.md geekdocFilePath: releasing.md
--- ---
@@ -1,10 +1,12 @@
--- ---
title: "Phoenix" title: "oCIS Web"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 10 weight: 10
geekdocRepo: https://github.com/owncloud/ocis-phoenix geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/web
geekdocFilePath: _index.md 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. This service embeds [Phoenix](https://github.com/owncloud/phoenix) to provide a UI for ownCloud Infinite Scale.
+18
View File
@@ -0,0 +1,18 @@
---
title: "Building"
date: 2018-05-02T00:00:00+00:00
weight: 30
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/web
geekdocFilePath: building.md
---
## Backend
{{< highlight txt >}}
cd ocis-phoenix
make generate
make build
{{< / highlight >}}
The above commands will download a [Phoenix](https://github.com/owncloud/phoenix) release and embed it into the binary. Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis-phoenix -h` to see all available options.
@@ -2,8 +2,8 @@
title: "Getting Started" title: "Getting Started"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 20 weight: 20
geekdocRepo: https://github.com/owncloud/ocis-phoenix geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/web
geekdocFilePath: getting-started.md geekdocFilePath: getting-started.md
--- ---
@@ -2,8 +2,8 @@
title: "License" title: "License"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 50 weight: 50
geekdocRepo: https://github.com/owncloud/ocis-phoenix geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/extensions/web
geekdocFilePath: license.md geekdocFilePath: license.md
--- ---
+14 -2
View File
@@ -1,5 +1,5 @@
--- ---
title: "Infinite Scale" title: "oCIS"
date: 2020-02-27T20:35:00+01:00 date: 2020-02-27T20:35:00+01:00
weight: -10 weight: -10
geekdocRepo: https://github.com/owncloud/ocis geekdocRepo: https://github.com/owncloud/ocis
@@ -7,7 +7,19 @@ geekdocEditPath: edit/master/docs
geekdocFilePath: _index.md 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">}} {{< mermaid class="text-center">}}
graph TD graph TD
-49
View File
@@ -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
```
+29
View File
@@ -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
+12
View File
@@ -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
@@ -3,12 +3,10 @@ title: "Building the documentation"
date: 2020-07-27T08:39:38+00:00 date: 2020-07-27T08:39:38+00:00
weight: 99 weight: 99
geekdocRepo: https://github.com/owncloud/ocis geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/development
geekdocFilePath: building-docs.md geekdocFilePath: building-docs.md
--- ---
{{< toc >}}
## Buildling the documentation ## Buildling the documentation
Following steps can be applied for every oCIS extension repository. Following steps can be applied for every oCIS extension repository.
+46
View File
@@ -0,0 +1,46 @@
---
title: "Building"
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:local .
{{< / highlight >}}
Then you can test as usual via
{{< highlight txt >}}
docker run --rm -ti owncloud/ocis:dev
{{< / highlight >}}
@@ -3,7 +3,7 @@ title: "Debugging"
date: 2020-03-19T08:21:00+01:00 date: 2020-03-19T08:21:00+01:00
weight: 50 weight: 50
geekdocRepo: https://github.com/owncloud/ocis geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/development
geekdocFilePath: debugging.md geekdocFilePath: debugging.md
--- ---
@@ -3,8 +3,8 @@ title: "Getting Started with Development"
date: 2020-07-07T20:35:00+01:00 date: 2020-07-07T20:35:00+01:00
weight: 15 weight: 15
geekdocRepo: https://github.com/owncloud/ocis geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/development
geekdocFilePath: development.md geekdocFilePath: getting-started.md
--- ---
{{< toc >}} {{< toc >}}
@@ -3,7 +3,7 @@ title: "Testing"
date: 2018-05-02T00:00:00+00:00 date: 2018-05-02T00:00:00+00:00
weight: 37 weight: 37
geekdocRepo: https://github.com/owncloud/ocis geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/development
geekdocFilePath: testing.md geekdocFilePath: testing.md
--- ---
@@ -3,7 +3,7 @@ title: "Tracing"
date: 2020-05-13T12:09:00+01:00 date: 2020-05-13T12:09:00+01:00
weight: 55 weight: 55
geekdocRepo: https://github.com/owncloud/ocis geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs/development
geekdocFilePath: tracing.md geekdocFilePath: tracing.md
--- ---
+1 -1
View File
@@ -1,7 +1,7 @@
--- ---
title: "Getting Started" title: "Getting Started"
date: 2020-02-27T20:35:00+01:00 date: 2020-02-27T20:35:00+01:00
weight: 15 weight: -15
geekdocRepo: https://github.com/owncloud/ocis geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs geekdocEditPath: edit/master/docs
geekdocFilePath: getting-started.md geekdocFilePath: getting-started.md