README.rst

   1 =========
   2 ifupdown2
   3 =========
   4
   5 Linux Interface Network Manager
   6
   7 * Free software: GNU General Public License v2
   8
   9 ============
  10 Installation
  11 ============
  12
  13 As of today (early june 2018), the preferred method to install ifupdown2, is by
  14 building the source code (as it will always install the most recent stable
  15 release). See `Installing latest stable release from sources`_ chapter.
  16
  17 Installing latest stable release from sources
  18 ---------------------------------------------
  19
  20 The sources for ifupdown2 can be downloaded from the `Github repo`_.
  21
  22 You can either clone the public repository:
  23
  24 .. code-block:: console
  25
  26     $ git clone git://github.com/CumulusNetworks/ifupdown2
  27
  28 Or download the `tarball`_:
  29
  30 .. code-block:: console
  31
  32     $ curl  -OL https://github.com/CumulusNetworks/ifupdown2/tarball/master
  33
  34 Once you have a copy of the source, you should build a deb-package and install it
  35
  36 .. code-block:: console
  37
  38     $ cd ifupdown2 && git checkout master-next && make deb
  39
  40 The generated deb should be in the root directory (``../ifupdown2_1.2.1_all.deb``)
  41
  42 .. code-block:: console
  43
  44     $ dpkg -i ../ifupdown2_1.2.1_all.deb
  45
  46 We don't recommend using ``setup.py install`` directly, as it's still missing systemd/init.d scripts.
  47 This capability should be added in the near future.
  48
  49 You might need to manually download dependencies. Mandatory dependencies:
  50
  51 .. code-block:: console
  52
  53     $ apt-get install build-essential devscripts dh-systemd fakeroot python-all python-docutils iproute2 python-ipaddr python-argcomplete python-setuptools
  54
  55 Suggested dependencies:
  56
  57 .. code-block:: console
  58
  59     $ apt-get install ethtool bridge-utils python-gvgen python-mako
  60
  61 .. _Github repo: https://github.com/CumulusNetworks/ifupdown2
  62 .. _tarball: https://github.com/CumulusNetworks/ifupdown2/tarball/master
  63
  64
  65 ============
  66 Contributing
  67 ============
  68
  69 Contributions are welcome, and they are greatly appreciated! Every little bit
  70 helps, and credit will always be given.
  71
  72 You can contribute in many ways:
  73
  74 Types of Contributions
  75 ----------------------
  76
  77 Report Bugs
  78 ~~~~~~~~~~~
  79
  80 Report bugs at https://github.com/CumulusNetworks/ifupdown2/issues.
  81
  82 If you are reporting a bug, please include:
  83
  84 * Your operating system name and version (``uname -a``).
  85 * Any details about your setup that might be helpful in troubleshooting.
  86 * Content of configuration files such as ``/etc/network/interfaces``
  87 * Detailed steps to reproduce the bug.
  88 * Debug output of the ifupdown2 command (see ``--debug`` option)
  89
  90 Write Documentation
  91 ~~~~~~~~~~~~~~~~~~~
  92
  93 ifupdown2 could always use more documentation, whether as part of the
  94 official ifupdown2 docs, in docstrings, or even on the web in blog posts,
  95 articles, and such.
  96
  97 Submit Feedback
  98 ~~~~~~~~~~~~~~~
  99
 100 The best way to send feedback is to file an issue at https://github.com/CumulusNetworks/ifupdown2/issues.
 101
 102 If you are proposing a feature:
 103
 104 * Explain in detail how it would work.
 105 * Keep the scope as narrow as possible, to make it easier to implement.
 106
 107 =======
 108 Credits
 109 =======
 110
 111 Development Lead
 112 ----------------
 113
 114 * Roopa Prabhu <roopa@cumulusnetworks.com>
 115 * Julien Fortin <julien@cumulusnetworks.com>
 116
 117 Contributors
 118 ------------
 119
 120 * Nikhil Gajendrakumar <nikhil.gajendrakumar@gmail.com>
 121 * Maximilian Wilhelm <max@sdn.clinic>
 122 * Sven Auhagen <sven.auhagen@voleatech.de>
 123 * skorpy <magnus@skorpy.space>
 124 * Sam Tannous <stannous@cumulusnetworks.com>
 125 * Wilson Kok <wkok@cumulusnetworks.com>
 126 * John Berezovik <berezovik@gmail.com>
 127 * Daniel Walton <dwalton76@gmail.com>
 128 * Anuradha Karuppiah <anuradhak@cumulusnetworks.com>
 129 * Balakrishnan Raman <balkee@yahoo.com>
 130 * Scott Emery <scotte@cumulusnetworks.com>
 131 * Dave Olson <olson@cumulusnetworks.com>
 132 * David Ahern <dsa@cumulusnetworks.com>
 133 * Jonathan Toppins <>
 134 * Nolan Leake <nolan@cumulusnetworks.com>
 135 * Sergey Sudakovich <sergey@cumulusnetworks.com>
 136 * Andy Gospodarek <>
 137 * Satish Ashok <sashok@cumulusnetworks.com>
 138 * Scott Laffer <slaffer@cumulusnetworks.com>
 139 * Vidya Sagar Ravipati <vidya.ravipati@gmail.com>
 140 * Marek Grzybowski <marek.grzybowski@rtbhouse.com>
 141 * Gaudenz Steinlin <gaudenz@users.noreply.github.com>
 142 * Nigel Kukard <nkukard@lbsd.net>
 143 * Jeffrey <jeffrey.bosma@gmail.com>
 144 * kokel <kokel@users.noreply.github.com>
 145
 146 Why not you too? :)
 147
 148
 149 =======
 150 History
 151 =======
 152
 153 See changelog here: https://github.com/CumulusNetworks/ifupdown2/blob/master/debian/changelog
 154
 155
 156 Credits
 157 -------
 158
 159 This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
 160
 161 .. _Cookiecutter: https://github.com/audreyr/cookiecutter
 162 .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage