Jörn Friedrich Dreyer
@@ -1,131 +1,46 @@
|
||||
# ownCloud Infinite Scale
|
||||
|
||||
-[](https://app.element.io/#/room/#opencloud:matrix.org)
|
||||
-[](https://opensource.org/licenses/Apache-2.0)
|
||||
|
||||
[](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)
|
||||
# Server Backend
|
||||
|
||||
* [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
|
||||
> [!TIP]
|
||||
> For general information about OpenCloud and how to install please visit [OpenCloud on Github](https://github.com/opencloud-eu/) and [OpenCloud GmbH](https://opencloud.eu).
|
||||
|
||||
ownCloud Infinite Scale (oCIS) is the new file sync & share platform that will be the foundation of your data management platform.
|
||||
This the main repository of the OpenCloud server. It contains the golang codebase for the backend services.
|
||||
|
||||
Make sure to download the [latest released version](https://download.owncloud.com/ocis/ocis/stable/?sort=time&order=desc) today!
|
||||
## Technology
|
||||
|
||||
## 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).
|
||||
Important information for contributors about the technology in use.
|
||||
|
||||
### 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.
|
||||
The OpenCloud backend authenticates users 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
|
||||
### Database
|
||||
|
||||
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.
|
||||
The OpenCloud backend does not use a database. It stores all data in the filesystem. By default, the root directory of the backend is `$HOME/.opencloud/`.
|
||||
|
||||
## Important Readings
|
||||
## Getting Involved
|
||||
|
||||
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.
|
||||
The OpenCloud server is released under [Apache 2.0](LICENSE). The project is very happy to receive contributions in all forms. Start hacking now 😃
|
||||
|
||||
## Run ownCloud Infinite Scale
|
||||
### Build OpenCloud
|
||||
|
||||
### Use the Official Documentation
|
||||
To build the backend, follow the following instructions:
|
||||
|
||||
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 git@github.com: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
|
||||
``` console
|
||||
make -C opencloud build
|
||||
```
|
||||
That will produce the binary `opencloud/bin/opencloud`.
|
||||
|
||||
All batteries included: no external database, no external IDP needed!
|
||||
For more information consult the [Development Documentation](https://docs.opencloud.eu/opencloud/).
|
||||
|
||||
## 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).
|
||||
Please always refer to our [Contribution Guidelines](https://github.com/opencloud-eu/opencloud/blob/master/CONTRIBUTING.md).
|
||||
|
||||
## 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 [security@owncloud.com](mailto:security@owncloud.com) first.
|
||||
See the [Security Aspects](https://docs.opencloud.eu/security/) for security related topics.
|
||||
|
||||
## 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).
|
||||
|
||||
## Copyright
|
||||
|
||||
```console
|
||||
Copyright (c) 2020-2023 ownCloud GmbH <https://owncloud.com>
|
||||
```
|
||||
If you find a security issue, please contact [security@opencloud.eu](mailto:security@opencloud.eu) first.
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
Reference in New Issue
Block a user