beta testing guide (#444)

* beta install guide

* Update README.md
This commit is contained in:
icepaq
2026-01-06 13:09:32 -05:00
committed by GitHub
parent ba29159b62
commit 11e02fdfea
3 changed files with 68 additions and 1 deletions
+2 -1
View File
@@ -45,4 +45,5 @@ closedsrc
.venv
bundle
*.pem
*.pem
.DS_store
+2
View File
@@ -23,6 +23,8 @@ Camoufox is the most modern, effective & future-proof open source solution for a
## <span style="color:yellow">Firefox Version Upgrade Notice</span>
The current main branch is built for Firefox v146. It is an experimental change and may contain several bugs. If you are building from source and require a stable production version, use branch `releases/135`.
See the [Beta Testing Guide](docs/beta-testing-ff146.md) for instructions on testing FF146.
---
## Sponsors
+64
View File
@@ -0,0 +1,64 @@
# Testing Firefox 146 Beta
This guide explains how to test the experimental Firefox 146 build of Camoufox.
> **Note:** The FF146 build is experimental and may contain bugs. For a stable production version, use branch `releases/135`.
## Build from Source
1. Clone the repository:
```bash
git clone --depth 1 https://github.com/daijro/camoufox
cd camoufox
```
2. Set up the build environment:
```bash
make dir
make bootstrap # only needed once
```
3. Build for your target platform:
```bash
python3 multibuild.py --target <os> --arch <arch>
```
| Parameter | Options |
|-----------|---------|
| `--target` | `linux`, `windows`, `macos` |
| `--arch` | `x86_64`, `arm64`, `i686` |
Build artifacts will appear in the `dist/` folder.
### Default Install Directories
When using the Python library (`camoufox fetch`), the default install directory is:
| OS | Install Directory |
|------|-------------------|
| **Linux** | `~/.cache/camoufox/` |
| **macOS** | `~/Library/Caches/camoufox/` |
| **Windows** | `C:\Users\<user>\AppData\Local\camoufox\camoufox\Cache\` |
## Replacing the Binary
To test FF146 with an existing Camoufox installation:
1. Build from source using the instructions above
2. Extract the built zip from `dist/`
3. Replace the binary at the corresponding path for your OS:
**Linux:**
```bash
cp /path/to/built/camoufox-bin ~/.cache/camoufox/camoufox-bin
```
**macOS:**
```bash
cp /path/to/built/Camoufox.app ~/Library/Caches/camoufox/Camoufox.app
```
**Windows:**
```powershell
copy C:\path\to\built\camoufox.exe C:\Users\<user>\AppData\Local\camoufox\camoufox\Cache\camoufox.exe
```