GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-30 14:49:28 +01:00
Code Issues Projects Releases Wiki Activity

example-conf: rewrap comments for the first server example

Browse Source
This commit is contained in:
James Lu 2019-05-31 18:43:53 -07:00
parent 762b47120d
commit 8d2ae6af50
1 changed files with 24 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
example-conf.yml
View File

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