# Floorp Browser

A browser built for keeping the Open, Private and Sustainable Web alive. Based on Mozilla Firefox.

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![License][license-shield]][license-url]
[![Crowdin](https://badges.crowdin.net/floorp-browser/localized.svg)](https://crowdin.com/project/floorp-browser)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Floorp-Projects/Floorp)

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

[contributors-shield]: https://img.shields.io/github/contributors/Floorp-Projects/Floorp.svg?style=for-the-badge
[contributors-url]: https://github.com/Floorp-Projects/Floorp/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Floorp-Projects/Floorp?style=for-the-badge
[forks-url]: https://github.com/Floorp-Projects/Floorp/network/members
[stars-shield]: https://img.shields.io/github/stars/Floorp-Projects/Floorp.svg?style=for-the-badge
[stars-url]: https://github.com/Floorp-Projects/Floorp/stargazers
[issues-shield]: https://img.shields.io/github/issues/Floorp-Projects/Floorp.svg?style=for-the-badge
[issues-url]: https://github.com/Floorp-Projects/Floorp/issues
[license-shield]: https://img.shields.io/github/license/Floorp-Projects/Floorp.svg?style=for-the-badge
[license-url]: https://github.com/Floorp-Projects/Floorp/blob/main/LICENSE

<!-- PROJECT LOGO -->
<br />
<div align="center">
  <a href="https://github.com/Floorp-Projects/Floorp">
    <img src="https://avatars.githubusercontent.com/u/94953125?s=200&v=4" alt="Logo" width="150" height="150">
  </a>

  <h3 align="center">Floorp Browser </h3>

  <p align="center">
    A browser built for keeping the Open, Private and Sustainable Web alive. Based on Mozilla Firefox.
    <br />
    <br />
    <a href="https://floorp.app">Official Site</a>
    ・
    <a href="#-download--install">Download</a>
    ・
    <a href="https://blog.floorp.app">Blog & Release Notes</a>
    ・
    <a href="https://discord.floorp.app">Official Discord</a>
    ・
    <a href="https://docs.floorp.app">Documentation</a>
  </p>
</div>

## 📄 Sponsorship

Floorp Browser is a free and open-source project. If you like Floorp Browser, please consider sponsoring us. Your sponsorship will help us to continue development and pay for the server costs. You may advertise if you continuously sponsor a minimum of $100 per month.

- [GitHub Sponsors](https://github.com/sponsors/Ryosuke-Asano)

<h2> 💕 Special Sponsors </h2>
<div align="left" style="display: flex; flex-wrap: wrap;">
  <a href="https://www.cube-soft.jp/" style="margin: 10px; overflow: hidden; padding: 0px 30px;">
    <img src="https://avatars.githubusercontent.com/u/346808?s=200&v=4" alt="CubeSoft, Inc." width="100" height="100">
    <h4 style="text-align: center;">CubeSoft, Inc.</h4>
  </a>
  <a href="https://1password.com/" style="margin: 10px; overflow: hidden; padding: 0px 30px;">
    <img src="https://avatars.githubusercontent.com/1Password?s=200&v=4" alt="1Password" width="100" height="100">
    <h4 style="text-align: center;">1Password</h4>
  </a>
  <a href="https://signpath.io/" style="margin: 10px; overflow: hidden; padding: 0px 30px;">
    <img src="https://avatars.githubusercontent.com/u/34448643?s=200&v=4" alt="SignPath" width="100" height="100">
    <h4 style="text-align: center;">SignPath</h4>
  </a>
</div>

## ⚡ Get Started

### 💻 Supported Operating Systems & Requirements

Floorp Browser is available for Windows, macOS, and Linux. You can install it by running the installer or by extracting the archive.

#### Windows

- Windows 10 or later. (Windows 7 and 8 are not supported)

- x86_64 CPU architecture. AArch64 is not supported.

- Floorp provides a `.exe` installer, `winget`, and `Scoop` installation options.

Winget install command:

```
winget install Ablaze.Floorp
```

Winget repository provided by [@Hibi_10000](https://github.com/Hibi-10000)

Scoop install command:

```
scoop bucket add extras
scoop install extras/floorp
```

Scoop repository provided by [@SegoCode](https://github.com/SegoCode)

**Floorp has obtained a Certum Open Source Code Signing Certificate. The official Floorp installer is signed by "Open Source Developer, Ryosuke Asano". However, the installer for the Daylight build is not signed.**

#### macOS

- macOS 10.15 or later.

- x86_64 CPU & ARM64 CPU architecture. Floorp provides a Universal build for both architectures.

Homebrew install command:

```
brew install --cask floorp
```

**After version 11.0.0, Floorp has obtained Apple Notarization & Certification. This means that you can install Floorp without any warning messages. Additionally, Floorp now includes an auto-update system.**

#### Linux

- Debian-based distributions (such as Ubuntu and Linux Mint) and Arch-based distributions (such as Manjaro) are supported.

- x86_64 & AArch64 CPU architecture.

- Floorp Browser Requirements: [Firefox system requirements](https://www.mozilla.org/firefox/system-requirements/)

Supported package managers:

- PPA (Ubuntu, Linux Mint, etc.): https://ppa.floorp.app
- Flatpak (most Linux distributions): https://flathub.org/apps/one.ablaze.floorp
- Tarball (most Linux distributions): https://github.com/Floorp-Projects/Floorp/releases/latest
- AUR bin (Arch-based distributions): https://aur.archlinux.org/packages/floorp-bin/ **Unofficial**
- AUR (Arch-based distributions): https://aur.archlinux.org/packages/floorp/ **Unofficial**
- SBo bin (Slackware-based distributions): https://slackbuilds.org/repository/15.0/network/floorp-bin/ **Unofficial**

### 📥 Download & 📦 Install

You can download the latest version of Floorp Browser from the official website: [Floorp.app](https://floorp.app/download) or from the [GitHub Releases](https://github.com/Floorp-Projects/Floorp/releases) page.

---

## 📖 Documentation

For more detailed information and guidance, check out our [Floorp Documentation Wiki](https://docs.floorp.app).

### 📝 License

[Mozilla Public License 2.0](https://www.mozilla.org/en-US/MPL/2.0/)

- Floorp's name is a registered trademark of Floorp's developer, and Floorp's logo is protected by copyright

- Floorp Browser is based on Mozilla Firefox. Floorp Browser is not affiliated with Mozilla & Mozilla Firefox.

- Floorp uses Mozilla Firefox's source code and other open-source projects. See [Floorp License Notices](#-Floorp-License-Notices-)

### 📧 Contact

- [Official Floorp Twitter](https://twitter.com/Floorp_Browser)

- [Official Floorp Projects Discord](https://discord.floorp.app)

### 📜 Privacy Policy

- [Floorp Privacy Policy](https://floorp.app/privacy)

### 📜 About Forks

- Floorp is independent of Mozilla Firefox. Floorp is not affiliated with Mozilla & Mozilla Firefox.

- We are also unaffiliated with the browser that is forking Floorp and we are developing it on our own.

- We are not affiliated with any organization other than Ablaze.

---

## 🌟 Contributing

### 🧰 How to Start Development

Floorp's dev workflow is orchestrated by `feles-build` (a Deno task).

To build and run Floorp, follow the [Building section of the documentation](https://docs.floorp.app/docs/building/).

#### Useful commands

- `deno task feles-build stage` (build production assets, run browser in dev mode)
- `deno task feles-build build --phase before-mach` (production assets step)
- `deno task feles-build build --phase after-mach` (post-build injection step)

### 🐛 Reporting Bugs

- If you find a bug, please report it to the [Issues](https://github.com/Floorp-Projects/Floorp/issues) page.

---

## 📄 Floorp License Notices 📄

Floorp utilizes various open-source projects. Below is a comprehensive list of the open-source projects used in Floorp.

Please note that while some of the software listed below is not included in Floorp itself, it is instead downloaded from the internet. Additionally, Floorp provides a list of recommended add-ons for users to install.

### 🦊 Mozilla Firefox

- [Mozilla Firefox](https://www.mozilla.org/en-US/firefox/new/)
- [Mozilla Public License 2.0](https://www.mozilla.org/en-US/MPL/2.0/)
- Authors: [Mozilla & Contributors](https://www.mozilla.org/credits/)

### 🐈 NyanRus Noraneko (Testhead of Floorp 12)

- [Noraneko](https://github.com/nyanrus/noraneko-runtime)
- [Mozilla Public License 2.0](https://github.com/nyanrus/noraneko-runtime/blob/main/LICENSE)
- Author: [NyanRus](https://github.com/nyanrus)

### 🎨 Firefox UI FIX (Lepton)

- [Firefox UI FIX (Lepton)](https://github.com/black7375/Firefox-UI-Fix)
- [Mozilla Public License 2.0](https://github.com/black7375/Firefox-UI-Fix/blob/master/LICENSE)
- Author: [black7375](https://github.com/black7375)

### 📦 userChromeCSS Loader

- [userChromeCSS Loader](floorp/browser/base/content/browser-chromeCSS.js)
- [MIT](floorp/browser/base/content/browser-chromeCSS.js)
- Author: Griever

Notice: if you are a developer of "userChromeCSS Loader", please contact us so that we can add your name and website to the list.

### 📦 Paxmod

- [Paxmod](https://github.com/numirias/paxmod)
- [MIT](https://github.com/numirias/paxmod/blob/master/LICENSE)
- Author: [numirias](https://github.com/numirias/)

Notice: If you are a maintainer of any listed component and your name or license is missing or incorrect, please contact us.

### 📦 Fushra Pulse

- [Fushra Pulse](https://pulsebrowser.app/)
- [Mozilla Public License 2.0](https://github.com/pulse-browser/browser/blob/main/LICENSE)
- Author: [Fushra](https://github.com/Fushra)

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=Floorp-Projects/Floorp&type=date&legend=top-left)](https://www.star-history.com/#Floorp-Projects/Floorp&type=date&legend=top-left)