Skip to main content
Version: main branch

Installation

Quickwit compiles to a single binary and we provide different methods to install it:

Prerequisites​

Quickwit is officially only supported for Linux. Freebsd and MacOS are not officially supported, but should work as well.

Quickwit supplies binaries for x86-64 and aarch64. No special instruction set is required, but on x86-64 SSE3 is recommended. Support of aarch64 is currently experimental.

Download​

Version: nightly - License: AGPL V3 - Downloads .tar.gz:

Check out the available builds in greater detail on GitHub

Note on external dependencies​

Quickwit depends on the following external libraries to work correctly:

  • libssl: the industry defacto cryptography library. These libraries can be installed on your system using the native package manager. You can install these dependencies using the following command:
apt-get -y update && apt-get -y install libssl

Additionally it requires a few more dependencies to compile it. These dependencies are not required on production system:

  • clang: used to compile some dependencies.
  • protobuf-compiler: used to compile protobuf definitions.
  • libssl-dev: headers for libssl.
  • pkg-config: used to locate libssl.
  • cmake: used to build librdkafka, for kafka support. These dependencies can be installed on your system using the native package manager. You can install these dependencies using the following command:
apt install -y clang protobuf-compiler libssl-dev pkg-config cmake

Install script​

To easily install Quickwit on your machine, just run the command below from your preferred shell. The script detects the architecture and then downloads the correct binary archive for the machine.

curl -L https://install.quickwit.io | sh

All this script does is download the correct binary archive for your machine and extracts it in the current working directory. This means you can download any desired archive from github that matches your OS architecture and manually extract it anywhere.

Once installed or extracted, all of Quickwit's installation files can be found in a directory named quickwit-{version} where version is the corresponding version of Quickwit. This directory has the following layout:

quickwit-{version}
    ├── config
    │   └── quickwit.yaml
    ├── LICENSE_AGPLv3.0.txt
    ├── quickwit
    └── qwdata
  • config/quickwit.yaml: is the default configuration file.
  • LICENSE_AGPLv3.0.txt: the license file.
  • quickwit: the quickwit executable binary.
  • qwdata/: the default data directory.

Use the Docker image​

If you use Docker, this might be one of the quickest way to get going. The following command will pull the image from Docker Hub and start a container ready to execute Quickwit commands.

docker run --rm quickwit/quickwit --version

# If you are using Apple silicon based macOS system you might need to specify the platform.
# You can also safely ignore jemalloc warnings.
docker run --rm --platform linux/amd64 quickwit/quickwit --version

To get the full gist of this, follow the Quickstart guide.