= Installation =

== 1. Requirements ==
* To generate a Makefile qmake, must be installed. This can be done with the following command:
{{{
  apt-get install qt4-qmake
}}}

* To build the mcproxy, the libraries boost_threat, boost_date_time and boost_system must be installed. This can be done with the following command:
{{{
  apt-get install libboost-all-dev
}}}

* To use the IPv6 functionality the kernel has to be configured and compiled with the experimental kernel feature <IPv6: multicast routing>. For more Details see this [wiki:Kernel page].

* To use more then one proxy instance for IPv4 and the IPv6 the kernel has to be configured and compiled with the experimental kernel feature <IP: multicast policy routing and IPv6: multicast policy routing>. For more Details see this [wiki:Kernel page].

* To build the documentation, doxygen must be installed. This can be done with the folling command:
{{{
  apt-get install doxygen
}}}

* The mcproxy has to be started with root privileges.

* A Linux kernel version greater than version 2.6.32 is required.


== 2. Compilation ==
* Build mcproxy
{{{
  qmake mcproxy.pro
  make
}}}

== 3. Installation ==
* To copy mcproxy to system directories, run (optional):
{{{
  make install
}}}

== 4. Documentation ==
* Mcproxy includes a HTML documentation. The documentation will be located in the docs/ directory after the execution of:
{{{
  make doc
}}}

== 5. Startup ==
 * For information on how to use mcproxy see [wiki:Startup].