3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-26 04:32:51 +01:00

example-conf: tweak some more defaults for clarity

(cherry picked from commit 66ec3d9755)

Conflicts:
	example-conf.yml
This commit is contained in:
James Lu 2018-04-07 15:44:44 -07:00
parent c82b12d9d6
commit bbc7a981ba

View File

@ -255,19 +255,21 @@ servers:
# these two fields to "*" and enable SSL with a cert and key file. # these two fields to "*" and enable SSL with a cert and key file.
recvpass: "coffee" recvpass: "coffee"
sendpass: "tea" sendpass: "tea"
#ssl: true #ssl: true
#ssl_certfile: mycert.pem #ssl_certfile: mycert.pem
#ssl_keyfile: mycert.pem #ssl_keyfile: mycert.pem
hostname: "pylink.example.com" hostname: "pylink.example.com"
sid: "2PY" sid: "2PY"
netname: "Network name: this should match your UnrealIRCd config"
sidrange: "8##" sidrange: "8##"
protocol: "unreal" protocol: "unreal"
autoconnect: 10 autoconnect: 10
# You can also define network-specific nicks, idents, and hosts for any service # Sets the full network name, used for display purposes.
# bot using the configuration options "servicename_nick", etc. netname: "Network name"
# You can also define network-specific nicks, idents, and hosts for various service
# bots, using the configuration options "servicename_nick", etc.
#pylink_nick: MagicServ #pylink_nick: MagicServ
#pylink_ident: magicserv #pylink_ident: magicserv
#pylink_host: magicserv.mynet.net #pylink_host: magicserv.mynet.net
@ -299,7 +301,7 @@ servers:
#channels: ["#lounge"] #channels: ["#lounge"]
protocol: p10 protocol: p10
autoconnect: 10 autoconnect: 10
netname: "Change this" netname: "Network name"
# Configures the relay separator. Note: /'s in nicks are automatically translated to | # Configures the relay separator. Note: /'s in nicks are automatically translated to |
# for IRCds other than Unreal and InspIRCd, since they are not supported in nicks. # for IRCds other than Unreal and InspIRCd, since they are not supported in nicks.
@ -365,7 +367,7 @@ servers:
sendpass: "abcd" sendpass: "abcd"
hostname: "pylink.example.com" hostname: "pylink.example.com"
sid: "8PY" sid: "8PY"
netname: "Your Network Name" netname: "Network name"
sidrange: "8##" sidrange: "8##"
protocol: "ts6" protocol: "ts6"
@ -393,7 +395,7 @@ servers:
# Optional server password. # Optional server password.
#sendpass: "wastedbytes103" #sendpass: "wastedbytes103"
netname: "Change this" netname: "Network name"
#channels: ["#this-works-as-usual"] #channels: ["#this-works-as-usual"]
protocol: "clientbot" protocol: "clientbot"
@ -432,7 +434,7 @@ servers:
# SASL PLAIN requires the sasl_username and sasl_password options to be set, while # SASL PLAIN requires the sasl_username and sasl_password options to be set, while
# SASL EXTERNAL requires ssl, ssl_certfile, and ssl_keyfile to work. # SASL EXTERNAL requires ssl, ssl_certfile, and ssl_keyfile to work.
#sasl_mechanism: "PLAIN" #sasl_mechanism: "PLAIN"
#sasl_username: "mIRCsKripterz" #sasl_username: "abc"
#sasl_password: "somestrangepassword" #sasl_password: "somestrangepassword"
# Defines the SASL timeout - this defaults to 15 seconds. # Defines the SASL timeout - this defaults to 15 seconds.
@ -442,6 +444,7 @@ servers:
# connected, as services become available throughout netsplits and reconnects. # connected, as services become available throughout netsplits and reconnects.
# Note: This requires an IRC server capable of IRCv3.2 cap-notify and sasl: # Note: This requires an IRC server capable of IRCv3.2 cap-notify and sasl:
# InspIRCd 3.x and charybdis 4+ are some compatible IRCds as of 2016-12-19. # InspIRCd 3.x and charybdis 4+ are some compatible IRCds as of 2016-12-19.
# This defaults to false.
#sasl_reauth: true #sasl_reauth: true
# Raw IRC messages to send on connect. As of 2.0-alpha2, expansions such as $nick, $ident, # Raw IRC messages to send on connect. As of 2.0-alpha2, expansions such as $nick, $ident,