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 && 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-setuptools
  54
  55 To build the deb file successfully, the following additional packages are required:
  56
  57 .. code-block:: console
  58
  59     $ apt-get install dh-python python3-all python3-setuptools python3-docutils
  60
  61 Suggested dependencies:
  62
  63 .. code-block:: console
  64
  65     $ apt-get install ethtool bridge-utils python-gvgen python-mako
  66
  67 .. _Github repo: https://github.com/CumulusNetworks/ifupdown2
  68 .. _tarball: https://github.com/CumulusNetworks/ifupdown2/tarball/master
  69
  70
  71 ============
  72 Contributing
  73 ============
  74
  75 Contributions are welcome, and they are greatly appreciated! Every little bit
  76 helps, and credit will always be given.
  77
  78 You can contribute in many ways:
  79
  80 Types of Contributions
  81 ----------------------
  82
  83 Report Bugs
  84 ~~~~~~~~~~~
  85
  86 Report bugs at https://github.com/CumulusNetworks/ifupdown2/issues.
  87
  88 If you are reporting a bug, please include:
  89
  90 * Your operating system name and version (``uname -a``).
  91 * Any details about your setup that might be helpful in troubleshooting.
  92 * Content of configuration files such as ``/etc/network/interfaces``
  93 * Detailed steps to reproduce the bug.
  94 * Debug output of the ifupdown2 command (see ``--debug`` option)
  95
  96 Write Documentation
  97 ~~~~~~~~~~~~~~~~~~~
  98
  99 ifupdown2 could always use more documentation, whether as part of the
 100 official ifupdown2 docs, in docstrings, or even on the web in blog posts,
 101 articles, and such.
 102
 103 Submit Feedback
 104 ~~~~~~~~~~~~~~~
 105
 106 The best way to send feedback is to file an issue at https://github.com/CumulusNetworks/ifupdown2/issues.
 107
 108 If you are proposing a feature:
 109
 110 * Explain in detail how it would work.
 111 * Keep the scope as narrow as possible, to make it easier to implement.
 112
 113 =======
 114 Credits
 115 =======
 116
 117 Development Lead
 118 ----------------
 119
 120 * Roopa Prabhu <roopa@cumulusnetworks.com>
 121 * Julien Fortin <julien@cumulusnetworks.com>
 122
 123 Contributors
 124 ------------
 125
 126 * Nikhil Gajendrakumar <nikhil.gajendrakumar@gmail.com>
 127 * Maximilian Wilhelm <max@sdn.clinic>
 128 * Sven Auhagen <sven.auhagen@voleatech.de>
 129 * skorpy <magnus@skorpy.space>
 130 * Alexandre Derumier <aderumier@odiso.com>
 131 * Sam Tannous <stannous@cumulusnetworks.com>
 132 * Wilson Kok <wkok@cumulusnetworks.com>
 133 * John Berezovik <berezovik@gmail.com>
 134 * Daniel Walton <dwalton76@gmail.com>
 135 * Anuradha Karuppiah <anuradhak@cumulusnetworks.com>
 136 * Balakrishnan Raman <balkee@yahoo.com>
 137 * Scott Emery <scotte@cumulusnetworks.com>
 138 * Dave Olson <olson@cumulusnetworks.com>
 139 * David Ahern <dsa@cumulusnetworks.com>
 140 * Jonathan Toppins <>
 141 * Nolan Leake <nolan@cumulusnetworks.com>
 142 * Sergey Sudakovich <sergey@cumulusnetworks.com>
 143 * Andy Gospodarek <>
 144 * Satish Ashok <sashok@cumulusnetworks.com>
 145 * Scott Laffer <slaffer@cumulusnetworks.com>
 146 * Vidya Sagar Ravipati <vidya.ravipati@gmail.com>
 147 * Marek Grzybowski <marek.grzybowski@rtbhouse.com>
 148 * Gaudenz Steinlin <gaudenz@users.noreply.github.com>
 149 * Nigel Kukard <nkukard@lbsd.net>
 150 * Jeffrey <jeffrey.bosma@gmail.com>
 151 * kokel <kokel@users.noreply.github.com>
 152
 153 Why not you too? :)
 154
 155
 156 =======
 157 History
 158 =======
 159
 160 See changelog here: https://github.com/CumulusNetworks/ifupdown2/blob/master/debian/changelog
 161
 162
 163 Credits
 164 -------
 165
 166 This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
 167
 168 .. _Cookiecutter: https://github.com/audreyr/cookiecutter
 169 .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage