fix typos, force oCIS and add links

This commit is contained in:
Willy Kloucek
2020-11-17 11:05:14 +01:00
parent 20eae462b3
commit f2a1c06145
31 changed files with 49 additions and 91 deletions

View File

@@ -41,7 +41,7 @@ For this configuration to be picked up, have a look at your extension `root` com
So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis/tree/master/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/ocis.yml`, `${HOME}/.ocis/ocis.yml` or `$(pwd)/config/ocis.yml`.
### Envrionment variables
### Environment variables
If you prefer to configure the service with environment variables you can see the available variables below.

View File

@@ -4,10 +4,15 @@ title: ownCloud
## Developer Documentation
Welcome to our developer documentation. Here you can find documentation for developers on
- The oCIS server
Welcome to our developer documentation. Here you can find developer documentation on:
- [oCIS](https://owncloud.github.io/ocis/) server
- oCIS extensions
- All Client, like Android, iOS, and the Desktop Client
- Clients, like:
- [Phoenix](https://github.com/owncloud/phoenix) - the new web frontend for oCIS and ownCloud
- [ownCloud Android app](https://github.com/owncloud/android)
- [ownCloud iOS app](https://github.com/owncloud/ios-app)
- [ownCloud Desktop Syncing Client](https://github.com/owncloud/client)
- Integrations
## We love open source
@@ -19,11 +24,10 @@ 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.
The oCIS server repository on github is a good entry point 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
For communication on development you can join our public chat [talk.owncloud.com](https://talk.owncloud.com)
If you want to help and improve ownCloud, start coding or open issues on github in the related repositiory.
If you want to help and improve ownCloud or oCIS, start coding or open issues on github in the related repository.
We are very happy to hear your feedback and ideas!

View File

@@ -8,7 +8,7 @@ geekdocFilePath: _index.md
---
## Abstract
OCIS needs to be able to identify users. Whithout a non reassignable and persistend account ID share metadata cannot be reliably persisted. `ocis-accounts` allows exchanging oidc claims for a uuid. Using a uuid allows users to change the login, mail or even openid connect provider without breaking any persisted metadata that might have been attached to it.
oCIS needs to be able to identify users. Without a non reassignable and persistent account ID share metadata cannot be reliably persisted. `accounts` allows exchanging oidc claims for a uuid. Using a uuid allows users to change the login, mail or even openid connect provider without breaking any persisted metadata that might have been attached to it.
- persists accounts
- uses graph api properties

View File

@@ -20,49 +20,3 @@ TBD
### Binaries
TBD
## Configuration
We provide overall three different variants of configuration. The variant based on environment variables and commandline flags are split up into global values and command-specific values.
### Envrionment variables
If you prefer to configure the service with environment variables you can see the available variables below.
#### Server
OCIS_ACCOUNTS_NAME
: Name of the accounts service. It will be part of the namespace.
OCIS_ACCOUNTS_NAMESPACE
: Namespace of the accounts service.
OCIS_ACCOUNTS_ADDRESS
: Endpoint for the grpc service endpoint.
### Commandline flags
If you prefer to configure the service with commandline flags you can see the available variables below.
### Configuration file
So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis/accounts/tree/master/pkg/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/accounts.yml`, `${HOME}/.ocis/accounts.yml` or `$(pwd)/config/accounts.yml`.
## Usage
The program provides a few sub-commands on execution. The available configuration methods have already been mentioned above. Generally you can always see a formated help output if you execute the binary via `ocis-accounts --help`.
### Server
The server command is used to start the grpc server. For further help please execute:
{{< highlight txt >}}
accounts server --help
{{< / highlight >}}
### Version
The version command lists the versions of all running instances. For further help please execute:
{{< highlight txt >}}
accounts version --help
{{< /highlight >}}

View File

@@ -25,7 +25,7 @@ TBD
We provide overall three different variants of configuration. The variant based on environment variables and commandline flags are split up into global values and command-specific values.
### Envrionment variables
### Environment variables
If you prefer to configure the service with environment variables you can see the available variables below.

View File

@@ -10,7 +10,7 @@ geekdocFilePath: releasing.md
## Releasing
The next generation Web Frontend is shipped as an ocis Extension. The `ocis-phoenix` extension is also embedded in the single binary and part of the `ocis server` command.
The next generation Web Frontend is shipped as an oCIS Extension. The `ocis-phoenix` extension is also embedded in the single binary and part of the `ocis server` command.
To update this package within all the deliveries, we need to update the package in the following chain from the bottom to the top.

View File

@@ -5,4 +5,4 @@ geekdocEditPath: edit/master/docs/extensions/proxy
geekdocFilePath: _index.md
---
This service provides a basic proxy in front of the public ocis services.
This service provides a basic proxy in front of the public oCIS services.

View File

