otty / dotfiles

All tools/irssi

irssi

Irssi is a modular text mode chat client.

Detected by irssi | macOS, Linux, Windows |irssi.org

Sync it irssi.toml

Sync rules

What travels, what stays, what never leaves

Synced1 path, copied whole to your other machines

~/.irssi/directory

Secret fieldsInside a file that otherwise syncs

~/.irssi/configlines starting with

passwordtls_passsasl_password

The rest of the file syncs. Only these values are lifted out and kept in your secret store.

Stays on this machineInside a file that otherwise syncs

~/.irssi/configlines starting with tls_cert, tls_pkey, own_host

…

port = "6697";

use_tls = "yes";

tls_verify = "yes";

tls_cert = "/home/octocat/.irssi/certs/libera.pem";machine-local

tls_pkey = "/home/octocat/.irssi/certs/libera.key";machine-local

tls_pass = "FAKEcertpassphrase0000";

tls_cafile = "/etc/ssl/certs/ca-certificates.crt";

tls_capath = "/etc/ssl/certs";

password = "FAKEserverpassword0000";

own_host = "192.0.2.10";machine-local

autoconnect = "yes";

}

);

…

Otty splits these out before upload and puts each machine’s own back on the way down — no templates to write. The lines above come from this tool’s test fixture in the catalog.

Stays on this machineInside a file that otherwise syncs

~/.irssi/configlines starting with tls_cafile, tls_capath

…

tls_cert = "/home/octocat/.irssi/certs/libera.pem";

tls_pkey = "/home/octocat/.irssi/certs/libera.key";

tls_pass = "FAKEcertpassphrase0000";

tls_cafile = "/etc/ssl/certs/ca-certificates.crt";machine-local

tls_capath = "/etc/ssl/certs";machine-local

password = "FAKEserverpassword0000";

own_host = "192.0.2.10";

autoconnect = "yes";

…

Otty splits these out before upload and puts each machine’s own back on the way down — no templates to write. The lines above come from this tool’s test fixture in the catalog.

Excluded2 paths, state rather than configuration — never uploaded

~/.irssi/away.log

~/.irssi/config.autosave

Not a subtraction from the paths above: this is everything else irssi writes in your home directory that is state, not configuration. It keeps a whole-home manager like chezmoi from sweeping those up, and it still holds if the synced paths are ever widened.

irssi in your home directory Every rule on this page, by file

· away.log Exclude

· config.autosave Exclude

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/irssi.tomlThe file this page is generated from

id = "irssi"

name = "irssi"

homepage = "https://irssi.org"

description = "Irssi is a modular text mode chat client."

# The irssi icon, from the project's repository.

icon = "https://raw.githubusercontent.com/irssi/irssi/master/irssi-icon.png"

detect = ["irssi"]

# irssi(1), FILES: "~/.irssi/config — personal configuration file",

# "~/.irssi/default.theme — default irssi theme", "~/.irssi/startup — file

# containing a list of commands to execute on startup", "~/.irssi/scripts/ —

# default scripts directory" and "~/.irssi/scripts/autorun/ — directory

# containing links to scripts that should be loaded automatically on startup".

# https://irssi.org/documentation/manual/configuration/ adds that "The

# configuration is saved to ~/.irssi/config file", in a format of irssi's own

# resembling libPropList, and that comment lines survive /SAVE. The whole

# directory is listed: themes, scripts and the startup command list are as much

# the user's setup as the config file is.

paths = ["~/.irssi/"]

# Same FILES list: away.log is "logged messages in away status", a transcript

# rather than configuration, and config.autosave is "automatic save of the

# personal config file when it was changed externally" — a backup copy irssi

# writes for itself.

exclude = [

"~/.irssi/away.log",

"~/.irssi/config.autosave",

]

secret = []

# The passwords irssi writes into the config file, by the key names its own

# writers use. src/core/servers-setup.c, server_setup_save():

# `iconfig_node_set_str(node, "password", rec->password)` for the server

# password and "tls_pass" for the client-certificate key passphrase.

# src/irc/core/irc-chatnets.c writes "sasl_password" alongside "sasl_username"

# and "sasl_mechanism" for a chatnet. All three keys are listed because they are

# three separate credentials in one file; `password` as a prefix does not reach

# `sasl_password`, which is why that one is spelled out.

[[secret_paths]]

file = "~/.irssi/config"

match = { prefix = ["password", "tls_pass", "sasl_password"] }

# From the same server_setup_save(): tls_cert and tls_pkey are absolute paths to

# the certificate and key file on this machine, and own_host is the local

# address irssi binds outgoing connections to. Nicknames, themes, key bindings

# and the network list are deliberately not here: those are what the user wants

# carried over. The certificate the user was issued and the address this box

# answers on are its own, and have to be put back by hand after a rebuild, so

# they are kept: backup.

[[machine_lines]]

file = "~/.irssi/config"

match = { prefix = ["tls_cert", "tls_pkey", "own_host"] }

scope = "backup"

# tls_cafile and tls_capath are split out of the rule above because they are

# not this machine's at all: they name the system CA bundle, /etc/ssl/certs on

# one distro and a Homebrew prefix on the next, the same on every box of that

# kind. Decided by the platform, so they travel to one of the same kind.

[[machine_lines]]

file = "~/.irssi/config"

match = { prefix = ["tls_cafile", "tls_capath"] }

scope = "platform"

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/irssi. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these is generated from the same rules as this page. None of them splits tls_cert and tls_pkey for you — that part is Otty’s own sync, or a template you write by hand.