https://github.com/heitoraugustoln/betterfox-nix
Home-manager module to integrate Betterfox user.js in Firefox and Librewolf
https://github.com/heitoraugustoln/betterfox-nix
betterfox firefox home-manager librewolf nix nix-darwin nix-flake nixos
Last synced: 8 months ago
JSON representation
Home-manager module to integrate Betterfox user.js in Firefox and Librewolf
- Host: GitHub
- URL: https://github.com/heitoraugustoln/betterfox-nix
- Owner: HeitorAugustoLN
- License: mit
- Created: 2024-07-21T18:48:57.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-10T15:51:37.000Z (over 1 year ago)
- Last Synced: 2025-02-07T21:56:00.428Z (over 1 year ago)
- Topics: betterfox, firefox, home-manager, librewolf, nix, nix-darwin, nix-flake, nixos
- Language: Nix
- Homepage:
- Size: 63.5 KB
- Stars: 20
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Betterfox-nix
This repository provides a Nix Home Manager module that integrates the [Betterfox user.js](https://github.com/yokoffing/Betterfox) configurations into Firefox, enhancing privacy and performance.
## Table of contents
- [Features](#features)
- [Getting started](#getting-started)
- [Acknowledgments](#acknowledgments)
- [License](#license)
## Features
- **Automatic Integration:** Seamlessly apply Betterfox settings to your Firefox profiles using Nix.
- **Version Control:** Choose the Betterfox version that suits your needs, including the latest main branch or specific releases.
- **Cross-platform**: Works on any system supported by Nix and Home Manager.
## Getting started
To begin using Betterfox-nix, add the module to your Nix configuration and enable it for your preferred browser.
#### Example Configuration
Below is an example of how to integrate Betterfox with Firefox using this module:
```nix
{ inputs, ... }:
{
imports = [ inputs.betterfox.modules.homeManager.betterfox ]; # or inputs.betterfox.homeModules.betterfox
# In firefox
programs.firefox = {
enable = true;
betterfox = {
enable = true;
profiles.example-profile = {
# Set this to enable all sections by default
enableAllSections = true;
settings = {
# To enable/disable specific sections
fastfox.enable = true;
# To enable/disable specific subsections
peskyfox = {
enable = true;
mozilla-ui.enable = false;
};
# To enable/disable specific options
securefox = {
enable = true;
tracking-protection."browser.download.start_downloads_in_tmp_dir".value = false;
};
};
};
version = "142.0"; # Set version here, defaults to main branch
};
profiles.example-profile = {
name = "Example";
};
};
}
```
## Acknowledgments
- [@e-tho](https://github.com/e-tho) for the foundational work on betterfox-extractor and betterfox-generator.
- [@dwarfmaster](https://github.com/dwarfmaster) for developing the arkenfox home-manager module that inspired this project.
## License
This project is licensed under the [MIT License](LICENSE).