summaryrefslogtreecommitdiff
path: root/docs/conf/inspircd.conf.example
diff options
context:
space:
mode:
Diffstat (limited to 'docs/conf/inspircd.conf.example')
-rw-r--r--docs/conf/inspircd.conf.example29
1 files changed, 24 insertions, 5 deletions
diff --git a/docs/conf/inspircd.conf.example b/docs/conf/inspircd.conf.example
index 9baaa5261..f421eb0e8 100644
--- a/docs/conf/inspircd.conf.example
+++ b/docs/conf/inspircd.conf.example
@@ -135,6 +135,7 @@
# information on how to load this module! If you do not load this #
# module, server ports will NOT work! #
+# Listener that binds on a TCP/IP endpoint:
<bind
# address: IP address to bind to if the box that you are hosting
# on has more than one IP, else the ircd will try to bind to all
@@ -175,8 +176,29 @@
# whether the interface that provides the bind address is available. This
# is useful for if you are starting InspIRCd on boot when the server may
# not have brought the network interfaces up yet.
- free="no"
->
+ free="no">
+
+# Listener that binds on a UNIX endpoint (not supported on Windows):
+#<bind
+
+ # path: The location to store the UNIX socket
+ #path="/tmp/inspircd.sock"
+
+ # type: Type of bind block this is. It can either be clients or
+ # servers. Whichever you select will be the only type able to connect
+ # to this bind section.
+ #type="clients"
+
+ # permissions: The octal permissions to set on the UNIX socket after it has
+ # been created. If you are not familiar with octal permissions you should
+ # not define this or refer to http://permissions-calculator.org for help.
+ #permissions=""
+
+ # replace: if the UNIX socket path already exists then remove it before
+ # attempting to create the new one. This is strongly recommended as it
+ # allows InspIRCd to create sockets in cases where it previously did not
+ # shut down cleanly and left a zombie socket behind.
+ #replace="yes">
<bind address="" port="6660-6669" type="clients">
@@ -185,9 +207,6 @@
# module).
#<bind address="" port="7002" type="clients" hook="websocket">
-# EXPERIMENTAL: Listener that binds on a UNIX endpoint instead of a TCP/IP endpoint:
-#<bind path="/tmp/inspircd.sock" type="clients">
-
# You can define a custom <sslprofile> tag which defines the SSL configuration
# for this listener. See the docs page for the SSL module you are using for
# more details.