Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Profiles

Each SIP account is a profile, stored as TOML at ~/.config/ringo/profiles/<name>/profile.toml. Create and edit profiles right in the picker (Ctrl+N / Ctrl+E), or write the file by hand:

username     = "user123"
password     = "secret"
domain       = "sip.example.com"
display_name = "My Name"               # optional
transport    = "tls"                   # optional: udp, tcp, tls
outbound     = "sip:proxy.example.com" # optional
stun_server  = "stun:stun.example.com" # optional
media_enc    = "dtls_srtp"             # optional
notify       = true                    # desktop notifications (default: true)
mwi          = true                    # message-waiting indicator (default: true)

Password from a file or command

Instead of the inline password, ringo can resolve it at launch — handy for secret managers and for keeping the password out of the profile file:

password_file = "~/.secrets/sip"     # read the password from this file
# or:
password_cmd  = "pass show sip/work" # run a command; its stdout is the password

Precedence is password_cmd > password_file > password. A single trailing newline is stripped, and a leading ~/ in password_file expands to your home directory. The command runs via sh -c; a non-zero exit or an unreadable file fails the launch. Both fields are also editable in the profile form.

Custom SIP headers

Add headers to every outgoing INVITE. Order is preserved and duplicate keys are allowed (e.g. RFC 4244 History-Info). Values are percent-encoded for baresip’s uaaddheader — write them as plain text, no manual escaping. The ${uuid} placeholder is replaced per call with a fresh UUIDv4 (shared across all headers in the same INVITE); use $$ for a literal $.

custom_headers = [
  ["History-Info", "<sip:1@example.com>;index=1"],
  ["History-Info", "<sip:2@example.com>;index=1.1"],
  ["X-Trace-Id",   "call-${uuid}"],
]

File locations

PathDescription
~/.config/ringo/ringo.tomlGlobal config
~/.config/ringo/contacts.tomlContact book
~/.config/ringo/profiles/<name>/profile.tomlProfile config
~/.config/ringo/profiles/<name>/call_historyPer-profile call history (JSONL)
~/.local/share/ringo/historyGlobal dial history
~/.local/state/ringo/<name>.logApplication log (hooks, errors, lifecycle); $XDG_STATE_HOME
/tmp/ringo-baresip-<pid>/baresip conf dir (empty; auto-cleaned on exit)