Installation
Edit pageGetting Xapiand installed and ready-to-go should only take a few minutes. If it ever becomes a pain, please file an issue (or submit a pull request) describing the issue you encountered and how we might make the process easier.
Docker
Section titled “Docker”docker pull ghcr.io/kronuz/xapiand:latestThe image is multi-arch and exposes port 8880. Arguments after the image name
are options of xapiand:
docker run -p 8880:8880 -v xapiand-data:/var/db/xapiand --rm \ ghcr.io/kronuz/xapiand:latest -vvvvThe entrypoint keeps the indexes in /var/db/xapiand and runs the node as the
xapiand user. These environment variables set what the matching option does,
unless the command line gives the option itself:
| Variable | Option | Default |
|---|---|---|
XAPIAND_DATABASE | -D, --database | /var/db/xapiand |
XAPIAND_NAME | --name | the container’s host name |
XAPIAND_UID | --uid | the user the container runs as (xapiand for root) |
XAPIAND_GID | --gid | the group the container runs as (xapiand for root) |
Installation with Homebrew
Section titled “Installation with Homebrew”Xapiand contains a formula for Homebrew (a package manager for OS X). It can be installed by using the following command:
brew install Kronuz/tap/xapiandFreeBSD
Section titled “FreeBSD”A native FreeBSD package (amd64, built for FreeBSD 14) is attached to each
release. Download it and install
the local package file with:
pkg add ./xapiand-*.pkgRPM (x86_64, aarch64) and DEB (amd64, arm64) packages are attached to
each release. Download the one
matching your distribution and architecture and install it:
# RPM-based (Fedora, RHEL, CentOS, ...):sudo rpm -i xapiand-*.x86_64.rpm
# DEB-based (Debian 13+, Ubuntu 24.04+):sudo dpkg -i xapiand_*_amd64.debA multi-arch Docker image is also available for any distribution.
Checking the install
Section titled “Checking the install”xapiand --versionxapiand --helpxapiand --help lists every option; they are described in
Options. Start the node and follow the
Quick-start to use it.
Building
Section titled “Building”You can also build and install from the sources if there’s no other way. You can find information about how to build from the sources here.