Getting Started

Run oCIS

We are distributing oCIS as binaries and Docker images.

You can find more deployments examples in the deployment section

Binaries

The binaries for different platforms are downloadable at our download mirror or on GitHub. Latest binaries from the master branch can be found at our download mirrors testing section.

# for mac
curl https://download.owncloud.com/ocis/ocis/1.0.0/ocis-1.0.0-darwin-amd64 --output ocis
# for linux
curl https://download.owncloud.com/ocis/ocis/1.0.0/ocis-1.0.0-linux-amd64 --output ocis
# make binary executable
chmod +x ocis
./ocis server

The default primary storage location is /var/tmp/ocis. You can change that value by configuration.

Docker

Docker images for oCIS are available on Docker Hub.

The latest tag always reflects the current master branch.

docker pull owncloud/ocis
docker run --rm -ti -p 9200:9200 owncloud/ocis

Usage

Login to ownCloud Web

Open https://localhost:9200 and login using one of the demo accounts:

einstein:relativity
marie:radioactivity
richard:superfluidity

There are admin demo accounts:

moss:vista
admin:admin

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 section. We now will show you some more management commands, which you may also explore by typing ocis --help or going to the docs.

To start oCIS server:

ocis server

The list command prints all running oCIS extensions.

ocis list

To stop a particular extension:

ocis kill web

To start a particular extension:

ocis run web

The version command prints the version of your installed oCIS.

ocis --version

The health command is used to execute a health check, if the exit code equals zero the service should be up and running, if the exist code is greater than zero the service is not in a healthy state. Generally this command is used within our Docker containers, it could also be used within Kubernetes.

ocis health --help