========= ifupdown2 ========= Linux Interface Network Manager * Free software: GNU General Public License v2 ============ Installation ============ As of today (early june 2018), the preferred method to install ifupdown2, is by building the source code (as it will always install the most recent stable release). See `Installing latest stable release from sources`_ chapter. Installing latest stable release from sources --------------------------------------------- The sources for ifupdown2 can be downloaded from the `Github repo`_. You can either clone the public repository: .. code-block:: console $ git clone git://github.com/CumulusNetworks/ifupdown2 Or download the `tarball`_: .. code-block:: console $ curl -OL https://github.com/CumulusNetworks/ifupdown2/tarball/master Once you have a copy of the source, you should build a deb-package and install it .. code-block:: console $ cd ifupdown2 && git checkout master && make deb The generated deb should be in the root directory (``../ifupdown2_1.2.1_all.deb``) .. code-block:: console $ dpkg -i ../ifupdown2_1.2.1_all.deb We don't recommend using ``setup.py install`` directly, as it's still missing systemd/init.d scripts. This capability should be added in the near future. You might need to manually download dependencies. Mandatory dependencies: .. code-block:: console $ apt-get install build-essential devscripts dh-systemd fakeroot python-all python-docutils iproute2 python-ipaddr python-setuptools To build the deb file successfully, the following additional packages are required: .. code-block:: console $ apt-get install dh-python python3-all python3-setuptools python3-docutils Suggested dependencies: .. code-block:: console $ apt-get install ethtool bridge-utils python-gvgen python-mako .. _Github repo: https://github.com/CumulusNetworks/ifupdown2 .. _tarball: https://github.com/CumulusNetworks/ifupdown2/tarball/master ============ Contributing ============ Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. You can contribute in many ways: Types of Contributions ---------------------- Report Bugs ~~~~~~~~~~~ Report bugs at https://github.com/CumulusNetworks/ifupdown2/issues. If you are reporting a bug, please include: * Your operating system name and version (``uname -a``). * Any details about your setup that might be helpful in troubleshooting. * Content of configuration files such as ``/etc/network/interfaces`` * Detailed steps to reproduce the bug. * Debug output of the ifupdown2 command (see ``--debug`` option) Write Documentation ~~~~~~~~~~~~~~~~~~~ ifupdown2 could always use more documentation, whether as part of the official ifupdown2 docs, in docstrings, or even on the web in blog posts, articles, and such. Submit Feedback ~~~~~~~~~~~~~~~ The best way to send feedback is to file an issue at https://github.com/CumulusNetworks/ifupdown2/issues. If you are proposing a feature: * Explain in detail how it would work. * Keep the scope as narrow as possible, to make it easier to implement. ======= Credits ======= Development Lead ---------------- * Roopa Prabhu * Julien Fortin Contributors ------------ * Nikhil Gajendrakumar * Maximilian Wilhelm * Sven Auhagen * skorpy * Alexandre Derumier * Sam Tannous * Wilson Kok * John Berezovik * Daniel Walton * Anuradha Karuppiah * Balakrishnan Raman * Scott Emery * Dave Olson * David Ahern * Jonathan Toppins <> * Nolan Leake * Sergey Sudakovich * Andy Gospodarek <> * Satish Ashok * Scott Laffer * Vidya Sagar Ravipati * Marek Grzybowski * Gaudenz Steinlin * Nigel Kukard * Jeffrey * kokel Why not you too? :) ======= History ======= See changelog here: https://github.com/CumulusNetworks/ifupdown2/blob/master/debian/changelog Credits ------- This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template. .. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage