zfs README

The project's README from github.com/openzfs/zfs. As one markdown file: README.md.

img

OpenZFS is an advanced file system and volume manager which was originally developed for Solaris and is now maintained by the OpenZFS community. This repository contains the code for running OpenZFS on Linux and FreeBSD.

codecov coverity

Official Resources

Installation

Full documentation for installing OpenZFS on your favorite operating system can be found at the Getting Started Page.

Contribute & Develop

We have a separate document with contribution guidelines.

We have a Code of Conduct.

Release

OpenZFS is released under a CDDL license. For more details see the NOTICE, LICENSE and COPYRIGHT files; UCRL-CODE-235197

Supported Kernels and Distributions

Linux

Given the wide variety of Linux environments, we prioritize development and testing on stable, supported kernels and distributions.

Kernel (kernel.org)

All longterm kernels from kernel.org are supported. stable kernels are usually supported in the next OpenZFS release.

Supported longterm kernels: 6.18, 6.12, 6.6, 6.1, 5.15, 5.10.

Red Hat Enterprise Linux (RHEL)

All RHEL (and compatible systems: AlmaLinux OS, Rocky Linux, etc) on the full or maintenance support tracks are supported.

Supported RHEL releases: 8.10, 9.7, 10.1.

Ubuntu

All Ubuntu LTS releases are supported.

Supported Ubuntu releases: 26.04 “Resolute”, 24.04 “Noble”, 22.04 “Jammy”.

Debian

All Debian stable and LTS releases are supported.

Supported Debian releases: 13 “Trixie”, 12 “Bookworm”, 11 “Bullseye”.

Other Distributions

Generally, if a distribution is following an LTS kernel, it should work well with OpenZFS.

FreeBSD

All FreeBSD releases receiving security support are supported by OpenZFS.

Supported FreeBSD releases: 15.1, 14.4.

zfs (openzfs/zfs)

Searching Database…

12.5K ·GitHub
What is this?OpenZFS is an advanced file system and volume manager that started life on Solaris and is now maintained by the OpenZFS community. This repository contains the code for running it on Linux and FreeBSD.
Is it its own operating system, or something I install onto an existing one?Something you install: OpenZFS is not an OS, it's a file system and volume manager that runs on top of Linux or FreeBSD.
How do I get it installed?Follow the official Getting Started Page — it has full installation documentation for every supported operating system.
Will it run on my Linux distro and kernel version?Very likely: all kernel.org longterm kernels are supported (6.18, 6.12, 6.6, 6.1, 5.15, 5.10), plus RHEL 8.10/9.7/10.1 with AlmaLinux and Rocky, Ubuntu LTS 26.04/24.04/22.04 and Debian 13/12/11.
My distro is not on that list — am I out of luck?Probably not: any distribution following an LTS kernel should generally work well, though development and testing are prioritized on the stable, supported ones.
I mainly use macOS and Windows — will it work there?Not from this repo, which targets Linux and FreeBSD (FreeBSD 15.1 and 14.4 are supported). Ports for illumos, OSX and Windows exist as separate OpenZFS efforts listed on the OpenZFS site.
Do non-LTS kernels get any support?Usually yes — stable kernels are typically supported in the next OpenZFS release; the guaranteed list is the kernel.org longterm kernels from 6.18 down to 5.10.
Creator
openzfs
Size
157.6 MB
Stars
12.5K
Age
16y
Commits · 90 Days