txircd.yaml-example

# txircd default/example configuration
# Copy or rename this file to 'txircd.yaml' before you start!
# All of the config values are commented out by default and will be given
# default values in the application.  Remember to uncomment lines when changing
# the values.  When the comments reference a default value, the default value is
# the value that option will have if you don't uncomment it (although it is
# typically also the value shown when commented)!
# 
# This configuration file is organized into sections based on what each section
# overall is related to.

# SERVER INFO
# This section relates to information on the server, along with some of how it
# runs.

# Server Name: The server name must appear to be a domain name, but it does not
# have to resolve (e.g. it can be a domain name you haven't purchased or a
# subdomain you haven't set up yet if you want).
# If not given (left commented), it is set to the server's fully-qualified
# domain name as determined by the server, which will work but is probably not
# what you want.
#server_name: irc.example.com

# Server Description: A description of the server; can be any text of reasonable
# length.
#server_description: A txircd server

# Network Name: The network name must be a single word (i.e. no spaces) which
# serves as the name of the network.  The default value is 'txircd'.
#server_network_name: txircd

# Password: This is the password to get into your server.  Defaults to no
# password.  If specified, clients will be required to give this password
# during registration in order to connect.
#server_password: null

# Ports: The IRCd will listen to one or more ports of each type in order to
# accept connections.  Each is a list of descriptions of each port on which to
# listen.  Ports specified under server_client_ports will be available for
# clients to connect, and ports under server_link_ports will be available for
# the other servers of your network to link.
# Each port is specified with
# [connection type]:[port number]:[optional parameters]
# where the connection type is "tcp" for plaintext connections or "ssl" for
# secure (SSL) connections.  Without optional parameters, the server will bind
# all available IPv4 addresses on the given port.  You can bind all IPv4 and
# IPv6 addresses by specifying all IPv6 addresses under interface (i.e.
# interface={::}). Due to the colon already being the separator, you must wrap
# the address in braces ('{address}') or escape each individual colon with a
# backslash.  If you don't want to bind all available addresses, you may
# specify individual IP addresses to bind in the interface.  For example, you
# may specify tcp:6667:interface=127.0.0.1 to bind only to IPv4 loopback on port
# 6667.
# 
# For SSL connections, the optional parameters may include certKey, privateKey,
# and extraCertChain, which respectively have the file names of the certificate,
# the private key, and a certificate chain file..  If the private key is not
# given, it is assumed to be server.pem.  If the certificate is not given, it is
# assumed to be in the same file as the private key.  If the extra cert file is
# not given, it is not checked.
# 
# You may make a port into a websocket port by prefixing the whole string
# with "sockjs:" and wrapping the rest in braces.
#
# The server BINDS NO PORTS BY DEFAULT, so make sure you specify some of these
# if you want to connect!
#
#server_client_ports:
#- 'tcp:6667:interface={::}'
#- 'ssl:6697:interface={::}:privateKey=test.key:certKey=test.pem'
#- 'sockjs:{ssl:8080:interface={::}}'
#
#server_link_ports:
#- 'tcp:7000:interface={::}'
#- 'ssl:7001:interface={::}:privateKey=test.key:certKey=test.pem'

# serverlinks: This is where you specify data for servers that can link to this
# one.  Servers not specified here will be denied linking.  The default value is
# none; the value listed here is to illustrate the values used for linking
# servers.
# ip, incoming_password, and outgoing_password are all required values in
# order for a server to link successfully.  The IP address of the incoming
# and outgoing connections are checked to help verify that it's not some other
# machine than the one expected.  The passwords further verify the incoming
# connection.
# connect is required only for servers to which this server will be connecting
# (rather than the other server connecting to this one).  The format of this
# line should be as follows:
# [connection type]:[address]:[port]:[optional parameters]
# As with the port descriptions above, IPv6 addresses must be wrapped in braces.
# The optional parameters include the following:
# - bindAddress, which is the address of the local IP address to which to bind
#   the connection (if your machine has more than one).
#serverlinks:
#  servername.example.com:
#    ip: 12.34.56.78
#    connect: 'ssl:12.34.56.78:7001:bindAddress=98.76.54.32'
#    incoming_password: lolol
#    outgoing_password: whateven

# serverlink_autoconnect: This is a list of server names specified above to
# automatically connect to.
#serverlink_autoconnect: []

# MOTD
# 1. Maximum line length.  The default of 80 characters is recommended.
#server_motd_line_length: 80
# 2. Message of the day.
# This value is the MOTD sent to clients.  Lines will be wrapped at
# server_motd_line_length characters.  Just put the entirety of your MOTD as
# this value.
#server_motd: Welcome to txircd!

