opencloud/docs/getting-started.md

title, date, weight, geekdocRepo, geekdocEditPath, geekdocFilePath

title	date	weight	geekdocRepo	geekdocEditPath	geekdocFilePath
Getting Started	2018-05-02T00:00:00+00:00	20	https://github.com/owncloud/ocis-proxy	edit/master/docs	getting-started.md

{{< toc >}}

Installation

So far we are offering two different variants for the installation. You can choose between Docker or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.

Docker

TBD

Binaries

TBD

Configuration

We provide overall three different variants of configuration. The variant based on environment variables and commandline flags are split up into global values and command-specific values.

Envrionment variables

If you prefer to configure the service with environment variables you can see the available variables below.

Server

OCIS_PROXY_NAME

Name of the proxy service. It will be part of the namespace.

OCIS_PROXY_NAMESPACE

Namespace of the proxy service.

OCIS_PROXY_ADDRESS

Endpoint for the http service endpoint.

Commandline flags

If you prefer to configure the service with commandline flags you can see the available variables below.

Configuration file

So far we support the file formats JSON and YAML, if you want to get a full example configuration just take a look at our repository, there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at /etc/ocis/proxy.yml, ${HOME}/.ocis/proxy.yml or $(pwd)/config/proxy.yml.

Usage

The program provides a few sub-commands on execution. The available configuration methods have already been mentioned above. Generally you can always see a formated help output if you execute the binary via ocis-proxy --help.

Server

The server command is used to start the http server. For further help please execute:

{{< highlight txt >}} ocis-proxy server --help {{< / highlight >}}