@@ -25,7 +25,7 @@ TBD
We provide overall three different variants of configuration. The variant based on environment variables and commandline flags are split up into global values and command-specific values.
### Envrionment variables
### Environment variables
If you prefer to configure the service with environment variables you can see the available variables below.

View File

@@ -32,7 +32,7 @@ In the context of this extension and oCIS in general, we are using the following
### Settings Bundle
- Collection of related settings
- Registered by an ocis extension
- Registered by an oCIS extension
### Settings Value

View File

@@ -25,7 +25,7 @@ TBD
We provide overall three different variants of configuration. The variant based on environment variables and commandline flags are split up into global values and command-specific values.
### Envrionment variables
### Environment variables
If you prefer to configure the service with environment variables you can see the available variables below.

View File

@@ -25,7 +25,7 @@ TBD
We provide overall three different variants of configuration. The variant based on environment variables and commandline flags are split up into global values and command-specific values.
### Envrionment variables
### Environment variables
If you prefer to configure the service with environment variables you can see the available variables below.

View File

@@ -25,7 +25,7 @@ TBD
We provide overall three different variants of configuration. The variant based on environment variables and commandline flags are split up into global values and command-specific values.
#### Envrionment variables
#### Environment variables
If you prefer to configure the service with environment variables you can see the available variables below.

View File

