jimmy/postgrest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added documentation for server-unix-socket-mode config option

Browse Source
This commit is contained in:
Danilo Amoroso
2019-11-26 11:24:43 -05:00
committed by Steve Chavez
parent a0179cfd4b
commit e1c9b8fe76
1 changed files with 36 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
configuration.rst
+36 -22
View File
@@ -30,28 +30,29 @@ The user specified in the db-uri is also known as the authenticator role. For mo
Here is the full list of configuration parameters. Here is the full list of configuration parameters.
==================== ====== ========= ======== ======================= ====== ========= ========
Name Type Default Required Name Type Default Required
==================== ====== ========= ======== ======================= ====== ========= ========
db-uri String Y db-uri String Y
db-schema String Y db-schema String Y
db-anon-role String Y db-anon-role String Y
db-pool Int 10 db-pool Int 10
db-pool-timeout Int 10 db-pool-timeout Int 10
db-extra-search-path String public db-extra-search-path String public
server-host String !4 server-host String !4
server-port Int 3000 server-port Int 3000
server-unix-socket String server-unix-socket String
server-proxy-uri String server-unix-socket-mode String 755
jwt-secret String server-proxy-uri String
jwt-aud String jwt-secret String
secret-is-base64 Bool False jwt-aud String
max-rows Int ∞ secret-is-base64 Bool False
pre-request String max-rows Int ∞
app.settings.* String pre-request String
role-claim-key String .role app.settings.* String
raw-media-types String role-claim-key String .role
==================== ====== ========= ======== raw-media-types String
======================= ====== ========= ========
.. _db-uri: .. _db-uri:
@@ -141,6 +142,18 @@ server-unix-socket
server-unix-socket = "/tmp/pgrst.sock" server-unix-socket = "/tmp/pgrst.sock"
.. _server-unix-socket-mode:
server-unix-socket-mode
-----------------------
`Unix file mode <https://en.wikipedia.org/wiki/File_system_permissions>`_ to be set for the socket specified in :ref:`server-unix-socket`
Needs to be a valid octal between 600 and 777.
.. code:: bash
server-unix-socket-mode = "755"
.. _server-proxy-uri: .. _server-proxy-uri:
server-proxy-uri server-proxy-uri
@@ -239,3 +252,4 @@ raw-media-types
raw-media-types="image/png, text/xml" raw-media-types="image/png, text/xml"