Mathias Gibbens 7f3d021349 Include the debian security and -updates repos as well in sources.list
Users following the ZFS guide may not realize their system won't
receive important security updates between minor point releases
unless additional configuration is added to sources.list.

Signed-off-by: Mathias Gibbens <mathias@calenhad.com>
2020-11-25 17:17:29 -06:00
2020-05-27 13:12:55 -05:00

.. image:: docs/_static/img/logo/480px-Open-ZFS-Secondary-Logo-Colour-halfsize.png
.. highlight:: sh

OpenZFS Documentation
=====================

Public link: https://openzfs.github.io/openzfs-docs/

Building Locally
----------------

Install Prerequisites
~~~~~~~~~~~~~~~~~~~~~

The dependencies are available via pip::

   # For Debian based distros
   sudo apt install python3-pip
   # For RPM-based distros
   sudo yum install python3-pip

   pip3 install -r docs/requirements.txt
   # Add ~/.local/bin to your $PATH, e.g. by adding this to ~/.bashrc:
   PATH=$HOME/.local/bin:$PATH

Build
~~~~~

::

   cd docs
   make html
   # HTML files will be generated in: _build/html
Description
OpenZFS Documentation
Readme 2 MiB
Languages
Python 83.7%
Shell 16.1%
Makefile 0.2%