GitHub
/
ergo
mirror of https://github.com/ergochat/ergo.git
3
0
Fork 0
Code Issues Projects Releases Wiki Activity

clean up some config comments

This commit is contained in:
Shivaram Lingamneni 2020-12-09 02:09:35 -05:00
parent 58edabf5c3
commit b3daf51f0a
2 changed files with 26 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
default.yaml
View File

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

27
traditional.yaml
View File

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