diff --git a/options.xhtml b/options.xhtml index 1156f5ccc..d09b27300 100644 --- a/options.xhtml +++ b/options.xhtml @@ -20261,6 +20261,892 @@ strings concatenated with “\n”
+programs.floorp.enable
+
+
+Whether to enable Floorp.
+ +Type: +boolean
+ +Default:
+false
Example:
+true
Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.enableGnomeExtensions
+
+
+Whether to enable the GNOME Shell native host connector. Note, you
+also need to set the NixOS option
+services.gnome.gnome-browser-connector.enable
to
+true
.
Type: +boolean
+ +Default:
+false
Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.package
+
+
+The Floorp package to use. If state version ≥ 19.09 then
+this should be a wrapped Floorp package. For earlier state
+versions it should be an unwrapped Floorp package.
+Set to null
to disable installing Floorp.
Type: +null or package
+ +Default:
+pkgs.floorp
Example:
pkgs.floorp.override {
+ # See nixpkgs' firefox/wrapper.nix to check which options you can use
+ nativeMessagingHosts = [
+ # Gnome shell native connector
+ pkgs.gnome-browser-connector
+ # Tridactyl native connector
+ pkgs.tridactyl-native
+ ];
+}
+
+
+
+Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.finalPackage
+
+
+Resulting Floorp package.
+ +Type: +null or package (read only)
+ +Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.languagePacks
+
+
+The language packs to install. Available language codes can be found
+on the releases page:
+https://releases.mozilla.org/pub/firefox/releases/${version}/linux-x86_64/xpi/
,
+replacing ${version}
with the version of Firefox you have.
Type: +list of string
+ +Default:
+[ ]
Example:
[
+ "en-GB"
+ "de"
+]
+
+
+Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.nativeMessagingHosts
+
+
+Additional packages containing native messaging hosts that should be +made available to Floorp extensions.
+ +Type: +list of package
+ +Default:
+[ ]
Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.policies
+
+
+Type: +attribute set of (JSON value)
+ +Default:
+{ }
Example:
{
+ BlockAboutConfig = true;
+ DefaultDownloadDirectory = "\${home}/Downloads";
+}
+
+
+Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles
+
+
+Attribute set of Floorp profiles.
+ +Type: +attribute set of (submodule)
+ +Default:
+{ }
Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.bookmarks
+
+
+Preloaded bookmarks. Note, this may silently overwrite any +previously existing bookmarks!
+ +Type: +(list of ((bookmark submodule) or (directory submodule))) or (attribute set of ((bookmark submodule) or (directory submodule))) convertible to it
+ +Default:
+[ ]
Example:
[
+ {
+ name = "wikipedia";
+ tags = [ "wiki" ];
+ keyword = "wiki";
+ url = "https://en.wikipedia.org/wiki/Special:Search?search=%s&go=Go";
+ }
+ {
+ name = "kernel.org";
+ url = "https://www.kernel.org";
+ }
+ {
+ name = "Nix sites";
+ toolbar = true;
+ bookmarks = [
+ {
+ name = "homepage";
+ url = "https://nixos.org/";
+ }
+ {
+ name = "wiki";
+ tags = [ "wiki" "nix" ];
+ url = "https://wiki.nixos.org/";
+ }
+ ];
+ }
+]
+
+
+
+Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.containers
+
+
+Attribute set of container configurations. See +Multi-Account +Containers +for more information.
+ +Type: +attribute set of (submodule)
+ +Default:
+{ }
Example:
{
+ dangerous = {
+ color = "red";
+ icon = "fruit";
+ id = 2;
+ };
+ shopping = {
+ color = "blue";
+ icon = "cart";
+ id = 1;
+ };
+}
+
+
+Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.containers.<name>.color
+
+
+Container color.
+ +Type: +one of “blue”, “turquoise”, “green”, “yellow”, “orange”, “red”, “pink”, “purple”, “toolbar”
+ +Default:
+"pink"
Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.containers.<name>.icon
+
+
+Container icon.
+ +Type: +one of “briefcase”, “cart”, “circle”, “dollar”, “fence”, “fingerprint”, “gift”, “vacation”, “food”, “fruit”, “pet”, “tree”, “chill”
+ +Default:
+"fruit"
Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.containers.<name>.id
+
+
+Container ID. This should be set to a unique number per container in this profile.
+ +Type: +unsigned integer, meaning >=0
+ +Default:
+0
Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.containers.<name>.name
+
+
+Container name, e.g., shopping.
+ +Type: +string
+ +Default:
+"‹name›"
Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.containersForce
+
+
+Whether to force replace the existing containers configuration. +This is recommended since Firefox will replace the symlink on +every launch, but note that you’ll lose any existing configuration +by enabling this.
+ +Type: +boolean
+ +Default:
+false
Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.extensions
+
+
+List of ‹name› add-on packages to install for this profile. +Some pre-packaged add-ons are accessible from the +Nix User Repository. +Once you have NUR installed run
$ nix-env -f '<nixpkgs>' -qaP -A nur.repos.rycee.firefox-addons
+
to list the available ‹name› add-ons.
Note that it is necessary to manually enable these extensions +inside ‹name› after the first installation.
To automatically enable extensions add
+"extensions.autoDisableScopes" = 0;
+to
+programs.floorp.profiles.<profile>.settings
Type: +list of package
+ +Default:
+[ ]
Example:
with pkgs.nur.repos.rycee.firefox-addons; [
+ privacy-badger
+]
+
+
+
+Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.extraConfig
+
+
+Extra preferences to add to user.js
.
Type: +strings concatenated with “\n”
+ +Default:
+""
Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.id
+
+
+Profile ID. This should be set to a unique number per profile.
+ +Type: +unsigned integer, meaning >=0
+ +Default:
+0
Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.isDefault
+
+
+Whether this is a default profile.
+ +Type: +boolean
+ +Default:
+"true if profile ID is 0"
Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.name
+
+
+Profile name.
+ +Type: +string
+ +Default:
+"‹name›"
Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.path
+
+
+Profile path.
+ +Type: +string
+ +Default:
+"‹name›"
Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.search.default
+
+
+The default search engine used in the address bar and search bar.
+ +Type: +null or string
+ +Default:
+null
Example:
+"DuckDuckGo"
Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.search.engines
+
+
+Attribute set of search engine configurations. Engines
+that only have metaData
specified will
+be treated as builtin to ‹name›.
See SearchEngine.jsm +in Firefox’s source for available options. We maintain a +mapping to let you specify all options in the referenced +link without underscores, but it may fall out of date with +future options.
Note, icon
is also a special option
+added by Home Manager to make it convenient to specify
+absolute icon paths.
Type: +attribute set of attribute set of (JSON value)
+ +Default:
+{ }
Example:
{
+ "Nix Packages" = {
+ urls = [{
+ template = "https://search.nixos.org/packages";
+ params = [
+ { name = "type"; value = "packages"; }
+ { name = "query"; value = "{searchTerms}"; }
+ ];
+ }];
+
+ icon = "${pkgs.nixos-icons}/share/icons/hicolor/scalable/apps/nix-snowflake.svg";
+ definedAliases = [ "@np" ];
+ };
+
+ "NixOS Wiki" = {
+ urls = [{ template = "https://wiki.nixos.org/index.php?search={searchTerms}"; }];
+ iconUpdateURL = "https://wiki.nixos.org/favicon.png";
+ updateInterval = 24 * 60 * 60 * 1000; # every day
+ definedAliases = [ "@nw" ];
+ };
+
+ "Bing".metaData.hidden = true;
+ "Google".metaData.alias = "@g"; # builtin engines only support specifying one additional alias
+}
+
+
+
+Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.search.force
+
+
+Whether to force replace the existing search +configuration. This is recommended since ‹name› will +replace the symlink for the search configuration on every +launch, but note that you’ll lose any existing +configuration by enabling this.
+ +Type: +boolean
+ +Default:
+false
Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.search.order
+
+
+The order the search engines are listed in. Any engines +that aren’t included in this list will be listed after +these in an unspecified order.
+ +Type: +list of string
+ +Default:
+[ ]
Example:
[
+ "DuckDuckGo"
+ "Google"
+]
+
+
+Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.search.privateDefault
+
+
+The default search engine used in the Private Browsing.
+ +Type: +null or string
+ +Default:
+null
Example:
+"DuckDuckGo"
Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.settings
+
+
+Attribute set of ‹name› preferences.
‹name› only supports int, bool, and string types for +preferences, but home-manager will automatically +convert all other JSON-compatible values into strings.
+ +Type: +attribute set of (‹name› preference (int, bool, string, and also attrs, list, float as a JSON string))
+ +Default:
+{ }
Example:
{
+ "browser.startup.homepage" = "https://nixos.org";
+ "browser.search.region" = "GB";
+ "browser.search.isUS" = false;
+ "distribution.searchplugins.defaultLocale" = "en-GB";
+ "general.useragent.locale" = "en-GB";
+ "browser.bookmarks.showMobileBookmarks" = true;
+ "browser.newtabpage.pinned" = [{
+ title = "NixOS";
+ url = "https://nixos.org";
+ }];
+}
+
+
+
+Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.userChrome
+
+
+Custom ‹name› user chrome CSS.
+ +Type: +strings concatenated with “\n”
+ +Default:
+""
Example:
''
+ /* Hide tab bar in FF Quantum */
+ @-moz-document url(chrome://browser/content/browser.xul), url(chrome://browser/content/browser.xhtml) {
+ #TabsToolbar {
+ visibility: collapse !important;
+ margin-bottom: 21px !important;
+ }
+
+ #sidebar-box[sidebarcommand="treestyletab_piro_sakura_ne_jp-sidebar-action"] #sidebar-header {
+ visibility: collapse !important;
+ }
+ }
+''
+
+
+Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.floorp.profiles.<name>.userContent
+
+
+Custom ‹name› user content CSS.
+ +Type: +strings concatenated with “\n”
+ +Default:
+""
Example:
''
+ /* Hide scrollbar in FF Quantum */
+ *{scrollbar-width:none !important}
+''
+
+
+Declared by:
+
+
+<home-manager/modules/programs/floorp.nix>
+
+ |
programs.foot.enable