]> git.proxmox.com Git - mirror_zfs.git/blame - README.md
ZTS: Skip udev actions in zvol_misc when not Linux
[mirror_zfs.git] / README.md
CommitLineData
521abcc4 1![img](https://github.com/openzfs/zfs/wiki/img/480px-Open-ZFS-Secondary-Logo-Colour-halfsize.png)
34bc5537 2
521abcc4 3OpenZFS is an advanced file system and volume manager which was originally
bb2773b3 4developed for Solaris and is now maintained by the OpenZFS community.
521abcc4 5This repository contains the code for running OpenZFS on Linux and FreeBSD.
bb2773b3 6
521abcc4
MA
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)
d57f03e4
GM
9
10# Official Resources
93ce2b4c 11
521abcc4
MA
12 * [Wiki](https://github.com/openzfs/zfs/wiki) - for using and developing this repo
13 * [ZoL Site](https://zfsonlinux.org) - Linux release info & links
14 * [Mailing lists](https://github.com/openzfs/zfs/wiki/Mailing-Lists)
15 * [OpenZFS site](http://open-zfs.org/) - for conference videos and info on other platforms (illumos, OSX, Windows, etc)
2ee4a18b 16
d57f03e4 17# Installation
93ce2b4c 18
521abcc4
MA
19Full documentation for installing OpenZFS on your favorite Linux distribution can
20be found at the [ZoL Site](https://zfsonlinux.org/).
21
22FreeBSD support is a work in progress. See the [PR](https://github.com/openzfs/zfs/pull/8987).
d57f03e4
GM
23
24# Contribute & Develop
93ce2b4c 25
bb2773b3 26We have a separate document with [contribution guidelines](./.github/CONTRIBUTING.md).
93ce2b4c 27
521abcc4
MA
28We have a [Code of Conduct](./CODE_OF_CONDUCT.md).
29
93ce2b4c
BB
30# Release
31
521abcc4 32OpenZFS is released under a CDDL license.
93ce2b4c 33For more details see the NOTICE, LICENSE and COPYRIGHT files; `UCRL-CODE-235197`
928046b7
AR
34
35# Supported Kernels
521abcc4 36 * The `META` file contains the officially recognized supported Linux kernel versions.