git.sesse.net Git - bcachefs-tools-debian/blob - INSTALL

   1 -- Getting started --
   2
   3 Dependencies:
   4
   5  * libaio
   6  * libblkid
   7  * libkeyutils
   8  * liblz4
   9  * libscrypt
  10  * libsodium
  11  * liburcu
  12  * libuuid
  13  * libzstd
  14  * pkg-config
  15  * zlib1g
  16  * valgrind
  17
  18 Debian (Bullseye or later) and Ubuntu (20.04 or later): you can install these with
  19     apt install -y pkg-config libaio-dev libblkid-dev libkeyutils-dev \
  20         liblz4-dev libscrypt-dev libsodium-dev liburcu-dev libzstd-dev \
  21         uuid-dev zlib1g-dev valgrind libudev-dev git build-essential \
  22         python3 python3-docutils
  23
  24 Fedora: install the "Development tools" group along with:
  25     dnf install -y libaio-devel libsodium-devel \
  26         libblkid-devel libzstd-devel zlib-devel userspace-rcu-devel \
  27         lz4-devel libuuid-devel valgrind-devel keyutils-libs-devel \
  28         libscrypt-devel findutils
  29
  30 Arch: install bcachefs-tools-git from the AUR.
  31 Or to build from source, install libscrypt from the AUR along with,
  32     pacman -S base-devel libaio keyutils libsodium liburcu zstd valgrind
  33
  34 Then, just make && make install
  35
  36
  37 -- Experimental features --
  38
  39 Experimental fuse support is currently disabled by default. Fuse support is at
  40 an early stage and may corrupt your filesystem, so it should only be used for
  41 testing. To enable, you'll also need to add:
  42
  43 * libfuse3 >= 3.7
  44
  45 On Debian/Ubuntu (Bullseye/20.04 or later needed for libfuse >= 3.7):
  46     apt install -y libfuse3-dev
  47
  48 On Fedora (32 or later needed for lbifuse >= 3.7):
  49     dnf install -y fuse3-devel
  50
  51 Arch:
  52     pacman -S fuse3
  53
  54 Then, make using the BCACHEFS_FUSE environment variable (make clean first if
  55 previously built without fuse support):
  56
  57 BCACHEFS_FUSE=1 make && make install
  58
  59
  60 -- Tests --
  61
  62 Some tests are available to validate the "bcachefs" binary.  The tests depend
  63 on python3 pytest.
  64
  65 On debian:
  66     apt install -u python3-pytest
  67
  68 Then, you can run the tests via:
  69
  70     make check
  71     # or if pytest has a different name
  72     make check PYTEST=pytest
  73
  74 Optionally, you may wish to run tests in parallel using python3-pytest-xdist:
  75
  76     cd tests; pytest-3 -n4