some documentation for UNIX sockets

moccu · Nov 8, 2014 · 5050563 · 5050563
1 parent 67f96e5
commit 5050563
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/docs/source/server/configuration.rst b/docs/source/server/configuration.rst
@@ -15,12 +15,14 @@ and tries to upgrade to websockets if possible.
 -----------------------
 
 Used to decide on which address the ``omnibusd`` server binds.
-Defaults to all addresses.
+Defaults to all addresses. If ``OMNIBUS_SERVER_PORT`` is set to ``None``
+then acts as a UNIX socket path.
 
 ``OMNIBUS_SERVER_PORT``
 -----------------------
 
 Sets the port on which the ``omnibusd`` listens. Defaults to ``4242``.
+Set ``None`` for UNIX socket.
 
 ``OMNIBUS_SERVER_BASE_URL``
 ---------------------------

diff --git a/docs/source/server/installation.rst b/docs/source/server/installation.rst
@@ -36,6 +36,10 @@ This enables `django-omnibus` with normal websocket support.
     ``OMNIBUS_AUTH_TOKEN`` to the template context. You can use these variables
     to configure the JS library.
 
+.. hint::
+
+    If you're using UNIX sockets then ``OMNIBUS_ENDPOINT`` variable is useless.
+
 Using SockJS
 ------------