| 1 | = suika-config(5)
|
|---|
| 2 | Simon Ser and contributors / Izuru Yakumo
|
|---|
| 3 | v0.4.3
|
|---|
| 4 |
|
|---|
| 5 | :doctype: manpage
|
|---|
| 6 | :manmanual: Suika IRC Bouncer
|
|---|
| 7 | :mansource: SUIKA-CONFIG
|
|---|
| 8 |
|
|---|
| 9 | == Name
|
|---|
| 10 | suika-config - Configuration file for suika(1)
|
|---|
| 11 |
|
|---|
| 12 | == Description
|
|---|
| 13 | The config file has one directive per line
|
|---|
| 14 |
|
|---|
| 15 | Example:
|
|---|
| 16 |
|
|---|
| 17 | listen ircs://
|
|---|
| 18 | tls cert.pem key.pem
|
|---|
| 19 | hostname example.org
|
|---|
| 20 |
|
|---|
| 21 | The following directives are supported:
|
|---|
| 22 |
|
|---|
| 23 | * listen <uri>
|
|---|
| 24 | Listening URI (default ":6697")
|
|---|
| 25 |
|
|---|
| 26 | The following URIs are supported:
|
|---|
| 27 |
|
|---|
| 28 | * ircs://host:port
|
|---|
| 29 | Listens with TLS over TCP
|
|---|
| 30 | * irc+insecure://host:port
|
|---|
| 31 | Listens with plain-text over TCP
|
|---|
| 32 | * unix:///<path>
|
|---|
| 33 | Listens on a Unix domain socket
|
|---|
| 34 | * unix+admin:///<path>
|
|---|
| 35 | Listens on a Unix domain socket for use with suikactl(1)
|
|---|
| 36 | * wss://host:port
|
|---|
| 37 | Listens for WebSocket connections over TLS
|
|---|
| 38 | * ws+insecure://host:port
|
|---|
| 39 | Listens for plain-text WebSocket connections
|
|---|
| 40 | * ident://host:port
|
|---|
| 41 | Listens for plain-text ident connections
|
|---|
| 42 | * http+prometheus://host:port
|
|---|
| 43 | Listens for plain-text HTTP connections and serves Prometheus metrics (host must be "localhost")
|
|---|
| 44 | * http+pprof://host:port
|
|---|
| 45 | Listens for plain-text HTTP connections and serves pprof runtime profiling data (host must be "localhost")
|
|---|
| 46 | For more information, see: https://pkg.go.dev/net/http/pprof.
|
|---|
| 47 |
|
|---|
| 48 | --
|
|---|
| 49 |
|
|---|
| 50 | * hostname <name>
|
|---|
| 51 | Server hostname
|
|---|
| 52 | * title <title>
|
|---|
| 53 | Server title. This will be sent as the ISUPPORT NETWORK value when clients don't select a specific network.
|
|---|
| 54 | * tls <cert> <key>
|
|---|
| 55 | Enable TLS support. The certificate and key files must be PEM-encoded.
|
|---|
| 56 | * db <driver> <source>
|
|---|
| 57 | Set the database location for user, network and channel storage.
|
|---|
| 58 | By default, a sqlite3 database is opened in ./suika.db.
|
|---|
| 59 |
|
|---|
| 60 | Supported drivers:
|
|---|
| 61 | * sqlite3: expects source to be a path to the SQLite file
|
|---|
| 62 | * postgres: expects source to be a space- separated list of key=value parameters, e.g. db postgres host=/run/postgresql dbname=suika.
|
|---|
| 63 | Note that sslmode defaults to require.
|
|---|
| 64 | For more information on connection strings, see: https://pkg.go.dev/github.com/lib/pq#hdr-Connection_String_Parameters
|
|---|
| 65 |
|
|---|
| 66 | --
|
|---|
| 67 |
|
|---|
| 68 | * log fs <path>
|
|---|
| 69 | Path to the bouncer logs directory, or empty to disable logging.
|
|---|
| 70 | By default, logging is disabled.
|
|---|
| 71 |
|
|---|
| 72 | * http-origin <patterns>
|
|---|
| 73 | List of allowed HTTP origins for WebSocket listeners. The parameters are interpreted as shell patterns, see glob(3)
|
|---|
| 74 | By default, only the request host is authorized. Use this directive to enable cross-origin WebSockets.
|
|---|
| 75 |
|
|---|
| 76 | * accept-proxy-ip <cidr..>
|
|---|
| 77 | Allow the specified IPs to act as a proxy.
|
|---|
| 78 | Proxies have the ability to overwrite the remote and local connection addresses (via the PROXY protocol, the Forwarded HTTP header field defined in RFC 7239 or the X-Forwarded- HTTP header fields).
|
|---|
| 79 | The special name "localhost" accepts the loopback addresses 127.0.0.0/8 and ::1/128.
|
|---|
| 80 | By default, all IPs are rejected.
|
|---|
| 81 |
|
|---|
| 82 | * max-user-networks <limit>
|
|---|
| 83 | Maximum number of networks per user. By default, there is no limit.
|
|---|
| 84 |
|
|---|
| 85 | * motd <path>
|
|---|
| 86 | Path to the MOTD file.
|
|---|
| 87 | The bouncer MOTD is sent to clients which aren't bound to a specific network.
|
|---|
| 88 | By default, no MOTD is sent.
|
|---|
| 89 |
|
|---|
| 90 | * multi-upstream-mode <true|false>
|
|---|
| 91 | Globally enable or disable multi-upstream mode.
|
|---|
| 92 | By default, multi-upstream mode is enabled.
|
|---|
| 93 |
|
|---|
| 94 | * upstream-user-ip <cidr...>
|
|---|
| 95 | Enable per-user IP addresses.
|
|---|
| 96 | One IPv4 range and/or one IPv6 range can be specified in CIDR notation.
|
|---|
| 97 | One IP address per range will be assigned to each user and will be used as the source address when connecting to an upstream network.
|
|---|
| 98 | This can be useful to avoid having the whole bouncer banned from an upstream network because of one malicious user.
|
|---|
| 99 |
|
|---|
| 100 | == See Also
|
|---|
| 101 | suika(1)
|
|---|
| 102 | suikadb(1)
|
|---|
| 103 | suika-znc-import(1)
|
|---|
| 104 | suika-bouncerserv(7)
|
|---|
