[tor-commits] [tor/master] doc: Explain how to limit Tor's sockets in the man page

[nickm at torproject.org]

commit 40d5b573a4b5ba1f06e0d842dde9e2a8e4dab5d0
Author: teor <teor at torproject.org>
Date:   Fri Aug 17 11:20:03 2018 +1000

    doc: Explain how to limit Tor's sockets in the man page
    
    Closes 22747.
---
 doc/tor.1.txt | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 0c010d94f..065fbd0e1 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -303,8 +303,15 @@ GENERAL OPTIONS
     descriptors as the OS will allow (you can find this by "ulimit -H -n").
     If this number is less than ConnLimit, then Tor will refuse to start. +
  +
-    You probably don't need to adjust this. It has no effect on Windows
-    since that platform lacks getrlimit(). (Default: 1000)
+    Tor relays need thousands of sockets, to connect to every other relay.
+    If you are running a private bridge, you can reduce the number of sockets
+    that Tor uses. For example, to limit Tor to 500 sockets, run
+    "ulimit -n 500" in a shell. Then start tor in the same shell, with
+    **ConnLimit 500**. You may also need to set **DisableOOSCheck 0**. +
+ +
+    Unless you have severely limited sockets, you probably don't need to
+    adjust **ConnLimit** itself. It has no effect on Windows, since that
+    platform lacks getrlimit(). (Default: 1000)
 
 [[DisableNetwork]] **DisableNetwork** **0**|**1**::
     When this option is set, we don't listen for or accept any connections