Table of Contents
- Base Installation
- Prerequisites
- Installation of Keycloak
- Configuration of Keycloak
- Configuration of the Olvid Plugin
- Upgrading
- Additional Configuration
- Configuration of an External IdP
- Using LDAP User Federation
- x509 Client Certificates Authentication
- Configure Olvid via an MDM
- Using the management console
- Use the Olvid Management Console
- Misc.
- Changelog
Olvid Management Console Changelog
Version 4.3.2 (released 2025-09-06)
- Upgrade to Keycloak 26.3.3.
- Better support for cluster installs for recurrent jobs.
- Performance improvement with the ability to load fewer details in user and group lists.
- New login theme, with support for light and dark mode and for multilingual selector. This new theme should be easier to customize if you want to include your own company logo.
- Fix some layouts in mobile view and small screen.
Version 4.3.0 (released 2025-06-02)
- Upgrade to Keycloak 26.2.5.
- Change to how the plugin is packaged:
- use of the official keycloak release package to allow deployment on managed Keycloak instances,
- removal of the default theme selector and separate packaging of Olvid themes for easier modification.
- In-console notifications of new releases.
The Olvid theme is no longer applied by default and needs to be manually selected:
- as Admin, Login, and Account themes for the
master
realm, - as Login and Account themes for the
olvid_admin
realm, - as Login theme for the
olvid
realm.
Version 4.2.0 (released 2025-05-02)
- Upgrade to Keycloak 26.2.2.
- Introduction of “Visibility Circles,” allowing you to define rules about who can see who when searching the directory:
- create circles,
- assign users to them,
- configure the visibility rules that suit you needs.
- Bug fixes.
Version 4.1.2 (released 2025-03-06)
- Upgrade to Keycloak 26.1.3.
- Minor bug fixes and UI improvements.
Version 4.1.1 (released 2025-02-25)
- Hotfix for a few bugs detected in version 4.1.
Version 4.1 (released 2025-02-20)
- Upgrade to Keycloak 26.1.2.
- New “Transfer Restricted” option to force users to authenticate with Keycloak before being able to transfer their profile on a new device (can be activated from the Realms Configuration page).
- New
listUsers
entry point for BOTs to easily list all activated users on Keycloak. - Several “quality of life” and UI improvements to the Olvid Management Console.
- Bug fixes.
Version 4.0.1 (released 2024-11-11)
- Upgrade to Keycloak 25.0.6.
- Mostly bug fixes.
Version 4.0.0 (released 2024-09-02)
- Upgrade to Keycloak 25.0.4, which now requires Java 21, Java 17 is no longer supported.
- Complete redesign of the Olvid Management Console UI with better responsiveness and support for mobile screens!
- Possibility to generate Olvid licenses for external users (not authenticated on Keycloak).
- Fixes some issues with user exports, background synchronization jobs, etc.
Version 3.1.0 (released 2023-12-11)
- Upgrade to Keycloak 23.0.6.
-
Change in theme management: keycloak administrators can now manually choose which theme to use, the olvid theme is only use as a default if no theme is selected.
- Various improvements to the Olvid Management Console:
- Possibility to see when a user was last active, based on their latest keycloak query (performed at each app startup).
- Possibility to export users as CSV/XLSX.
- Please check that the master realm is not using the base theme, this could break the Keycloak Administration console!
- If your keycloak server requires a proxy for outgoing connections, make sure to update the syntax in the
run-keycloak.sh
script by removing double quotes (see the updated documentation).
Version 3.0.3 (released 2023-09-19)
- Upgrade to Keycloak 22.0.3, which now requires Java 17, Java 11 is no longer supported.
- Possibility to duplicate or move a group.
- Many improvements to the Olvid Management Console:
- Better search and filtering.
- Improved bot support.
Version 3.0.2 (released 2023-07-11)
- Many improvements to the Olvid Management Console:
- Possibility to delete groups.
- Possibility to import CSV/create users without generating a password.
- Per realm settings: search result count.
- Redesign of some pages.
- Preliminary support for bots (experimental).
- Upgrade to Keycloak 21.1.2.
Version 3.0.1 (released 2023-05-13)
- Minor bug fixes.
- Upgrade to Keycloak 21.1.1.
Version 3.0 (released 2023-04-21)
- Many new features added to the Olvid Management Console:
- Improved user management.
- Support for importing users in batch using a CSV file.
- Support for olvid group discussion creation.
- Dropped support for Keycloak legacy.
- Upgrade to Keycloak 21.0.2.
Version 2.1.1 (released 2022-11-28)
- Hotfix for admin permissions being too restrictive (
editor
role was equivalent toviewer
role).
Version 2.1 (released 2022-10-28)
Added the possibility to run Olvid specific background jobs on Keycloak:
- Nightly synchronisation of Olvid user licences with the Olvid server:
- Ensures all active Keycloak user licences are valid.
- Release licences that are no longer associated to a user on Keycloak.
Version 2.0 (released 2022-01-25)
First version of the Olvid Management Console:
- Improved interface to configure the Olvid Plugin.
- Possibility to have administrators for this console without administrator privilege on Keycloak itself.
- List users and revoke compromised user identities.
- Revocation log of all revoked users.
Version 1.0 (released 2021-09-20)
First functional version of the Keycloak Olvid Plugin, allowing users to:
- Authenticate with OpenID Connect.
- Search other users in the directory.
- Add them to their contacts in “one click”.