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 Jul 20, 2020
1 parent 2bc777d commit 6c4bc77
Showing 1 changed file with 47 additions and 54 deletions.
101 changes: 47 additions & 54 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: fatal

## leak_sensitive_values ##
#
Expand Down Expand Up @@ -85,7 +85,7 @@ log:
# - Windows Command Line (CMD):
# > set LOG_FORMAT=<value>
#
format: text
format: json

## serve ##
#
Expand All @@ -107,7 +107,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_PUBLIC_PORT=<value>
#
port: 28171
port: 8733

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

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

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

## allowed_methods ##
#
Expand All @@ -178,9 +176,9 @@ serve:
# > set SERVE_PUBLIC_CORS_ALLOWED_METHODS=<value>
#
allowed_methods:
- POST
- CONNECT
- PUT
- OPTIONS
- TRACE

## allowed_headers ##
#
Expand All @@ -195,7 +193,8 @@ serve:
# > set SERVE_PUBLIC_CORS_ALLOWED_HEADERS=<value>
#
allowed_headers:
- eiusmod ea dolor est
- quis
- Duis esse

## exposed_headers ##
#
Expand All @@ -210,10 +209,7 @@ serve:
# > set SERVE_PUBLIC_CORS_EXPOSED_HEADERS=<value>
#
exposed_headers:
- minim et
- ad aliqua pariatur
- non incididunt nostrud
- magna esse proident
- magna consequat officia

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

## max_age ##
#
Expand All @@ -255,7 +251,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_PUBLIC_CORS_MAX_AGE=<value>
#
max_age: 45522322
max_age: 69640614

## debug ##
#
Expand Down Expand Up @@ -286,7 +282,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_PUBLIC_SOCKET_OWNER=<value>
#
owner: sunt sint in
owner: ullamco culpa amet laborum

## group ##
#
Expand All @@ -298,7 +294,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_PUBLIC_SOCKET_GROUP=<value>
#
group: qui Ut quis nisi
group: dolore officia dolore sit ex

## mode ##
#
Expand All @@ -316,7 +312,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_PUBLIC_SOCKET_MODE=<value>
#
mode: 343
mode: 95

## access_log ##
#
Expand Down Expand Up @@ -350,7 +346,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_ADMIN_PORT=<value>
#
port: 62818
port: 31837

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

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

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

## allowed_methods ##
#
Expand All @@ -421,9 +415,7 @@ serve:
# > set SERVE_ADMIN_CORS_ALLOWED_METHODS=<value>
#
allowed_methods:
- PATCH
- PUT
- OPTIONS
- DELETE

## allowed_headers ##
#
Expand All @@ -438,9 +430,11 @@ serve:
# > set SERVE_ADMIN_CORS_ALLOWED_HEADERS=<value>
#
allowed_headers:
- magna occaecat commodo in ad
- aliqua ipsum fugiat labore culpa
- elit Duis velit
- mollit pariatur est eiusmod
- et adipisicing
- elit
- ipsum
- Duis sint exercitation ex laboris

## exposed_headers ##
#
Expand All @@ -455,10 +449,10 @@ serve:
# > set SERVE_ADMIN_CORS_EXPOSED_HEADERS=<value>
#
exposed_headers:
- Duis
- consequat proident ipsum in
- enim veniam non ex
- id est
- deserunt Duis consequat ut
- eiusmod voluptate ad laboris
- et incididunt
- Duis quis velit proident officia

## allow_credentials ##
#
Expand Down Expand Up @@ -500,7 +494,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_ADMIN_CORS_MAX_AGE=<value>
#
max_age: 26635639
max_age: 34004489

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

## socket ##
#
Expand All @@ -531,7 +525,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_ADMIN_SOCKET_OWNER=<value>
#
owner: culpa consectetur
owner: in

## group ##
#
Expand All @@ -543,7 +537,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_ADMIN_SOCKET_GROUP=<value>
#
group: commodo
group: id voluptate

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

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

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

## dsn ##
#
Expand All @@ -679,7 +673,7 @@ serve:
# - Windows Command Line (CMD):
# > set DSN=<value>
#
dsn: et in dolor
dsn: dolore reprehenderit sunt

## webfinger ##
#
Expand All @@ -706,8 +700,7 @@ webfinger:
# - Windows Command Line (CMD):
# > set WEBFINGER_JWKS_BROADCAST_KEYS=<value>
#
broadcast_keys:
- hydra.openid.id-token
broadcast_keys: hydra.jwt.access-token

## oidc_discovery ##
#
Expand Down Expand Up @@ -982,7 +975,7 @@ strategies:
# - Windows Command Line (CMD):
# > set STRATEGIES_SCOPE=<value>
#
scope: wildcard
scope: DEPRECATED_HIERARCHICAL_SCOPE_STRATEGY

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

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

## oauth2 ##
#
Expand Down Expand Up @@ -1119,7 +1112,7 @@ oauth2:
# - Windows Command Line (CMD):
# > set OAUTH2_HASHERS_BCRYPT_COST=<value>
#
cost: 74799897
cost: 31308046

## pkce ##
#
Expand Down Expand Up @@ -1348,5 +1341,5 @@ tracing:
# - Windows Command Line (CMD):
# > set TRACING_PROVIDERS_ZIPKIN_SERVER_URL=<value>
#
server_url: https://ojkgtdIf.pqq6bM+CpCfogq0v
server_url: https://yGwBKZnJKZWNze.hfnun70JMmIjY11
```

0 comments on commit 6c4bc77

Please sign in to comment.