mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-05-05 19:09:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

Revert "run remark linter locally"

Browse Source 
This reverts commit 97c348f1ae.
This commit is contained in:
A.Unger
2020-09-23 11:48:59 +02:00
parent 97c348f1ae
commit 8b9e02ec0b
447 changed files with 6088 additions and 6178 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/ocis/getting-started.md
+18 -19
View File
@@ -1,14 +1,13 @@
* * *
---
title: "Getting Started"
date: 2020-02-27T20:35:00+01:00
weight: 15
geekdocRepo: <https://github.com/owncloud/ocis>
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs
geekdocFilePath: getting-started.md
---
## geekdocFilePath: getting-started.md
{{&lt; toc >}}
{{< toc >}}
## Installation
@@ -16,7 +15,7 @@ So far we are offering two different variants for the installation. You can choo
### Docker
Docker images for ocis are hosted on <https://hub.docker.com/r/owncloud/ocis>.
Docker images for ocis are hosted on https://hub.docker.com/r/owncloud/ocis.
The `latest` tag always reflects the current master branch.
@@ -26,8 +25,8 @@ docker pull owncloud/ocis
#### Dependencies
- Running ocis currently needs a working Redis caching server
- The default storage location in the container is `/var/tmp/reva/data`. You may want to create a volume to persist the files in the primary storage
- Running ocis currently needs a working Redis caching server
- The default storage location in the container is `/var/tmp/reva/data`. You may want to create a volume to persist the files in the primary storage
#### Docker compose
@@ -41,7 +40,7 @@ docker-compose -f ocis.yml -f ../cache/redis-ocis.yml up
### Binaries
The pre-built binaries for different platforms are downloadable at <https://download.owncloud.com/ocis/ocis/> . Specific releases are organized in separate folders. They are in sync which every release tag on GitHub. The binaries from the current master branch can be found in <https://download.owncloud.com/ocis/ocis/testing/>
The pre-built binaries for different platforms are downloadable at https://download.owncloud.com/ocis/ocis/ . Specific releases are organized in separate folders. They are in sync which every release tag on GitHub. The binaries from the current master branch can be found in https://download.owncloud.com/ocis/ocis/testing/
```console
curl https://download.owncloud.com/ocis/ocis/1.0.0-beta1/ocis-1.0.0-beta1-darwin-amd64 --output ocis
@@ -51,8 +50,8 @@ chmod +x ocis
#### Dependencies
- Running ocis currently needs a working Redis caching server
- The default promary storage location is `/var/tmp/reva/data`. You can change that value by configuration.
- Running ocis currently needs a working Redis caching server
- The default promary storage location is `/var/tmp/reva/data`. You can change that value by configuration.
## Usage
@@ -62,21 +61,21 @@ The program provides a few sub-commands on execution. The available configuratio
The server command is used to start the http and debug server on two addresses within a single process. The http server is serving the general webservice while the debug server is used for health check, readiness check and to server the metrics mentioned below. For further help please execute:
{{&lt; highlight txt >}}
{{< highlight txt >}}
ocis server --help
{{&lt; / highlight >}}
{{< / highlight >}}
### Health
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.
{{&lt; highlight txt >}}
{{< highlight txt >}}
ocis health --help
{{&lt; / highlight >}}
{{< / highlight >}}
## Quickstart for Developers
Following <https://github.com/owncloud/ocis#development>
Following https://github.com/owncloud/ocis#development
```console
git clone https://github.com/owncloud/ocis.git
@@ -84,7 +83,7 @@ cd ocis
make generate build
```
Open https&#x3A;//localhost:9200 and login using one of the demo accounts:
Open https://localhost:9200 and login using one of the demo accounts:
```console
einstein:relativity
@@ -226,4 +225,4 @@ promhttp_metric_handler_requests_in_flight
: Current number of scrapes being served
promhttp_metric_handler_requests_total
: Total number of scrapes by HTTP status code
: Total number of scrapes by HTTP status code