overview
Getting started with FoxFork
What is FoxFork
FoxFork is a build tool and documentation for creating firefox-based browsers. Its goal is to simplify the process of creating web browsers to encourage competition and development within the space.
Getting help
If you are having problems with following these instructions, or with FoxFork in general, please contact us. You can create a discussion on github.
System requirements
OS: Linux and MacOS (If you are using windows, take a look at the Windows Guide)
Disk Space: 20GB
Memory: 4GB
CPU: 2 cores
Getting started
The first thing you are going to need to do is to install FoxFork. As it is a nodejs program it can be installed through npm or yarn.
npm install -g foxfork
# or
yarn global add foxfork
# or
pnpm install -g foxfork
# Note: Linux and mac users may have to run the above command with sudoNow create a git repo and clone it to your local machine. Then run the following:
This will ask you a variety of questions in relation to your project setup. Firstly, the release of the browser you want to bind to.
You can change what version you are bound to at any time. Pulse Browser currently uses the stable releases, but if you want a lower workload, the newer Extended Support releases might be good for you.
Then next is the version of the browser you want to use. By default FoxFork will populate this with the latest version available, which we recommend using. Simply click enter to accept.
Next it will ask for the name of your browser. Avoid references to Firefox or other Mozilla brands, as this is likely to lead to trademark and copyright issues down the road.
The binary name is the name that your program will be run from. We recommend that you add -browser to the end to avoid conflicts with common utilities.
Vendor is the company (or solo developer) who is creating the browser.
The appid follows reverse dns naming conventions. For example, Fushra owns the domain binaryblazer.me, so our browser is com.binaryblazer.browser.desktop. If you do not have a domain, you can use your username / pseudonym as the appid, e.g. trickypr.watermelon.
Next you need to chose a starting template for your browser. If you know what you are doing, you can go with None and configure it how you like. Otherwise, we recommend you stick with UserChrome.
Now you have created the directory structure for your project, you can build it for the first time. First, ask FoxFork to download the firefox source.
If you are running this for the first time, you will need to install the firefox dependencies. You can do this via boostrapping:
After the source code has been downloaded, the changes to firefox described in the source code must be applied.
Finally, you can start building the firefox source code. This takes around an hour and a half on my computer, but the binary output will be cached, making later builds faster
Now you can finally start the browser!
Common errors
Here are some common errors that you might run into whilst running foxfork build and some potential fixes.
Anything to do with wasm-ld
wasm-ldOn Arch linux, there were two errors that were thrown:
On Linux, I fixed the first error by installing ldd:
The second error was fixed by installing the associated wasm libraries:
You will need to port the above command to your distrobution. If you do not care about the improved security of sandboxed libraries, you can simply disable them by adding the following to ``
Last updated