aboutsummaryrefslogtreecommitdiff
path: root/infra/libkookie/nixpkgs/doc/builders/packages/firefox.section.md
diff options
context:
space:
mode:
Diffstat (limited to 'infra/libkookie/nixpkgs/doc/builders/packages/firefox.section.md')
-rw-r--r--infra/libkookie/nixpkgs/doc/builders/packages/firefox.section.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/infra/libkookie/nixpkgs/doc/builders/packages/firefox.section.md b/infra/libkookie/nixpkgs/doc/builders/packages/firefox.section.md
new file mode 100644
index 000000000000..28fa3f0dbd7c
--- /dev/null
+++ b/infra/libkookie/nixpkgs/doc/builders/packages/firefox.section.md
@@ -0,0 +1,49 @@
+# Firefox {#sec-firefox}
+
+## Build wrapped Firefox with extensions and policies
+
+The `wrapFirefox` function allows to pass policies, preferences and extension that are available to firefox. With the help of `fetchFirefoxAddon` this allows build a firefox version that already comes with addons pre-installed:
+
+```nix
+{
+ myFirefox = wrapFirefox firefox-unwrapped {
+ nixExtensions = [
+ (fetchFirefoxAddon {
+ name = "ublock";
+ url = "https://addons.mozilla.org/firefox/downloads/file/3679754/ublock_origin-1.31.0-an+fx.xpi";
+ sha256 = "1h768ljlh3pi23l27qp961v1hd0nbj2vasgy11bmcrlqp40zgvnr";
+ })
+ ];
+
+ extraPolicies = {
+ CaptivePortal = false;
+ DisableFirefoxStudies = true;
+ DisablePocket = true;
+ DisableTelemetry = true;
+ DisableFirefoxAccounts = true;
+ FirefoxHome = {
+ Pocket = false;
+ Snippets = false;
+ };
+ UserMessaging = {
+ ExtensionRecommendations = false;
+ SkipOnboarding = true;
+ };
+ };
+
+ extraPrefs = ''
+ // Show more ssl cert infos
+ lockPref("security.identityblock.show_extended_validation", true);
+ '';
+ };
+}
+```
+
+If `nixExtensions != null` then all manually installed addons will be uninstalled from your browser profile.
+To view available enterprise policies visit [enterprise policies](https://github.com/mozilla/policy-templates#enterprisepoliciesenabled)
+or type into the Firefox url bar: `about:policies#documentation`.
+Nix installed addons do not have a valid signature, which is why signature verification is disabled. This does not compromise security because downloaded addons are checksumed and manual addons can't be installed.
+
+## Troubleshooting {#sec-firefox-troubleshooting}
+If addons do not appear installed although they have been defined in your nix configuration file reset the local addon state of your Firefox profile by clicking `help -> restart with addons disabled -> restart -> refresh firefox`. This can happen if you switch from manual addon mode to nix addon mode and then back to manual mode and then again to nix addon mode.
+