Skip to content

install.md

Latest commit

 

History

History
148 lines (108 loc) · 5.31 KB

install.md

File metadata and controls

148 lines (108 loc) · 5.31 KB

🚀Install

Important

⚠️ After Phoenix is installed, you MUST restart Firefox after its first run with Phoenix installed. This ensures all of Phoenix's changes are applied...

Phoenix currently provides official support for:

  • Android
  • Arch Linux
  • Debian (& derivatives...)
  • Fedora Linux
  • NixOS
  • macOS
  • Ubuntu (& derivatives...)

Other platforms have unfortunately proven difficult to support, though progress is being made. Contributions are always welcome and appreciated.

Note

⚠️ Flatpak (User) & Snap packages of Firefox are currently not supported.

Important

Android users are recommended to install IronFox (Recommended), which uses Phoenix for its configs. Android users can also manually install Phoenix for any Firefox-based browser on Android via the directions here.

Arch

[!NOTE] You can use paru instead of yay with the same options.

Firefox (Pacman):

yay -S phoenix-arch

Firefox (System Flatpak):

yay -S phoenix-flatpak

Debian/Ubuntu & derivatives

Before installing Phoenix, you'll first need to add celenity's OBS repo:

[!NOTE] You may see a warning, such as the following, when updating your apt cache.

Warning: https://download.opensuse.org/repositories/home:/celenity/Debian_Unstable/InRelease: Policy will reject signature within a year, see --audit for details

This is because apt will not support V3 GPG keys after 2026-02-01, and currently the OBS uses a V3 GPG key. For now, there shouldn't be any issues.

echo 'deb https://download.opensuse.org/repositories/home:/celenity/Debian_Unstable/ /' | sudo tee /etc/apt/sources.list.d/home:celenity.list
wget -O- https://download.opensuse.org/repositories/home:celenity/Debian_Unstable/Release.key 2>/dev/null | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/home_celenity.gpg > /dev/null
sudo apt update

Firefox (DEB):

sudo apt install phoenix

Firefox (System Flatpak):

sudo apt install phoenix-flatpak

Fedora

Before installing Phoenix, you'll first need to add celenity's COPR repo:

sudo dnf copr enable celenity/copr
sudo dnf makecache

Firefox (RPM):

sudo dnf install phoenix

Firefox (System Flatpak):

sudo dnf install phoenix-flatpak

macOS

[!IMPORTANT] ⚠️ Before proceeding, you must have Homebrew installed.

Run the following installation script in your terminal of choice:

/bin/zsh -c "$(curl -q --disable --no-netrc -j -e "" -A "" -S --clobber --create-dirs --delegation none --disallow-username-in-url --doh-cert-status --ftp-create-dirs --ftp-ssl-control --junk-session-cookies --no-basic --no-ca-native --no-digest --no-doh-insecure --no-http0.9 --no-insecure --no-proxy-insecure --no-negotiate --no-ntlm --no-proxy-basic --no-proxy-ca-native --no-proxy-digest --no-proxy-insecure --no-proxy-ntlm --no-proxy-ssl-allow-beast --no-proxy-ssl-auto-client-cert --no-sessionid --no-skip-existing --no-ssl --no-ssl-allow-beast --no-ssl-auto-client-cert --no-ssl-no-revoke --no-ssl-revoke-best-effort --no-tls-earlydata --no-xattr --progress-meter --proto -all,https --proto-default https --proto-redir -all,https --referer "" --remove-on-error --show-error --ssl-reqd --trace-time --user-agent "" --verbose -sSL https://gitlab.com/celenityy/Phoenix/-/raw/pages/installer_scripts/osx_install.sh)"

NixOS

NixOS is supported for flake-based configurations:

  1. Add the Phoenix repository to your flake inputs.
  2. Add phoenix as one of the arguments to your output function.
  3. Add the Phoenix NixOS Module to your configuration.
{
  inputs = {
    # Note that this assumes you have a flake-input called nixpkgs,
    # which is often the case. If you've named it something else,
    # you'll need to change the `nixpkgs` below.
    phoenix = {
      url = "git+https://gitlab.com/celenityy/Phoenix?ref=pages";
      inputs.nixpkgs.follows = "nixpkgs";
    };
  };
  # Add the `phoenix` argument to your output function, as below:
  outputs = {nixpkgs, phoenix, ...}: {
	# The configuration here is an example; it will look slightly different
	# based on your machine name and architecture.
    nixosConfigurations.your-box = nixpkgs.lib.nixosSystem {
      system = "x86_64-linux";
      modules = [
        # This is the important part -- add this line to your module list!
        phoenix.nixosModules.default
      ];
	};
  };
}

Alternatively, the Phoenix package, overlay, and NixOS module can be used directly in both flake and non-flake contexts. Simply pin the Phoenix source repository using your tool of choice (e.g. niv, npins, flakes) and then include nix/package.nix, nix/overlay.nix, or nix/module.nix as desired.

If you would like to use Phoenix on any other unsupported platform, see 📛Manual Installation.