Chat

GOnnect does not contain a chat protocol implementation itself. Instead, it talks to a separate chat backend via the GOuda interface, a local interface based on Protocol Buffers. The backend runs as a helper process started by GOnnect and handles the connection to the chat server.

Currently, a backend for Matrix is available (gouda-matrix).

This page describes the setup. For using the chat, see Chat.

Installing the chat backend

Linux (Flatpak)

The Matrix backend is shipped as a separate Flatpak plugin for GOnnect. It is not downloaded automatically and must be installed explicitly:

# List available GOnnect plugins
flatpak search de.gonicus.gonnect.plugin

# Install the Matrix chat backend
flatpak install flathub de.gonicus.gonnect.plugin.Matrix

Restart GOnnect afterwards. On start, GOnnect searches the installed plugins and uses the chat backend found there.

Windows

Outside the Flatpak, and therefore on Windows, GOnnect does not search for plugins. The chat backend executable must be provided separately and its path must be configured with headlessClientPath in the generic section:

Example 1. 05-chat-backend.conf
[generic]
headlessClientPath=C:/path/to/gouda-matrix.exe
headlessClientPath

Path to the chat backend executable. Only used if GOnnect is not running as Flatpak; in the Flatpak, the installed plugins are used instead.

Chat account

The chat account is configured in a section whose name starts with chat followed by a number, e.g. chat0.

Example 2. 30-chat.conf
[chat0]
backendUrl=https://matrix.example.org
userId=@jdoe:example.org
loginFlow=SSO
#identityProviderId=
displayName=GOnnect

# Link chat users to address book contacts:
# "@jdoe:example.org" is looked up as "jdoe@example.org"
idConvRegexpString=^@([^:]+):(.+)$
idConvReplacementString=\\1@\\2
backendUrl

The URL of the chat server, e.g. the Matrix homeserver. Mandatory.

userId

The ID of the chat user, e.g. the Matrix ID @jdoe:example.org. Mandatory.

loginFlow

How to log in. Mandatory.

  • Credentials - Log in with user ID and password. GOnnect asks for the password on first login and stores it in the system’s credential store.

  • SSO - Log in via single sign-on in the browser.

identityProviderId

Only for loginFlow=SSO: the identity provider to use if the server offers more than one. If empty, the server’s default provider is used.

displayName

The device name of this session, e.g. shown in the session list of the chat account. It is also used as a fallback name for your own messages. (optional, default: GOnnect)

verifyServer

Whether the TLS certificate of the chat server is validated. Disable this only for testing, e.g. with self-signed certificates. (optional, default: true)

idConvRegexpString

A regular expression applied to the IDs of chat users. Together with idConvReplacementString, it converts a chat user ID into an e-mail address, which is then looked up in the address book. This links chat users to the contacts found in your address books. (optional)

idConvReplacementString

The replacement for idConvRegexpString. Capturing groups can be referenced with \\1, \\2 and so on. As GOnnect uses QSettings, backslashes must be doubled. The conversion is only active if both values are set and the regular expression is valid. (optional)

avatarPrio

The priority of avatar images from this chat account, see Avatars. (optional, default: 50)

If one of the mandatory values is missing or loginFlow has an unknown value, the section is ignored.