Skip to content

First run and accounts ​

On first start Siple writes an example config.toml (its sample account is disabled) and, when no enabled account exists, shows the setup wizard. It has three steps: account, audio and done.

First-run wizard, account stepFirst-run wizard, account step

The wizard ​

  1. Add your SIP account. Enter the account details and choose Test & continue. Siple registers once on a private socket to check them before anything is saved (this is the account.test API method; it does not disturb running accounts). Skip, I'll edit config.toml leaves the file for you to edit by hand.
  2. Check your audio. Pick devices, watch the live meter and test speaker and echo. On macOS the step offers Allow microphone access.
  3. You're ready to make calls. Choose whether Siple opens sip:, tel: and callto: links, shows in the tray / menu bar, and shows desktop notifications. Every one of these is a setting you can change later.

Skip and Finish both record that the wizard has run (in state.toml). To see it again, use Run setup again in Settings > Accounts.

What the test tells you ​

account.test returns a diagnosis, and the wizard shows its message:

DiagnosisMeaning
okRegistered.
auth_failed401, 403 or 407 after the digest answer: wrong username or password.
not_found404: the user does not exist on the server.
timeoutNo answer within 15 s by default. With UDP, try TCP or TLS.
tls_untrustedThe server certificate is not trusted; the result includes its SHA-256 fingerprint.
dns_failedThe server name did not resolve.
network_unreachableNo route to the server.
otherAnother SIP status or a local failure.

Trusting a certificate ​

For a PBX with a self-signed or private certificate, the wizard offers Trust this server after a tls_untrusted result. That pins the certificate by writing tls_fingerprint to the account and tests again. Turn off verification (not recommended) sets tls_verify = false, which ignores all certificate errors. You can also trust a CA with tls_ca_file. The fingerprint of a PEM file is openssl x509 -in pbx.pem -noout -fingerprint -sha256.

Passwords and the keychain ​

By default the password is stored in config.toml, which is created with mode 0600. In the account form you can instead store the password in the system keychain (password_store = "keyring"): macOS Keychain, Windows Credential Manager, or the Linux Secret Service (GNOME Keyring, KWallet). With the keychain, password in the file is empty. If there is no credential store (headless Linux, Docker) the account is switched off with an error rather than falling back to a plaintext password. Details: Passwords in the system keyring.

Managing accounts later ​

Settings > Accounts edits the same config.toml the wizard wrote.

Settings, Accounts pageSettings, Accounts page

Next: Making and taking calls.

Source-available under FSL-1.1-ALv2. Questions: oss@zyno.io