azizur77 / cloonix Goto Github PK

-----------------------------------------------------------------------------
AGPLv3 software for a tool that helps in the creation of virtual 
machine networks.

See directory cloonix for the LICENCE

See cloonix.fr for more documentation.
-----------------------------------------------------------------------------


--------------------------------------
Build and install from github sources:
--------------------------------------

    git clone --depth=1 https://github.com/clownix/cloonix.git
    cd cloonix
    ./install_depends build
    ./doitall

  Whatever the distribution, packets have to be installed for the build,
  the install_depends file detects the distribution and installs all
  the necessary packages for the build.
  It must be run with root privilege.
  
  Then then a call to ./doitall does the build, and at the end, installs
  the binaries in /usr/local/bin (root privilege necessary for the
  install part).

  Be aware that your cloonix_config must be saved because it is overwritten
  with each new install, the config has been put in:
  /usr/local/bin/cloonix/cloonix_config.

-----------------------------------------------------------------------------



-----------------------------------------------------------
Install from already compiled binaries found at cloonix.fr:
-----------------------------------------------------------

    wget http://cloonix.fr/bin_stored/v-39-00/stretch-cloonix-39-00.tar.gz
    wget http://cloonix.fr/bin_stored/v-39-00/install_depends.gz
    wget http://cloonix.fr/bin_stored/v-39-00/install_cloonix.gz
    gunzip install_depends.gz
    gunzip install_cloonix.gz
    chmod +x install_depends
    chmod +x install_cloonix
    ./install_depends run
    ./install_cloonix stretch-cloonix-39-00.tar.gz

  To run the pre-compiled software, the host needs a subset of the packets
  needed for the build, install_depends can be launched with run as input
  to install the packages needed for the run.
  It must be run with root privilege.


----------------------------------------------------------
To use the software, a virtual machine qcow2 is necessary:
----------------------------------------------------------
       
    wget http://cloonix.fr/bulk_stored/v-39-00/stretch.qcow2.xz
    mv stretch.qcow2.xz ${HOME}/cloonix_data/bulk
    cd ${HOME}/cloonix_data/bulk
    xz -d stretch.qcow2.xz

  After the install, download one of the virtual machines provided at
  cloonix.fr, for example, choose the stretch.qcow2, and put it in your
  "bulk" directory, see in /usr/local/bin/cloonix/cloonix_config the
  path for the bulk directory which is by default: 
  ${HOME}/cloonix_data/bulk. 
  

-----------------------------------------
Use a demo script to begin using cloonix:
-----------------------------------------

  http://cloonix.fr/demo_stored/v-39-00

  Download one of the demo scripts provided at cloonix.fr, choose the 
  ping.tar.gz because it is the simplest one, untar and launch it.
  


NOTES:
-----
  To use the sniffer, you must install wireshark-qt on the machine
  hosting the cloonix server.
  To build a cisco csr1000v machine compatible with cloonix, see the
  documentation at http://cloonix.fr

  On a jessie host, from the 37.03 version, you must have an updated 
  glib2, to make the spice compilation work, I did:
  tar xvf glib2.0_2.48.0.orig.tar.xz
  ./configure --prefix=/usr/local
  make
  make install

---------------------------------------------------------------------
If no machine wants to be created, test the compilation of the qemu
with a working machine qcow2 as follows:

export LD_LIBRARY_PATH="/usr/local/bin/cloonix/common/spice/spice_lib"
/usr/local/bin/cloonix/server/qemu/qemu_bin/qemu-system-x86_64 \
-L /usr/local/bin/cloonix/server/qemu/qemu_bin \
-hda openwrt.qcow2 -nographic
---------------------------------------------------------------------