]> git.proxmox.com Git - mirror_zfs.git/blob - README.md
Update README for OpenZFS
[mirror_zfs.git] / README.md
1 ![img](https://github.com/openzfs/zfs/wiki/img/480px-Open-ZFS-Secondary-Logo-Colour-halfsize.png)
2
3 OpenZFS is an advanced file system and volume manager which was originally
4 developed for Solaris and is now maintained by the OpenZFS community.
5 This 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 * [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)
16
17 # Installation
18
19 Full documentation for installing OpenZFS on your favorite Linux distribution can
20 be found at the [ZoL Site](https://zfsonlinux.org/).
21
22 FreeBSD support is a work in progress. See the [PR](https://github.com/openzfs/zfs/pull/8987).
23
24 # Contribute & Develop
25
26 We have a separate document with [contribution guidelines](./.github/CONTRIBUTING.md).
27
28 We have a [Code of Conduct](./CODE_OF_CONDUCT.md).
29
30 # Release
31
32 OpenZFS is released under a CDDL license.
33 For more details see the NOTICE, LICENSE and COPYRIGHT files; `UCRL-CODE-235197`
34
35 # Supported Kernels
36 * The `META` file contains the officially recognized supported Linux kernel versions.