Documentation Index
Fetch the complete documentation index at: https://docs.flumeirc.io/llms.txt
Use this file to discover all available pages before exploring further.
irc.toml
Networks are defined in~/.config/flume/irc.toml:
Fields
| Field | Default | Description |
|---|---|---|
name | required | Display name for the network |
address | required | Server hostname |
port | 6697 | Port number |
tls | true | Use TLS encryption |
tls_accept_invalid_certs | false | Accept self-signed/invalid TLS certificates |
password | "" | Server password (IRC PASS command, use ${secret} for vault) |
username | from general | IRC username (appears in hostmask) |
auth_method | "none" | "none", "sasl", or "nickserv" |
sasl_mechanism | "PLAIN" | "PLAIN", "SCRAM-SHA-256", or "EXTERNAL" |
sasl_username | "" | SASL username |
sasl_password | "" | SASL password (use ${secret} for vault) |
nickserv_password | "" | NickServ password (use ${secret} for vault) |
nick | from general | Override default nick for this network |
autojoin | [] | Channels to join on connect |
autoconnect | false | Connect automatically on startup |
bouncer | "none" | "none", "znc", or "soju" |
playback | true | Enable bouncer buffer playback |
Managing Servers at Runtime
Vault References
Use${secret_name} syntax to reference secrets stored in the vault:
TLS Notes
IP addresses: Flume supports connecting to servers by IP address (not just hostname) with TLS enabled. Self-signed certificates: For bouncers or private servers with self-signed certs, enable certificate acceptance:irc.toml:
Channel Types
Flume supports all four IRC channel prefixes per RFC 2811:| Prefix | Type | Description |
|---|---|---|
# | Standard | Normal channels |
& | Local | Server-local channels |
+ | Modeless | No channel modes |
! | Safe | Timestamped/safe channels |