Beaker is an experimental peer-to-peer Web browser. It adds new APIs for building hostless applications, while remaining compatible with the rest of the Web. Visit the website.
Please feel free to open usability issues. Join us at #beakerbrowser on Freenode.
Table of Contents
- Known issues
Visit the Releases Page to find the installer you need.
Building from source
Requires node 6 or higher. On Windows, you may need to use npm version 4, due to a bug in npm 5.
In Linux (and in some cases macOS) you need libtool, m4, and automake:
sudo apt-get install libtool m4 make g++ # debian/ubuntu sudo dnf install libtool m4 make gcc-c++ # fedora
npm config set python c:/python27 npm config set msvs_version 2015 npm install -g node-gyp npm install -g gulp
git clone https://github.com/beakerbrowser/beaker.git cd beaker npm install npm run rebuild # see https://github.com/electron/electron/issues/5851 npm start
If you pull latest from the repo and get weird module errors, do:
npm run burnthemall
This invokes the mad king, who will torch your
node_modules/, and do the full install/rebuild process for you.
npm start should work afterwards.
If you're doing development,
npm run watch to have assets build automatically.
- Web APIs
DEBUG: which log systems to output? A comma-separated string. Can be
beaker_open_url: open the given URL on load.
beaker_user_data_path: override the user-data path, therefore changing where data is read/written. Useful for testing. For default value see
userDatain the electron docs.
beaker_sites_path: override the default path for saving sites. Useful for testing. Default value is
$HOMEis the users home directory.
beaker_dat_quota_default_bytes_allowed: override the default max-quota for bytes allowed to be written by a dat site. Useful for testing. Default value is
'500mb'. This can be a Number or a String. Check bytes.parse for supported units and abbreviations.
NODE_ENV: set to
testto disable Beaker's close-to-tray feature
Launching from tmux is known to cause issues with GUI apps in macOS. On Beaker, it may cause the application to hang during startup.
This project exists thanks to all the people who contribute. [Contribute].
Thank you to all our backers!
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
Modified MIT License (MIT)
Copyright (c) 2018 Paul Frazee
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.