Files
opencloud/README.md
Martin 16c4480e28 Apply suggestions from code review
Co-authored-by: Phil Davis <phil@jankaritech.com>
2022-11-10 10:34:24 +01:00

8.5 KiB

ownCloud Infinite Scale

Rocket chat Build Status Security Rating Coverage Go Report Go Doc oCIS docker image License

ownCloud Infinite Scale (oCIS) is the new file sync & share platform that will be the foundation of your data platform.

Inifinite Scale is currently in code freeze for general availability of version 2.0. Feature completeness was reached and the community is concentrating on bug fixes and performance improvements.

Make sure to download the latest release candidate build today!

Infinite Scale allows web, Android, iOS and desktop clients to synchronize and share file spaces with a scalable server side based on reva using open and well defined APIs like WebDAV and CS3. External applications like Collabora Online, OnlyOffice Docs or Microsoft Office Online Server can be used to collaborate using a WOPI application gateway. Users are authenticated using OpenID Connect and the embedded LibreGraph Connect identity provider.

With a focus on easy install and operation, Infinite Scale is delivered as a single binary that allows scaling oCIS from a Raspberry Pi to 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 Keycloak as the identity provider.

Run ownCloud Infinite Scale

Please see Binary Setup for a single node bare metal deployment like on a Raspberry Pi or learn how to deploy to Kubernetes.

To build and run a local instance with demo users:

# 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

All batteries included: no external database, no external IDP needed!

Documentation

Development Documentation

Please see Development Documentation - Getting Started to get an overview of Requirements, the repository structure and other starting points.

Admin Documentation

Please see Admin Documentation - Introduction to Infinite Scale to get started with running oCIS in production.

Security

If you find a security issue please contact security@owncloud.com first.

Contributing

We are very happy that oCIS does not require a CLA as it is Apache 2.0 licensed. 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 rocket chat channel or reach out to the the ownCloud central forum.

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 project behind this link: or Transifex for ownCloud web.

Please always refer to our Contribution Guidelines.

Copyright (c) 2020-2022 ownCloud GmbH <https://owncloud.com>