about summary refs log tree commit diff
path: root/nixos/modules/programs/firefox.nix
blob: 76e6c1a553f3a1818d967f69f5746dad655f9caf (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
{ pkgs, config, lib, ... }:

with lib;

let
  cfg = config.programs.firefox;

  policyFormat = pkgs.formats.json { };

  organisationInfo = ''
    When this option is in use, Firefox will inform you that "your browser
    is managed by your organisation". That message appears because NixOS
    installs what you have declared here such that it cannot be overridden
    through the user interface. It does not mean that someone else has been
    given control of your browser, unless of course they also control your
    NixOS configuration.
  '';

in {
  options.programs.firefox = {
    enable = mkEnableOption (mdDoc "the Firefox web browser");

    package = mkOption {
      description = mdDoc "Firefox package to use.";
      type = types.package;
      default = pkgs.firefox;
      defaultText = literalExpression "pkgs.firefox";
      relatedPackages = [
        "firefox"
        "firefox-beta-bin"
        "firefox-bin"
        "firefox-devedition-bin"
        "firefox-esr"
        "firefox-esr-wayland"
        "firefox-wayland"
      ];
    };

    policies = mkOption {
      description = mdDoc ''
        Group policies to install.

        See [Mozilla's documentation](https://github.com/mozilla/policy-templates/blob/master/README.md")
        for a list of available options.

        This can be used to install extensions declaratively! Check out the
        documentation of the `ExtensionSettings` policy for details.

        ${organisationInfo}
      '';
      type = policyFormat.type;
      default = {};
    };

    preferences = mkOption {
      description = mdDoc ''
        Preferences to set from `about://config`.

        Some of these might be able to be configured more ergonomically
        using policies.

        ${organisationInfo}
      '';
      type = with types; attrsOf (oneOf [ bool int string ]);
      default = {};
    };
  };

  config = mkIf cfg.enable {
    environment.systemPackages = [ cfg.package ];

    environment.etc."firefox/policies/policies.json".source =
      let policiesJSON =
        policyFormat.generate
        "firefox-policies.json"
        { inherit (cfg) policies; };
      in mkIf (cfg.policies != {}) "${policiesJSON}";

    # Preferences are converted into a policy
    programs.firefox.policies =
      mkIf (cfg.preferences != {})
      {
        Preferences = (mapAttrs (name: value: {
          Value = value;
          Status = "locked";
        }) cfg.preferences);
      };
  };

  meta.maintainers = with maintainers; [ danth ];
}