foxgirl-linux/docs/README.md

89 lines
5.1 KiB
Markdown
Raw Normal View History

2019-07-04 04:38:12 +02:00
![Logo](https://gitlab.com/librewolf-community/librewolf/raw/master/branding/logo/Logo.svg)
2019-07-04 02:44:00 +02:00
# LibreWolf: Browse With Freedom
2019-07-04 04:33:13 +02:00
[![Download Badge](https://img.shields.io/badge/Download-purple.svg)](https://gitlab.com/librewolf-community/librewolf/releases)
2019-07-04 04:07:54 +02:00
[![Website Badge](https://img.shields.io/badge/Website-librewolf.gitlab.io-blue.svg)](https://LibreWolf.gitlab.io)
2019-07-04 04:33:13 +02:00
[![Docs Badge](https://img.shields.io/badge/Docs-librewolf.readthedocs.io-blue.svg)](https://librewolf.readthedocs.io)
[![Chat Badge](https://img.shields.io/badge/Chat-Gitter-blue.svg)](https://gitter.im/librewolf-community/librewolf)
[![Status Badge](https://img.shields.io/badge/Status-Active_Development-brightgreen.svg)](https://gitlab.com/librewolf-community/librewolf/commits/master)
2019-07-04 04:07:54 +02:00
[![Pipelines Badge](https://gitlab.com/librewolf-community/librewolf/badges/master/pipeline.svg)](https://gitlab.com/librewolf-community/librewolf/pipelines)
2019-07-04 04:33:13 +02:00
[![Docs Status](https://readthedocs.org/projects/librewolf/badge/?version=latest)](https://librewolf.readthedocs.io/en/latest/)
2019-07-04 02:44:00 +02:00
This project is an independent fork of Firefox, with the primary goals of privacy security and user freedom. It is the community run successor to [LibreFox](https://github.com/intika/Librefox)
LibreWolf uses more than 500 privacy/security/performance settings, patches, LibreWolf-Addons (optional) and is designed to minimize data collection and telemetry as much as possible (updater, crashreporter and Firefox's integrated addons that don't respect privacy are removed).
**LibreWolf is NOT associated with Mozilla or its products.**
## Features
- Latest Version of Firefox: LibreWolf is compiled directly from the latest build of Firefox Nightly. As a result, you will have the most bleeding edge of features, technologies and security updates. Stable builds are also planned in the future.
- Completely Independent Build: LibreWolf uses a completely independent build from Firefox and has its own settings, profile folder and installation path. As a result, it can be installed alongside Firefox or any other browser.
- Extensions firewall: limit internet access for extensions ([firewall-test-feature](#extensions-firewall-))
- IJWY (I Just Want You To Shut Up): embedded server links and other calling home functions are removed ([zero unauthorized connection](#ijwy-i-just-want-you-to-shut-up) by default).
- User settings updates: gHacks/pyllyukko base is kept up to date.
- Settings protection: important settings are enforced/locked within `librewolf.cfg` and `policies.json`, those settings cannot be changed by addons/updates/LibreWolf itself or unwanted/accidental manipulation; To change those settings you can easily do it by editing `librewolf.cfg` and `policies.json`.
- LibreWolf-addons: set of optional LibreWolf extensions
- Statistics disabled: telemetry and similar functions are disabled
- Tested settings: settings are performance aware
- ESR and Tor version (LibreWolf TBB Beta)
- Tor LibreWolf-addons: adapted LibreWolf extensions for TBB
- Multi-platform (Windows/Linux/Mac/and soon Android)
- Dark theme (classic and advanced)
- Recommended and *code reviewed* addons list
- Community-Driven
- And much more...
2019-07-04 02:57:33 +02:00
## Download and Installation
2019-07-04 02:44:00 +02:00
2019-07-04 02:57:33 +02:00
### Linux
2019-07-04 02:44:00 +02:00
2019-07-04 02:57:33 +02:00
#### Manual Compilation
2019-07-04 02:44:00 +02:00
2019-07-04 02:57:33 +02:00
- Build instruction will be updated soon
2019-07-04 02:44:00 +02:00
2019-07-04 02:57:33 +02:00
#### AppImage
2019-07-04 02:51:33 +02:00
2019-07-04 02:57:33 +02:00
LibreWolf is available in an AppImage Format. Check out the [releases page](https://gitlab.com/librewolf-community/librewolf/-/releases) for downloads.
2019-07-04 02:44:00 +02:00
2019-07-04 02:57:33 +02:00
#### Binary Tarball
2019-07-04 02:44:00 +02:00
2019-07-04 02:57:33 +02:00
LibreWolf is available as a binary tarball. Check out the [releases page](https://gitlab.com/librewolf-community/librewolf/-/releases) for downloads.
2019-07-04 02:44:00 +02:00
2019-07-04 02:57:33 +02:00
#### Arch
2019-07-04 02:44:00 +02:00
2019-07-04 02:57:33 +02:00
LibreWolf is available on the AUR in both [source code](https://aur.archlinux.org/packages/librewolf/) and [binary](https://aur.archlinux.org/packages/librewolf-bin) format.
2019-07-04 02:44:00 +02:00
2019-07-04 02:57:33 +02:00
### Windows
- Build instruction will be updated soon
2019-07-04 02:44:00 +02:00
### Mac
2019-07-04 02:57:33 +02:00
- Build instruction will be updated soon
2019-07-04 02:44:00 +02:00
2019-07-04 03:53:14 +02:00
## Roadmap
See https://gitlab.com/librewolf-community/librewolf/issues
2019-07-04 02:44:00 +02:00
## About
**License:** [Mozilla Public License 2.0](https://gitlab.com/librewolf-community/librewolf/blob/master/LICENSE)
**Inspired from:** [ungoogled-chromium](https://github.com/Eloston/ungoogled-chromium)
**Based on:** [Librefox](https://github.com/intika/Librefox), whose development seems to have halted.
**Acknowledgement**, special thanks to:
- @intika for putting Librefox together
- The Mozilla team for their amazing work on Firefox
- The gHacks-User team for allowing the usage of their work
- All the stargazers (users that are encouraging this project by starring it)
- Icon was created with images by [OpenClipart-Vectors](https://pixabay.com/users/OpenClipart-Vectors-30363/?utm_source=link-attribution&utm_medium=referral&utm_campaign=image&utm_content=157677) from [Pixabay](https://pixabay.com/?utm_source=link-attribution&utm_medium=referral&utm_campaign=image&utm_content=157677)
- Icons made by <a href="https://www.flaticon.com/authors/vaadin" title="Vaadin">Vaadin</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a> is licensed by <a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0" target="_blank">CC 3.0 BY</a>