# STATS options
# The /stats command can contain data which is sensitive and therefore
# restricted to opers.  However, not all /stats data is so confidential, and
# some of it may even be more helpful to share with everyone.  This value is a
# string containing all of the stats characters that should not be restricted to
# just opered users.  The default value is 'ou'.
#server_stats_public: ou


# APP OPTIONS
# This section relates to some application details.

# Verbose: Determines whether the application will give lots of verbose output
# or not.  The default value is false.  You can override a false value on
# startup by passing the -v flag as an argument to the program.
#app_verbose: false

# Log dir: Where the server should write logs.  Defaults to 'logs' (the logs
# subdirectory of the program's working directory).
#app_log_dir: logs

# SSL Certificate: The key and PEM (cert) files containing the SSL certificate
# to use with connections.
#app_ssl_key: test.key
#app_ssl_pem: test.pem

# IRC spec: Which level of IRC spec to conform to.  This determines what is the
# base set of modules to load.  Valid values are 'rfc1459' and 'ircv3'.  The
# default value is rfc1459.
# The rfc1459 level will provide by default all of the basic features required
# by the RFC.  The ircv3 level provides all the required RFC features along with
# additional features that make it fully IRCv3.1 (base and optional extensions)
# and partially IRCv3.2 compliant.
#app_irc_spec: rfc1459


# ADMIN OPTIONS
# This section contains information about the server administrators.
# 
# admin_info_*: These three options are used as the output for the ADMIN
# command.
#admin_info_server: Host Corp: 123 Example Street, Seattle, WA, USA
#admin_info_organization: Umbrella Corp: 123 Example Street, Seattle, WA, USA
#admin_info_person: Lazy Admin <admin@example.com>


# CHANNEL OPTIONS
# This section contains options that control channel behavior.
# 
# Channel ban list size: The maximum number of bans that can be set in a
# channel.  The default value is 60.
#channel_ban_list_size: 60

# Default channel modes: The default mode set for a channel.  This is a
# dictionary of modes -> parameters.  If a mode does not take a parameter, set
# its parameter as null.  The default modes are +nt.
#channel_default_mode:
#  n: null
#  t: null

# Default channel status: The status a user receives upon creating a channel.
# The default value is 'o'.
#channel_default_status: o

# Exempt chanops: A string containing channel modes whose effects should not
# apply to channel operators.  The default value is none.  Possible modes depend
# on the set of modules loaded (see below).
#channel_exempt_chanops: ''

# Minimum level: The minimum level one must have to use certain commands on a
# channel.  The default level is 'o' for everything.  You may add more commands
# to this list provided in additional modules that you load (below).
#channel_minimum_level:
#  KICK: o
#  INVITE: o
#  METADATA: o
#  MODE: o
#  TOPIC: o

# Minimum status set: The minimum status one must have in order to set or unset
# a given prefix on a channel.  Defaults to the same level as the status.
# Note that despite the presence of all modes, some levels may not be able to
# change based on restrictions on channel commands in channel_minimum_level (see
# above).  If you don't want someone at a mode level to be able to give or take
# that level from others (e.g. halfops giving/removing halfops), set the value
# to something higher than the level in the key.
# The q, a, and h levels in this example will have no effect without the
# chanowner, chanadmin, and halfop modules loaded (see module configuration
# below) and are here as an example and/or to remind you to set them.
#channel_status_minimum_change:
#  q: q
#  a: a
#  o: o
#  h: h
#  v: v


# CLIENT OPTIONS
# This section contains options that affect management of clients.
# 
# Ban msg: This is the message sent to users when they are disconnected for
# being banned from the server.  It is accompanied by the ban reason.
#client_ban_msg: You're banned! Email abuse@xyz.com for help.

# Max data: This is the maximum number of bytes we can receive from a client in
# a five-second period before the client is disconnected for flooding.  The
# default value is 5000.
#client_max_data: 5000

# Peer connections: The maximum number of clients that can connect from a single
# IP address.  The default value is 3.  Set to 0 for unlimited.
#client_peer_connections: 3

# Peer exemptions: The maximum number of clients that can connect from a given
# IP address.  This is a dictionary mapping IP addresses to their maximum
# values.  Set a value to 0 for unlimited.  The default value is localhost
# (127.0.0.1) having unlimited connections.
#client_peer_exempt:
#  127.0.0.1: 0

# Ping interval: How often to send a PING message to a client in seconds.  The
# default value is 60.
#client_ping_interval: 60

# Ping timeout delay: How long to wait after last activity before disconnecting
# a client if the client doesn't respond to pings.  The default value is 120.
#client_timeout_delay: 120

