Server Settings

Each server should be represented by a list entry in the top-level servers: section.

servers:
  -- first configured server
  * hostname: "example.com"
    nick:     "mynick"

  -- second configured server
  * hostname: "alt.example.com"

setting	type	description
name	text	name of server entry, defaults to hostname
hostname	text	hostname used to connect and to specify the server
port	number	port number, defaults to 6667 without TLS and 6697 with TLS
nick	text or list of text	nicknames to try in order
username	text	server username
realname	text	real name / GECOS
password	text	server password
sasl	sasl configuration	SASL configuration section
tls	yes/no	use TLS to connect (insecure mode disables certificate checks)
tls-verify	yes or no.	verify hostname on server's TLS certificate
tls-client-cert	text	path to TLS client certificate
tls-client-key	text	path to TLS client key
tls-server-cert	text	path to TLS CA certificate to use when validating certificates
connect-cmds	list of text	client commands to send upon connection
socks-host	text	hostname of SOCKS proxy to connect through
socks-port	number	port number of SOCKS proxy to connect through
chanserv-channels	list of text	list of channels with chanserv op permission
flood-penalty	number	cost in seconds per message
flood-threshold	number	threshold in seconds for burst
message-hooks	list of text	names of hooks to enable
reconnect-attempts	int	number of reconnections to attempt on error
autoconnect	yes or no	automatically connect at client startup
log-dir	text	path to directory for chat logs

SASL configuration

Three SASL mechanisms are supported. Use a configuration fragment below.

PLAIN

The PLAIN mechanism sends a plaintext username and password.

sasl:
  username: "yourusername"
  password: "yourpassword"

EXTERNAL

Authenticate using an external authentication mechanism. This is typically a TLS client-side certificate.

sasl: mechanism: external

ECDSA-NIST256P-CHALLENGE

Authenticate using an elliptic-curve challenge response protocol: https://github.com/kaniini/ecdsatool

sasl:
  mechanism: ecdsa-nist256p-challenge
  username: "yourusername"
  private-key: "somekey.pem"