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 4c58601 commit 8772df0
Showing 1 changed file with 48 additions and 47 deletions.
95 changes: 48 additions & 47 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: panic
level: error

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

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

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

## allowed_headers ##
#
Expand All @@ -194,8 +195,9 @@ serve:
# > set SERVE_PUBLIC_CORS_ALLOWED_HEADERS=<value>
#
allowed_headers:
- veniam Excepteur culpa laboris ea
- in magna ullamco laborum Duis
- ad quis laborum laboris labore
- commodo eiusmod ea
- fugiat cillum est commodo

## exposed_headers ##
#
Expand All @@ -210,9 +212,11 @@ serve:
# > set SERVE_PUBLIC_CORS_EXPOSED_HEADERS=<value>
#
exposed_headers:
- commodo exercitation
- officia
- ut quis in
- exercitation esse nulla
- commodo dolore
- dolor labore
- tempor
- laborum eu in dolor

## allow_credentials ##
#
Expand Down Expand Up @@ -254,7 +258,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_PUBLIC_CORS_MAX_AGE=<value>
#
max_age: 51071447
max_age: 49290909

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

## socket ##
#
Expand All @@ -285,7 +289,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_PUBLIC_SOCKET_OWNER=<value>
#
owner: minim labore nostrud Excepteur
owner: culpa

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

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

## access_log ##
#
Expand All @@ -334,7 +338,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_PUBLIC_ACCESS_LOG_DISABLE_FOR_HEALTH=<value>
#
disable_for_health: true
disable_for_health: false

## admin ##
#
Expand All @@ -349,7 +353,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_ADMIN_PORT=<value>
#
port: 20038
port: 28778

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

## allowed_origins ##
#
Expand All @@ -403,7 +407,9 @@ serve:
# > set SERVE_ADMIN_CORS_ALLOWED_ORIGINS=<value>
#
allowed_origins:
- '*'
- https://example.com
- https://*.example.com
- https://*.foo.example.com

## allowed_methods ##
#
Expand All @@ -418,10 +424,8 @@ serve:
# > set SERVE_ADMIN_CORS_ALLOWED_METHODS=<value>
#
allowed_methods:
- OPTIONS
- OPTIONS
- DELETE
- HEAD
- TRACE
- PUT

## allowed_headers ##
#
Expand All @@ -436,11 +440,8 @@ serve:
# > set SERVE_ADMIN_CORS_ALLOWED_HEADERS=<value>
#
allowed_headers:
- ad tempor
- magna
- deserunt incididunt anim nisi do
- et
- et aliquip velit reprehenderit commodo
- in veniam
- aliqua in mollit

## exposed_headers ##
#
Expand All @@ -455,9 +456,9 @@ serve:
# > set SERVE_ADMIN_CORS_EXPOSED_HEADERS=<value>
#
exposed_headers:
- cillum dolor
- veniam sed enim pariatur est
- Lorem et
- do deserunt aute
- eiusmod exercitation in
- ex aliquip labore dolore ullamco

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

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

## debug ##
#
Expand Down Expand Up @@ -530,7 +531,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_ADMIN_SOCKET_OWNER=<value>
#
owner: consequat
owner: mollit irure exercitation id

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

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

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

## allow_termination_from ##
#
Expand Down Expand Up @@ -669,7 +670,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_COOKIES_SAME_SITE_LEGACY_WORKAROUND=<value>
#
same_site_legacy_workaround: true
same_site_legacy_workaround: false

## dsn ##
#
Expand All @@ -681,7 +682,7 @@ serve:
# - Windows Command Line (CMD):
# > set DSN=<value>
#
dsn: et
dsn: anim ut consectetur

## webfinger ##
#
Expand Down Expand Up @@ -999,7 +1000,7 @@ strategies:
# - Windows Command Line (CMD):
# > set STRATEGIES_ACCESS_TOKEN=<value>
#
access_token: jwt
access_token: opaque

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

## id_token ##
#
Expand Down Expand Up @@ -1074,7 +1075,7 @@ ttl:
# - Windows Command Line (CMD):
# > set TTL_AUTH_CODE=<value>
#
auth_code: 1h
auth_code: 10m

## oauth2 ##
#
Expand Down Expand Up @@ -1120,7 +1121,7 @@ oauth2:
# - Windows Command Line (CMD):
# > set OAUTH2_HASHERS_BCRYPT_COST=<value>
#
cost: 3229330
cost: 45632799

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

0 comments on commit 8772df0

Please sign in to comment.