Building the Zotero Desktop App
Note: If you don't plan to make any code changes yourself, and only wish to run the latest prerelease versions of Zotero, you can just install a beta build.
Windows users: The following commands assume a POSIX-compliant system. To build Zotero on Windows, please follow the Windows-specific steps first.
- Make sure you have Git and Git LFS installed.
git lfsshouldn't show an error.
- Clone the Zotero source code:
git clone --recursive https://github.com/zotero/zotero zotero-client
- Change to the source code repo:
- Check your system for the necessary tools and install any that are missing:
This script checks all requirements for the official Zotero distribution system. If you're only creating a custom build, you only need the build requirements listed at the top, not the distribution requirements.
- Install Node.js modules using Node 18 or later:
- Build and run Zotero:
The build will be placed in the
app/staging/ folder in unpackaged form.
npm run build (or keep it prepared automatically as you make changes with
npm start) and then run
app/scripts/dir_build with the
-p flag for the desired platform (e.g.,
app/scripts/dir_build -p w for Windows).
npm run build manually, you may need to set the environment variable
NODE_OPTIONS=–openssl-legacy-provider to avoid an
Running Your Custom Build
After you've built the client, you can continue to run it from
app/staging/ or move the app directory to a location of your choosing and start it normally.
For development, you'll generally want to leave the app in the staging directory and use the
build_and_run helper script, but you can also call the launcher directly:
In most cases, you'll want to use the helper script below instead of passing these flags directly to the launcher, but it's helpful to know the available options, which also work with release and beta builds:
-ZoteroDebugenable real-time debug output from
-jsconsolewill open the Error Console (Tools → Developer → Error Console)
-ZoteroSkipBundledFilesskips style and translator initialization, which speeds up startup time after rebuilding if you're working on something that doesn't require styles or translators
-debuggerstarts the Mozilla DevTools server for remote debugging, if Zotero was built with devtools enabled; not available in release builds
For local development, you'll want to use the build_and_run helper script, which automates rebuilding Zotero and starting it with debug output enabled and the error console open. Create an alias for
app/scripts/build_and_run with an appropriate name (e.g.,
zotero-source), or create a shell script in your path that selects a preexisting development profile and forwards command-line parameters:
#!/bin/bash -e export ZOTERO_PROFILE="Dev" ~/zotero-client/app/scripts/build_and_run "$@"
You can then run, e.g.,
zotero-source -r to rebuild Zotero with your changes and start it up.
-rRebuild (calling `npm run build` automatically if `npm start` isn't running)
-bSkip bundled styles and translators
-dStart the devtools server for remote debugging
Running Zotero Plugins
- In Keychain Access, create
buildkeychain with password
- Import Developer ID certificate, public key, and private key
- Set up app-specific password for Apple developer account
- Create a
SIGN=1 KEYCHAIN=build KEYCHAIN_PASSWORD=<keychain password> NOTARIZATION_BUNDLE_ID=<bundle id (e.g., org.foo.App) — only used for notification emails> NOTARIZATION_USER="<username of Apple developer account>" NOTARIZATION_PASSWORD="<app-specific password for Apple developer account>" BUILD_PLATFORMS=m
- Verify that git is set to check out files without modifying line endings.
$ git config --global core.autocrlf
The response should be either empty (meaning
input. If set to
true(as it may be if you selected the default option while installing the Windows version of git), change this with the following command:
git config --global core.autocrlf false
See the git manual for details on this setting.
- Install NSIS 3 and install the necessary plugins by running
- The Windows SDK is needed for the included
signtool.exeutility. You can uncheck all other installation options. Adjust the path in
app/config.shto point to the correct version of the Windows SDK.
Installation and Packaging Notes
Note: These instructions are not applicable on macOS, which handles protocol handler and MIME type registration through the bundled Info.plist file. Additionally, they are only applicable on Windows if for some reason you want to run Zotero without running the installer.
Protocol handler registration
Zotero should be registered as the system's default protocol handler for the
File extensions and MIME types
Zotero should be registered as a handler for the following file extensions and MIME types:
|File type description||File extension(s)||MIME type(s)|
|Research Information Systems Document||ris|| application/x-research-info-systems
|ISI Common Export Format Document||ciw, isi||application/x-inst-for-Scientific-info|
|Metadata Object Description Schema Document||mods||application/mods+xml|
|Resource Description Framework Document||rdf||application/rdf+xml|
|BibTeX Document||bib, bibtex|| application/x-bibtex
|MARC Record||mrc, marc||application/marc|
|CSL Citation Style||csl||vnd.citationstyles.style+xml|
Distribution steps are beyond the scope of this page, but see
app/scripts/build_and_deploy for an example of the necessary steps.