Docs Edit links, Changelog template, Makefile

This commit is contained in:
Michael Barz
2020-03-09 21:50:59 +01:00
parent 2aba428eb1
commit 0a07d7e663
7 changed files with 44 additions and 29 deletions

View File

@@ -1,31 +1,35 @@
---
title: "Getting Started"
date: 2018-05-02T00:00:00+00:00
anchor: "getting-started"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis-proxy
geekdocEditPath: edit/master/docs
geekdocFilePath: getting-started.md
---
### Installation
{{< toc >}}
## Installation
So far we are offering two different variants for the installation. You can choose between [Docker](https://www.docker.com/) 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
### Docker
TBD
#### Binaries
### Binaries
TBD
### Configuration
## 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
### Envrionment variables
If you prefer to configure the service with environment variables you can see the available variables below.
##### Server
#### Server
OCIS_PROXY_NAME
: Name of the proxy service. It will be part of the namespace.
@@ -36,19 +40,19 @@ OCIS_PROXY_NAMESPACE
OCIS_PROXY_ADDRESS
: Endpoint for the http service endpoint.
#### Commandline flags
### Commandline flags
If you prefer to configure the service with commandline flags you can see the available variables below.
#### Configuration file
### 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](https://github.com/owncloud/ocis-proxy/tree/master/pkg/config), 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
## 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
### Server
The server command is used to start the http server. For further help please execute: