fune/browser/installer/windows/docs/index.rst
Matt Howell 022b3fe431 Bug 1325121 - Add some installer documentation to the tree. r=agashlin
This is not exhaustive technical documentation for every aspect of the installer
code, but it's better than what we had, and it does contain the ping
documentation that this bug was originally asking for.

MozReview-Commit-ID: 5h7UwnAk4Iq

--HG--
extra : rebase_source : a3a8a8bdee9e76ee039c342a07a121170872708c
2018-02-14 10:01:38 -08:00

19 lines
1.4 KiB
ReStructuredText

=========
Installer
=========
The main role of the Firefox installer is to get a user running Firefox as quickly and reliably as possible, while taking all necessary steps to make Firefox an integrated part of the system.
It turns out that the only platform where we need an installer in order to accomplish all of that is Windows. So we only develop and ship and installer for Windows, and on other platforms we distribute a package in a non-executable format typical of applications distributed on that platform.
Currently, the installers are built on the `NSIS <http://nsis.sourceforge.net/Main_Page>`_ installer framework. This is a Windows-only framework which compiles scripts written in its custom language (along with some native plugins) into an executable installer.
We build two different kinds of installers, the :doc:`Stub Installer <StubInstaller>` and the :doc:`Full Installer <FullInstaller>`. The stub is the default installer intended for most individual users, and the full installer is aimed at power users and administrators who need more control.
There's also a third installer-related program, which is called :doc:`helper.exe <Helper>`. It's also written in NSIS and has a few different jobs that involve maintaining things that the installer sets up, including the uninstaller and a post-update routine.
.. toctree::
InstallerBuild
StubInstaller
FullInstaller
Helper