summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJörg Thalheim <joerg@thalheim.io>2020-12-02 09:49:43 +0100
committerJörg Thalheim <joerg@thalheim.io>2020-12-02 10:02:22 +0100
commit7c8994e40e411d5b0a151b3891a57a73006d0e8d (patch)
tree815785bbef034c9bb1fde5e93625efb758e59999 /doc
parent9712bbdf7454be4f35a290bc2be23042dff8c60d (diff)
doc/firefox: initial documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/builders/packages/firefox.section.md40
-rw-r--r--doc/builders/packages/index.xml1
2 files changed, 41 insertions, 0 deletions
diff --git a/doc/builders/packages/firefox.section.md b/doc/builders/packages/firefox.section.md
new file mode 100644
index 000000000000..2f89da2d4595
--- /dev/null
+++ b/doc/builders/packages/firefox.section.md
@@ -0,0 +1,40 @@
+# 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 {
+ extraExtensions = [
+ (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);
+ '';
+ };
+}
+```
diff --git a/doc/builders/packages/index.xml b/doc/builders/packages/index.xml
index 3c9a56a81b7f..6d7537bb36de 100644
--- a/doc/builders/packages/index.xml
+++ b/doc/builders/packages/index.xml
@@ -10,6 +10,7 @@
<xi:include href="eclipse.xml" />
<xi:include href="elm.xml" />
<xi:include href="emacs.xml" />
+ <xi:include href="firefox.section.xml" />
<xi:include href="ibus.xml" />
<xi:include href="kakoune.section.xml" />
<xi:include href="linux.xml" />