golem web browser
Go away. Nothing to see here. Yet.
go get /
Golem does not follow go conventions that
go generate is to be run by the
author and generated code stored in the repository.
Reason for this is that platform the generated code includes a platform- dependant shared object file.
As golem is not a library, the fact that it doesn't directly function with
go get is not a huge loss.
To install golem with the
go command, instead execute:
go get -d github.com/tkerber/golem go generate .../golem go install .../golem
go generate requires the following programs to execute:
go-bindatawhich can be obtained with
go get github.com/jteeuwen/go-bindata
go get github.com/tkerber/go-version)
- Google's closure compile is an optional dependency for minifying pdf.js.
If the environment variable
CLOSURE_COMPILERis set for
go generate, the closure compiler will be used to produce a minified version of pdf.js instead.
node is not required is pdf.js in disabled entirely. This can be done by
removing it as a target in the
golem was chosen to remind people of what this browser should not
be: Slow and cumbersome.
- A keyboard driven, minimalistic browser.
- Powerful adblocking and noscript support.
- Fully configurable.
- Powerful whitelisting support.
- In particular it should be possible to whitelist particular users on services such as youtube and twitch.
- Written in go.
- Capable of running multiple windows within one instance.
- One process per tab.
- Everything runs in it's own goroutine.
- No crashes. All goroutines should fail gracefully.
- In-browser pdf support.
- Multi-profile support.
- Vim-like keybindings.
- Fully reconfigurable keybindings.
- Public extensions API.
- Must exit quickly and gracefully on SIGTERM.
- Should exit cleanly on SIGKILL (in particular should not corrupt cookies).
- Browser should always be responsive. The UI goroutine should not handle any meaningful computation.
- Vertical and horizontal tab bar support
- Option to limit to one tab per window.
- Per-tab, per-window and global private browsing mode
- Clear visual indicator
- Restore pages option upon restarting browser.
- Optional lazy tab loading
Choice of layout engine
The options I considered for the choice of layout engine were Gecko and Webkit. Having using webkit-based browsers much in the past, and having seen many bugs attributed to them in fact being webkit bugs I was originally inclined to use gecko.
Unfortunately gecko is (no longer) built for embedding into applications, and it has no stable API to do so. As a result a gecko-based browser would be very difficult to maintain.
I chose to use webkit instead, and to focus the energy on ensuring that webkit can crash at most one tab at a time.
There is no documentation for this package.
Package adblock is in charge of parsing adblock filter fists and deciding whether or not to block URIs.
|Package adblock is in charge of parsing adblock filter fists and deciding whether or not to block URIs.|
Package cmd implements vim-like stateful operation.
|Package cmd implements vim-like stateful operation.|
Package states defines constants of the substates used in golem's state machine.
|Package states defines constants of the substates used in golem's state machine.|
Package ui contains golem's user-interface implementation.
|Package ui contains golem's user-interface implementation.|
Package version contains golem's version constants.
|Package version contains golem's version constants.|
Package xdg wraps around glib's xdg directory functions, to allow retrieval of the names of config directories.
|Package xdg wraps around glib's xdg directory functions, to allow retrieval of the names of config directories.|