From 1da7f82d202661347f566bb48a49d2c3be1377ba Mon Sep 17 00:00:00 2001 From: ByteOtter Date: Sat, 15 Jun 2024 00:25:13 +0200 Subject: [PATCH] Add installation guide to docs --- docs/installation.rst | 51 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/docs/installation.rst b/docs/installation.rst index 3c05e58..87900b5 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,3 +1,54 @@ *********************** Installing Cobbler-TFTP *********************** + +Please note that Cobbler-TFTP is currently still in an early development stage and is not yet ready to be released. +However, these methods of Installation will be available: + +Installation Requirements +========================= + +To install and use Cobbler-TFTP, please make sure you have *at least Python 3.6* installed. + +### Install via `pip` + +Cobbler-TFTP is published to PyPi. +To install it, please make sure that your system fulfills the installation requirements listed above and has `pip`, +the Python package manager, installed. + +To install Cobbler-TFTP you can then simply run: + +.. code-block:: bash + +pip install cobbler-tftp + + +Install on Linux via Package manager +==================================== + +Cobbler-TFTP is packaged for a number of Linux distributions. + +Note: The native linux packages do not yet exist. +These instructions are just representing what we have planned for the near future. + +Install on openSUSE +------------------- + +.. code-block:: bash + +sudo zypper install cobbler-tftp + +Install on Fedora +----------------- + +.. code-block:: bash + +sudo dnf install cobbler-tftp + + +Install on Debian, Ubuntu and Linux Mint +---------------------------------------- + +.. code-block:: bash + +sudo apt install cobbler-tftp