summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Bruhin <me@the-compiler.org>2021-01-02 11:29:15 +0100
committerFlorian Bruhin <me@the-compiler.org>2021-01-02 11:29:15 +0100
commitc6f0927920ffb81bbf397d40655956828462a280 (patch)
treeb13982ab5ce4b869448d9f202d42d1d032f5b802
parent6c2f1557637174fe924b9f4354b429a0d0228d19 (diff)
downloadqutebrowser-c6f0927920ffb81bbf397d40655956828462a280.tar.gz
qutebrowser-c6f0927920ffb81bbf397d40655956828462a280.zip
Update some config docs
See #5754
-rw-r--r--doc/help/settings.asciidoc16
-rw-r--r--qutebrowser/config/configdata.yml31
2 files changed, 33 insertions, 14 deletions
diff --git a/doc/help/settings.asciidoc b/doc/help/settings.asciidoc
index b1666b2c2..76aed5a88 100644
--- a/doc/help/settings.asciidoc
+++ b/doc/help/settings.asciidoc
@@ -372,9 +372,9 @@ Default: +pass:[false]+
[[backend]]
=== backend
Backend to use to display websites.
-qutebrowser supports two different web rendering engines / backends, QtWebKit and QtWebEngine.
-QtWebKit was discontinued by the Qt project with Qt 5.6, but picked up as a well maintained fork: https://github.com/annulen/webkit/wiki - qutebrowser only supports the fork.
-QtWebEngine is Qt's official successor to QtWebKit. It's slightly more resource hungry than QtWebKit and has a couple of missing features in qutebrowser, but is generally the preferred choice.
+qutebrowser supports two different web rendering engines / backends, QtWebEngine and QtWebKit (not recommended).
+QtWebEngine is Qt's official successor to QtWebKit, and both the default/recommended backend. It's based on a stripped-down Chromium and regularily updated with security fixes and new features by the Qt project: https://wiki.qt.io/QtWebEngine
+QtWebKit was qutebrowser's original backend when the project was started. However, support for QtWebKit was discontinued by the Qt project with Qt 5.6 in 2016. The development of QtWebKit was picked up in an official fork: https://github.com/qtwebkit/qtwebkit - however, the project seems to have stalled again. The latest release (5.212.0 Alpha 4) from March 2020 is based on a WebKit version from 2016, with many known security vulnerabilities. Additionally, there is no process isolation and sandboxing. Due to all those issues, while support for QtWebKit is still available in qutebrowser for now, using it is strongly discouraged.
This setting requires a restart.
@@ -382,8 +382,8 @@ Type: <<types,String>>
Valid values:
- * +webengine+: Use QtWebEngine (based on Chromium).
- * +webkit+: Use QtWebKit (based on WebKit, similar to Safari).
+ * +webengine+: Use QtWebEngine (based on Chromium - recommended).
+ * +webkit+: Use QtWebKit (based on WebKit, similar to Safari - many known security issues!).
Default: +pass:[webengine]+
@@ -1911,6 +1911,12 @@ List of URLs to ABP-style adblocking rulesets.
Only used when Brave's ABP-style adblocker is used (see `content.blocking.method`).
+You can find an overview of available lists here:
+https://adblockplus.org/en/subscriptions - note that the special
+`subscribe.adblockplus.org` links aren't handled by qutebrowser, you will instead
+need to find the link to the raw `.txt` file (e.g. by extracting it from the
+`location` parameter of the subscribe URL and URL-decoding it).
+
Type: <<types,List of Url>>
diff --git a/qutebrowser/config/configdata.yml b/qutebrowser/config/configdata.yml
index 6eb65dce7..fa1fe593b 100644
--- a/qutebrowser/config/configdata.yml
+++ b/qutebrowser/config/configdata.yml
@@ -118,23 +118,30 @@ backend:
type:
name: String
valid_values:
- - webengine: Use QtWebEngine (based on Chromium).
- - webkit: Use QtWebKit (based on WebKit, similar to Safari).
+ - webengine: "Use QtWebEngine (based on Chromium - recommended)."
+ - webkit: "Use QtWebKit (based on WebKit, similar to Safari - many known security
+ issues!)."
default: webengine
restart: true
desc: >-
Backend to use to display websites.
qutebrowser supports two different web rendering engines / backends,
- QtWebKit and QtWebEngine.
+ QtWebEngine and QtWebKit (not recommended).
- QtWebKit was discontinued by the Qt project with Qt 5.6, but picked up as a
- well maintained fork: https://github.com/annulen/webkit/wiki - qutebrowser
- only supports the fork.
+ QtWebEngine is Qt's official successor to QtWebKit, and both the default/recommended
+ backend. It's based on a stripped-down Chromium and regularily updated with security
+ fixes and new features by the Qt project: https://wiki.qt.io/QtWebEngine
- QtWebEngine is Qt's official successor to QtWebKit. It's slightly more
- resource hungry than QtWebKit and has a couple of missing features in
- qutebrowser, but is generally the preferred choice.
+ QtWebKit was qutebrowser's original backend when the project was started. However,
+ support for QtWebKit was discontinued by the Qt project with Qt 5.6 in 2016. The
+ development of QtWebKit was picked up in an official fork:
+ https://github.com/qtwebkit/qtwebkit - however, the project seems to have stalled
+ again. The latest release (5.212.0 Alpha 4) from March 2020 is based on a WebKit
+ version from 2016, with many known security vulnerabilities. Additionally, there is
+ no process isolation and sandboxing. Due to all those issues, while support for
+ QtWebKit is still available in qutebrowser for now, using it is strongly
+ discouraged.
## qt
@@ -660,6 +667,12 @@ content.blocking.adblock.lists:
Only used when Brave's ABP-style adblocker is used (see `content.blocking.method`).
+ You can find an overview of available lists here:
+ https://adblockplus.org/en/subscriptions - note that the special
+ `subscribe.adblockplus.org` links aren't handled by qutebrowser, you will instead
+ need to find the link to the raw `.txt` file (e.g. by extracting it from the
+ `location` parameter of the subscribe URL and URL-decoding it).
+
content.blocking.whitelist:
default: []
type: