mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-04-24 04:58:31 -05:00
Code Issues Packages Projects Releases Wiki Activity

add / edit templates for configuration docs

Browse Source
This commit is contained in:
Willy Kloucek
2020-11-12 15:29:13 +01:00
parent 48a519d0e4
commit f1fed2de81
12 changed files with 566 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
proxy/templates/CONFIGURATION.tmpl
+8 -8
View File
@@ -2,8 +2,8 @@
title: "Configuration"
date: "{{ date "2006-01-02T15:04:05-0700" now }}"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis-proxy
geekdocEditPath: edit/master/docs
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/proxy
geekdocFilePath: configuration.md
---
{{- define "options"}}
@@ -25,7 +25,7 @@ geekdocFilePath: configuration.md
oCIS Single Binary is not responsible for configuring extensions. Instead, each extension could either be configured by environment variables, cli flags or config files.
Each extension has its dedicated documentation page (e.g. https://owncloud.github.io/extensions/ocis_proxy/configuration) which lists all possible configurations. Config files and environment variables are picked up if you use the `./bin/ocis server` command within the oCIS single binary. Command line flags must be set explicitly on the extensions subcommands.
Each extension has its dedicated documentation page (e.g. https://owncloud.github.io/extensions/proxy/configuration/) which lists all possible configurations. Config files and environment variables are picked up if you use the `./bin/ocis server` command within the oCIS single binary. Command line flags must be set explicitly on the extensions subcommands.
### Configuration using config files
@@ -52,12 +52,12 @@ If you prefer to configure the service with commandline flags you can see the av
{{ $options := .Options -}}
{{ range $com := .Commands }}{{ with (list $options $com) -}}
{{ $c := last . -}}
{{ if eq $c.Name "ocis-proxy" -}}
{{ if eq $c.Name "proxy" -}}
## Root Command
{{ $c.Usage }}
Usage: `ocis-proxy [global options] command [command options] [arguments...]`
Usage: `proxy [global options] command [command options] [arguments...]`
{{ template "options" . -}}
## Sub Commands
@@ -66,12 +66,12 @@ Usage: `ocis-proxy [global options] command [command options] [arguments...]`
{{ end -}}
{{- range $com := .Commands }}{{ with (list $options $com) -}}
{{- $c := last . }}
{{- if ne $c.Name "ocis-proxy" -}}
### ocis-proxy {{ $c.Name }}
{{- if ne $c.Name "proxy" -}}
### proxy {{ $c.Name }}
{{ $c.Usage }}
Usage: `ocis-proxy {{ $c.Name }} [command options] [arguments...]`
Usage: `proxy {{ $c.Name }} [command options] [arguments...]`
{{ template "options" . }}
{{- end -}}
{{- end -}}