From 99a238a0dc6bfb4c943033c941a6cd9a87e0e29e Mon Sep 17 00:00:00 2001 From: Jeremy Grossmann Date: Wed, 29 Apr 2020 14:57:15 +0930 Subject: [PATCH] Update README Ref #1719 --- README.rst | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 19468f8a..250cc4ed 100644 --- a/README.rst +++ b/README.rst @@ -10,9 +10,20 @@ GNS3-server This is the GNS3 server repository. The GNS3 server manages emulators such as Dynamips, VirtualBox or Qemu/KVM. -Clients like the GNS3 GUI controls the server using a HTTP REST API. +Clients like the `GNS3 GUI `_ and the `GNS3 Web UI `_ control the server using a HTTP REST API. -You will need the GNS3 GUI (gns3-gui repository) to control the server. +Software dependencies +--------------------- + +In addition of Python dependencies listed in a section below, other software may be required, recommended or optional. + +* `uBridge `_ is required, it interconnects the nodes. +* `Dynamips `_ is required for running IOS routers (using real IOS images) as well as the internal switches and hubs. +* `VPCS `_ is recommended, it is a builtin node simulating a very simple computer to perform connectitivy tests using ping, traceroute etc. +* Qemu is strongly recommended on Linux, as most node types are based on Qemu, for example Cisco IOSv and Arista vEOS. +* libvirt is recommended (Linux only), as it's needed for the NAT cloud +* Docker is optional (Linux only), some nodes are based on Docker. +* i386-libraries of libc and libcrypto are optional (Linux only), they are only needed to run IOU based nodes. Branches -------- @@ -22,7 +33,7 @@ master master is the next stable release, you can test it in your day to day activities. Bug fixes or small improvements pull requests go here. -2.x (2.1 for example) +2.x (2.3 for example) ********************* Next major release @@ -45,11 +56,7 @@ You must be connected to the Internet in order to install the dependencies. Dependencies: -- Python 3.4 or above -- aiohttp -- setuptools -- psutil -- jsonschema +- Python 3.5.3, setuptools and the ones listed `here `_ The following commands will install some of these dependencies: