3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-30 23:09:23 +01:00
PyLink/config.yml.example
James Lu f5f031e41b config.yml.example: add header and note about comments
Apparently this isn't obvious enough for some. Figures. :|
2015-07-22 11:46:38 -07:00

59 lines
2.0 KiB
Plaintext

# This is a sample configuration file for PyLink. You'll likely want to rename it to config.yml
# and begin your configuration there.
# Note: lines starting with a "#" are comments and will be ignored.
bot:
# Sets nick, user/ident, and real name.
nick: pylink
user: pylink
realname: PyLink Service Client
# Console log verbosity: see https://docs.python.org/3/library/logging.html#logging-levels
loglevel: DEBUG
login:
# PyLink administrative login - Change this, or the service will not start!
user: admin
password: changeme
servers:
yournet:
# Server IP, port, and passwords
ip: 127.0.0.1
port: 7000
recvpass: "abcd"
sendpass: "abcd"
# Hostname we will use to connect to the remote server
hostname: "pylink.yournet"
# SID - required for InspIRCd and TS6 based servers. This must be three characters long.
# The first char must be a digit [0-9], and the remaining two chars may be letters [A-Z] or digits.
sid: "0AL"
# SID range - the range of SIDs PyLink is allowed to use to generate server IDs. 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. You will want to make sure no other servers
# are using this range. There must be at least one # in the entry.
sidrange: "8##"
# Autojoin channels
channels: ["#pylink"]
protocol: "inspircd"
# Sets autoconnect delay - comment this out or set the value negative to disable autoconnect entirely.
autoconnect: 5
# Sets ping frequency (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.
pingfreq: 30
# Separator character (used by relay)
separator: "/"
# Plugins to load (omit the .py extension)
plugins:
- commands
# - admin
# - relay