Export translations

Settings

Group

Language

Format

Export for off-line translation

Export in native format

Export in CSV format

<div lang="en" dir="ltr" class="mw-content-ltr">
[https://www.mozilla.org/firefox Firefox] is a graphical web browser developed by Mozilla. It can be used with a [[Firefox Sync Server]].
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
== Installation ==
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
Set <code>programs.firefox.enable</code> to true in your system or [[Home Manager]] configuration.
Keep in mind that the NixOS and Home Manager modules have different options, so choose accordingly.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
== Firefox Variants ==
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
There are several Firefox variants that you can choose to install. To choose a variant, set <code>programs.firefox.package</code> accordingly.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
'''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.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
=== Variant: Official Binaries ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
Mozilla provides official pre-built Firefox binaries. This is the <code>firefox-bin</code> package and will be downloaded directly from the Mozilla servers.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
=== Variant: ESR ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
<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.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
=== Variant: Nightly ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
Nightly builds are daily builds of Firefox from the central Mozilla repository.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
==== Reproducible ====
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
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.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
First, add the following inputs to your flake:
</div>
<syntaxhighlight lang="nix">
inputs = {
  firefox.url = "github:nix-community/flake-firefox-nightly";
  firefox.inputs.nixpkgs.follows = "nixpkgs";
};
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
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:
</div>
<syntaxhighlight lang="nix">
{ pkgs, inputs, config, ... }:
{
  environment.systemPackages = [
    inputs.firefox.packages.${pkgs.system}.firefox-nightly-bin
  ];
}
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
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.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
==== Non-reproducible (Impure) ====
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
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.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
{{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].}}
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
<syntaxhighlight lang="nix">
nixpkgs.overlays =
  let
    # Change this to a rev sha to pin
    moz-rev = "master";
    moz-url = builtins.fetchTarball { url = "https://github.com/mozilla/nixpkgs-mozilla/archive/${moz-rev}.tar.gz";};
    nightlyOverlay = (import "${moz-url}/firefox-overlay.nix");
  in [
    nightlyOverlay
  ];
programs.firefox.package = pkgs.latest.firefox-nightly-bin;
</syntaxhighlight>
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
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:
</div>
<syntaxHighlight lang="console">
$ nixos-rebuild switch --impure
</syntaxHighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
== Customizing with [[Home Manager]] ==
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
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.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
[https://nix-community.github.io/home-manager/options.xhtml More options are available on Home Manager's site]
</div>
<syntaxhighlight lang="nix">
home-manager.users.username = {
  programs.firefox = {
    enable = true;
    profiles = {
      "user" = {
        id = 0;
        isDefault = true;

search.engines = {
          "Nix Packages" = {
            urls = [{
              template = "https://search.nixos.org/packages";
              params = [
                { name = "query"; value = "{searchTerms}"; }
              ];
            }];
            icon = "${pkgs.nixos-icons}/share/icons/hicolor/scalable/apps/nix-snowflake.svg";
            definedAliases = [ "@np" ];
          };
          "Nix Options" = {
            definedAliases = [ "@no" ];
            urls = [{
              template = "https://search.nixos.org/options";
              params = [
                { name = "query"; value = "{searchTerms}"; }
              ];
            }];
          };
        };
      };
    };
  };
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
== FAQ ==
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
=== How do I use ALSA with Firefox instead of PulseAudio? ===
</div>
<syntaxhighlight lang="nix">
programs.firefox.package = (pkgs.wrapFirefox.override { libpulseaudio = pkgs.libpressureaudio; }) pkgs.firefox-unwrapped { };
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
== Tips ==
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
=== Enabling
[https://community.kde.org/Plasma/Browser_Integration#How_to_install Plasma Browser Integration] ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
1. Add the following line to your <code>configuration.nix</code> (note that [[KDE#Installation|enabling Plasma]] automatically does this):
</div>

<syntaxhighlight lang="nix">
programs.firefox.nativeMessagingHosts.packages = [ pkgs.plasma5Packages.plasma-browser-integration ];
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
2. Install [https://addons.mozilla.org/en-US/firefox/addon/plasma-integration/ KDE's Firefox extension].
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
=== Use KDE file picker ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
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>
</div>
<syntaxhighlight lang="nix">
  # Make Firefox use the KDE file picker.
  # Preferences source: https://wiki.archlinux.org/title/firefox#KDE_integration
  programs.firefox = {
    enable = true;
    preferences = {
      "widget.use-xdg-desktop-portal.file-picker" = 1;
    };
  };
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
=== Use xinput2 ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
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:
</div> 
<syntaxhighlight lang="nix">
environment.sessionVariables = {
  MOZ_USE_XINPUT2 = "1";
};
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
== Troubleshooting==
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
=== If you can't start the browser because of a configuration error ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
For example:
</div> 
<syntaxhighlight lang="text">
firefox
1554035168269	Marionette	FATAL	XML parsing error: undefined entity
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>
<div lang="en" dir="ltr" class="mw-content-ltr">
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.
</div> 
<div lang="en" dir="ltr" class="mw-content-ltr">
=== <code>nativeMessagingHosts</code> doesn't work ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
Such as <code>enablePlasmaBrowserIntegration</code>, <code>enableGnomeExtensions</code>, and <code>enableBrowserpass</code>.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
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>
</div>
<hr />
<references />
<div lang="en" dir="ltr" class="mw-content-ltr">
=== Screen Sharing under Wayland ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
When using Firefox with Wayland, screen sharing options might be limited and require additional configuration (exact capabilities vary with different compositors).
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
* add Pipewire support to Firefox:
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
<syntaxhighlight lang="nix">
# when programs.firefox.enable == true
programs.firefox.wrapperConfig = {
  pipewireSupport = true;
};
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
# or, alternatively
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
environment.systemPackages = [
  # Replace this
  pkgs.firefox
  # With this
  (pkgs.wrapFirefox (pkgs.firefox-unwrapped.override { pipewireSupport = true;}) {})
];
</syntaxhighlight>
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
* Enable [https://pipewire.org/ PipeWire]
</div>
<syntaxhighlight lang="nix">
services.pipewire.enable = true;
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
* Enable [https://github.com/flatpak/xdg-desktop-portal/blob/master/README.md xdg desktop integration]:
</div>
<syntaxhighlight lang="nix">
xdg = {
  portal = {
    enable = true;
    extraPortals = with pkgs; [
      xdg-desktop-portal-wlr
      xdg-desktop-portal-gtk
    ];
  };
};
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
* Set environment variables to hint Firefox to use Wayland features. E.g.:
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
<syntaxhighlight lang="nix">
# Classical NixOS setup
environment.sessionVariables = {
  # only needed for Sway
  XDG_CURRENT_DESKTOP = "sway"; 
};
</syntaxhighlight>
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
<syntaxhighlight lang="nix">
# Home Manager setup
home.sessionVariables = {
  # only needed for Sway
  XDG_CURRENT_DESKTOP = "sway"; 
};
</syntaxhighlight>
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
* Ensure that the environment variables are correctly set for the user systemd units, e.g.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
# 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
</div>
<syntaxhighlight lang="bash">
exec systemctl --user import-environment
</syntaxhighlight>

[[Category:Cookbook]]
[[Category:Applications]]