Skip to content

Commit

Permalink
autogen(docs): generate and format documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
aeneasr committed Aug 2, 2020
1 parent 5a53d28 commit 1208827
Showing 1 changed file with 50 additions and 53 deletions.
103 changes: 50 additions & 53 deletions docs/docs/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ log:
# - Windows Command Line (CMD):
# > set LOG_LEVEL=<value>
#
level: trace
level: panic

## leak_sensitive_values ##
#
Expand Down Expand Up @@ -107,7 +107,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_PUBLIC_PORT=<value>
#
port: 58567
port: 14392

## host ##
#
Expand Down Expand Up @@ -141,7 +141,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_PUBLIC_CORS_ENABLED=<value>
#
enabled: false
enabled: true

## allowed_origins ##
#
Expand Down Expand Up @@ -176,9 +176,10 @@ serve:
# > set SERVE_PUBLIC_CORS_ALLOWED_METHODS=<value>
#
allowed_methods:
- POST
- GET
- TRACE
- HEAD
- PATCH
- OPTIONS

## allowed_headers ##
#
Expand All @@ -193,11 +194,8 @@ serve:
# > set SERVE_PUBLIC_CORS_ALLOWED_HEADERS=<value>
#
allowed_headers:
- ad incididunt
- ipsum eu dolore id Duis
- consequat eiusmod sit irure
- ad laborum
- esse exercitation mollit commodo eiusmod
- veniam Excepteur culpa laboris ea
- in magna ullamco laborum Duis

## exposed_headers ##
#
Expand All @@ -212,10 +210,9 @@ serve:
# > set SERVE_PUBLIC_CORS_EXPOSED_HEADERS=<value>
#
exposed_headers:
- in aliquip aliqua eiusmod commodo
- et do ad qui
- Lorem laborum deserunt anim
- irure id ad
- commodo exercitation
- officia
- ut quis in

## allow_credentials ##
#
Expand Down Expand Up @@ -243,7 +240,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_PUBLIC_CORS_OPTIONS_PASSTHROUGH=<value>
#
options_passthrough: false
options_passthrough: true

## max_age ##
#
Expand All @@ -257,7 +254,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_PUBLIC_CORS_MAX_AGE=<value>
#
max_age: 39268583
max_age: 51071447

## debug ##
#
Expand Down Expand Up @@ -288,7 +285,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_PUBLIC_SOCKET_OWNER=<value>
#
owner: ipsum id occaecat
owner: minim labore nostrud Excepteur

## group ##
#
Expand All @@ -300,7 +297,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_PUBLIC_SOCKET_GROUP=<value>
#
group: aliqua
group: ut do ullamco ut Excepteur

## mode ##
#
Expand All @@ -318,7 +315,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_PUBLIC_SOCKET_MODE=<value>
#
mode: 450
mode: 507

## access_log ##
#
Expand Down Expand Up @@ -352,7 +349,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_ADMIN_PORT=<value>
#
port: 3161
port: 20038

## host ##
#
Expand All @@ -367,7 +364,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_ADMIN_HOST=<value>
#
host: ''
host: localhost

## cors ##
#
Expand All @@ -386,7 +383,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_ADMIN_CORS_ENABLED=<value>
#
enabled: true
enabled: false

## allowed_origins ##
#
Expand Down Expand Up @@ -421,7 +418,10 @@ serve:
# > set SERVE_ADMIN_CORS_ALLOWED_METHODS=<value>
#
allowed_methods:
- POST
- OPTIONS
- OPTIONS
- DELETE
- HEAD

## allowed_headers ##
#
Expand All @@ -436,11 +436,11 @@ serve:
# > set SERVE_ADMIN_CORS_ALLOWED_HEADERS=<value>
#
allowed_headers:
- in sit amet sint
- in non Lorem
- ad quis nulla
- deserunt
- sunt non
- ad tempor
- magna
- deserunt incididunt anim nisi do
- et
- et aliquip velit reprehenderit commodo

## exposed_headers ##
#
Expand All @@ -455,11 +455,9 @@ serve:
# > set SERVE_ADMIN_CORS_EXPOSED_HEADERS=<value>
#
exposed_headers:
- nulla elit irure occaecat
- laborum aute minim laboris
- cillum eiusmod culpa irure
- magna sit
- dolore
- cillum dolor
- veniam sed enim pariatur est
- Lorem et

