<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="repartee — A modern terminal IRC client built with Ratatui, Tokio, and Rust. Scripting, theming, encrypted logging, and more.">
<meta name="keywords" content="irc, terminal, tui, client, chat, repartee, ratatui, tokio, rust">
<meta name="author" content="outragedevs">
<meta property="og:title" content="Configuration — repartee">
<meta property="og:description" content="A modern terminal IRC client built with Ratatui, Tokio, and Rust. Inspired by irssi, designed for the future.">
<meta property="og:type" content="website">
<meta property="og:url" content="https://outragedevs.github.io/repartee/">
<meta property="og:image" content="https://outragedevs.github.io/repartee/images/chat.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="{{title}} — repartee">
<meta name="twitter:description" content="A modern terminal IRC client built with Ratatui, Tokio, and Rust.">
<meta name="twitter:image" content="https://outragedevs.github.io/repartee/images/chat.png">
<title>{{title}} — repartee</title>
<link rel="stylesheet" href="css/style.css">
</head>
<body>
<!-- Mobile hamburger toggle -->
<button class="hamburger" aria-label="Toggle navigation">
<span></span>
<span></span>
<span></span>
</button>
<div class="page-wrapper">
<!-- Sidebar navigation -->
<aside class="sidebar">
<div class="sidebar-header">
<a href="index.html" class="brand">repartee</a>
<span class="brand-tagline">Documentation</span>
</div>
<nav class="sidebar-nav">
<ul>
<li><a href="index.html">Home</a></li>
</ul>
<div class="nav-section">
<span class="nav-section-title">Getting Started</span>
<ul>
<li><a href="installation.html">Installation</a></li>
<li><a href="first-connection.html">First Connection</a></li>
<li><a href="configuration.html" class="active">Configuration</a></li>
</ul>
</div>
<div class="nav-section">
<span class="nav-section-title">Reference</span>
<ul>
<li><a href="commands.html">Commands</a></li>
</ul>
</div>
<div class="nav-section">
<span class="nav-section-title">Scripting</span>
<ul>
<li><a href="scripting-getting-started.html">Getting Started</a></li>
<li><a href="scripting-api.html">API Reference</a></li>
<li><a href="scripting-examples.html">Examples</a></li>
</ul>
</div>
<div class="nav-section">
<span class="nav-section-title">Customization</span>
<ul>
<li><a href="theming.html">Theming</a></li>
<li><a href="theming-format-strings.html">Format Strings</a></li>
<li><a href="logging.html">Logging & Search</a></li>
</ul>
</div>
<div class="nav-section">
<span class="nav-section-title">Usage</span>
<ul>
<li><a href="web-frontend.html">Web Frontend</a></li>
<li><a href="sessions.html">Sessions & Detach</a></li>
</ul>
</div>
<div class="nav-section">
<span class="nav-section-title">Project</span>
<ul>
<li><a href="architecture.html">Architecture</a></li>
<li><a href="faq.html">FAQ</a></li>
</ul>
</div>
</nav>
<div class="sidebar-footer">
Built with <a href="https://www.rust-lang.org">Rust</a>
·
<a href="https://github.com/outragedevs/repartee">GitHub</a>
</div>
</aside>
<!-- Overlay for mobile sidebar -->
<div class="sidebar-overlay"></div>
<!-- Main content -->
<div class="content-wrapper">
<main class="content">
<h1>Configuration</h1>
<h2>Config location</h2>
<p>repartee stores its configuration in <code>~/.repartee/config.toml</code>. This file is created automatically on first run with sensible defaults.</p>
<p>The full directory layout:</p>
<pre><code>~/.repartee/
config.toml # main configuration
.env # credentials (passwords, SASL)
themes/ # custom themes
scripts/ # user scripts (Lua)
logs/messages.db # chat logs (SQLite)
dicts/ # Hunspell dictionaries (.dic/.aff)
sessions/ # Unix sockets for detached sessions
certs/ # TLS certificates for web frontend
</code></pre>
<h2>Full annotated example</h2>
<pre><code class="language-toml">[general]
nick = "mynick"
username = "mynick"
realname = "repartee user"
theme = "default"
timestamp_format = "%H:%M:%S"
flood_protection = true
ctcp_version = "repartee"
[display]
nick_column_width = 8
nick_max_length = 8
nick_alignment = "right" # "left", "right", or "center"
nick_truncation = true
show_timestamps = true
scrollback_lines = 2000
backlog_lines = 20 # history lines loaded when buffer opens (0 = off)
[sidepanel.left]
width = 20
visible = true
[sidepanel.right]
width = 18
visible = true
[statusbar]
items = ["active_windows", "nick_info", "channel_info", "lag", "time"]
[servers.libera]
label = "Libera"
address = "irc.libera.chat"
port = 6697
tls = true
tls_verify = true
autoconnect = true
channels = ["#repartee", "#secret mykey"]
autosendcmd = "MSG NickServ identify pass; WAIT 2000; MODE $N +i"
# nick = "othernick" # per-server nick override
# sasl_user = "mynick"
# sasl_pass = "hunter2"
# sasl_mechanism = "SCRAM-SHA-256" # PLAIN (default), EXTERNAL, SCRAM-SHA-256
# bind_ip = "192.168.1.100" # bind to specific local IP (vhost)
# auto_reconnect = true
# reconnect_delay = 30
# reconnect_max_retries = 10
[image_preview]
enabled = true
protocol = "auto" # "auto", "kitty", "iterm2", "sixel", "symbols"
max_width = 0 # 0 = auto
max_height = 0 # 0 = auto
cache_max_mb = 100
cache_max_days = 7
fetch_timeout = 30 # seconds
max_file_size = 10485760 # bytes (10 MB)
kitty_format = "rgba"
[logging]
enabled = true
encrypt = false
retention_days = 0 # 0 = keep forever
exclude_types = [] # e.g. ["join", "part", "quit"]
[aliases]
wc = "/close"
j = "/join"
[scripts]
autoload = ["slap"]
# debug = true
[dcc]
timeout = 300 # seconds before pending requests expire
own_ip = "" # override IP in DCC offers (empty = auto-detect)
port_range = "0" # "0" = OS-assigned, "1025 65535" = range
autoaccept_lowports = false # allow auto-accept from ports < 1024
# autochat_masks = ["*!*@trusted.host"] # hostmask patterns for auto-accept
max_connections = 10
[spellcheck]
enabled = true
languages = ["en_US"] # Hunspell language codes
dictionary_dir = "" # default: ~/.repartee/dicts
[web]
enabled = false # enable embedded web frontend
bind_address = "127.0.0.1" # listen address (0.0.0.0 for LAN)
port = 8443 # HTTPS port
tls_cert = "" # custom cert (empty = auto self-signed)
tls_key = "" # custom key
timestamp_format = "%H:%M" # web UI timestamp format
line_height = 1.35 # CSS line-height for chat messages
theme = "nightfall" # web theme (nightfall, catppuccin-mocha, etc.)
# cloudflare_tunnel_name = "" # future: Cloudflare tunnel name
[[ignores]]
mask = "*!*@spammer.host"
levels = ["ALL"]
</code></pre>
<h2>Sections explained</h2>
<h3><code>[general]</code></h3>
<p>Global identity and behavior. The <code>nick</code>, <code>username</code>, and <code>realname</code> are used as defaults for all servers unless overridden per-server. Set <code>theme</code> to the name of a theme file in <code>~/.repartee/themes/</code> (without the <code>.theme</code> extension).</p>
<h3><code>[display]</code></h3>
<p>Controls how messages are rendered. <code>nick_column_width</code> sets the fixed-width column for nicks in chat view. <code>scrollback_lines</code> is the number of messages kept in memory per buffer. <code>backlog_lines</code> sets how many historical messages to load from the log database when a channel, query, or DCC buffer is first opened (0 to disable).</p>
<h3><code>[sidepanel]</code></h3>
<p>Left panel shows buffer list, right panel shows nick list. Set <code>visible = false</code> to hide a panel. Widths are in terminal columns.</p>
<h3><code>[statusbar]</code></h3>
<p>Configure which items appear in the status line. Available items: <code>active_windows</code>, <code>nick_info</code>, <code>channel_info</code>, <code>lag</code>, <code>time</code>.</p>
<h3><code>[servers.*]</code></h3>
<p>Each server gets a unique identifier (the key after <code>servers.</code>). The <code>channels</code> array lists channels to auto-join on connect. Channels with keys use the format <code>"#channel key"</code>.</p>
<p>Set <code>sasl_mechanism</code> to override automatic mechanism selection. Available: <code>PLAIN</code> (default), <code>EXTERNAL</code> (client TLS certificate), <code>SCRAM-SHA-256</code> (secure challenge-response).</p>
<p>Set <code>bind_ip</code> to bind to a specific local IP address when connecting. Useful for multi-IP hosts (vhosts/bouncers). Supports both IPv4 and IPv6 — DNS resolution automatically filters to match the address family. Can also be set per-connection with <code>/connect -bind=<ip></code> or <code>/server add -bind=<ip></code>.</p>
<h3><code>[logging]</code></h3>
<p>Chat logging to SQLite. When <code>encrypt = true</code>, messages are encrypted with AES-256-GCM. <code>retention_days = 0</code> keeps logs forever.</p>
<h3><code>[aliases]</code></h3>
<p>Custom command shortcuts. The key is the alias name, the value is the command it expands to.</p>
<h3><code>[scripts]</code></h3>
<p>The <code>autoload</code> array lists script names to load on startup. Scripts live in <code>~/.repartee/scripts/</code> as <code>.lua</code> files.</p>
<h3><code>[dcc]</code></h3>
<p>DCC (Direct Client-to-Client) chat settings. DCC CHAT establishes peer-to-peer TCP connections that bypass the IRC server.</p>
<p><code>own_ip</code> overrides the IP address advertised in DCC offers. When empty, Repartee auto-detects from the IRC socket's local address (like irssi's <code>getsockname</code>). Set this to your public IP if behind NAT.</p>
<p><code>port_range</code> controls the TCP port for DCC listeners. <code>"0"</code> lets the OS assign a free port. Use <code>"1025 65535"</code> or <code>"5000-5100"</code> to restrict to a range (useful for firewall rules).</p>
<p><code>autochat_masks</code> is a list of <code>nick!ident@host</code> wildcard patterns. Incoming DCC CHAT offers matching any pattern are auto-accepted without prompting.</p>
<h3><code>[spellcheck]</code></h3>
<p>Inline spell checking. When <code>enabled = true</code>, misspelled words are underlined in red while typing. Press Tab to cycle suggestions, Space to accept, Escape to revert. <code>languages</code> is a list of Hunspell language codes (e.g., <code>en_US</code>, <code>pl_PL</code>, <code>de_DE</code>) — a word is correct if <strong>any</strong> active dictionary accepts it. Place <code>.dic</code>/<code>.aff</code> files in <code>~/.repartee/dicts/</code> (or set <code>dictionary_dir</code> to a custom path).</p>
<h3><code>[web]</code></h3>
<p>Embedded web frontend. When <code>enabled = true</code> and <code>WEB_PASSWORD</code> is set in <code>.env</code>, the app starts an HTTPS server alongside the terminal interface. Both share the same state — read a message on web, it's marked read on terminal, and vice versa.</p>
<p>Set <code>bind_address = "0.0.0.0"</code> to allow LAN access. TLS is always on — if no custom cert/key is provided, a self-signed certificate is auto-generated in <code>~/.repartee/certs/</code>.</p>
<p>The <code>theme</code> setting controls the web UI appearance. Available: <code>nightfall</code> (default dark), <code>catppuccin-mocha</code>, <code>tokyo-storm</code>, <code>gruvbox-light</code>, <code>catppuccin-latte</code>.</p>
<h3><code>[[ignores]]</code></h3>
<p>Ignore patterns for filtering unwanted messages. Uses wildcard matching (<code>*!*@host</code>). Levels: <code>MSGS</code>, <code>PUBLIC</code>, <code>NOTICES</code>, <code>ACTIONS</code>, <code>JOINS</code>, <code>PARTS</code>, <code>QUITS</code>, <code>NICKS</code>, <code>KICKS</code>, <code>CTCPS</code>, <code>ALL</code>.</p>
<h2>Credentials</h2>
<p>Passwords and SASL credentials should <strong>not</strong> go in <code>config.toml</code> — store them in <code>~/.repartee/.env</code> instead.</p>
<pre><code class="language-bash"># ~/.repartee/.env
LIBERA_SASL_USER=mynick
LIBERA_SASL_PASS=hunter2
LIBERA_PASSWORD=serverpassword
WEB_PASSWORD=mysecretpassword
</code></pre>
<p>Server credentials use the server identifier uppercased. <code>WEB_PASSWORD</code> is required for the web frontend — the server won't start without it.</p>
<h2>Runtime changes</h2>
<ul>
<li><strong><code>/set section.field value</code></strong> — change a config value at runtime. Changes are saved immediately.</li>
<li><strong><code>/reload</code></strong> — reload theme and config from disk.</li>
</ul>
<!-- Prev / Next navigation -->
<nav class="page-nav">
<a href="first-connection.html" class="page-nav-link prev">
<span class="page-nav-label">← Previous</span>
<span class="page-nav-title">First Connection</span>
</a>
<a href="commands.html" class="page-nav-link next">
<span class="page-nav-label">Next →</span>
<span class="page-nav-title">Commands</span>
</a>
</nav>
<footer class="site-footer">
Built with <a href="https://www.rust-lang.org">Rust</a> ·
<a href="https://github.com/outragedevs/repartee">GitHub</a> ·
MIT License
</footer>
</main>
</div>
</div>
<script>
// Mobile sidebar toggle
(function() {
const hamburger = document.querySelector('.hamburger');
const sidebar = document.querySelector('.sidebar');
const overlay = document.querySelector('.sidebar-overlay');
function toggleSidebar() {
hamburger.classList.toggle('active');
sidebar.classList.toggle('open');
overlay.classList.toggle('visible');
document.body.style.overflow = sidebar.classList.contains('open') ? 'hidden' : '';
}
function closeSidebar() {
hamburger.classList.remove('active');
sidebar.classList.remove('open');
overlay.classList.remove('visible');
document.body.style.overflow = '';
}
hamburger.addEventListener('click', toggleSidebar);
overlay.addEventListener('click', closeSidebar);
// Close sidebar on Escape key
document.addEventListener('keydown', function(e) {
if (e.key === 'Escape' && sidebar.classList.contains('open')) {
closeSidebar();
}
});
})();
</script>
</body>
</html>