Official NixOS Wiki

Firefox: Difference between revisions

← Older edit
Ardenet (talk | contribs)
2,206 edits
VisualWikitext
Eljamm (talk | contribs)
8 edits
Ardenet (talk | contribs)
2,206 edits
Marked this version for translation
 
(21 intermediate revisions by 11 users not shown)
Line 1: Line 1:
[https://www.mozilla.org/firefox Firefox] is a graphical web browser developed by Mozilla. It can be used with a [[Firefox Sync Server]].
<languages/>
{{infobox application
  |name=Mozilla Firefox
  |image=Firefox logo, 2019.svg
  |type=Web Browser
  |developer=Mozilla Foundation & Community
  |firstRelease=November 9, 2004
  |latestRelease=Firefox 140.0 (June 24, 2025)
  |status=Active
  |license=[https://www.mozilla.org/MPL/2.0/ Mozilla Public License 2.0]
  |os=Cross-platform (Linux, macOS, Windows, *BSD)
  |website=[https://www.mozilla.org/firefox mozilla.org/firefox]
  |github=mozilla/firefox
  |bugTracker=[https://bugzilla.mozilla.org/ Bugzilla]
  |documentation=[https://support.mozilla.org/ Official Support]
}}
<translate>
<!--T:1-->
<strong>Firefox</strong><ref>Mozilla Foundation, "Firefox", Official Website, Accessed June 2025. https://www.mozilla.org/firefox</ref> is a free and open-source web browser developed by the Mozilla Foundation. It is known for its focus on privacy, security, and user freedom, offering a customizable experience through a rich ecosystem of add-ons and themes.


== Installation ==
== Installation == <!--T:2-->


Set <code>programs.firefox.enable</code> to true in your system or [[Home Manager]] configuration.
==== Shell ==== <!--T:56-->
Keep in mind that the NixOS and Home Manager modules have different options, so choose accordingly.
</translate>


== Firefox Variants ==
{{code|lang=bash|line=no|1=$ nix-shell -p firefox}}


There are several Firefox variants that you can choose to install. To choose a variant, set <code>programs.firefox.package</code> accordingly.
<translate>
<!--T:57-->
The command above makes <code>firefox</code> available in your current shell without modifying any configuration files.


'''Note:''' The packages for the variants listed below are installed ''instead'' of the normal <code>firefox</code> package. Thus, you'll have to choose one among these options.
==== System setup ==== <!--T:58-->
</translate>


=== Variant: Official Binaries ===
{{code|lang=nix|line=no|1=# Example for /etc/nixos/configuration.nix
Mozilla provides official pre-built Firefox binaries. This is the <code>firefox-bin</code> package and will be downloaded directly from the Mozilla servers.
environment.systemPackages = [
  pkgs.firefox
];


=== Variant: ESR ===
# User-specific installation (in ~/.config/nixpkgs/home.nix)
<code>firefox-esr</code> is the '''E'''xtended '''S'''upport '''R'''elease of Firefox provided by Mozilla, which receives only security updates and a more relaxed cadence of feature implementation.
home.packages = [
  pkgs.firefox
];}}
<translate>
<!--T:59-->
After rebuilding with <code>nixos-rebuild switch</code>, Firefox will be installed system-wide.


=== Variant: Nightly ===
== Configuration == <!--T:60-->
Nightly builds are daily builds of Firefox from the central Mozilla repository.


==== Reproducible ====
==== Basic ==== <!--T:61-->
This method uses flakes to pull in nightly versions of Firefox in a reproducible way, and is recommended for use. If you don't want to use flakes, check out the next section.
</translate>


First, add the following inputs to your flake:
{{code|lang=nix|line=no|1=
programs.firefox = {
  enable = true;


<syntaxhighlight lang="nix">
  languagePacks = [ "en-US" "de" "fr" ];
inputs = {
 
  firefox.url = "github:nix-community/flake-firefox-nightly";
  preferences = {
   firefox.inputs.nixpkgs.follows = "nixpkgs";
    "browser.startup.homepage"      = "https://example.com";
    "privacy.resistFingerprinting" = true;
  };
 
   policies = {
    DisableTelemetry = true;
  };
};
};
</syntaxhighlight>
}}


Then, using the [[Flakes#Using_nix_flakes_with_NixOS|specialArgs]] attribute to pass flake inputs to external configuration files, add the nightly package to your system:
<translate>
<!--T:3-->
The snippet above enables Firefox for all users (or the current Home Manager profile, if placed in <code>home.nix</code>).


<syntaxhighlight lang="nix">
==== Advanced ==== <!--T:23-->
{ pkgs, inputs, config, ... }:
 
{
<!--T:24-->
  environment.systemPackages = [
Home Manager allows for deep customization of Firefox, including extensions, search engines, bookmarks, and themes. The example below shows a configuration for adding custom search engines with aliases.
    inputs.firefox.packages.${pkgs.system}.firefox-nightly-bin
</translate>
  ];
}
</syntaxhighlight>


The downside of using this method is that you'll have to update the flake input before you can get a new nightly version, which also means that you might miss new builds since the flake lags behind the nightly release.
{{code|lang=nix|line=no|1=
programs.firefox = {
  enable = true;


==== Non-reproducible (Impure) ====
  languagePacks = [ "en-US" ];
Using this method is bad for reproducibility since it fetches resources from non-pinned URLs, but it also means you always get the latest nightly version when you build your system.


{{tip|1=If you don't want to use flakes but you still want to reproducibly install Firefox nightly, you might want to use this method with [https://github.com/nmattia/niv niv].}}
  policies = {
    # Updates & Background Services
    AppAutoUpdate                = false;
    BackgroundAppUpdate          = false;


<syntaxhighlight lang="nix">
    # Feature Disabling
nixpkgs.overlays =
    DisableBuiltinPDFViewer      = true;
  let
    DisableFirefoxStudies        = true;
     # Change this to a rev sha to pin
    DisableFirefoxAccounts        = true;
     moz-rev = "master";
     DisableFirefoxScreenshots    = true;
     moz-url = builtins.fetchTarball { url = "https://github.com/mozilla/nixpkgs-mozilla/archive/${moz-rev}.tar.gz";};
     DisableForgetButton          = true;
     nightlyOverlay = (import "${moz-url}/firefox-overlay.nix");
     DisableMasterPasswordCreation = true;
   in [
    DisableProfileImport          = true;
     nightlyOverlay
     DisableProfileRefresh        = true;
  ];
    DisableSetDesktopBackground   = true;
programs.firefox.package = pkgs.latest.firefox-nightly-bin;
     DisablePocket                = true;
</syntaxhighlight>
    DisableTelemetry              = true;
    DisableFormHistory            = true;
    DisablePasswordReveal        = true;


Once you've added the overlay, you'll need to pass the <code>--impure</code> option to nix commands. For example, in order to build and activate your configuration, you'll have to run:
    # Access Restrictions
    BlockAboutConfig              = false;
    BlockAboutProfiles            = true;
    BlockAboutSupport            = true;


<syntaxHighlight lang="console">
    # UI and Behavior
$ nixos-rebuild switch --impure
    DisplayMenuBar                = "never";
</syntaxHighlight>
    DontCheckDefaultBrowser      = true;
    HardwareAcceleration          = false;
    OfferToSaveLogins            = false;
    DefaultDownloadDirectory      = "${home}/Downloads";


== Customizing with [[Home Manager]] ==
    # Extensions
Home manager allows more customization for firefox. Such as  extensions, search engines, bookmarks, [https://www.userchrome.org/ userChrome] and [https://kb.mozillazine.org/User.js_file user.js]. The example below shows a basic config defining Nix packages & options as a search engine.
    ExtensionSettings = let
      moz = short: "https://addons.mozilla.org/firefox/downloads/latest/${short}/latest.xpi";
    in {
      "*".installation_mode = "blocked";


[https://nix-community.github.io/home-manager/options.xhtml More options are available on Home Manager's site]<syntaxhighlight lang="nix">
      "uBlock0@raymondhill.net" = {
        install_url      = moz "ublock-origin";
        installation_mode = "force_installed";
        updates_disabled  = true;
      };


home-manager.users.username = {
      "{f3b4b962-34b4-4935-9eee-45b0bce58279}" = {
  programs.firefox = {
        install_url      = moz "animated-purple-moon-lake";
    enable = true;
        installation_mode = "force_installed";
    profiles = {
         updates_disabled  = true;
      "user" = {
      };
         id = 0;
        isDefault = true;


        search.engines = {
      "{73a6fe31-595d-460b-a920-fcc0f8843232}" = {
          "Nix Packages" = {
        install_url      = moz "noscript";
            urls = [{
        installation_mode = "force_installed";
              template = "https://search.nixos.org/packages";
        updates_disabled  = true;
              params = [
      };
                { name = "query"; value = "{searchTerms}"; }
    };
              ];
 
            }];
    # Extension configuration
            icon = "${pkgs.nixos-icons}/share/icons/hicolor/scalable/apps/nix-snowflake.svg";
    "3rdparty".Extensions = {
            definedAliases = [ "@np" ];
      "uBlock0@raymondhill.net".adminSettings = {
           };
        userSettings = rec {
           "Nix Options" = {
          uiTheme            = "dark";
            definedAliases = [ "@no" ];
           uiAccentCustom    = true;
            urls = [{
           uiAccentCustom0    = "#8300ff";
              template = "https://search.nixos.org/options";
          cloudStorageEnabled = mkForce false;
              params = [
 
                { name = "query"; value = "{searchTerms}"; }
          importedLists = [
              ];
            "https:#filters.adtidy.org/extension/ublock/filters/3.txt"
            }];
            "https:#github.com/DandelionSprout/adfilt/raw/master/LegitimateURLShortener.txt"
           };
          ];
 
           externalLists = lib.concatStringsSep "\n" importedLists;
         };
         };
        selectedFilterLists = [
          "CZE-0"
          "adguard-generic"
          "adguard-annoyance"
          "adguard-social"
          "adguard-spyware-url"
          "easylist"
          "easyprivacy"
          "https:#github.com/DandelionSprout/adfilt/raw/master/LegitimateURLShortener.txt"
          "plowe-0"
          "ublock-abuse"
          "ublock-badware"
          "ublock-filters"
          "ublock-privacy"
          "ublock-quick-fixes"
          "ublock-unbreak"
          "urlhaus-1"
        ];
       };
       };
     };
     };
   };
   };


  profiles.default.search = {
    force          = true;
    default        = "DuckDuckGo";
    privateDefault  = "DuckDuckGo";


</syntaxhighlight>
    engines = {
      "Nix Packages" = {
        urls = [
          {
            template = "https://search.nixos.org/packages";
            params = [
              { name = "channel"; value = "unstable"; }
              { name = "query";  value = "{searchTerms}"; }
            ];
          }
        ];
        icon          = "${pkgs.nixos-icons}/share/icons/hicolor/scalable/apps/nix-snowflake.svg";
        definedAliases = [ "@np" ];
      };


== FAQ ==
      "Nix Options" = {
        urls = [
          {
            template = "https://search.nixos.org/options";
            params = [
              { name = "channel"; value = "unstable"; }
              { name = "query";  value = "{searchTerms}"; }
            ];
          }
        ];
        icon          = "${pkgs.nixos-icons}/share/icons/hicolor/scalable/apps/nix-snowflake.svg";
        definedAliases = [ "@no" ];
      };


=== How do I use ALSA with Firefox instead of PulseAudio? ===
      "NixOS Wiki" = {
        urls = [
          {
            template = "https://wiki.nixos.org/w/index.php";
            params = [
              { name = "search"; value = "{searchTerms}"; }
            ];
          }
        ];
        icon          = "${pkgs.nixos-icons}/share/icons/hicolor/scalable/apps/nix-snowflake.svg";
        definedAliases = [ "@nw" ];
      };
    };
  };
};
}}
 
<translate>
<!--T:25-->
[https://nix-community.github.io/home-manager/options.xhtml#opt-programs.firefox.enable More options are available on Home Manager's site.]
 
== Firefox Variants == <!--T:4-->


<syntaxhighlight lang="nix">
<!--T:5-->
programs.firefox.package = (pkgs.wrapFirefox.override { libpulseaudio = pkgs.libpressureaudio; }) pkgs.firefox-unwrapped { };
There are several Firefox variants available. To choose one, set the <code>programs.firefox.package</code> option accordingly.
</syntaxhighlight>
</translate>


== Tips ==
{{Note|<translate><!--T:6--> The packages for the variants listed below are installed ''instead'' of the normal <code>firefox</code> package.</translate>}}


=== Enabling [https://community.kde.org/Plasma/Browser_Integration#How_to_install Plasma Browser Integration]  ===
<translate>
1. Add the following line to your <code>configuration.nix</code> (note that [[KDE#Installation|enabling Plasma]] automatically does this):
=== Variant: Official Binaries === <!--T:7-->


<syntaxhighlight lang="nix">
<!--T:8-->
programs.firefox.nativeMessagingHosts.packages = [ pkgs.plasma5Packages.plasma-browser-integration ];
Mozilla provides official pre-built Firefox binaries via the <code>firefox-bin</code> package, which are downloaded directly from Mozilla's servers.
</syntaxhighlight>


2. Install [https://addons.mozilla.org/en-US/firefox/addon/plasma-integration/ KDE's Firefox extension].
=== Variant: Extended Support Release (ESR) === <!--T:9-->


=== Use KDE file picker ===
<!--T:10-->
<code>firefox-esr</code> is a variant that receives security updates for a longer period with a slower feature implementation cadence. It also allows for more extensive policy-based configuration.


You must instruct Firefox to use the file picker offered by the XDG Desktop Portal framework. This setting can be found in Firefox's ''about:config'' as ''widget.use-xdg-desktop-portal.file-picker''. The value 1 means "always". To set it using NixOS, add to '<code>configuration.nix'</code>
=== Variant: Nightly === <!--T:11-->


<syntaxhighlight lang="nix">
<!--T:12-->
  # Make Firefox use the KDE file picker.
Nightly builds are daily builds from the central Mozilla repository.
  # Preferences source: https://wiki.archlinux.org/title/firefox#KDE_integration
  programs.firefox = {
    enable = true;
    preferences = {
      "widget.use-xdg-desktop-portal.file-picker" = 1;
    };
  };
</syntaxhighlight>


=== Use xinput2 ===
==== Method 1: Using nix-community/flake-firefox-nightly ==== <!--T:13-->


You can make Firefox use xinput2 by setting the <code>MOZ_USE_XINPUT2</code> environment variable. This improves touchscreen support and enables additional touchpad gestures. It also enables smooth scrolling as opposed to the stepped scrolling that Firefox has by default. To do this, put the following in your config:  
<!--T:14-->
This method is reproducible but may lag behind the upstream version. First, add the input to your flake:
</translate>


<syntaxhighlight lang="nix">
{{code|lang=nix|line=no|1=
environment.sessionVariables = {
inputs = {
   MOZ_USE_XINPUT2 = "1";
  firefox.url = "github:nix-community/flake-firefox-nightly";
   firefox.inputs.nixpkgs.follows = "nixpkgs";
};
};
</syntaxhighlight>
}}
 
<translate>
<!--T:16-->
Then, add the package to your system:
</translate>
 
{{code|lang=nix|line=no|1=
# In configuration.nix, assuming use of specialArgs
environment.systemPackages = [
  inputs.firefox.packages.${pkgs.stdenv.hostPlatform.system}.firefox-nightly-bin
];
}}
 
<translate>
==== Method 2: Using mozilla/nixpkgs-mozilla ==== <!--T:18-->
 
<!--T:19-->
This method is not necessarily reproducible without a flake-like system but will always be the latest version.
</translate>
 
{{code|lang=nix|line=no|1=
nixpkgs.overlays = [
  (import (builtins.fetchTarball "https://github.com/mozilla/nixpkgs-mozilla/archive/master.tar.gz"))
];
programs.firefox.package = pkgs.latest.firefox-nightly-bin;
}}
 
<translate>
<!--T:22-->
Using this method requires the <code>--impure</code> flag for Nix commands, for example:
</translate>
 
{{code|lang=bash|line=no|1=$ nixos-rebuild switch --impure}}
 
<translate>
== Tips and Tricks == <!--T:28-->
 
==== Force XWayland (X11) instead of Wayland ==== <!--T:62-->
 
<!--T:63-->
Firefox defaults to native Wayland when running under a Wayland compositor. To force it to use XWayland (X11) instead:
</translate>
 
{{code|lang=nix|line=no|1=environment.sessionVariables.MOZ_ENABLE_WAYLAND = "0";}}
 
<translate>
<!--T:30a-->
This is useful when troubleshooting Wayland-specific issues or when certain features work better under X11.
 
==== Touchpad Gestures and Smooth Scrolling ==== <!--T:34-->


== Troubleshooting==
<!--T:35-->
Enable <code>xinput2</code> to improve touchscreen support and enable additional touchpad gestures and smooth scrolling.
</translate>


=== If you can't start the browser because of a configuration error ===  
{{code|lang=nix|line=no|1=
environment.sessionVariables.MOZ_USE_XINPUT2 = "1";
}}


For example:  
<translate>
==== KDE Plasma Integration ==== <!--T:29-->


<syntaxhighlight lang="text">
<!--T:30-->
firefox
1. Add the native messaging host package to your configuration:
1554035168269 Marionette FATAL XML parsing error: undefined entity
</translate>
Location: chrome://browser/content/browser.xul
Line 2526, column 13:            <toolbarbutton id="tracking-protection-preferences-button"
JavaScript error: resource:///modules/aboutpages/AboutPrivateBrowsingHandler.jsm, line 28: TypeError: this.pageListener is undefined
</syntaxhighlight>


An easy way to get away from this is to start firefox with the <code>firefox -safe-mode</code> command. Then you can troubleshoot your actual problem or you can call your luck by calling the refresh option (a special button will appear when firefox starts in this mode). This will reset your configuration to a sane state and you will be usually able to start the browser again, but you will lose most of your customization.
{{code|lang=nix|line=no|1=programs.firefox.nativeMessagingHosts.packages = [ pkgs.kdePackages.plasma-browser-integration ];}}


=== <code>nativeMessagingHosts</code> doesn't work ===
<translate>
<!--T:31-->
2. Install the corresponding [https://addons.mozilla.org/en-US/firefox/addon/plasma-integration/ browser add-on].


such as <code>enablePlasmaBrowserIntegration</code>, <code>enableGnomeExtensions</code>, and <code>enableBrowserpass</code>.
==== Use KDE file picker ==== <!--T:32-->


They do not work with the <code>firefox-bin</code> derivation<ref>https://github.com/NixOS/nixpkgs/issues/47340#issuecomment-476368401</ref> or with <code>firefox</code> installed via <code>nix-env</code>
<!--T:33-->
To use the KDE file picker instead of the GTK one, set the following preference:
</translate>


<hr />
{{code|lang=nix|line=no|1=
<references />
programs.firefox.preferences = {
  "widget.use-xdg-desktop-portal.file-picker" = 1;
};
}}


=== Screen Sharing under Wayland ===
<translate>
== Troubleshooting == <!--T:36-->


When using Firefox with Wayland, screen sharing options might be limited and require additional configuration (exact capabilities vary with different compositors).
==== Native Messaging Hosts Fail to Load ==== <!--T:40-->


* add Pipewire support to Firefox:<syntaxhighlight lang="nix">
<!--T:42-->
environment.systemPackages = [
Native messaging hosts (used for extensions like Plasma Integration) do not work with the <code>-bin</code> variants of Firefox or with Firefox installed imperatively via <code>nix-env</code>. You must use a variant built from source via your NixOS or Home Manager configuration.
  # Replace this
 
  pkgs.firefox
==== ALSA audio instead of PulseAudio ==== <!--T:27-->
  # With this
 
  (pkgs.wrapFirefox (pkgs.firefox-unwrapped.override { pipewireSupport = true;}) {})
<!--T:64-->
];
To force Firefox to use ALSA, you can override it with a wrapper:
</syntaxhighlight>
</translate>
* Enable [https://pipewire.org/ PipeWire]:<syntaxhighlight lang="nix">
 
{{code|lang=nix|line=no|1=programs.firefox.package = pkgs.wrapFirefox pkgs.firefox-unwrapped { libpulseaudio = pkgs.libalsa; };}}
 
<translate>
==== Screen Sharing under Wayland ==== <!--T:43-->
 
<!--T:44-->
Screen sharing on Wayland requires enabling PipeWire and the appropriate XDG Desktop Portals.
</translate>
 
{{code|lang=nix|line=no|1=
services.pipewire.enable = true;
services.pipewire.enable = true;
</syntaxhighlight>
xdg.portal = {
* Enable [https://github.com/flatpak/xdg-desktop-portal/blob/master/README.md xdg desktop integration]:<syntaxhighlight lang="nix">
   enable = true;
xdg = {
  # Add the portal for your compositor, e.g.:
   portal = {
  extraPortals = with pkgs; [
    enable = true;
    xdg-desktop-portal-wlr # For Sway/wlroots
    extraPortals = with pkgs; [
    # xdg-desktop-portal-gtk # For GNOME
      xdg-desktop-portal-wlr
     # xdg-desktop-portal-kde # For KDE
      xdg-desktop-portal-gtk
   ];
     ];
  };
};
</syntaxhighlight>
* Set environment variables to hint Firefox to use Wayland features. E.g.:<syntaxhighlight lang="nix">
# Classical NixOS setup
environment.sessionVariables = {
  # only needed for Sway
   XDG_CURRENT_DESKTOP = "sway";  
};
};
}}
<translate>
== See also == <!--T:65-->
<!--T:66-->
* [[Home Manager]] – Declarative per-user configuration
* [https://search.nixos.org/options?channel=unstable&query=programs.firefox NixOS options for Firefox]
* [https://discourse.nixos.org/tag/firefox Firefox topics on NixOS Discourse]


# Home Manager setup
== References == <!--T:67-->
home.sessionVariables = {
</translate>
  # only needed for Sway
  XDG_CURRENT_DESKTOP = "sway";
};
</syntaxhighlight>
* Ensure that the environment variables are correctly set for the user systemd units, e.g.:<syntaxhighlight lang="bash">
# Sway users might achieve this by adding the following to their Sway config file
# This ensures all user units started after the command (not those already running) set the variables
exec systemctl --user import-environment
</syntaxhighlight>


[[Category:Cookbook]]
[[Category:Applications]]
[[Category:Applications]]
[[Category:Web Browser]]
Retrieved from "https://wiki.nixos.org/wiki/Firefox"