# VHosts: Virtual hosts to set on clients instead of the normal cloaked hosts.
# This is a dictionary of IP addresses to the cloaked host.  The default value
# sets 127.0.0.1 to localhost.
#client_vhosts:
#  127.0.0.1: localhost

# WHOWAS expiry: Amount of time after disconnection that the related WHOWAS
# entry should expire.  Accept durations in 1y2w3d4h5m6s format or in a raw
# number of seconds.  The default value is '1d'.
#client_whowas_expire: 1d

# WHOWAS limit: The maximum number of WHOWAS entries to keep for one nickname.
# The default value is 10.
#client_whowas_limit: 10


# OPER OPTIONS
# This section contains options controlling oper-up info and who can do so.
# 
# Oper IPs: Only IP addresses listed here can oper up.  If this list is empty,
# opers can oper from any IP address (this is highly discouraged).  It is
# recommended that you put the IP addresses of your opers here and keep them
# updated.  The default value is just 127.0.0.1.
#oper_ips:
#- 127.0.0.1

# Oper logins: This is a dictionary mapping oper usernames to oper passwords.
# You'll use the username on the left and the hash value on the right to oper
# up.  The password is a hashed password.  A utility is provided to generate
# these for you; from the txircd base directory, run the following:
# python passcrypt.py password
# where 'python' is the appropriate command to run the python interpreter on
# your server, and 'password' is the password you're trying to hash.  The
# program will output a hash suitable for use in this configuration as the
# oper password.
# The default value is NO LOGINS, so make sure you specify some.
# The value shown below (username: admin, password: password) is incredibly
# insecure and should not be used.
#oper_logins:
#  admin: sha256:1000:abc:e/+7RSuHvTHideDuZkpvFXtq65+oHM9x


