mirror of
https://github.com/opencloud-eu/opencloud.git
synced 2026-04-04 07:41:48 -04:00
unify links
This commit is contained in:
@@ -8,7 +8,7 @@ title: ownCloud
|
||||
|
||||
Welcome to our developer documentation. Here you can find developer documentation on:
|
||||
|
||||
- [oCIS]({{< ref "./ocis/_index.md" >}}) server
|
||||
- [oCIS]({{< ref "./ocis" >}}) server
|
||||
- oCIS extensions
|
||||
- Clients like:
|
||||
- [ownCloud Web](https://github.com/owncloud/web) - the new web frontend for oCIS and ownCloud
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "OnlyOffice"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 10
|
||||
weight: 20
|
||||
geekdocRepo: https://github.com/owncloud/ocis
|
||||
geekdocEditPath: edit/master/docs/extensions/onlyoffice
|
||||
geekdocFilePath: _index.md
|
||||
|
||||
@@ -15,7 +15,7 @@ for other extensions to register new settings within oCIS. It is responsible for
|
||||
settings values as well.
|
||||
|
||||
For ease of use, this extension provides an ocis-web extension which allows users to change their settings values.
|
||||
Please refer to the [ocis-web extension docs]({{< relref "../../ocis/development/extensions/#external-ownCloud-Web-apps" >}})
|
||||
Please refer to the [ocis-web extension docs]({{< ref "../../ocis/development/extensions/#external-ownCloud-Web-apps" >}})
|
||||
for running ocis-web extensions.
|
||||
|
||||
{{< mermaid class="text-center">}}
|
||||
|
||||
@@ -14,7 +14,7 @@ provided by this service.
|
||||
## Identifying settings values
|
||||
|
||||
A *settings value* is uniquely identified by four attributes. Three of them are coming from the definition of
|
||||
the setting within it's settings bundle (see [Settings Bundles]({{< relref "bundles.md" >}})
|
||||
the setting within it's settings bundle (see [Settings Bundles]({{< ref "bundles" >}})
|
||||
for an example). The fourth identifies the user.
|
||||
- extension: Key of the extension that registered the settings bundle,
|
||||
- bundleKey: Key of the settings bundle,
|
||||
|
||||
@@ -13,7 +13,7 @@ To release a new version of the storage submodule, you have to follow a few simp
|
||||
|
||||
## Preparation
|
||||
|
||||
1. Before releasing, make sure that reva has been [updated to the desired version]({{< ref "updating.md" >}})
|
||||
1. Before releasing, make sure that reva has been [updated to the desired version]({{< ref "updating" >}})
|
||||
|
||||
## Release
|
||||
1. Check out master
|
||||
|
||||
@@ -15,5 +15,5 @@ geekdocFilePath: updating.md
|
||||
2. Create a changelog entry containing changes that were done in [reva](https://github.com/cs3org/reva/commits/master)
|
||||
3. Create a Pull Request to ocis-reva master with those changes
|
||||
4. If test issues appear, you might need to adjust the tests
|
||||
5. After the PR is merged, consider doing a [release of the storage submodule]({{< ref "releasing.md" >}})
|
||||
5. After the PR is merged, consider doing a [release of the storage submodule]({{< ref "releasing" >}})
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ A lot of embedded services in oCIS are built upon the [REVA](https://reva.link/)
|
||||
Interacting with oCIS involves a multitude af APIs. The server and all clients rely on [OpenID Connect](https://openid.net/connect/) for authentication. The [embedded konnectd](https://github.com/owncloud/ocis/tree/master/idp) can be replaced with any other OpenID Connect Identity Provider. Clients use the [WebDAV](http://webdav.org/) based [oc sync protocol](https://github.com/cernbox/smashbox/blob/master/protocol/protocol.md) to manage files and folders, [ocs to manage shares](https://doc.owncloud.com/server/developer_manual/core/apis/ocs-share-api.html) and [TUS](https://tus.io/protocols/resumable-upload.html) to upload files in a resumable way. On the server side [REVA](https://reva.link/) is the reference implementation of the [CS3 apis](https://github.com/cs3org/cs3apis) which is defined using [protobuf](https://developers.google.com/protocol-buffers/). By embedding [glauth](https://github.com/glauth/glauth/), oCIS provides a read-only [LDAP](https://tools.ietf.org/html/rfc2849) interface to make accounts, including guests available to firewalls and other systems. In the future, we are looking into [the Microsoft Graph API](https://docs.microsoft.com/en-us/graph/api/overview?view=graph-rest-1.0), which is based on [odata](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html), as a well defined REST/JSON dialect for the existing endpoints.
|
||||
|
||||
### Acceptance test suite
|
||||
We run a huge [test suite](https://github.com/owncloud/core/tree/master/tests), which originated in ownCloud 10 and continues to grow. A detailed description can be found in the developer docs for [testing]({{< relref "development/testing.md" >}}).
|
||||
We run a huge [test suite](https://github.com/owncloud/core/tree/master/tests), which originated in ownCloud 10 and continues to grow. A detailed description can be found in the developer docs for [testing]({{< ref "development/testing" >}}).
|
||||
|
||||
### Architecture Overview
|
||||
|
||||
|
||||
@@ -16,14 +16,14 @@ This section handles deployments and operations for admins and people who are in
|
||||
### Setup oCIS on your server
|
||||
oCIS deployments are super simple, yet there are many configurations possible for advanced setups.
|
||||
|
||||
- [Basic oCIS setup]({{< ref "basic-remote-setup.md" >}}) - configure domain, certificates and port
|
||||
- [oCIS setup with Traefik for SSL termination]({{< ref "ocis_traefik.md" >}})
|
||||
- [oCIS setup with Keycloak as identity provider]({{< ref "ocis_keycloak.md" >}})
|
||||
- [Basic oCIS setup]({{< ref "basic-remote-setup" >}}) - configure domain, certificates and port
|
||||
- [oCIS setup with Traefik for SSL termination]({{< ref "ocis_traefik" >}})
|
||||
- [oCIS setup with Keycloak as identity provider]({{< ref "ocis_keycloak" >}})
|
||||
|
||||
### 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 setup with oCIS serving ownCloud Web and acting as OIDC provider]({{< ref "owncloud10_with_oc_web.md" >}}) - This allows you to switch between the traditional ownCloud 10 frontend and the new ownCloud Web frontend
|
||||
- [ownCloud 10 setup with oCIS serving ownCloud Web and acting as OIDC provider]({{< ref "owncloud10_with_oc_web" >}}) - This allows you to switch between the traditional ownCloud 10 frontend and the new ownCloud Web frontend
|
||||
- Run ownCloud 10 and oCIS in parallel - together
|
||||
- Migrate users from ownCloud 10 to oCIS
|
||||
|
||||
@@ -56,4 +56,4 @@ oCIS ships with a few demo users besides the system users:
|
||||
- Marie Curie (f7fbf8c8-139b-4376-b307-cf0a8c2d0d9c)
|
||||
|
||||
You can view them in ownCloud Web if you log in as Admin user or list them by running `ocis accounts list`.
|
||||
After adding your own user it is safe to delete the demo users in the web UI or with the command `ocis accounts remove <id>`. Please do not delete the system users (see [change default secrets]({{< ref "_index.md#change-default-secrets" >}})) or oCIS will not function properly anymore.
|
||||
After adding your own user it is safe to delete the demo users in the web UI or with the command `ocis accounts remove <id>`. Please do not delete the system users (see [change default secrets]({{< ref "./#change-default-secrets" >}})) or oCIS will not function properly anymore.
|
||||
|
||||
@@ -22,7 +22,7 @@ The `identifier-registration.yml` file will only be generated if it does not exi
|
||||
{{< /hint >}}
|
||||
|
||||
{{< hint warning >}}
|
||||
oCIS is currently in a Tech Preview state and is shipped with demo users. In order to secure your oCIS instances please follow following guide: [secure an oCIS instance]({{< ref "_index.md/#secure-an-ocis-instance" >}})
|
||||
oCIS is currently in a Tech Preview state and is shipped with demo users. In order to secure your oCIS instances please follow following guide: [secure an oCIS instance]({{< ref "./#secure-an-ocis-instance" >}})
|
||||
{{< /hint >}}
|
||||
|
||||
For the following examples you need to have the oCIS binary in your current working directory, we assume it is named `ocis` and it needs to be marked as executable. See [Getting Started]({{< ref "../getting-started/#binaries" >}}) for where to get the binary from.
|
||||
@@ -49,8 +49,8 @@ PROXY_TRANSPORT_TLS_CERT=./certs/your-host.crt \
|
||||
./ocis server
|
||||
```
|
||||
|
||||
For more configuration options check the configuration section in [oCIS]({{< ref "../configuration.md" >}}) and the oCIS extensions.
|
||||
For more configuration options check the configuration section in [oCIS]({{< ref "../configuration" >}}) and the oCIS extensions.
|
||||
|
||||
## Start the oCIS fullstack server with Docker Compose
|
||||
|
||||
Please have a look at our other [deployment examples]({{< ref "./_index.md" >}}).
|
||||
Please have a look at our other [deployment examples]({{< ref "./" >}}).
|
||||
|
||||
@@ -11,7 +11,7 @@ geekdocFilePath: monitoring_tracing.md
|
||||
|
||||
Monitoring and tracing gives developers and admin insights into a complex system, in this case oCIS.
|
||||
|
||||
If you are a developer and want to trace during developing you should have a look at [example server setup]({{< ref "../development/tracing.md" >}}).
|
||||
If you are a developer and want to trace during developing you should have a look at [example server setup]({{< ref "../development/tracing" >}}).
|
||||
|
||||
This documentation describes how to set up a long running monitoring & tracing infrastructure for one or multiple oCIS servers or deployments. After reading this guide, you also should know everything needed to integrate oCIS into your existing monitoring and tracing infrastructure.
|
||||
|
||||
|
||||
@@ -19,9 +19,9 @@ geekdocFilePath: ocis_keycloak.md
|
||||
|
||||
The docker stack consists 4 containers. One of them is Traefik, a proxy which is terminating ssl and forwards the requests to oCIS in the internal docker network.
|
||||
|
||||
Keykloak add two containers: Keycloak itself and a PostgreSQL as database. Keycloak will be configured as oCIS' IDP instead of the internal IDP [Konnectd]({{< ref "../../extensions/idp/_index.md" >}})
|
||||
Keykloak add two containers: Keycloak itself and a PostgreSQL as database. Keycloak will be configured as oCIS' IDP instead of the internal IDP [Konnectd]({{< ref "../../extensions/idp" >}})
|
||||
|
||||
The other container is oCIS itself running all extensions in one container. In this example oCIS uses [oCIS storage driver]({{< ref "../../extensions/storage/storages.md#storage-drivers" >}})
|
||||
The other container is oCIS itself running all extensions in one container. In this example oCIS uses [oCIS storage driver]({{< ref "../../extensions/storage/storages#storage-drivers" >}})
|
||||
|
||||
## Server Deployment
|
||||
|
||||
@@ -33,7 +33,7 @@ The other container is oCIS itself running all extensions in one container. In t
|
||||
- keycloak.* for serving Keycloak
|
||||
- traefik.* for serving the Traefik dashboard
|
||||
|
||||
See also [example server setup]({{< ref "preparing_server.md" >}})
|
||||
See also [example server setup]({{< ref "preparing_server" >}})
|
||||
|
||||
|
||||
### Install oCIS and Traefik
|
||||
@@ -103,7 +103,7 @@ See also [example server setup]({{< ref "preparing_server.md" >}})
|
||||
|
||||
If you want to change the OIDC client id of th ownCloud Web frontend, you can do this by setting the name to `OCIS_OIDC_CLIENT_ID=`.
|
||||
|
||||
You also must override three default secrets in `IDP_LDAP_BIND_PASSWORD`, `STORAGE_LDAP_BIND_PASSWORD` and `OCIS_JWT_SECRET` in order to secure your oCIS instance. Choose some random strings eg. from the output of `openssl rand -base64 32`. For more information see [secure an oCIS instance]({{< ref "_index.md/#secure-an-ocis-instance" >}}).
|
||||
You also must override three default secrets in `IDP_LDAP_BIND_PASSWORD`, `STORAGE_LDAP_BIND_PASSWORD` and `OCIS_JWT_SECRET` in order to secure your oCIS instance. Choose some random strings eg. from the output of `openssl rand -base64 32`. For more information see [secure an oCIS instance]({{< ref "./#secure-an-ocis-instance" >}}).
|
||||
|
||||
Set your domain for the Keycloak administration panel and authentication endpoints to `KEYCLOAK_DOMAIN=` eg. `KEYCLOAK_DOMAIN=keycloak.owncloud.test`.
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ geekdocFilePath: ocis_traefik.md
|
||||
|
||||
The docker stack consists of two containers. One of them is Traefik, a proxy which is terminating ssl and forwards the requests to oCIS in the internal docker network.
|
||||
|
||||
The other one is oCIS itself running all extensions in one container. In this example oCIS uses its internal IDP [Konnectd]({{< ref "../../extensions/idp/_index.md" >}}) and the [oCIS storage driver]({{< ref "../../extensions/storage/storages.md#storage-drivers" >}})
|
||||
The other one is oCIS itself running all extensions in one container. In this example oCIS uses its internal IDP [Konnectd]({{< ref "../../extensions/idp" >}}) and the [oCIS storage driver]({{< ref "../../extensions/storage/storages#storage-drivers" >}})
|
||||
|
||||
## Server Deployment
|
||||
|
||||
@@ -29,7 +29,7 @@ The other one is oCIS itself running all extensions in one container. In this ex
|
||||
- ocis.* for serving oCIS
|
||||
- traefik.* for serving the Traefik dashboard
|
||||
|
||||
See also [example server setup]({{< ref "preparing_server.md" >}})
|
||||
See also [example server setup]({{< ref "preparing_server" >}})
|
||||
|
||||
|
||||
### Install oCIS and Traefik
|
||||
@@ -84,7 +84,7 @@ See also [example server setup]({{< ref "preparing_server.md" >}})
|
||||
|
||||
Set your domain for the oCIS frontend in `OCIS_DOMAIN=`, eg. `OCIS_DOMAIN=ocis.owncloud.test`.
|
||||
|
||||
You also must override three default secrets in `IDP_LDAP_BIND_PASSWORD`, `STORAGE_LDAP_BIND_PASSWORD` and `OCIS_JWT_SECRET` in order to secure your oCIS instance. Choose some random strings eg. from the output of `openssl rand -base64 32`. For more information see [secure an oCIS instance]({{< ref "_index.md/#secure-an-ocis-instance" >}}).
|
||||
You also must override three default secrets in `IDP_LDAP_BIND_PASSWORD`, `STORAGE_LDAP_BIND_PASSWORD` and `OCIS_JWT_SECRET` in order to secure your oCIS instance. Choose some random strings eg. from the output of `openssl rand -base64 32`. For more information see [secure an oCIS instance]({{< ref "./#secure-an-ocis-instance" >}}).
|
||||
|
||||
Now you have configured everything and can save the file.
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ In this setup relies on graph-api app to be installed in ownCloud 10. This app i
|
||||
- oc10.* for serving
|
||||
- traefik.* for serving the Traefik dashboard
|
||||
|
||||
See also [example server setup]({{< ref "preparing_server.md" >}})
|
||||
See also [example server setup]({{< ref "preparing_server" >}})
|
||||
|
||||
### Install oCIS and Traefik
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ geekdocFilePath: build.md
|
||||
|
||||
## Build requirements
|
||||
|
||||
see [Development - Getting Started]({{< relref "getting-started.md/#requirements">}})
|
||||
see [Development - Getting Started]({{< ref "getting-started/#requirements">}})
|
||||
|
||||
## Get the sources
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ Each extension lives in a subfolder (eg. `accounts` or `settings`) within this r
|
||||
|
||||
The `ocis` folder contains our [go-micro](https://github.com/asim/go-micro/) and [suture](https://github.com/thejerf/suture) based runtime. It is used to import all extensions and implements commands to manage them, similar to a small orchestrator. With the resulting oCIS binary you can start single extensions or even all extensions at the same time.
|
||||
|
||||
The `docs` folder contains the source for the [oCIS documentation](https://owncloud.dev/ocis/).
|
||||
The `docs` folder contains the source for the [oCIS documentation]({{< ref "../" >}}).
|
||||
|
||||
The `deployments` folder contains documented deployment configurations and templates. On a single node, running a single ocis runtime is a resource efficient way to deploy ocis. For multiple nodes docker compose or helm charts for kubernetes examples can be found here.
|
||||
|
||||
@@ -46,10 +46,10 @@ Depending on what you want to develop there are different starting points. These
|
||||
If you want to contribute to oCIS:
|
||||
|
||||
- see [contribution guidelines](https://github.com/owncloud/ocis#contributing)
|
||||
- make sure the tooling is set up by [building oCIS]({{< relref "build.md" >}}) and [building the docs]({{< relref "build-docs.md" >}})
|
||||
- make sure the tooling is set up by [building oCIS]({{< ref "build" >}}) and [building the docs]({{< ref "build-docs" >}})
|
||||
- create or pick an [open issue](https://github.com/owncloud/ocis/issues) to develop on and mention in the issue that you are working on it
|
||||
- open a PR and get things done
|
||||
|
||||
### Developing extensions
|
||||
|
||||
If you want to develop an extension, start here: [Extensions]({{< relref "extensions.md">}})
|
||||
If you want to develop an extension, start here: [Extensions]({{< ref "extensions">}})
|
||||
|
||||
@@ -13,7 +13,7 @@ geekdocFilePath: _index.md
|
||||
|
||||
We are distributing oCIS as binaries and Docker images.
|
||||
|
||||
You can find more deployment examples in the [deployment section]({{< ref "../deployment/_index.md" >}}).
|
||||
You can find more deployment examples in the [deployment section]({{< ref "../deployment" >}}).
|
||||
|
||||
### Binaries
|
||||
You can find the latest official release of oCIS at [our download mirror](https://download.owncloud.com/ocis/ocis/) or on [GitHub](https://github.com/owncloud/ocis/releases).
|
||||
@@ -59,7 +59,7 @@ Open [https://localhost:9200](https://localhost:9200) and [login using one of th
|
||||
|
||||
### Basic Management Commands
|
||||
|
||||
The oCIS single binary contains multiple extensions and the `ocis` command helps you to manage them. You already used `ocis server` to run all available extensions in the [Run oCIS]({{< relref "#run-ocis" >}}) section. We now will show you some more management commands, which you may also explore by typing `ocis --help` or going to the [docs]({{< relref "../configuration.md" >}}).
|
||||
The oCIS single binary contains multiple extensions and the `ocis` command helps you to manage them. You already used `ocis server` to run all available extensions in the [Run oCIS]({{< ref "#run-ocis" >}}) section. We now will show you some more management commands, which you may also explore by typing `ocis --help` or going to the [docs]({{< ref "../configuration" >}}).
|
||||
|
||||
To start oCIS server:
|
||||
|
||||
|
||||
@@ -19,4 +19,4 @@ Following users are available in the demo set:
|
||||
| moss | vista | moss@example.org | admin | users |
|
||||
| richard | superfluidity | richard@example.org | user | users, philosophy-haters, physics-lovers, quantum-lovers |
|
||||
|
||||
You may also want to run oCIS with only your custom users by [deleting the demo users]({{< ref "../deployment/_index.md#delete-demo-users" >}}).
|
||||
You may also want to run oCIS with only your custom users by [deleting the demo users]({{< ref "../deployment#delete-demo-users" >}}).
|
||||
|
||||
@@ -26,7 +26,7 @@ You can also read the full [ownCloud Infinite Scale changelog](https://github.co
|
||||
|
||||
### Breaking changes
|
||||
{{< hint warning >}}
|
||||
We are currently in a Tech Preview state and breaking changes may occur at any time. For more information see our [release roadmap]({{< ref "./release_roadmap.md" >}})
|
||||
We are currently in a Tech Preview state and breaking changes may occur at any time. For more information see our [release roadmap]({{< ref "./release_roadmap" >}})
|
||||
{{< /hint >}}
|
||||
|
||||
#### Changed oCIS storage driver file layout
|
||||
@@ -86,7 +86,7 @@ More details about this release can be found in the full [ownCloud Infinite Scal
|
||||
|
||||
### Breaking changes
|
||||
{{< hint warning >}}
|
||||
We are currently in a Tech Preview state and breaking changes may occur at any time. For more information see our [release roadmap]({{< ref "./release_roadmap.md" >}})
|
||||
We are currently in a Tech Preview state and breaking changes may occur at any time. For more information see our [release roadmap]({{< ref "./release_roadmap" >}})
|
||||
{{< /hint >}}
|
||||
|
||||
## ownCloud Infinite Scale 1.2.0 Technology Preview
|
||||
@@ -104,7 +104,7 @@ You can also read the full [ownCloud Infinite Scale changelog](https://github.co
|
||||
|
||||
### Breaking changes
|
||||
{{< hint warning >}}
|
||||
We are currently in a Tech Preview state and breaking changes may occur at any time. For more information see our [release roadmap]({{< ref "./release_roadmap.md" >}})
|
||||
We are currently in a Tech Preview state and breaking changes may occur at any time. For more information see our [release roadmap]({{< ref "./release_roadmap" >}})
|
||||
{{< /hint >}}
|
||||
|
||||
#### Fix IDP service user
|
||||
@@ -208,7 +208,7 @@ ownCloud Infinite Scale is built as a modular framework in which components can
|
||||
- a built-in IdP
|
||||
- an application gateway/proxy
|
||||
|
||||
These components can be deployed in a multi-tier deployment architecture. See the [documentation]({{< ref "./_index.md" >}}) for an overview of the services.
|
||||
These components can be deployed in a multi-tier deployment architecture. See the [documentation]({{< ref "./" >}}) for an overview of the services.
|
||||
|
||||
### Operation modes
|
||||
|
||||
@@ -282,7 +282,7 @@ Production environments will need a more sophisticated setup, see <{{< ref "./de
|
||||
{{< tab "Docker" >}}
|
||||
#### Containerized Setup
|
||||
|
||||
For more sophisticated setups we recommend using one of our docker setup examples. See the [documentation](<{{< ref "./deployment/ocis_traefik.md" >}}>) for a setup with [Traefik](https://traefik.io/traefik/) as a reverse proxy which also includes automated SSL certificate provisioning using Letsencrypt tools.
|
||||
For more sophisticated setups we recommend using one of our docker setup examples. See the [documentation](<{{< ref "./deployment/ocis_traefik" >}}>) for a setup with [Traefik](https://traefik.io/traefik/) as a reverse proxy which also includes automated SSL certificate provisioning using Letsencrypt tools.
|
||||
|
||||
{{< /tab >}}
|
||||
{{< /tabs >}}
|
||||
|
||||
Reference in New Issue
Block a user