3.1 KiB
title, date, weight, geekdocRepo, geekdocEditPath, geekdocFilePath
| title | date | weight | geekdocRepo | geekdocEditPath | geekdocFilePath |
|---|---|---|---|---|---|
| Getting Started | 2020-02-27T20:35:00+01:00 | 0 | https://github.com/owncloud/ocis | edit/master/docs/ocis | getting-started.md |
{{< toc >}}
Run oCIS
We are distributing oCIS as binaries and Docker images.
You can find more deployment examples in the deployment section.
Binaries
You can find the latest official release of oCIS at our download mirror or on GitHub. The latest build from the master branch can be found at our download mirrors testing section.
To run oCIS as binary you need to download it first and then run the following commands. For this example, assuming version 1.2.0 of oCIS running on a Linux AMD64 host:
# download
curl https://download.owncloud.com/ocis/ocis/1.2.0/ocis-1.2.0-linux-amd64 --output ocis
# make binary executable
chmod +x ocis
# run
./ocis server
The default primary storage location is /var/tmp/ocis. You can change that value by configuration.
{{< hint warning >}} oCIS by default relies on Multicast DNS (mDNS), usually via avahi-daemon. If your system has a firewall, make sure mDNS is allowed in your active zone. {{< /hint >}}
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]({{< 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" >}}).
To start oCIS server:
{{< highlight txt >}} ocis server {{< / highlight >}}
The list command prints all running oCIS extensions. {{< highlight txt >}} ocis list {{< / highlight >}}
To stop a particular extension: {{< highlight txt >}} ocis kill web {{< / highlight >}}
To start a particular extension: {{< highlight txt >}} ocis run web {{< / highlight >}}
The version command prints the version of your installed oCIS. {{< highlight txt >}} ocis --version {{< / highlight >}}
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.
{{< highlight txt >}} ocis health --help {{< / highlight >}}