xref: /freebsd/sys/contrib/openzfs/README.md (revision 7ef62cebc2f965b0f640263e179276928885e33d) 
1![img](https://openzfs.github.io/openzfs-docs/_static/img/logo/480px-Open-ZFS-Secondary-Logo-Colour-halfsize.png)
2
3OpenZFS is an advanced file system and volume manager which was originally
4developed for Solaris and is now maintained by the OpenZFS community.
5This repository contains the code for running OpenZFS on Linux and FreeBSD.
6
7[![codecov](https://codecov.io/gh/openzfs/zfs/branch/master/graph/badge.svg)](https://codecov.io/gh/openzfs/zfs)
8[![coverity](https://scan.coverity.com/projects/1973/badge.svg)](https://scan.coverity.com/projects/openzfs-zfs)
9
10# Official Resources
11
12  * [Documentation](https://openzfs.github.io/openzfs-docs/) - for using and developing this repo
13  * [ZoL Site](https://zfsonlinux.org) - Linux release info & links
14  * [Mailing lists](https://openzfs.github.io/openzfs-docs/Project%20and%20Community/Mailing%20Lists.html)
15  * [OpenZFS site](https://openzfs.org/) - for conference videos and info on other platforms (illumos, OSX, Windows, etc)
16
17# Installation
18
19Full documentation for installing OpenZFS on your favorite operating system can
20be found at the [Getting Started Page](https://openzfs.github.io/openzfs-docs/Getting%20Started/index.html).
21
22# Contribute & Develop
23
24We have a separate document with [contribution guidelines](./.github/CONTRIBUTING.md).
25
26We have a [Code of Conduct](./CODE_OF_CONDUCT.md).
27
28# Release
29
30OpenZFS is released under a CDDL license.
31For more details see the NOTICE, LICENSE and COPYRIGHT files; `UCRL-CODE-235197`
32
33# Supported Kernels
34  * The `META` file contains the officially recognized supported Linux kernel versions.
35  * Supported FreeBSD versions are any supported branches and releases starting from 12.2-RELEASE.
36