Skip to content

Commit

Permalink
fix: fix server-proxy-uri config (#35)
Browse files Browse the repository at this point in the history
  • Loading branch information
hugomrdias authored and begriffs committed Feb 10, 2017
1 parent 01def80 commit 6e1e8f0
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions admin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ db-anon-role String Y
db-pool Int 10
server-host String \*4
server-port Int 3000
server-proxy-url String
server-proxy-uri String
jwt-secret String
secret-is-base64 Bool False
max-rows Int ∞
Expand All @@ -56,8 +56,25 @@ server-host
Where to bind the PostgREST web server.
server-port
The port to bind the web server.
server-proxy-url
Overrides the base URL used within the OpenAPI self-documentation hosted at the API root path.
server-proxy-uri
Overrides the base URL used within the OpenAPI self-documentation hosted at the API root path. Use a complete URI syntax :code:`scheme:[//[user:password@]host[:port]][/]path[?query][#fragment]`. Ex. :code:`https://postgrest.com`

.. code:: json
{
"swagger": "2.0",
"info": {
"version": "0.4.0.0",
"title": "PostgREST API",
"description": "This is a dynamic API generated by PostgREST"
},
"host": "postgrest.com:443",
"basePath": "/",
"schemes": [
"https"
]
}
jwt-secret
The secret used to decode JWT tokens clients provide for authentication. If this parameter is not specified then PostgREST refuses authentication requests. Choosing a value for this parameter beginning with the at sign such as :code:`@filename` loads the secret out of an external file. This is useful for automating deployments. Note that any binary secrets must be base64 encoded.
secret-is-base64
Expand Down

0 comments on commit 6e1e8f0

Please sign in to comment.