nixos/firefox: add more options #201033

linsui · 2022-11-13T14:16:26Z

Description of changes

add preferencesStatus for preferences
add autoConfig since many config are not available in preferences
add nativeMessagingHosts options
fix error: The option `environment.etc."firefox/policies/policies.json".source' is used but not defined.

enableGnomeExtensions and enablePlasmaBrowserIntegration are not added since they are covered by other modules. wmc-mpris is not added since it's deprecated. chrome-token-signing is not added because it should be migrated to web-eid first.

Things done

linsui · 2022-11-13T14:36:17Z

nixos/modules/programs/firefox.nix

-    environment.systemPackages = [ cfg.package ];
+    environment.systemPackages = [
+      (cfg.package.override {
+        extraPrefs = cfg.autoConfig;


Firefox may support read this from etc. https://bugzilla.mozilla.org/show_bug.cgi?id=1170092 We can also apply the patch.

According to https://github.com/pyllyukko/user.js#system-wide-installation-all-platforms /etc/firefox/syspref.js is supported but I didn't find docs and it seems the api is unstable.

It would be good to read this from /etc if possible, as that avoids rebuilding the package.

AutoConfig in etc requires a patch so we should ask firefox maintains. @lovesegfault @mweinelt

I have no interest in this module.

Then let's wait upstream. Using the wrapper for now should be good enough.

danth

Looks good to me.

The "used but not defined" error will hit unstable soon so we should try and get this merged.

nixos/modules/programs/firefox.nix

nixos-discourse · 2022-11-17T07:44:12Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/prs-already-reviewed/2617/679

SuperSandro2000

The commit message is a bit meaningless.

SuperSandro2000 · 2022-11-17T21:08:18Z

nixos/modules/programs/firefox.nix

+        policiesJSON =
+          policyFormat.generate
+            "firefox-policies.json"
+            { inherit (cfg) policies; };


Suggested change

policiesJSON =

policyFormat.generate

"firefox-policies.json"

{ inherit (cfg) policies; };

policiesJSON = policyFormat.generate "firefox-policies.json" { inherit (cfg) policies; };

SuperSandro2000 · 2022-11-17T21:13:19Z

nixos/modules/programs/firefox.nix

+        - `"default"`: Read/Write: Settings appear as default even if factory default differs.
+        - `"locked"`: Read-Only: Settings appear as default even if factory default differs.
+        - `"user"`: Read/Write: Settings appear as changed if it differs from factory default.
+        - `"clear"`: Read/Write: Value has no effect. Resets to factory defaults on each startup.


What means Read/write here? Which settings? That is not clear from the explanation.

SuperSandro2000 · 2022-11-17T21:14:40Z

nixos/modules/programs/firefox.nix

+      description = mdDoc ''
+        The status of `firefox.preferences`.
+
+        `status` can be "default", "locked", "user" or "clear"
+        - `"default"`: Read/Write: Settings appear as default even if factory default differs.
+        - `"locked"`: Read-Only: Settings appear as default even if factory default differs.
+        - `"user"`: Read/Write: Settings appear as changed if it differs from factory default.
+        - `"clear"`: Read/Write: Value has no effect. Resets to factory defaults on each startup.
+      '';
+      type = types.enum [ "default" "locked" "user" "clear" ];
+      default = "locked";


Normally we would order type, default and description but all other things are like this too, so whatever.

SuperSandro2000 · 2022-11-17T21:15:37Z

nixos/modules/programs/firefox.nix

+        AutoConfig files can be used to set and lock preferences that are not covered
+        by the policies.json for Mac and Linux. This method can be used to automatically
+        change user preferences or prevent the end user from modifiying specific
+        preferences by locking them.


Where would I find more information how to use this?

SuperSandro2000 · 2022-11-17T21:50:55Z

nixos/modules/programs/firefox.nix

+      browserpass = mkEnableOption (mdDoc "Browserpass support");
+      bukubrow = mkEnableOption (mdDoc "Bukubrow support");
+      ff2mpv = mkEnableOption (mdDoc "ff2mpv support");
+      fxCast = mkEnableOption (mdDoc "fx_cast support");
+      gsconnect = mkEnableOption (mdDoc "GSConnect support");
+      jabref = mkEnableOption (mdDoc "JabRef support");
+      passff = mkEnableOption (mdDoc "PassFF support");
+      tridactyl = mkEnableOption (mdDoc "Tridactyl support");
+      ugetIntegrator = mkEnableOption (mdDoc "Uget Integrator support");


Can we express this a bit smarter and shorter?

I'm not sure... What's your suggestion?

something like mapAttrs (_: v: mkEnableOption (mdDoc v)) { browserpass = "Browserpass support"; … } maybe?

Ah, got it. Thanks!

AndersonTorres · 2022-11-18T02:14:17Z

nixos/modules/programs/firefox.nix

+      description = mdDoc ''
+        The status of `firefox.preferences`.
+
+        `status` can be "default", "locked", "user" or "clear"


Suggested change

`status` can be "default", "locked", "user" or "clear"

`status` can assume the following values:

linsui · 2022-11-18T03:17:34Z

I applied suggestions and split the commits.

... and nativeMessagingHosts

linsui · 2022-12-04T11:57:17Z

Is this good enough to merge? What else should I do?

AndersonTorres · 2022-12-04T14:32:11Z

Nothing.

linsui · 2022-12-04T15:18:52Z

Thanks!

RossComputerGuy · 2023-01-13T16:52:49Z

Can we get this backported to 22.11 please? I ran into an error that this PR will fix.

github-actions · 2023-01-13T16:59:07Z

Successfully created backport PR #210557 for release-22.11.

flokli · 2023-04-20T17:35:11Z

Hmmh, the way this is currently wired together doesn't allow passing nixpkgs.config.firefox additional, not-yet-wired-into-the-module-system native messaging hosts: #227303. Would welcome any input :-)

github-actions bot added 6.topic: nixos 8.has: module (update) labels Nov 13, 2022

ofborg bot added 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 labels Nov 13, 2022

linsui requested a review from danth November 13, 2022 14:31

linsui commented Nov 13, 2022

View reviewed changes

danth approved these changes Nov 13, 2022

View reviewed changes

nixos/modules/programs/firefox.nix Outdated Show resolved Hide resolved

linsui requested a review from AndersonTorres November 13, 2022 16:38

SuperSandro2000 reviewed Nov 17, 2022

View reviewed changes

AndersonTorres reviewed Nov 18, 2022

View reviewed changes

linsui force-pushed the firefox branch 2 times, most recently from 1d6a730 to f3555d4 Compare November 18, 2022 03:14

linsui added 4 commits November 19, 2022 17:50

nixos/firefox: fix "The option is used but not defined"

6120738

nixos/firefox: lint

b9778b3

nixos/firefox: add preferencesStatus, autoConfig

958cdd7

... and nativeMessagingHosts

nixos/firefox: remove firefox-wayland

7370fcf

linsui force-pushed the firefox branch from f3555d4 to 7370fcf Compare November 19, 2022 09:55

linsui requested review from SuperSandro2000 and AndersonTorres November 26, 2022 03:20

SuperSandro2000 removed their request for review December 4, 2022 01:32

AndersonTorres merged commit 3ec5fa6 into NixOS:master Dec 4, 2022

linsui deleted the firefox branch December 4, 2022 15:18

SuperSandro2000 added the backport release-22.11 label Jan 13, 2023

github-actions bot mentioned this pull request Jan 13, 2023

[Backport release-22.11] nixos/firefox: add more options #210557

Merged

1 task

flokli mentioned this pull request Apr 20, 2023

firefox module: unable to pass third-party native messaging hosts #227303

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nixos/firefox: add more options #201033

nixos/firefox: add more options #201033

linsui commented Nov 13, 2022 •

edited

linsui Nov 13, 2022

linsui Nov 13, 2022

danth Nov 13, 2022

linsui Nov 13, 2022

mweinelt Nov 13, 2022

linsui Nov 13, 2022

danth left a comment

nixos-discourse commented Nov 17, 2022

SuperSandro2000 left a comment

SuperSandro2000 Nov 17, 2022

SuperSandro2000 Nov 17, 2022

SuperSandro2000 Nov 17, 2022

SuperSandro2000 Nov 17, 2022

SuperSandro2000 Nov 17, 2022

linsui Nov 18, 2022

ajs124 Nov 18, 2022

linsui Nov 18, 2022

AndersonTorres Nov 18, 2022

linsui commented Nov 18, 2022

linsui commented Dec 4, 2022

AndersonTorres commented Dec 4, 2022

linsui commented Dec 4, 2022

RossComputerGuy commented Jan 13, 2023

github-actions bot commented Jan 13, 2023

flokli commented Apr 20, 2023

	`status` can be "default", "locked", "user" or "clear"
	`status` can assume the following values:

nixos/firefox: add more options #201033

nixos/firefox: add more options #201033

Conversation

linsui commented Nov 13, 2022 • edited

Description of changes

Things done

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danth left a comment

Choose a reason for hiding this comment

nixos-discourse commented Nov 17, 2022

SuperSandro2000 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

linsui commented Nov 18, 2022

linsui commented Dec 4, 2022

AndersonTorres commented Dec 4, 2022

linsui commented Dec 4, 2022

RossComputerGuy commented Jan 13, 2023

github-actions bot commented Jan 13, 2023

flokli commented Apr 20, 2023

linsui commented Nov 13, 2022 •

edited