Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

programs.firefoxpwa.enable

Whether to enable Progressive Web Apps for Firefox.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.firefoxpwa.package

The firefoxpwa package to use.

Type: null or package

Default:

pkgs.firefoxpwa

Declared by:

programs.firefoxpwa.profiles

Attribute set of profile options. The keys of that attribute set consist of ULIDs. A ULID is made of 26 characters, each of which is one of ‘0123456789ABCDEFGHJKMNPQRSTVWXYZ’ (Excluding I, L, O and U). See https://github.com/ulid/spec?tab=readme-ov-file#canonical-string-representation.

Type: attribute set of (submodule)

Default:

{ }

Example:

{
  "0123456789ABCDEFGHJKMNPQRSTVWXYZ".sites."ZYXWVTSRQPNMKJHGFEDCBA9876543210" = {
    name = "MDN Web Docs";
    url = "https://developer.mozilla.org/";
    manifestUrl = "https://developer.mozilla.org/manifest.f42880861b394dd4dc9b.json";
    desktopEntry.icon = pkgs.fetchurl {
      url = "https://developer.mozilla.org/favicon-192x192.png";
      sha256 = "0p8zgf2ba48l2pq1gjcffwzmd9kfmj9qc0v7zpwf2qd54fndifxr";
    };
  };
}

Declared by:

programs.firefoxpwa.profiles.<name>.name

Name of the profile.

Type: string

Default:

"‹name›"

Declared by:

programs.firefoxpwa.profiles.<name>.settings

Settings for this profile. See https://github.com/filips123/PWAsForFirefox/blob/cb4fc76873cc51129d9290754768e6a340c521b2/native/src/components/profile.rs#L13-L34 for a list of available options.

Type: JSON value

Default:

{ }

Declared by:

programs.firefoxpwa.profiles.<name>.sites

Attribute set of site options for this profile. The keys of that attribute set consist of ULIDs. A ULID is made of 26 characters, each of which is one of ‘0123456789ABCDEFGHJKMNPQRSTVWXYZ’ (Excluding I, L, O and U). See https://github.com/ulid/spec?tab=readme-ov-file#canonical-string-representation. Site ULIDs must be unique across profiles.

Type: attribute set of (submodule)

Default:

{ }

Declared by:

programs.firefoxpwa.profiles.<name>.sites.<name>.desktopEntry.enable

Whether to enable the desktop entry for this site.

Type: boolean

Default:

"true if host platform is Linux"

Declared by:

programs.firefoxpwa.profiles.<name>.sites.<name>.desktopEntry.categories

Categories in which the entry should be shown in a menu.

Type: null or (list of string)

Default:

null

Declared by:

programs.firefoxpwa.profiles.<name>.sites.<name>.desktopEntry.icon

Icon to display in file manager, menus, etc.

Type: null or string or absolute path

Default:

null

Example:

pkgs.fetchurl {
  url = "https://developer.mozilla.org/favicon-192x192.png";
  sha256 = "0p8zgf2ba48l2pq1gjcffwzmd9kfmj9qc0v7zpwf2qd54fndifxr";
}

Declared by:

programs.firefoxpwa.profiles.<name>.sites.<name>.manifestUrl

URL of the site’s web app manifest.

Type: string

Example:

"https://developer.mozilla.org/manifest.f42880861b394dd4dc9b.json"

Declared by:

programs.firefoxpwa.profiles.<name>.sites.<name>.name

Name of the site.

Type: string

Default:

"‹name›"

Example:

"MDN Web Docs"

Declared by:

programs.firefoxpwa.profiles.<name>.sites.<name>.settings

Settings for this site. See https://github.com/filips123/PWAsForFirefox/blob/cb4fc76873cc51129d9290754768e6a340c521b2/native/src/components/site.rs#L98-L115 for a list of available options.

Type: JSON value

Default:

{ }

Example:

{
  config = {
    manifest_url = "https://developer.mozilla.org/manifest.f42880861b394dd4dc9b.json";
  };
}

Declared by:

programs.firefoxpwa.profiles.<name>.sites.<name>.url

Start URL of the site.

Type: string

Example:

"https://developer.mozilla.org/"

Declared by:

programs.firefoxpwa.settings

Settings to be written to the configuration file. See https://github.com/filips123/PWAsForFirefox/blob/cb4fc76873cc51129d9290754768e6a340c521b2/native/src/storage.rs#L61-L77 for a list of available options.

Type: JSON value

Default:

{ }

Declared by: