diff --git a/admin.rst b/admin.rst index d157fc4d9..95fd11b68 100644 --- a/admin.rst +++ b/admin.rst @@ -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 ∞ @@ -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