- At least 4 GB of RAM. 8 GB or more is recommended. While you can build Thunderbird on older hardware it can take quite a bit of time to compile on slower machines with less RAM.
- Good internet connection for the initial source download.
Depending on your Operating System you will need to carry out a different process to prepare your machine. So firstly complete the instructions for your OS and then continue following these build instructions.
To build on Windows, please read the prerequisites so you don't skip preparing the MAPI headers needed to compile Thunderbird.
Get the latest source code from Mozilla's
comm-central Mercurial code repository:
hg clone https://hg.mozilla.org/comm-central
Then, get all the repositories it depends on. The comm-central repository includes a script to do just that. This may take a while, it's a lot of code! First, cd into the
comm-central subdirectory (created automatically by the previous command):
python client.py checkout
The source code requires 3.6GB of free space or more and additionally 5GB or more for default build. For more on getting the source code, see the page Getting comm-central Source Code Using Mercurial [en-US].
To build Thunderbird, you need to add a file named
mozconfig to the root directory of the comm-central checkout that contains the following line:
You can create a file with this line by doing this:
cd comm-central echo 'ac_add_options --enable-application=mail' > mozconfig
If you omit this line, the build system will build Firefox instead. Other build configuration options can be added to this file, although it's strongly recommended that you only use options that you fully understand. For example, to create a debug build instead of a release build, that file would contain:
For more on configuration options, see the page Configuring build options. Note that if you use an MOZ_OBJDIR it cannot be a sibling folder to your source directory. Use an absolute path to be sure!
Before you start, make sure that the version you checked out is not busted. For hg tip, you should see green Bs on https://treeherder.mozilla.org/#/jobs?repo=comm-central
To start the build, cd into the
comm-central subdirectory, and run:
mach is our command-line tool to streamline common developer tasks. See the mach article for more.
Building can take a significant amount of time, depending on your system, OS, and chosen build options. Linux builds on a fast box may take under 15 minutes, but Windows builds on a slow box may take several hours. Tips for making builds faster.
The executable will be at the location listed under Running below.
Building Thunderbird and Lightning
If you've set up your build environment as above, then all you need to do is:
echo 'ac_add_options --enable-calendar' >> mozconfig
comm-central directory, or just add the
ac_add_options --enable-calendar line to your mozconfig with your favorite editor.
Then just re-run the mach command above (you can do the addition before running mach for the first time).
To run your build, you can use
There are various command line parameters you can add, e.g. to specify a profile.
Various temporary files, libraries, and the Thunderbird executable will be found in your object directory (under
comm-central/), which is prefixed with
obj-. The exact name depends on your system and OS. For example, a Mac user may get an object directory name of
The Thunderbird executable in particular, and its dependencies, are located under the
dist/bin folder under the object directory. To run the executable from your
comm-central working directory:
- OS X:
comm-central directory, run the same command as before:
python client.py checkout
Then just re-run the mach command above. This will only recompile files that changed, but it's still a long haul.
To build after making changes, run
again. This will only rebuild what is necessary for these changes. It is also possible to rebuild specifically.
If you changed C or C++ files, run:
./mozilla/mach build binaries
./mozilla/mach build path/to/dir
This is the tricky bit, since you need to specify the directory that installs the files, which may be a parent directory of the changed file's directory.
For all other changes run the full rebuild:
- Check comm-central on Treeherder for known failures at the time you pulled the code. The current status of the trunk can also be checked at https://treestatus.mozilla.org/
- If the trunk is broken (i.e. closed), you may wish to consider building one of the branches (to pull the source code from a branch, just replace the url to the repository in the hg clone instruction).
- On Windows: check that the MAPI header files from https://www.microsoft.com/en-us/download/details.aspx?id=12905 are installed because the MAPI header files are not bundled with Visual Studio 2013/2015 (Windows SDK 8.1/10). You should copy the header files to a Windows SDK include directory so that the build process will find the files, for example to
C:\Program Files (x86)\Windows Kits\8.1\Include\sharedand/or
C:\Program Files (x86)\Windows Kits\10\Include\10.0.nnnnn.0\sharedrespectively, where
nnnnnis the highest number present on the system.
- Check to make sure that the path in which you placed the source code has no spaces, and is not too long.
- Searched the bug database for issues relating to your problem (e.g., platform-specific issues).
- Try asking in mozilla.dev.builds - include details of what is in your mozconfig, and what the actual error is.
- Check if your mozilla/ is a symlink. A symlink there is not supported.
- Check for
@TOPSRCDIR@or relative paths in your mozconfig. Those have caused several problems historically and tend to be poorly tested when the build system changes.
- If on Windows you get link errors like "LNK1102: out of memory" or "LNK1318: Unexpected PDB error; OK (0)", try deleting the largest .PDB files before rushing out the door to buy more RAM. Clobbering (see below) will also remove those files.
- Try with a clean obj-dir. You can clean out previous build artefacts using