@@ -1,5 +1,5 @@
---
title: "oCIS"
title: "oCIS - ownCloud Infinite Scale"
date: 2020-02-27T20:35:00+01:00
weight: -10
geekdocRepo: https://github.com/owncloud/ocis
@@ -11,27 +11,27 @@ geekdocFilePath: _index.md
## 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.
Welcome to oCIS, the modern file-sync and share platform, which is based on our knowledge and experience with the PHP based [ownCloud server](https://owncloud.com/#server).
### oCIS Server
### 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/).
The oCIS server implementation follows [Go](https://golang.org/) 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.
We run a huge [test suite](https://github.com/owncloud/core/tree/master/tests), which was originated in ownCloud 10 and continues to grow.
### Architecture Overview
{{< mermaid class="text-center">}}
graph TD
ocis-proxy -->
ocis-konnectd & ocis-phoenix & ocis-thumbnails & ocis-ocs & ocis-webdav
proxy -->
konnectd & ocis-phoenix & thumbnails & ocs & webdav
ocis-phoenix --> ocis-reva-fronted
ocis-reva-fronted --> ocis-reva-gateway
ocis-konnectd --> ocis-glauth
konnectd --> glauth
ocis-reva-gateway --> ocis-reva-users
ocis-reva-gateway --> accounts
ocis-reva-gateway --> ocis-reva-authbasic
ocis-reva-gateway --> ocis-reva-auth-bearer

View File

@@ -57,7 +57,7 @@ The described setup can also be used to do a zero-downtime migration from ownClo
`$ sudo chmod +x /usr/local/bin/docker-compose`
* Environment variables for OCIS Stack are provided by .env file
* Environment variables for oCIS Stack are provided by .env file
### Setup on server

View File

@@ -49,7 +49,7 @@ geekdocFilePath: ocis_traefik.md
`$ sudo chmod +x /usr/local/bin/docker-compose`
* Environment variables for OCIS Stack are provided by .env file
* Environment variables for oCIS Stack are provided by .env file
### Setup on server

View File

@@ -20,9 +20,9 @@ git clone https://github.com/owncloud/ocis.git
cd ocis
{{< / highlight >}}
## Build the ocis binary
## Build the oCIS binary
The ocis binary source is in the ocis/ocis folder. In this folder you can 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

View File

@@ -19,7 +19,7 @@ To build and run your local ocis code with default storage driver
docker run --rm -ti --name ocis -v $PWD:/ocis -p 9200:9200 owncloud/eos-ocis-dev
```
The eos-ocis-dev container will build and run ocis using the owncloud storage driver and store files in the container at `/var/tmp/reva/data/<username>/files`
The eos-ocis-dev container will build and run oCIS using the ownCloud storage driver and store files in the container at `/var/tmp/reva/data/<username>/files`
To check the uploaded files start digging with: `docker exec -it ocis ls -l /var/tmp/reva/`

View File

@@ -10,7 +10,7 @@ geekdocFilePath: testing.md
## Acceptance tests
We are using the ownCloud 10 acceptance testsuite against ocis. To set this up you need the owncloud 10 core repo, a ldap server that the acceptance tests can use to manage users, a redis server for file-versions and the ocis code.
We are using the ownCloud 10 acceptance testsuite against ocis. To set this up you need the owncloud 10 core repo, a ldap server that the acceptance tests can use to manage users, a redis server for file-versions and the oCIS code.
### Getting the tests

View File

@@ -9,7 +9,7 @@ geekdocFilePath: eos.md
{{< toc >}}
OCIS can be configured to run on top of [eos](https://eos.web.cern.ch/). While the [eos documentation](http://eos-docs.web.cern.ch/) does cover a lot of topics it leaves out some details that you may have to either pull from various [docker containers](https://gitlab.cern.ch/eos/eos-docker), the [forums](https://eos-community.web.cern.ch/) or even the [source](https://github.com/cern-eos/eos) itself.
oCIS can be configured to run on top of [eos](https://eos.web.cern.ch/). While the [eos documentation](http://eos-docs.web.cern.ch/) does cover a lot of topics it leaves out some details that you may have to either pull from various [docker containers](https://gitlab.cern.ch/eos/eos-docker), the [forums](https://eos-community.web.cern.ch/) or even the [source](https://github.com/cern-eos/eos) itself.
This document is a work in progress of the current setup.

View File

@@ -41,7 +41,7 @@ For this configuration to be picked up, have a look at your extension `root` com
So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis/tree/master/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/ocis.yml`, `${HOME}/.ocis/ocis.yml` or `$(pwd)/config/ocis.yml`.
### Envrionment variables
### Environment variables
If you prefer to configure the service with environment variables you can see the available variables below.

View File

@@ -41,7 +41,7 @@ For this configuration to be picked up, have a look at your extension `root` com
So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis/tree/master/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/ocis.yml`, `${HOME}/.ocis/ocis.yml` or `$(pwd)/config/ocis.yml`.
### Envrionment variables
### Environment variables
If you prefer to configure the service with environment variables you can see the available variables below.

View File

@@ -41,7 +41,7 @@ For this configuration to be picked up, have a look at your extension `root` com
So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis/tree/master/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/ocis.yml`, `${HOME}/.ocis/ocis.yml` or `$(pwd)/config/ocis.yml`.
### Envrionment variables
### Environment variables
If you prefer to configure the service with environment variables you can see the available variables below.

View File

@@ -1,4 +1,4 @@
# Docker image for ocis development with eos
# Docker image for oCIS development with eos
Image is based on [owncloud/eos-base](https://hub.docker.com/r/owncloud/eos-base) from [eos-stack](https://github.com/owncloud-docker/eos-stack)

View File

@@ -1,4 +1,4 @@
# Docker image for ocis running on eos
# Docker image for oCIS running on eos
Image is based on [owncloud/eos-base](https://hub.docker.com/r/owncloud/eos-base) from [eos-stack](https://github.com/owncloud-docker/eos-stack)

View File

@@ -41,7 +41,7 @@ For this configuration to be picked up, have a look at your extension `root` com
So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis/tree/master/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/ocis.yml`, `${HOME}/.ocis/ocis.yml` or `$(pwd)/config/ocis.yml`.
### Envrionment variables
### Environment variables
If you prefer to configure the service with environment variables you can see the available variables below.

View File

@@ -41,7 +41,7 @@ For this configuration to be picked up, have a look at your extension `root` com
So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis/tree/master/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/ocis.yml`, `${HOME}/.ocis/ocis.yml` or `$(pwd)/config/ocis.yml`.
### Envrionment variables
### Environment variables
If you prefer to configure the service with environment variables you can see the available variables below.

View File

@@ -41,7 +41,7 @@ For this configuration to be picked up, have a look at your extension `root` com
So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis/tree/master/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/ocis.yml`, `${HOME}/.ocis/ocis.yml` or `$(pwd)/config/ocis.yml`.
### Envrionment variables
### Environment variables
If you prefer to configure the service with environment variables you can see the available variables below.

View File

@@ -54,7 +54,7 @@ For this configuration to be picked up, have a look at your extension `root` com
So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis/tree/master/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/ocis.yml`, `${HOME}/.ocis/ocis.yml` or `$(pwd)/config/ocis.yml`.
### Envrionment variables
### Environment variables
If you prefer to configure the service with environment variables you can see the available variables below.

View File

@@ -41,7 +41,7 @@ For this configuration to be picked up, have a look at your extension `root` com
So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis/tree/master/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/ocis.yml`, `${HOME}/.ocis/ocis.yml` or `$(pwd)/config/ocis.yml`.
### Envrionment variables
### Environment variables
If you prefer to configure the service with environment variables you can see the available variables below.

View File

@@ -41,7 +41,7 @@ For this configuration to be picked up, have a look at your extension `root` com
So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis/tree/master/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/ocis.yml`, `${HOME}/.ocis/ocis.yml` or `$(pwd)/config/ocis.yml`.
### Envrionment variables
### Environment variables
If you prefer to configure the service with environment variables you can see the available variables below.

View File

@@ -41,7 +41,7 @@ For this configuration to be picked up, have a look at your extension `root` com
So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis/tree/master/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/ocis.yml`, `${HOME}/.ocis/ocis.yml` or `$(pwd)/config/ocis.yml`.
### Envrionment variables
### Environment variables
If you prefer to configure the service with environment variables you can see the available variables below.