3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-27 21:19:31 +01:00
PyLink/config.yml.example
James Lu 4d76593901 TS6: Initial support for elemental-ircd
The TS6 protocol gets some new options here: use_halfop, use_admin, use_owner, and use_elemental_modes, to deal with features
supported in Elemental but not charybdis. A second server block is added in the example config to document this.
2015-08-03 23:20:19 -07:00

94 lines
3.1 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"
# Autojoin channels
channels: ["#pylink"]
# Sets the protocol module to use - see the protocols/ folder for a list of valid values
# (omitting the .py extension).
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.
# Defaults to 30 if not set.
pingfreq: 30
# Separator character (used by relay)
separator: "/"
# Sets the max nick length for the network. It is important this is set correctly, or
# PyLink might introduce a nick that is too long and cause netsplits!
maxnicklen: 30
ts6net:
ip: 127.0.0.1
port: 7000
recvpass: "abcd"
sendpass: "abcd"
hostname: "pylink.example.com"
sid: "8PY"
# Leave this as an empty list if you don't want to join any channels.
channels: []
protocol: "ts6"
autoconnect: 5
pingfreq: 30
maxnicklen: 30
# /'s in nicks are automatically converted to |'s for TS6 networks, since they
# don't allow "/" in nicks
separator: "|"
# The following options are specific to TS6 servers:
# Toggles owner (+y), admin (+a), and halfop (+h) support for shadowircd/elemental-ircd.
# This defaults to off for the best compatibility.
use_owner: false
use_admin: false
use_halfop: false
# Toggles support of shadowircd/elemental-ircd specific channel modes:
# +T (no notice), +u (hidden ban list), +E (no kicks), +J (blocks kickrejoin),
# +K (no repeat messages), +d (no nick changes), and user modes:
# +B (bot), +C (blocks CTCP), +D (deaf), +V (no invites), +I (hides channel list)
use_elemental_modes: false
# Plugins to load (omit the .py extension)
plugins:
- commands
# - admin
# - relay