From 543a68cfb55abd709a3efa2acb340b08f2361c1a Mon Sep 17 00:00:00 2001
From: Jacob Vosmaer <jacob@gitlab.com>
Date: Fri, 10 Mar 2017 15:03:56 +0100
Subject: Document gitaly.socket_path setting

---
 config/gitlab.yml.example | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/config/gitlab.yml.example b/config/gitlab.yml.example
index 720df0cac2d..b4f6cba1833 100644
--- a/config/gitlab.yml.example
+++ b/config/gitlab.yml.example
@@ -441,6 +441,16 @@ production: &base
   shared:
     # path: /mnt/gitlab # Default: shared
 
+  # Gitaly settings
+  gitaly:
+    # The socket_path setting is optional and obsolete. When this is set
+    # GitLab assumes it can reach a Gitaly services via a Unix socket at
+    # this path. When this is commented out GitLab will not use Gitaly.
+    # 
+    # This setting is obsolete because we expect it to be moved under
+    # repositories/storages in GitLab 9.1.
+    #
+    # socket_path: tmp/sockets/gitaly.socket
 
   #
   # 4. Advanced settings
-- 
cgit v1.2.1