Add Gitaly configuration documentationgitaly-doc

2 files changed, 35 insertions, 1 deletions

diff --git a/config/gitlab.yml.example b/config/gitlab.yml.example
index 42e5f105d46..5ab0e413f3c 100644
--- a/config/gitlab.yml.example
+++ b/config/gitlab.yml.example
@@ -534,6 +534,10 @@ production: &base
       # Ban an IP for one hour (3600s) after too many auth attempts
       # bantime: 3600
 
+  # Gitaly settings
+  # gitaly:
+  #   socket_path: /home/git/gitaly/gitaly.socket
+
 development:
   <<: *base
 
@@ -586,4 +590,4 @@ test:
         admin_group: ''
 
 staging:
-  <<: *base
\ No newline at end of file
+  <<: *base
diff --git a/doc/administration/gitaly.md b/doc/administration/gitaly.md
new file mode 100644
index 00000000000..b09b5315754
--- /dev/null
+++ b/doc/administration/gitaly.md
@@ -0,0 +1,30 @@
+# Gitaly
+
+> [Introduced][ce-8440] in GitLab 8.16.
+
+
+[Gitaly][gitaly] is a Git RPC service for handling git calls made by GitLab. You
+can configure the path where Gitaly is located in GitLab's configuration. This
+configuration will be shared with all other components that make use of Gitaly.
+If you don't this configuration option, Gitaly features will be disabled.
+
+## Configure GitLab
+
+**For installations from source**
+
+1. Edit `gitlab.yml` and add the Gitaly path:
+
+  ```yaml
+  # Gitaly settings
+  gitaly:
+    socket_path: /home/git/gitaly/gitaly.socket
+  ```
+
+
+**For Omnibus installations**
+
+???
+
+
+[ce-8440]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8440
+[gitaly]: https://gitlab.com/gitlab-org/gitaly/