logo

badwolf

minimalist and privacy-oriented web browser based on WebKitGTK git clone https://anongit.hacktivis.me/git/badwolf.git/

README.md (4427B)

    

  1. # BadWolf
  2. ```
  3. SPDX-FileCopyrightText: 2019-2022 Badwolf Authors <https://hacktivis.me/projects/badwolf>
  4. SPDX-License-Identifier: BSD-3-Clause
  5. ```
  7. Minimalist and privacy-oriented WebKitGTK+ browser.
  9. Homepage: <https://hacktivis.me/projects/badwolf>
  11. The name is a reference to BBC's Doctor Who TV series, I took it simply because I wanted to have a specie in the name, like some other web browsers do, but doesn't go into the “gentle” zone.
  13. ## Differences
  14. Comparing from other small WebKit browsers for unixes found in the wild:
  16. - Independent of environment, should just work if GTK and WebKitGTK does
  17. - Storing data should be:
  18.   - explicit and optional (i.e. Applying preferences doesn't imply Saving to disk)
  19.   - not queryabe by WebKit (so the web can't use it)
  20.   - done in a standard format (like XBEL for bookmarks)
  21. - Static UI, no element should be added at runtime, this is to avoid potential tracking via viewport changes
  22. - Small codebase, should be possible to read and understand it completely over an afternoon.
  23. - Does not use modal editing (from vi) as that was designed for editing, not browsing
  24. - UTF-8 encoding by default
  26. Motivation from other clients <https://hacktivis.me/articles/www-client%20are%20broken>
  28. ## Contributing
  29. ### Translations
  30. You need to have gettext installed. If you want a GUI, poedit exists and Weblate is a good web platform that I might consider hosting at some point.
  32. - Syncing POT file with the source code: ``ninja po/messages.pot``
  33. - Syncing PO file with the POT file: ``ninja po/de.po``
  34. - Initialising a new PO file (example for German, `de_DE`): ``msginit -l de_DE -i po/messages.pot -o po/de.po``
  36. ## Contacts / Discussions
  37. - IRC: `#badwolf-browser` on [GeekNode](https://www.geeknode.org/)
  38. - Matrix (bridge): [#badwolf-browser:matrix.fdn.fr](https://matrix.to/#/#badwolf-browser:matrix.fdn.fr)
  40. ## Repositories
  41. ### git
  42. - Main: <https://hacktivis.me/git/badwolf/>, <git://hacktivis.me/git/badwolf.git>
  43. - Mirror: <https://git.sr.ht/~lanodan/badwolf>
  45. ### release assets
  46. - Main: <https://hacktivis.me/releases/>
  47. - Mirror: <https://git.sr.ht/~lanodan/badwolf/refs>
  49. - `*.tar.*` files are tarballs archives to be extracted with a program like `tar(1)`, GNU tar and LibArchive bsdtar are known to work.
  50. - `*.sign` files are minisign (OpenBSD `signify(1)` compatible) signatures, they key used for it can be found at <https://hacktivis.me/releases/signify/> as well as other places (feel free to ping me to get it)
  52. ## Manual Installation
  53. ### Dependencies
  54. - POSIX-compatible Shell (i.e. mrsh, dash, lksh)
  55. - [ninja](https://ninja-build.org/) or [samurai](https://github.com/michaelforney/samurai)
  56. - A pkg-config implementation (pkgconf is recommended)
  57. - C11 Compiler (such as clang or gcc)
  58. - [WebKitGTK](https://webkitgtk.org/), only the latest stable(2.32.0+) is supported
  59. - [libxml-2.0](http://www.xmlsoft.org/), no known version limitation
  60. - (optional, translating) [po4a](https://po4a.org/) to modify manpage translations
  61. - (optional, translating) gettext implementation (such as GNU Gettext)
  62. - (optional, translating) ed(1), the standard editor
  63. - (optional, lint) [mandoc](https://mdocml.bsd.lv/) (the command) for linting the manpage
  64. - (optional, lint) [shellcheck](https://www.shellcheck.net/) for linting the `./configure` script
  65. - (optional, lint) [flawfinder](https://www.dwheeler.com/flawfinder/) for examining C source code for flaws
  66. - (optional, lint) [reuse](https://reuse.software/) for checking REUSE compliance
  68. Note: Packagers can safely ignore the lint dependencies.
  70. ### Compiling
  71. ```
  72. ./configure && ninja
  73. ```
  75. Note: `configure` is a simple shell script (so not autotools) which supports variables like `PREFIX`.
  77. ### Installing
  78. ```
  79. ninja install
  80. # DESTDIR is supported
  81. ```
  83. Debian users will probably want to use `checkinstall` instead.
  85. An example AppArmor profile is provided at `usr.bin.badwolf`, please do some long runtime checks before shipping it or a modified version, help can be provided but with no support.
  87. If you modify the icons, you'll need `inkscape` (command line only), to regenerate the bitmap versions. It isn't needed for a normal installation as the bitmap icons are bundled.
  89. ## Notes
  90. Most of the privacy/security stuff will be done with patches against WebKit as quite a lot isn't into [WebKitSettings](https://webkitgtk.org/reference/webkit2gtk/stable/WebKitSettings.html) and with generic WebKit extensions that should be reusable.