Browse Source

clarify the semantics of additional-nick-limit

tags/v2.7.0
Shivaram Lingamneni 2 years ago
parent
commit
99a48496fa
2 changed files with 14 additions and 9 deletions
  1. 4
    2
      default.yaml
  2. 10
    7
      traditional.yaml

+ 4
- 2
default.yaml View File

@@ -456,7 +456,9 @@ accounts:
456 456
         enabled: true
457 457
 
458 458
         # how many nicknames, in addition to the account name, can be reserved?
459
-        additional-nick-limit: 2
459
+        # (note that additional nicks are unusable under force-nick-equals-account
460
+        # or if the client is always-on)
461
+        additional-nick-limit: 0
460 462
 
461 463
         # method describes how nickname reservation is handled
462 464
         #   strict:   users must already be logged in to their account (via
@@ -913,7 +915,7 @@ history:
913 915
         # if query-cutoff is set to 'registration-time', this allows retrieval
914 916
         # of messages that are up to 'grace-period' older than the above cutoff.
915 917
         # if you use 'registration-time', this is recommended to allow logged-out
916
-        # users to do session resumption / query history after disconnections.
918
+        # users to query history after disconnections.
917 919
         grace-period: 1h
918 920
 
919 921
     # options to store history messages in a persistent database (currently only MySQL).

+ 10
- 7
traditional.yaml View File

@@ -120,9 +120,10 @@ server:
120 120
     # them and relay them to non-websocket clients (as in traditional IRC).
121 121
     enforce-utf8: true
122 122
 
123
-    # whether to look up user hostnames with reverse DNS.
124
-    # (disabling this will expose user IPs instead of hostnames;
125
-    # to make IP/hostname information private, see the ip-cloaking section)
123
+    # whether to look up user hostnames with reverse DNS. there are 3 possibilities:
124
+    # 1. [enabled here] lookup-hostnames enabled, IP cloaking disabled; users will see each other's hostnames
125
+    # 2. lookup-hostnames disabled, IP cloaking disabled; users will see each other's numeric IPs
126
+    # 3. IP cloaking enabled; users will see cloaked hostnames
126 127
     lookup-hostnames: true
127 128
     # whether to confirm hostname lookups using "forward-confirmed reverse DNS", i.e., for
128 129
     # any hostname returned from reverse DNS, resolve it back to an IP address and reject it
@@ -428,6 +429,8 @@ accounts:
428 429
         enabled: true
429 430
 
430 431
         # how many nicknames, in addition to the account name, can be reserved?
432
+        # (note that additional nicks are unusable under force-nick-equals-account
433
+        # or if the client is always-on)
431 434
         additional-nick-limit: 2
432 435
 
433 436
         # method describes how nickname reservation is handled
@@ -671,7 +674,6 @@ logging:
671 674
         #   server          server startup, rehash, and shutdown events
672 675
         #   accounts        account registration and authentication
673 676
         #   channels        channel creation and operations
674
-        #   commands        command calling and operations
675 677
         #   opers           oper actions, authentication, etc
676 678
         #   services        actions related to NickServ, ChanServ, etc.
677 679
         #   internal        unexpected runtime behavior, including potential bugs
@@ -883,9 +885,10 @@ history:
883 885
         # joined the channel, so only always-on clients can view history).
884 886
         query-cutoff: 'none'
885 887
 
886
-        # but if this is set, you can retrieve messages that are up to `grace-period`
887
-        # older than the above cutoff time. this is recommended to allow logged-out
888
-        # users to do session resumption / query history after disconnections.
888
+        # if query-cutoff is set to 'registration-time', this allows retrieval
889
+        # of messages that are up to 'grace-period' older than the above cutoff.
890
+        # if you use 'registration-time', this is recommended to allow logged-out
891
+        # users to query history after disconnections.
889 892
         grace-period: 1h
890 893
 
891 894
     # options to store history messages in a persistent database (currently only MySQL).

Loading…
Cancel
Save