-
Notifications
You must be signed in to change notification settings - Fork 187
/
README.md
135 lines (89 loc) · 11.1 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# ownCloud Infinite Scale
[](https://app.element.io/#/room/#ocis:matrix.org)
[](https://talk.owncloud.com/channel/infinitescale)
[](https://drone.owncloud.com/owncloud/ocis)
[](https://sonarcloud.io/dashboard?id=owncloud_ocis)
[](https://sonarcloud.io/dashboard?id=owncloud_ocis)
[](https://goreportcard.com/report/github.com/owncloud/ocis)
[](http://godoc.org/github.com/owncloud/ocis)
[](https://hub.docker.com/r/owncloud/ocis)
[](https://opensource.org/licenses/Apache-2.0)
* [Introduction](#introduction)
* [Overview](#overview)
* [Clients](#clients)
* [Web Office Applications](#web-office-applications)
* [Authentication](#authentication)
* [Installation](#installation)
* [Important Readings](#important-readings)
* [Run ownCloud Infinite Scale](#run-owncloud-infinite-scale)
* [Use the Official Documentation](#use-the-official-documentation)
* [Use the ocis Repo as Source](#use-the-ocis-repo-as-source)
* [Documentation](#documentation)
* [Admin Documentation](#admin-documentation)
* [Development Documentation](#development-documentation)
* [Security](#security)
* [Contributing](#contributing)
* [Copyright](#copyright)
## Introduction
ownCloud Infinite Scale (oCIS) is the new file sync & share platform that will be the foundation of your data management platform.
Make sure to download the [latest released version](https://download.owncloud.com/ocis/ocis/stable/?sort=time&order=desc) today!
## Overview
### Clients
Infinite Scale allows the following ownCloud clients:
* [web](https://github.com/owncloud/web),
* [Android](https://github.com/owncloud/android),
* [iOS](https://github.com/owncloud/ios-app) and
* [Desktop](https://github.com/owncloud/client/)
to synchronize and share file spaces with a scalable server backend based on [reva](https://reva.link/) using open and well-defined APIs like [WebDAV](http://www.webdav.org/) and [CS3](https://github.com/cs3org/cs3apis/).
### Web Office Applications
Infinite Scale can integrate web office applications such as:
* [Collabora Online](https://github.com/CollaboraOnline/online),
* [OnlyOffice Docs](https://github.com/ONLYOFFICE/DocumentServer) or
* [Microsoft Office Online Server](https://owncloud.com/microsoft-office-online-integration-with-wopi/)
Collaborative editing is supported by the [WOPI application gateway](https://github.com/cs3org/wopiserver).
### Authentication
Users are authenticated via [OpenID Connect](https://openid.net/connect/) using either an external IdP like [Keycloak](https://www.keycloak.org/) or the embedded [LibreGraph Connect](https://github.com/libregraph/lico) identity provider.
### Installation
With focus on easy install and operation, Infinite Scale is delivered as a single binary or container that allows scaling from a Raspberry Pi to a Kubernetes cluster by changing the configuration and starting multiple services as needed. The multiservice architecture allows tailoring the functionality to your needs and reusing services that may already be in place like when using Keycloak. See the details below for various installation options.
## Important Readings
Before starting to set up an instance, we **highly** recommend reading the [Prerequisites](https://doc.owncloud.com/ocis/next/prerequisites/prerequisites.html), the [Deployment](https://doc.owncloud.com/ocis/next/deployment/) section and especially the [General Information](https://doc.owncloud.com/ocis/next/deployment/general/general-info.html) page describing and explaining information that is valid for all deployment types.
## Run ownCloud Infinite Scale
### Use the Official Documentation
See the [Quick Guide](https://doc.owncloud.com/ocis/next/quickguide/quickguide.html) or the [Binary Setup](https://doc.owncloud.com/ocis/next/deployment/binary/binary-setup.html) for a single-node bare-metal deployment starting with a Raspberry Pi or single server, the [Container Setup](https://doc.owncloud.com/ocis/next/deployment/container/container-setup.html) for classic container environments like docker or learn how to [deploy to Kubernetes](https://doc.owncloud.com/ocis/next/deployment/container/orchestration/orchestration.html).
### Use the ocis Repo as Source
Use this method to run an instance with the latest code. This is only recommended for development purposes. The minimum go version required is 1.22. Note that you need, as a prerequisite, a C compile environment installed because some dependencies like reva have components that require c-go libraries/tool-chains. The command installing for debian based systems is: `sudo apt install build-essentials`. To build and run a local instance with demo users:
```console
# get the source
git clone [email protected]:owncloud/ocis.git
# enter the ocis dir
cd ocis
# generate assets
make generate
# build the binary
make -C ocis build
# initialize a minimal oCIS configuration
./ocis/bin/ocis init
# run with demo users
IDM_CREATE_DEMO_USERS=true ./ocis/bin/ocis server
# Open your browser on http://localhost:9200 to access the bundled web-ui
```
All batteries included: no external database, no external IDP needed!
## Documentation
### Admin Documentation
Refer to the [Admin Documentation - Introduction to Infinite Scale](https://doc.owncloud.com/ocis/next/) to get started with running oCIS in production.
### Development Documentation
See the [Development Documentation - Getting Started](https://owncloud.dev/ocis/development/getting-started/) to get an overview of [Requirements](https://owncloud.dev/ocis/development/getting-started/#requirements), the [repository structure](https://owncloud.dev/ocis/development/getting-started/#repository-structure) and [other starting points](https://owncloud.dev/ocis/development/getting-started/#starting-points).
## Security
See the [Security Aspects](https://doc.owncloud.com/ocis/next/security/security.html) for a general overview of security related topics.
If you find a security issue, please contact [[email protected]](mailto:[email protected]) first.
## Contributing
We are _very_ happy that oCIS does not require a Contributor License Agreement (CLA) as it is [Apache 2.0 licensed](LICENSE). We hope this will make it easier to contribute code. If you want to get in touch, most of the developers hang out in our [matrix channel](https://app.element.io/#/room/#ocis:matrix.org), our [rocket chat channel](https://talk.owncloud.com/channel/infinitescale) or reach out to the [ownCloud central forum](https://central.owncloud.org/).
Infinite Scale is carefully internationalized so that everyone, no matter what language they speak, has a great experience. To achieve this, we rely on the help of volunteer translators. If you want to help, you can find the projects behind the following links:
[Transifex for ownCloud web](https://app.transifex.com/owncloud-org/owncloud-web/translate/) and [Transifex for ownCloud](https://app.transifex.com/owncloud-org/owncloud/translate/) (Select the resource by filtering for `ocis-`).
Please always refer to our [Contribution Guidelines](https://github.com/owncloud/ocis/blob/master/CONTRIBUTING.md).
## End User License Agreement
Some builds of stable ownCloud Infinite Scale releases provided by ownCloud GmbH are subject to an [End User License Agreement](https://owncloud.com/license-owncloud-infinite-scale/).
## Copyright
```console
Copyright (c) 2020-2023 ownCloud GmbH <https://owncloud.com>
```