Skip to content
This repository was archived by the owner on Mar 17, 2025. It is now read-only.

Keyring Backend Configuration

Jeremy Falling edited this page Jan 24, 2023 · 1 revision

You may need to change the keyring backend to suit your usage. This is documented at https://pypi.org/project/keyring/#customize-your-keyring-by-config-file, however this page attempts to simplify those instructions.

List the available keyrings by running keyring --list-backends . This will provide an output such as:

keyring.backends.chainer.ChainerBackend (priority: 10)
keyrings.alt.file.PlaintextKeyring (priority: 0.5)
keyring.backends.SecretService.Keyring (priority: 5)
keyring.backends.fail.Keyring (priority: 0)
keyring.backends.kwallet.DBusKeyring (priority: 5.1)

If the keyring you want is not there, you may have unmet dependencies (such as dbus-python for the kwallet backend). Please see the keyring documentation for more information.

Next run totp_generator --debug and look for a line that starts with [root DEBUG] keyring module config root: . This is the path to your keyring configuration.

Finally, edit or create the keyringrc.cfg file in the directory from the previous step. Under the backend section, change default-keyring to the full name of the keyring you want to use from the. For example:

[backend]
default-keyring=keyring.backends.kwallet.DBusKeyring

TOTP Generator should now use the correct keyring. Please consult the keyring module documentation for any addition configuration required that may be required.

Clone this wiki locally