Files
mirror_zfs/README.md
T

72 lines
2.7 KiB
Markdown
Raw Normal View History

2020-06-04 05:46:31 +03:00
![img](https://openzfs.github.io/openzfs-docs/_static/img/logo/480px-Open-ZFS-Secondary-Logo-Colour-halfsize.png)
2010-09-01 11:23:13 -07:00
2020-02-25 11:43:20 -08:00
OpenZFS is an advanced file system and volume manager which was originally
2017-09-22 18:54:34 -07:00
developed for Solaris and is now maintained by the OpenZFS community.
2020-02-25 11:43:20 -08:00
This repository contains the code for running OpenZFS on Linux and FreeBSD.
2017-09-22 18:54:34 -07:00
2020-02-25 11:43:20 -08:00
[![codecov](https://codecov.io/gh/openzfs/zfs/branch/master/graph/badge.svg)](https://codecov.io/gh/openzfs/zfs)
[![coverity](https://scan.coverity.com/projects/1973/badge.svg)](https://scan.coverity.com/projects/openzfs-zfs)
2016-12-09 20:48:12 +01:00
# Official Resources
2018-02-15 17:53:18 -08:00
2020-06-04 05:46:31 +03:00
* [Documentation](https://openzfs.github.io/openzfs-docs/) - for using and developing this repo
2025-11-04 06:07:58 +05:30
* [ZoL site](https://zfsonlinux.org) - Linux release info & links
2020-06-04 05:46:31 +03:00
* [Mailing lists](https://openzfs.github.io/openzfs-docs/Project%20and%20Community/Mailing%20Lists.html)
2022-01-06 18:25:01 -06:00
* [OpenZFS site](https://openzfs.org/) - for conference videos and info on other platforms (illumos, OSX, Windows, etc)
2012-07-09 11:23:00 +02:00
2016-12-09 20:48:12 +01:00
# Installation
2018-02-15 17:53:18 -08:00
2020-10-08 19:33:53 +03:00
Full documentation for installing OpenZFS on your favorite operating system can
be found at the [Getting Started Page](https://openzfs.github.io/openzfs-docs/Getting%20Started/index.html).
2020-02-25 11:43:20 -08:00
2016-12-09 20:48:12 +01:00
# Contribute & Develop
2018-02-15 17:53:18 -08:00
2017-09-22 18:54:34 -07:00
We have a separate document with [contribution guidelines](./.github/CONTRIBUTING.md).
2018-02-15 17:53:18 -08:00
2020-02-25 11:43:20 -08:00
We have a [Code of Conduct](./CODE_OF_CONDUCT.md).
2018-02-15 17:53:18 -08:00
# Release
2020-02-25 11:43:20 -08:00
OpenZFS is released under a CDDL license.
2018-02-15 17:53:18 -08:00
For more details see the NOTICE, LICENSE and COPYRIGHT files; `UCRL-CODE-235197`
2018-05-30 23:11:19 -04:00
# 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](https://kernel.org))
All **longterm** kernels from [kernel.org](https://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**: **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.0**, **14.3**, **13.5**.