Chromium Embedded Framework documentation
Available starting with CEF version 151.1.
The CEF Installer Library is part of the standard bootstrap binary and provides automatic CEF version management for Windows applications using the bootstrap architecture. It downloads, installs, updates, and uninstalls CEF from a shared installation directory so that multiple applications can share a single managed copy of a CEF version (including libcef and all associated DLLs and resources).
Installer behavior is optional. It activates only when a CEF_INSTALLER_CONFIG
resource is embedded in the client DLL or bootstrap executable. Without that
resource, the client DLL loads the libcef DLL in the usual way with no installer
involvement.
The authoritative reference is libcef_dll/bootstrap/installer/README.md. This document is a brief overview; follow the links below for full details.
%LocalAppData%\CEF\ for standard users
or %ProgramFiles%\CEF\ for admin installs).RunInstaller API, or manually via /cef-update (when enabled, see below).Embed a CEF_INSTALLER_CONFIG JSON resource in your client DLL (or bootstrap
.exe):
{
"appid": "A3B9C4D5-E6F7-4A8B-9C0D-E1F2A3B4C5D6",
"vmin": "151.1",
"vmax": "",
"abi_hash": "1234567890ABCDEF",
"launch_health": "explicit"
}
Key fields:
| Field | Purpose |
|---|---|
appid |
Unique UUID for your application (never changes). |
vmin |
Minimum compatible CEF version. |
vmax |
Maximum compatible CEF version (empty = no upper bound). |
abi_hash |
Sandbox compatibility hash from cef_version.h. |
launch_health |
"off", "explicit" (recommended), or "exit_code". |
For the full field reference, see Configuration Fields.
The standard Windows binary distribution provides an opt-in CMake flag for building cefclient with installer support:
cmake -G "Visual Studio 17" -A x64 -DUSE_INSTALLER=On ..
This Release-only configuration:
CEF_INSTALLER_CONFIG resource in the client DLL.exe, client DLL, and chrome_elf.dllReplace the sample application identity (appid) before production use. See
Build Integration
for resource embedding details.
The bootstrap verifies that chrome_elf.dll and the .exe share the same
code-signing certificate. Both must be signed before deployment. CEF
installations are signed and verified separately using their own catalog and
certificate.
Run the bootstrap executable with installer flags:
MyApp.exe /cef-update # Check for and install updates
MyApp.exe /cef-update /cef-background # Silent background update
MyApp.exe /cef-uninstall # Unregister and prune unused versions
These commands require enable_explicit_modes: true in the bootstrap’s
embedded configuration. See
Command-Line Options.
Client DLLs can trigger updates programmatically via the RunInstaller export:
auto run_installer = reinterpret_cast<RunInstallerFunc>(
GetProcAddress(GetModuleHandle(nullptr), "RunInstaller"));
const char* result = run_installer("update", config_json.c_str());
The result is a JSON string indicating success or failure. Available commands:
install, update, uninstall, query, and launch_success.
For the full API, result format, and extended configuration options, see Background Update API.
The installer picks the best CEF version from multiple sources:
install_path if configured)bundled_cef_path)Among qualifying candidates, newer wins; ties go to the installed copy. Revoked versions are excluded from normal selection, and crash-disqualified versions (when launch-health tracking is enabled) are deprioritized.
For the complete decision tree, see Version Selection.
Applications can optionally ship CEF alongside their own binaries instead of relying solely on the shared installation directory and CDN downloads.
bundled_cef_path: Points to a full CEF distribution directory (with
cef_version.json, catalog.cat, and Release/libcef.dll). The bundled
version participates in normal version selection — it is compared against
installed versions and the newer one wins. It is used in-place and never
copied to the shared directory. See
Bundled Version Behavior.
unchecked_cef_path: Points directly to a directory containing
libcef.dll. When set, this path is checked first and bypasses all version,
ABI, signature, and revocation checks — the application is fully responsible
for the integrity of that DLL. If the DLL is absent, the installer falls
through to normal resolution. See
Unchecked CEF Path.
| Topic | Link |
|---|---|
| Full installer reference | README.md |
| Security model | SECURITY.md |
| Enterprise policy | ADMIN_POLICY.md |
| Testing | TESTING.md |
| Bootstrap/client integration | sandbox_setup.md |