Browse Source

clean up some config comments

tags/v2.5.0-rc1
Shivaram Lingamneni 3 years ago
parent
commit
b3daf51f0a
2 changed files with 26 additions and 28 deletions
  1. 13
    14
      default.yaml
  2. 13
    14
      traditional.yaml

+ 13
- 14
default.yaml View File

116
 
116
 
117
     websockets:
117
     websockets:
118
         # Restrict the origin of WebSocket connections by matching the "Origin" HTTP
118
         # Restrict the origin of WebSocket connections by matching the "Origin" HTTP
119
-        # header. This settings makes oragono reject every WebSocket connection,
120
-        # except when it originates from one of the hosts in this list. Use this to
121
-        # prevent malicious websites from making their visitors connect to oragono
122
-        # without their knowledge. An empty list means that there are no restrictions.
119
+        # header. This setting causes oragono to reject websocket connections unless
120
+        # they originate from a page on one of the whitelisted websites in this list.
121
+        # This prevents malicious websites from making their visitors connect to your
122
+        # oragono instance without their knowledge. An empty list means there are no
123
+        # restrictions.
123
         allowed-origins:
124
         allowed-origins:
124
             # - "https://oragono.io"
125
             # - "https://oragono.io"
125
             # - "https://*.oragono.io"
126
             # - "https://*.oragono.io"
136
     # already up and running is problematic).
137
     # already up and running is problematic).
137
     casemapping: "precis"
138
     casemapping: "precis"
138
 
139
 
139
-    # enforce-utf8 controls whether the server allows non-UTF8 bytes in messages
140
-    # (as in traditional IRC) or preemptively discards non-UTF8 messages (since
141
-    # they cannot be relayed to websocket clients).
140
+    # enforce-utf8 controls whether the server will preemptively discard non-UTF8
141
+    # messages (since they cannot be relayed to websocket clients), or will allow
142
+    # them and relay them to non-websocket clients (as in traditional IRC).
142
     enforce-utf8: true
143
     enforce-utf8: true
143
 
144
 
144
     # whether to look up user hostnames with reverse DNS. there are 3 possibilities:
145
     # whether to look up user hostnames with reverse DNS. there are 3 possibilities:
185
         available-to-chanops: true
186
         available-to-chanops: true
186
 
187
 
187
     # IPs/CIDRs the PROXY command can be used from
188
     # IPs/CIDRs the PROXY command can be used from
188
-    # this should be restricted to localhost (127.0.0.1/8, ::1/128, and unix sockets),
189
-    # unless you have a good reason. you should also add these addresses to the
189
+    # This should be restricted to localhost (127.0.0.1/8, ::1/128, and unix sockets).
190
+    # Unless you have a good reason. you should also add these addresses to the
190
     # connection limits and throttling exemption lists.
191
     # connection limits and throttling exemption lists.
191
     proxy-allowed-from:
192
     proxy-allowed-from:
192
         - localhost
193
         - localhost
439
         additional-nick-limit: 2
440
         additional-nick-limit: 2
440
 
441
 
441
         # method describes how nickname reservation is handled
442
         # method describes how nickname reservation is handled
442
-        #   strict:   don't let the user change to the registered nickname unless they're
443
-        #             already logged-in using SASL or NickServ
443
+        #   strict:   users must already be logged in to their account (via
444
+        #             SASL, PASS account:password, or /NickServ IDENTIFY)
445
+        #             in order to use their reserved nickname(s)
444
         #   optional: no enforcement by default, but allow users to opt in to
446
         #   optional: no enforcement by default, but allow users to opt in to
445
         #             the enforcement level of their choice
447
         #             the enforcement level of their choice
446
-        #
447
-        # 'optional' matches the behavior of other NickServs, but 'strict' is
448
-        # preferable if all your users can enable SASL.
449
         method: strict
448
         method: strict
450
 
449
 
451
         # allow users to set their own nickname enforcement status, e.g.,
450
         # allow users to set their own nickname enforcement status, e.g.,

+ 13
- 14
traditional.yaml View File

90
 
90
 
91
     websockets:
91
     websockets:
92
         # Restrict the origin of WebSocket connections by matching the "Origin" HTTP
92
         # Restrict the origin of WebSocket connections by matching the "Origin" HTTP
93
-        # header. This settings makes oragono reject every WebSocket connection,
94
-        # except when it originates from one of the hosts in this list. Use this to
95
-        # prevent malicious websites from making their visitors connect to oragono
96
-        # without their knowledge. An empty list means that there are no restrictions.
93
+        # header. This setting causes oragono to reject websocket connections unless
94
+        # they originate from a page on one of the whitelisted websites in this list.
95
+        # This prevents malicious websites from making their visitors connect to your
96
+        # oragono instance without their knowledge. An empty list means there are no
97
+        # restrictions.
97
         allowed-origins:
98
         allowed-origins:
98
             # - "https://oragono.io"
99
             # - "https://oragono.io"
99
             # - "https://*.oragono.io"
100
             # - "https://*.oragono.io"
110
     # already up and running is problematic).
111
     # already up and running is problematic).
111
     casemapping: "precis"
112
     casemapping: "precis"
112
 
113
 
113
-    # enforce-utf8 controls whether the server allows non-UTF8 bytes in messages
114
-    # (as in traditional IRC) or preemptively discards non-UTF8 messages (since
115
-    # they cannot be relayed to websocket clients).
114
+    # enforce-utf8 controls whether the server will preemptively discard non-UTF8
115
+    # messages (since they cannot be relayed to websocket clients), or will allow
116
+    # them and relay them to non-websocket clients (as in traditional IRC).
116
     enforce-utf8: true
117
     enforce-utf8: true
117
 
118
 
118
     # whether to look up user hostnames with reverse DNS.
119
     # whether to look up user hostnames with reverse DNS.
158
         available-to-chanops: true
159
         available-to-chanops: true
159
 
160
 
160
     # IPs/CIDRs the PROXY command can be used from
161
     # IPs/CIDRs the PROXY command can be used from
161
-    # this should be restricted to localhost (127.0.0.1/8, ::1/128, and unix sockets),
162
-    # unless you have a good reason. you should also add these addresses to the
162
+    # This should be restricted to localhost (127.0.0.1/8, ::1/128, and unix sockets).
163
+    # Unless you have a good reason. you should also add these addresses to the
163
     # connection limits and throttling exemption lists.
164
     # connection limits and throttling exemption lists.
164
     proxy-allowed-from:
165
     proxy-allowed-from:
165
         - localhost
166
         - localhost
411
         additional-nick-limit: 2
412
         additional-nick-limit: 2
412
 
413
 
413
         # method describes how nickname reservation is handled
414
         # method describes how nickname reservation is handled
414
-        #   strict:   don't let the user change to the registered nickname unless they're
415
-        #             already logged-in using SASL or NickServ
415
+        #   strict:   users must already be logged in to their account (via
416
+        #             SASL, PASS account:password, or /NickServ IDENTIFY)
417
+        #             in order to use their reserved nickname(s)
416
         #   optional: no enforcement by default, but allow users to opt in to
418
         #   optional: no enforcement by default, but allow users to opt in to
417
         #             the enforcement level of their choice
419
         #             the enforcement level of their choice
418
-        #
419
-        # 'optional' matches the behavior of other NickServs, but 'strict' is
420
-        # preferable if all your users can enable SASL.
421
         method: optional
420
         method: optional
422
 
421
 
423
         # allow users to set their own nickname enforcement status, e.g.,
422
         # allow users to set their own nickname enforcement status, e.g.,

Loading…
Cancel
Save