From e1c9b8fe768167c7fb281a095ff46240b0a657ce Mon Sep 17 00:00:00 2001
From: Danilo Amoroso <dan.j.amoroso@gmail.com>
Date: Mon, 25 Nov 2019 12:55:57 +0100
Subject: [PATCH] added documentation for server-unix-socket-mode config option

---
 configuration.rst | 58 +++++++++++++++++++++++++++++------------------
 1 file changed, 36 insertions(+), 22 deletions(-)

diff --git a/configuration.rst b/configuration.rst
index 267ed24a1..c02d8a62c 100644
--- a/configuration.rst
+++ b/configuration.rst
@@ -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.
 
-====================  ======  =========  ========
-Name                  Type    Default    Required
-====================  ======  =========  ========
-db-uri                String             Y
-db-schema             String             Y
-db-anon-role          String             Y
-db-pool               Int     10
-db-pool-timeout       Int     10
-db-extra-search-path  String  public
-server-host           String  !4
-server-port           Int     3000
-server-unix-socket    String
-server-proxy-uri      String
-jwt-secret            String
-jwt-aud               String
-secret-is-base64      Bool    False
-max-rows              Int     ∞
-pre-request           String
-app.settings.*        String
-role-claim-key        String  .role
-raw-media-types       String
-====================  ======  =========  ========
+======================= ======  =========  ========
+Name                    Type    Default    Required
+======================= ======  =========  ========
+db-uri                  String             Y
+db-schema               String             Y
+db-anon-role            String             Y
+db-pool                 Int     10
+db-pool-timeout         Int     10
+db-extra-search-path    String  public
+server-host             String  !4
+server-port             Int     3000
+server-unix-socket      String
+server-unix-socket-mode String  755        
+server-proxy-uri        String
+jwt-secret              String
+jwt-aud                 String
+secret-is-base64        Bool    False
+max-rows                Int     ∞
+pre-request             String
+app.settings.*          String
+role-claim-key          String  .role
+raw-media-types         String
+======================= ======  =========  ========
 
 .. _db-uri:
 
@@ -141,6 +142,18 @@ server-unix-socket
 
     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
@@ -239,3 +252,4 @@ raw-media-types
 
    raw-media-types="image/png, text/xml"
 
+