From 8d2ae6af5036eeee38bba4c859ad5fb933f1f6db Mon Sep 17 00:00:00 2001 From: James Lu Date: Fri, 31 May 2019 18:43:53 -0700 Subject: [PATCH] example-conf: rewrap comments for the first server example --- example-conf.yml | 50 +++++++++++++++++++++++------------------------- 1 file changed, 24 insertions(+), 26 deletions(-) diff --git a/example-conf.yml b/example-conf.yml index a0ede9c..507f9c7 100644 --- a/example-conf.yml +++ b/example-conf.yml @@ -169,30 +169,29 @@ servers: # Hostname we will use to connect to the remote server hostname: "pylink.yournet.local" - # Sets the server ID (SID) that the main PyLink server should use. - # For TS6-like servers (InspIRCd, Charybdis, UnrealIRCd, etc.), this - # must be three characters: the first char must be a digit [0-9], and - # the remaining two may be either uppercase letters [A-Z] or digits. + # Sets the server ID (SID) that the main PyLink server should use. For TS6-like servers + # (InspIRCd, Charybdis, UnrealIRCd, etc.), this must be three characters: + # the first char must be a digit [0-9], and the remaining two may be either uppercase + # letters [A-Z] or digits. sid: "0PY" - # Server ID range: this specifies the range of server IDs that PyLink - # may use for subservers such as relay. On TS6, this should be a - # combination of digits, letters, and #'s. Each # denotes a range (0-9A-Z) - # of characters that can be used by PyLink to generate appropriate SIDs. + # Server ID range: this specifies the range of server IDs that PyLink# may use for + # subservers such as Relay. On TS6, this should be a combination of digits, letters, and #'s. + # Each # denotes a range (0-9A-Z) of characters that can be used by PyLink to generate SIDs. # You will want to make sure no other servers are using this range. # There must be at least one # in this entry. sidrange: "8##" - # Sets the protocol module to use for this network - see the README for a - # list of supported IRCds. + # Sets the protocol module to use for this network - see the README for a list of supported + # IRCds. protocol: "inspircd" - # Sets the max nick length for the network. It is important that this is - # set correctly, or PyLink might introduce a nick that is too long and - # cause netsplits! This defaults to 30 if not set. + # Sets the max nick length for the network. It is important that this is set correctly, or + # PyLink might introduce a nick that is too long and cause netsplits! + # This defaults to 30 if not set. maxnicklen: 30 - # Toggles SSL for this network - you should seriously consider using TLS in all your links + # Toggles SSL for this network - you should seriously consider using TLS in all server links # for optimal security. Defaults to False if not specified. ssl: true @@ -218,14 +217,13 @@ servers: #ssl_fingerprint: "e0fee1adf795c84eec4735f039503eb18d9c35cc" # This sets the hash type for the fingerprint (md5, sha1, sha256, etc.) - # Valid values include md5 and sha1-sha512, though others may be - # supported depending on your system: see - # https://docs.python.org/3/library/hashlib.html - # This setting defaults to sha256. + # Valid values include md5 and sha1-sha512, though others may be supported depending on + # your system: see https://docs.python.org/3/library/hashlib.html + # This defaults to sha256 if not set. #ssl_fingerprint_type: sha256 - # Sets autoconnect delay - comment this out or set the value below 1 to - # disable autoconnect entirely. + # Sets autoconnect delay - comment this out or set the value below 1 to disable autoconnect + # entirely. autoconnect: 10 # Optional autoconnect settings: @@ -252,18 +250,18 @@ servers: # This setting is EXPERIMENTAL as of PyLink 1.2.x. #encoding: utf-8 - # Sets the ping frequency in seconds (i.e. how long we should wait between - # sending pings to our uplink). When more than two consecutive pings are missed, - # PyLink will disconnect with a ping timeout. This defaults to 90 if not set. + # Sets the ping frequency in seconds (i.e. how long we should wait between sending pings to + # our uplink). When more than two consecutive pings are missed, PyLink will disconnect with + # a ping timeout. This defaults to 90 if not set. #pingfreq: 90 # If relay nick tagging is disabled, this option specifies a list of nick globs to always # tag when introducing remote users *onto* this network. #relay_forcetag_nicks: ["someuser", "Guest*"] - # Sets the suffix that relay subservers on this network should use. - # If not specified per network, this falls back to the value at - # relay::server_suffix, or "relay" if that is also not set. + # Sets the suffix that relay subservers on this network should use. If not specified per + # network, this falls back to the value at relay::server_suffix, or the string "relay" if + # that is also not set. #relay_server_suffix: "relay.yournet.net" # Determines whether relay will tag nicks on this network. This overrides the relay::tag_nicks