Skip to content
Wolk Trustless Web Browser
JavaScript CSS HTML Python
Branch: master
Clone or download
Latest commit a30100f Jul 10, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
app
build
module_bak
tasks
tests
.editorconfig
.eslintrc
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
appveyor.yml
build-notes.md
gulpfile.js
package.json
screenshot.png
settings.json

README.md

Wolk Browser

Wolk Browser is a Web browser built by Wolk (based off of the Beaker Browser) to display how apps can be built based on trustless protocols. Please feel free to open usability issues or email services@wolk.com with any questions or feedback.

About Wolk

Wolk is Decentralized: There is no central point of failure and is thereby censorship resistant. Users are in control, not Wolk or any other entity.

Wolk is Serverless: Users may store and retrieve content, applications and other data through any Wolk gateway node. There is no need to manage a server (or set of servers) in order to host your own website on Wolk or develop your own app. Be up and running just by simply uploading your files and assets to have a website working! Developers can develop apps without worrying about managing servers or databases. Sound too good to be true? Check out our appstore for sample apps built this way!

Wolk is Provable: All storage commands (i.e. POST/PUT) are signed, meaning that any request (i.e. GET) can be returned along with a proof to give users confidence in the data their viewing.

Table of Contents

Installing

Binaries

Visit Wolk Cloudstore 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, autoconf, and automake:

sudo apt-get install libtool m4 make g++ autoconf # debian/ubuntu
sudo dnf install libtool m4 make gcc-c++ libXScrnSaver  # fedora
brew install libtool autoconf automake # macos

In Windows, you'll need to install Python 2.7, Visual Studio 2015 or 2017, and Git. (You might try windows-build-tools.) Then run:

npm config set python c:/python27
npm config set msvs_version 2015
npm install -g node-gyp
npm install -g gulp

To build:

git clone https://github.com/wolkdb/browser.git
cd browser
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 afterward.

If you're doing development, npm run watch to have assets build automatically.

Documentation

Coming Soon

Env Vars

  • DEBUG: which log systems to output? A comma-separated string. Can be wolk, beaker, dat, bittorrent-dht, dns-discovery, hypercore-protocol. Specify * for all.

TODO: REVIEW

  • BEAKER_OPEN_URL: open the given URL on load, rather than the previous session or default tab.
  • BEAKER_USER_DATA_PATH: override the user-data path, therefore changing where data is read/written. Useful for testing. For default value see userData in the electron docs.
  • 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.

Known issues

tmux

Launching from tmux is known to cause issues with GUI apps in macOS. On Beaker, it may cause the application to hang during startup.

License

MIT License (MIT)

Copyright (c) 2019 Wolk, Inc.

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.

You can’t perform that action at this time.