Support socket paths for praefect

When investigating the integration of praefect in the GDK and Omnibus it
seemed that using sockets is much more convenient. From a configuration
perspective the behaviour of Gitaly is largely copied.

Closes: https://gitlab.com/gitlab-org/gitaly/issues/1523

1 files changed, 32 insertions, 0 deletions

diff --git a/doc/configuration/praefect.md b/doc/configuration/praefect.md
new file mode 100644
index 000000000..83f554662
--- /dev/null
+++ b/doc/configuration/praefect.md
@@ -0,0 +1,32 @@
+# Configuring Praefect
+
+This document describes how to configure the praefect server.
+
+Praefect is configured via a [TOML](https://github.com/toml-lang/toml)
+configuration file. The TOML file contents and location depends on how you 
+installed GitLab. See: https://docs.gitlab.com/ce/administration/gitaly/
+
+The configuration file is passed as an argument to the `praefect`
+executable. This is usually done by either omnibus-gitlab or your init
+script.
+
+```
+gitaly -config /path/to/config.toml
+```
+
+## Format
+
+```toml
+listen_addr = "127.0.0.1:2305"
+socket_path = "/path/to/praefect.socket"
+
+[logging]
+format = "json"
+level = "info"
+
+[[gitaly_server]]
+name = "default"
+listen_addr = "tcp://localhost:9999"
+```
+
+An example [config toml](config.praefect.toml) is stored in this repository.