|
Note
|
qutebrowser recently had some bigger dependency changes for v1.0.0, which means those instructions might be out of date in some places. Please help updating them if you notice something being broken! |
How to install qutebrowser depends a lot on the version of Debian/Ubuntu you’re running.
Those distributions only have Python 3.4 and a too old Qt version available, while qutebrowser requires Python 3.5 and Qt 5.7.1 or newer.
It should be possible to install Python 3.5 e.g. from the deadsnakes PPA or via_ipca pyenv, but nobody tried that yet.
If you get qutebrowser running on those distributions, please contribute to update this documentation!
Ubuntu 16.04 doesn’t come with an up-to-date engine (a new enough QtWebKit, or QtWebEngine). However, it comes with Python 3.5, so you can install qutebrowser via tox.
Those versions come with QtWebEngine in the repositories. This makes it possible to install qutebrowser via the Debian package.
Install the dependencies via apt-get:
# apt install python-tox python3-{lxml,pyqt5,sip,jinja2,pygments,yaml} python3-pyqt5.qt{webengine,quick,opengl,sql} libqt5sql5-sqlite
Get the qutebrowser package from the release page and download the PyPEG2 package.
Install the packages:
# dpkg -i python3-pypeg2_*_all.deb # dpkg -i qutebrowser_*_all.deb
Some additional hints:
-
Alternatively, you can install qutebrowser via tox to get a newer QtWebEngine version.
-
If running from git, run the following to generate the documentation for the
:helpcommand:# apt-get install --no-install-recommends asciidoc source-highlight $ python3 scripts/asciidoc2html.py
-
If you prefer using QtWebKit, there’s an up-to-date version available in Debian experimental, or from this repository for Debian Stretch.
-
If video or sound don’t work with QtWebKit, try installing the gstreamer plugins:
# apt-get install gstreamer1.0-plugins-{bad,base,good,ugly}
qutebrowser is available in the official repositories for Fedora 22 and newer.
# dnf install qutebrowser
It’s also recommended to install python3-qt5-webengine and start with --backend
webengine to use the new backend.
qutebrowser is available in the official [community] repository.
# pacman -S qutebrowser
Archlinux packages an updated qt5-webkit package by default. If you want to
use the QtWebEngine backend instead, install qt5-webengine and start with
--backend webengine.
There is also a -git version available in the AUR: qutebrowser-git.
You can install it using makepkg like this:
$ git clone https://aur.archlinux.org/qutebrowser-git.git $ cd qutebrowser-git $ makepkg -si $ cd .. $ rm -r qutebrowser-git
or you could use an AUR helper, e.g. yaourt -S qutebrowser-git.
If video or sound don’t work with QtWebKit, try installing the gstreamer plugins:
# pacman -S gst-plugins-{base,good,bad,ugly} gst-libav
|
Warning
|
The Gentoo packages (even the live version) are lagging behind a lot, which means those instructions probably won’t work anymore. Until things are looking better, it’s recommended to install qutebrowser via tox. |
A version of qutebrowser is available in the main repository and can be installed with:
# emerge -av qutebrowser
However it is suggested to install the Live version (-9999) to take advantage of the newest features introduced.
First of all you need to edit your package.accept_keywords file to accept the live version:
# nano /etc/portage/package.accept_keywords
And add the following line to it:
=www-client/qutebrowser-9999 **
Save the file and then install qutebrowser via
# emerge -av qutebrowser
Or rebuild your system if you already installed it.
To update to the last Live version, remember to do
# emerge -uDNav @live-rebuild @world
To include qutebrowser among the updates.
Make sure you have python3_4 in your PYTHON_TARGETS
(/etc/portage/make.conf) and rebuild your system (emerge -uDNav @world) if
necessary.
You’ll also need to install dev-qt/qtwebengine or a newer QtWebKit using
this ebuild.
If video or sound don’t work with QtWebKit, try installing the gstreamer plugins:
# emerge -av gst-plugins-{base,good,bad,ugly,libav}
To be able to play videos with proprietary codecs with QtWebEngine, you will
need to turn off the bindist flag for dev-qt/qtwebengine.
See the Gentoo Wiki for more information.
qutebrowser is available in the official repositories and can be installed with:
# xbps-install qutebrowser
It’s currently recommended to install python3-PyQt5-webengine and
python3-PyQt5-opengl, then start with --backend webengine to use the new
backend.
Nixpkgs collection contains pkgs.qutebrowser since June 2015. You can install
it with:
$ nix-env -i qutebrowser
It’s recommended to install qt5.qtwebengine and start with
--backend webengine to use the new backend.
There are prebuilt RPMs available at OBS.
To use the QtWebEngine backend, install libqt5-qtwebengine.
qutebrowser is in OpenBSD ports.
Install the package:
# pkg_add qutebrowser
Or alternatively, use the ports system :
# cd /usr/ports/www/qutebrowser # make install
There are different ways to install qutebrowser on Windows:
Prebuilt standalone packages and installers are built for every release.
-
PackageManagement PowerShell module
PS C:\> Install-Package qutebrowser
-
Chocolatey’s client
C:\> choco install qutebrowser
-
Use the installer from python.org to get Python 3 (be sure to install pip).
-
Use the installer from Riverbank computing to get Qt and PyQt5.
$ pip install tox
The easiest way to install qutebrowser on macOS is to use the prebuilt .app
files from the
release page.
This binary is also available through the Homebrew Cask package manager:
$ brew cask install qutebrowser
Alternatively, you can install the dependencies via a package manager (like Homebrew or MacPorts) and run qutebrowser from source.
$ brew install qt5 $ pip3 install qutebrowser
Homebrew’s builds of Qt and PyQt no longer include QtWebKit - if you need QtWebKit support, it is necessary to build from source. The build takes several hours on an average laptop.
$ brew install qt5 --with-qtwebkit $ brew install -s pyqt5 $ pip3 install qutebrowser
There are example .desktop and icon files provided. They would go in the
standard location for your distro (/usr/share/applications and
/usr/share/pixmaps for example).
The normal setup.py install doesn’t install these files, so you’ll have to do
it as part of the packaging process.
First of all, clone the repository using git and switch into the repository folder:
$ git clone https://github.com/qutebrowser/qutebrowser.git $ cd qutebrowser
Then run tox inside the qutebrowser repository to set up a virtual environment:
$ tox -e mkvenv-pypi
If your distribution uses OpenSSL 1.1 (like Debian Stretch or Archlinux), you’ll
need to set LD_LIBRARY_PATH to the OpenSSL 1.0 directory
(export LD_LIBRARY_PATH=/usr/lib/openssl-1.0 on Archlinux) before starting
qutebrowser.
Alternatively, you can use tox -e mkvenv (without -pypi) to symlink your
local Qt install instead of installing PyQt in the virtualenv. However, unless
you have QtWebKit-NG or QtWebEngine available, qutebrowser will use the legacy
QtWebKit backend.
On Windows, run `tox -e mkvenv-win instead, however make sure that ONLY Python3 is in your PATH before running tox.
This installs all needed Python dependencies in a .venv subfolder.
You can then create a simple wrapper script to start qutebrowser somewhere in
your $PATH (e.g. /usr/local/bin/qutebrowser or ~/bin/qutebrowser):
#!/bin/bash ~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser "$@"
When you updated your local copy of the code (e.g. by pulling the git repo, or extracting a new version), the virtualenv should automatically use the updated code. However, if dependencies got added, this won’t be reflected in the virtualenv. Thus it’s recommended to run the following command to recreate the virtualenv:
$ tox -r -e mkvenv-pypi