# MODULE CONFIGURATION
# 
# Modules: In addition to those loaded by the IRC spec, you can specify
# additional modules to enable additional features.  Any uncommented
# module below will be loaded.
#server_modules: # Uncomment this line if you enable any modules below
# 
# All modules in this list prefixed with 'ircv3_' are modules that are loaded
# automatically when app_irc_spec is set to ircv3, and you should not need to
# load them again here when they are already specified by the IRC spec.  They
# are listed here to allow selective addition of features to the rfc1459 spec.
# 
# IRCv3.1 Base Extensions
# ircv3_cap: Enables the IRCv3 client capability negotiation mechanism.  This
# module is required for most of the other IRCv3 features to function, as these
# features need to be enabled for each client that supports it to prevent
# breaking older clients, and this enabling is done through the CAP command
# provided by this module.
#- ircv3_cap
# 
# ircv3_multi-prefix: Enables the multi-prefix extension on the server, which
# allows clients to receive all of a channel member's status ranks in the NAMES
# or WHO reply rather than just the first one.  This capability is formerly
# known as NAMESX and may still be referred to as such in other IRC software.
#- ircv3_multi-prefix
# 
# ircv3_sasl: Enables the SASL mechanism of identifying to an account during
# connection registration.  This is now supported by most IRC services.
#- ircv3_sasl
# 
# IRCv3.1 Optional Extensions
# ircv3_account-notify: Enables the account-notify feature, which notifies users
# when other channel members have identified to or logged out of an account.
#- ircv3_account-notify
# 
# ircv3_away-notify: Enables the away-notify feature, which notifies users when
# other channel members have changed their away status.
#- ircv3_away-notify
# 
# ircv3_extended-join: Enables the extended-join feature, which adds information
# to the JOIN message when a user joins a channel, giving extended-join enabled
# clients information on the joining user's account name and gecos.
#- ircv3_extended-join
# 
# ircv3_tls: Enables the STARTTLS feature, which allows clients to negotiate a
# TLS connection during IRC connection registration on a plaintext port.
#- ircv3_tls
# 
# IRCv3.2 Base Extensions (some of them)
# ircv3_monitor: Enables the monitor feature, which allows clients to be
# notified when certain users connect to or disconnect from the network.
# This also ties into some 3.1 extensions to make subscribed users also
# receive some of those notifications.
#- ircv3_monitor
# 
# ircv3_metadata: Enables users to edit certain metadata pertaining to user or
# client info, and adds a feature allowing clients to be notified of changes to
# same.
#- ircv3_metadata
# END IRCv3
# 
# userhost-in-names: Enables the userhost-in-names feature, which displays the
# ident and host of users in NAMES output.  This is formerly known as UHNAMES
# and may still be referred to as such in other IRC software.  This requires
# ircv3_cap (either manually specified or from setting app_irc_spec to 'ircv3')
# to function.
#- userhost-in-names
# 
# whox: Enables part of the WHOX feature implemented in ircu and other IRCds,
# which extends the WHO syntax to control which fields are shown.
#- whox
# 
# die: Enables the /die command, which allows opers to shut down the server from
# IRC.
#- die
# 
# restart: Enables the /restart command, which allows opers to restart the
# server from IRC.
#- restart
# 
# globops: Enables the /globops command, which sends a notice to all online
# opers.
#- globops
# 
# modules: Enables the /modules command, which lists all modules loaded on the
# server.
#- modules
# 
# knock: Enables the /knock command, which serves as a mechanism for users to
# request an invite to a channel.
#- knock
#
# blockcolor: Enables the +c channel mode, which blocks messages with color from
# being sent to the channel.
#- blockcolor
# 
# stripcolor: Enables the +S channel mode, which strips color codes from
# messages sent to the channel.
#- stripcolor
# 
# blockctcp: Enables the +C channel mode, which blocks CTCP requests and replies
# sent to the channel.
#- blockctcp
# 
# chanadmin: Enables the channel admin (+a) rank.
#- chanadmin
# 
# chanowner: Enables the channel founder (+q) rank.
#- chanowner
# 
# halfop: Enables the chanel halfop (+h) rank.
#- halfop
# 
# sajoin: Enables the /sajoin command, which enables opers to join other users
# to channels.
#- sajoin
# 
# sakick: Enables the /sakick command, which enables opers to kick users from
# any channel.
#- sakick
# 
# samode: Enables the /samode command, which enables opers to set modes on any
# user or channel.
#- samode
# 
# sanick: Enables the /sanick command, which enables opers to change the nick of
# any user.
#- sanick
# 
# satopic: Enables the /satopic command, which enables opers to set the topic of
# any channel.
#- satopic
# 
# servnoticeconnect: Enables sending server notices to opers when users connect.
# Activated through the "connect" notice type under the server notice mode
# (+s connect).
#- servnoticeconnect
# 
# servnoticequit: Enables sending server notices to opers when users quit.
# Activated through the "quit" notice type under the server notice mode
# (+s quit).
#- servnoticequit
# 
# shun: Enables the shun feature, which ignores all but a few certain commands
# from users matching the provided mask.  Setting and removing shuns works
# similarly to g:lines.
#- shun
# 
# badword: Enables the global censoring of certain words or phrases by the
# /badword command.
#- badword
#
# denychans: Prevents certain channels from being created.  You can configure
# which channels are denied or allowed below.
#- denychans
# 
# dccblock: Blocks DCC requests sent between clients.
#- dccblock
#
# conn_join: Forces clients to join one or more channels on connect.
#- conn_join
#
# cloaking: Implements user mode +x, which allows users to apply a hostname
# cloak.
#- cloaking
#
# channellog: Logs all messages sent to all channels to the log directory
# (app_log_dir).
#- channellog
# 
# db_services: Implements the Desert Bus services suite.
# This module requires PyCrypto to be installed (pip install pycrypto).
#- db_services
#
# db_services_leaf: Serves as a leaf to the Desert Bus services suite.
# Desert Bus services is designed to run on one server of the network;
# db_services_leaf should be loaded on all others.  This module implements
# command aliases for services and implements the command blocking functionality
# for users not on the main services server.
# Of the db_services config below, this module only requires
# services_nickserv_nick, services_chanserv_nick, services_bidserv_nick, and
# services_operserv_nick.
# The four values MUST be set to the same as the services nicks for the server
# with db_services loaded (or identical across the network).
#- db_services_leaf


# shun config
# command_list: A list of all the commands allowed to shunned users.  This list
# does not apply to registration (i.e. you can leave out NICK and the client
# will still be able to complete registration).
# The default value is JOIN, PART, QUIT, PING, PONG.
#shun_command_list:
#- JOIN
#- PART
#- QUIT
#- PING
#- PONG


# ircv3_sasl config
# sasl_agent: The SASL agent for this network.  The SASL agent specified must be
# another server connected to the network which operates as a SASL agent (either
# through some module or a different software altogether connected to the
# network).  If left as an empty string, uses an internal agent provided by
# another module (e.g. db_services).  The default value is ''.
#server_sasl_agent: ''


# denychans config
# denychans: Allows you to choose which channels cannot be joined by normal
# users.  Opers will still be able to join these channels.  This is a list of
# channels; the * and ? wildcards may be used.
#channel_denychans:
#- '*'

# allowchans: This serves as a whitelist; channels in this list will be
# available even if they match a channel in denychans.  This list of channels
# also supports the * and ? wildcards.
#channel_allowchans:
#- '#desertbus'
#- '#help'


# conn_join config
# join_on_connect: A list of channels all users will join automatically upon
# connection to the server.
#client_join_on_connect:
#- '#desertbus'


# monitor config
# monitor_limit: The maximum number of entries one client can have in their
# monitor list.  Set to null for unlimited.  The default value is null.
#client_monitor_limit: null


# db_services config
# servdb options: Information for the database connection.  If any of these are
# not given (except servdb_marker), db_services will not connect to the
# database.
# servdb_library: The python library to use for MySQL functions.  pymysql is
# installed as part of txircd setup and works fine, so you shouldn't need to
# change this (just uncomment it) unless you have a preferred library installed.
#servdb_library: pymysql

# servdb_host: The host of the MySQL server.
#servdb_host: localhost

# servdb_port: The port the MySQL server is listening on.
#servdb_port: 3306

# servdb_username: The username of txircd's database user.
#servdb_username: txircd

# servdb_password: The password of txircd's database user.
#servdb_password: txircd

# servdb_database: The name of txircd's database.
#servdb_database: txircd

# servdb_marker: The marker used by the given MySQL library to place parameters
# in prepared statements.  This shouldn't be changed unless you changed the
# servdb_library value.  The default value is '%s'.
#servdb_marker: '%s'

# BidServ client: BidServ needs a nick, ident, host, and gecos.
#services_bidserv_nick: BidServ
#services_bidserv_ident: BidServ
#services_bidserv_host: services.desertbus.org
#services_bidserv_gecos: Bidding Service

# NickServ client: NickServ needs a nick, ident, host, and gecos.
#services_nickserv_nick: NickServ
#services_nickserv_ident: NickServ
#services_nickserv_host: services.desertbus.org
#services_nickserv_gecos: Nickname Service

# ChanServ client: ChanServ needs a nick, ident, host, and gecos.
#services_chanserv_nick: ChanServ
#services_chanserv_ident: ChanServ
#services_chanserv_host: services.desertbus.org
#services_chanserv_gecos: Channel Service

# OperServ client: OperServ needs a nick, ident, host, and gecos.
#services_operserv_nick: OperServ
#services_operserv_ident: OperServ
#services_operserv_host: services.desertbus.org
#services_operserv_gecos: Operator Service

# BidServ configuration
# increment: The minimum increment between bids.  If not given, bids can be any
# amount over the previous high bid.
#services_bidserv_increment: 5.0

# limit: The maximum amount allowed to be bid.  If not given, a maximum limit on
# bids is not enforced.
#services_bidserv_limit: 1000000.0

# Madness levels: The madness levels to display when they are passed in bid
# amount.
#services_bidserv_madness_levels:
#  300: MADNESS
#  600: DOUBLE MADNESS
#  900: TRIPLE MADNESS
#  1000: Myth Busted
#  1200: QUADRUPLE MADNESS
#  1500: QUINTUPLE MADNESS
#  1800: SEXTUPLE MADNESS
#  2100: SEPTUPLE MADNESS
#  2400: OCTUPLE MADNESS
#  2700: NONUPLE MADNESS
#  3000: DECUPLE MADNESS
#  3300: UNDECUPLE MADNESS
#  3600: WHARRGARBL MADNESS
#  3900: TREDECUPLE MADNESS
#  4200: QUATTUORDECUPLE MADNESS
#  4500: QUINDECUPLE MADNESS
#  4800: SEXDECUPLE MADNESS
#  5100: SEPTENDECUPLE MADNESS
#  5400: OCTODECUPLE MADNESS
#  5700: NOVEMDECUPLE MADNESS
#  6000: VIGUPLE MADNESS

# Show all madness: Whether to show all madness levels passed by a bid (true) or
# just the highest one (false).  The default value is false.
#services_bidserv_madness_show_all: false

# Space Bid: The text to show when the current highest bidder in an auction bids
# a higher amount.
#services_bidserv_space_bid: SPACE BID

# NickServ configuration
# guest prefix: The prefix of nicks given to users who try to use nicks that
# belong to accounts to which they are not identified if they don't change away
# in time.  The default value is 'Guest'.
#services_nickserv_guest_prefix: Guest

# Nick limit: The maximum number of nicknames that can be registered to an
# account.  Use 0 for unlimited.  The default value is unlimited.
#services_nickserv_nick_limit: 5

# Timeout: The amount of time in seconds until NickServ changes a user's nick
# when the user is not identfied to the account that nick belongs to.  The
# default value is 60.
#services_nickserv_timeout: 60