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 Apr 6, 2020
1 parent f4da8f6 commit 11d9666
Showing 1 changed file with 20 additions and 14 deletions.
34 changes: 20 additions & 14 deletions docs/docs/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ section.
# - Windows Command Line (CMD):
# > set DSN=<value>
#
dsn: postgres://user:password@host:123/database
dsn: mysql://user:password@tcp(host:123)/database

## HTTP REST API ##
#
Expand Down Expand Up @@ -78,7 +78,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_HOST=<value>
#
host: ''
host: 127.0.0.1

## Cross Origin Resource Sharing (CORS) ##
#
Expand All @@ -97,7 +97,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_CORS_ENABLED=<value>
#
enabled: true
enabled: false

## Allowed Origins ##
#
Expand Down Expand Up @@ -132,7 +132,11 @@ serve:
# > set SERVE_CORS_ALLOWED_METHODS=<value>
#
allowed_methods:
- HEAD
- POST
- DELETE
- CONNECT
- TRACE

## Allowed Request HTTP Headers ##
#
Expand All @@ -147,8 +151,9 @@ serve:
# > set SERVE_CORS_ALLOWED_HEADERS=<value>
#
allowed_headers:
- sit veniam Lorem velit
- cillum magna sit irure
- sunt dolor eiusmod in
- aute
- veniam

## Allowed Response HTTP Headers ##
#
Expand All @@ -163,10 +168,11 @@ serve:
# > set SERVE_CORS_EXPOSED_HEADERS=<value>
#
exposed_headers:
- ex consectetur ut deserunt aliquip
- ad in in magna velit
- exercitation ut dolore
- nostrud elit
- sunt pariatur fugiat magna
- Ut esse in tempor
- voluptate aliqua eiusmod adipisicing
- id sit occaecat
- irure anim

## Allow HTTP Credentials ##
#
Expand All @@ -192,7 +198,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_CORS_MAX_AGE=<value>
#
max_age: -15653991
max_age: 1296018

## Enable Debugging ##
#
Expand All @@ -206,7 +212,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_CORS_DEBUG=<value>
#
debug: true
debug: false

## HTTPS ##
#
Expand Down Expand Up @@ -269,7 +275,7 @@ serve:
# - Windows Command Line (CMD):
# > set PROFILING=<value>
#
profiling: mem
profiling: ''

## Log ##
#
Expand All @@ -288,7 +294,7 @@ log:
# - Windows Command Line (CMD):
# > set LOG_LEVEL=<value>
#
level: panic
level: warn

## Format ##
#
Expand All @@ -302,7 +308,7 @@ log:
# - Windows Command Line (CMD):
# > set LOG_FORMAT=<value>
#
format: json
format: text

## tracing ##
#
Expand Down

0 comments on commit 11d9666

Please sign in to comment.