]> git.proxmox.com Git - mirror_zfs.git/blame - README.md
etc/init.d: decide which variant to use at build time.
[mirror_zfs.git] / README.md
CommitLineData
52998c7f 1![img](https://openzfs.github.io/openzfs-docs/_static/img/logo/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
52998c7f 12 * [Documentation](https://openzfs.github.io/openzfs-docs/) - for using and developing this repo
521abcc4 13 * [ZoL Site](https://zfsonlinux.org) - Linux release info & links
52998c7f 14 * [Mailing lists](https://openzfs.github.io/openzfs-docs/Project%20and%20Community/Mailing%20Lists.html)
862d5dfc 15 * [OpenZFS site](https://openzfs.org/) - for conference videos and info on other platforms (illumos, OSX, Windows, etc)
2ee4a18b 16
d57f03e4 17# Installation
93ce2b4c 18
b0c9239f
GM
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).
521abcc4 21
d57f03e4 22# Contribute & Develop
93ce2b4c 23
bb2773b3 24We have a separate document with [contribution guidelines](./.github/CONTRIBUTING.md).
93ce2b4c 25
521abcc4
MA
26We have a [Code of Conduct](./CODE_OF_CONDUCT.md).
27
93ce2b4c
BB
28# Release
29
521abcc4 30OpenZFS is released under a CDDL license.
93ce2b4c 31For more details see the NOTICE, LICENSE and COPYRIGHT files; `UCRL-CODE-235197`
928046b7
AR
32
33# Supported Kernels
521abcc4 34 * The `META` file contains the officially recognized supported Linux kernel versions.
126efb58 35 * Supported FreeBSD versions are any supported branches and releases starting from 12.4-RELEASE.