## allow_credentials ##
#
Expand All @@ -473,7 +471,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_ADMIN_CORS_ALLOW_CREDENTIALS=<value>
#
allow_credentials: false
allow_credentials: true

## options_passthrough ##
#
Expand Down Expand Up @@ -501,7 +499,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_ADMIN_CORS_MAX_AGE=<value>
#
max_age: 30360643
max_age: 23241552

## debug ##
#
Expand All @@ -515,7 +513,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_ADMIN_CORS_DEBUG=<value>
#
debug: false
debug: true

## socket ##
#
Expand All @@ -532,7 +530,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_ADMIN_SOCKET_OWNER=<value>
#
owner: consequat qui dolore
owner: consequat

## group ##
#
Expand All @@ -544,7 +542,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_ADMIN_SOCKET_GROUP=<value>
#
group: non
group: ullamco

## mode ##
#
Expand All @@ -562,7 +560,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_ADMIN_SOCKET_MODE=<value>
#
mode: 445
mode: 367

## access_log ##
#
Expand Down Expand Up @@ -593,30 +591,30 @@ serve:
# Configures the private key (pem encoded).
#
key:
## path ##
## base64 ##
#
# Set this value using environment variables on
# - Linux/macOS:
# $ export SERVE_TLS_KEY_PATH=<value>
# $ export SERVE_TLS_KEY_BASE64=<value>
# - Windows Command Line (CMD):
# > set SERVE_TLS_KEY_PATH=<value>
# > set SERVE_TLS_KEY_BASE64=<value>
#
path: /path/to/file.pem
base64: b3J5IGh5ZHJhIGlzIGF3ZXNvbWUK

## cert ##
#
# Configures the private key (pem encoded).
#
cert:
## path ##
## base64 ##
#
# Set this value using environment variables on
# - Linux/macOS:
# $ export SERVE_TLS_CERT_PATH=<value>
# $ export SERVE_TLS_CERT_BASE64=<value>
# - Windows Command Line (CMD):
# > set SERVE_TLS_CERT_PATH=<value>
# > set SERVE_TLS_CERT_BASE64=<value>
#
path: /path/to/file.pem
base64: b3J5IGh5ZHJhIGlzIGF3ZXNvbWUK

## allow_termination_from ##
#
Expand All @@ -633,7 +631,6 @@ serve:
- 127.0.0.1/32
- 127.0.0.1/32
- 127.0.0.1/32
- 127.0.0.1/32

## cookies ##
#
Expand Down Expand Up @@ -684,7 +681,7 @@ serve:
# - Windows Command Line (CMD):
# > set DSN=<value>
#
dsn: dolor anim aute
dsn: et

## webfinger ##
#
Expand Down Expand Up @@ -1049,7 +1046,7 @@ ttl:
# - Windows Command Line (CMD):
# > set TTL_REFRESH_TOKEN=<value>
#
refresh_token: -1
refresh_token: 720h

## id_token ##
#
Expand Down Expand Up @@ -1097,7 +1094,7 @@ oauth2:
# - Windows Command Line (CMD):
# > set OAUTH2_EXPOSE_INTERNAL_ERRORS=<value>
#
expose_internal_errors: false
expose_internal_errors: true

## hashers ##
#
Expand All @@ -1123,7 +1120,7 @@ oauth2:
# - Windows Command Line (CMD):
# > set OAUTH2_HASHERS_BCRYPT_COST=<value>
#
cost: 27714222
cost: 3229330

## pkce ##
#
Expand Down Expand Up @@ -1352,5 +1349,5 @@ tracing:
# - Windows Command Line (CMD):
# > set TRACING_PROVIDERS_ZIPKIN_SERVER_URL=<value>
#
server_url: http://cvhvfNplfLKmuKrmdMAxxqrg.gqzO25rRobl
server_url: https://UJpmjDwvRuGToILDTAaKDSM.xwhrB-sFggElx+uNdzTPVUJ
```

0 comments on commit 1208827

Please sign in to comment.