Add insecure TCP listener to Gitaly

1 files changed, 19 insertions, 3 deletions

diff --git a/doc/configuration/README.md b/doc/configuration/README.md
index f2c6078fc..accb1ea54 100644
--- a/doc/configuration/README.md
+++ b/doc/configuration/README.md
@@ -5,18 +5,34 @@ application.
 
 Gitaly is configured via environment variables that start with
 `GITALY_`. It depends on how you installed GitLab how you should go
-about setting these variables. **LINK TO DOCS SITE**
+about setting these variables. See:
+https://docs.gitlab.com/ce/administration/gitaly/
 
 ## GITALY_SOCKET_PATH
 
-Required.
+Required unless GITALY_LISTEN_ADDR is set.
 
-The path at which Gitaly should open a Unix socket. Example value:
+A path at which Gitaly should open a Unix socket. Example value:
 
 ```
 GITALY_SOCKET_PATH=/home/git/gitlab/tmp/sockets/private/gitaly.socket
 ```
 
+## GITALY_LISTEN_ADDR
+
+Required unless GITALY_SOCKET_PATH is set.
+
+TCP address for Gitaly to listen on. Note: at the moment Gitaly does
+not offer any form of authentication. When you use a TCP listener you
+must use firewalls or other network-based security to restrict access
+to Gitaly.
+
+Example value:
+
+```
+GITALY_LISTEN_ADDR=localhost:1234
+```
+
 ## GITALY_PROMETHEUS_LISTEN_ADDR
 
 Optional.