.Dd $Mdocdate$
.Dt SUIKA-CONFIG 5
.Os
.Sh NAME
.Nm suika-config
.Nd Configuration file for the IRC bouncer
.Sh SYNOPSIS
.Bk -words
listen ircs://
.Pp
tls cert.pem key.pem
.Pp
hostname example.org
.Ek
.Sh DESCRIPTION
This document describes the format of the configuration
file used by
.Xr suika 1
.Sh OPTIONS
.Bl -tag -width Ds
.It listen Ar uri
With this you can control on what
ports/protocols
.Xr suika 1
listens on, it supports
irc (cleartext IRC), ircs (IRC with TLS), and unix
(IRC over Unix domain sockets)
.It hostname Ar hostname
Server hostname, if unset, the system one is used.
.It title Ar title
Server title, this will be sent as the ISUPPORT NETWORK value when
clients don't select a specific network.
.It tls Ar cert Ar key
Enable TLS support, the certificate and key files must be
PEM-encoded.
.It db Ar driver Ar path
Set the database driver for user, network and channel storage.
By default a SQLite 3 database is opened in
.Pa ./suika.db
Supported drivers are sqlite and postgres, the former
expects a path to the database file, and the latter
a space-separated list of key=value parameters,
e.g. host=localhost dbname=suika
.It log fs Ar path
Path to the bouncer logs directory, or empty to disable
logging.
By default, logging is disabled.
.It max-user-networks Ar limit
Maximum number of networks per user, by default
there is no limit.
.It motd Ar path
Path to the MOTD file, its contents are sent to clients
which aren't bound to a particular network.
By default, no MOTD is sent.
.It multi-upstream-mode Ar bool
Globally enable or disable multi-upstream mode.
By default, it is enabled.
.It upstream-user-ip Ar cidr
Enable per-user-IP addresses.
One IPv4 and/or one IPv6 range can be specified in CIDR notation.
One IP address per range will be assigned to each user as the
source address when connecting to an upstream network.
This can be useful to avoid having the whole bouncer banned from
an upstream network because of one malicious user.
.El
.Sh AUTHORS
.An Simon Ser Aq Mt contact@emersion.fr
.An The soju Contributors
.Sh MAINTAINERS
.An Izuru Yakumo Aq Mt yakumo.izuru@chaotic.ninja