GNS3 server
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Jeremy Grossmann 3634cc8307
Merge pull request #2094 from mm1ke/master
3 days ago
.github/workflows Use Python 3.7 to publish API documentation 5 months ago
conf Config option to disable built-in templates 2 months ago
docs Fix link for appliance JSON schema 2 years ago
gns3server Revert "Development on v2.2.34dev2" 2 months ago
init gns3.service.openrc: make openrc script posix compliant 3 days ago
scripts Release web Ui 2.2.32 with correct version displayed 4 months ago
tests Fix Docker tests 2 months ago
.coveragerc Fix coveralls configuration 7 years ago
.gitattributes Keep the untouched when merging 6 years ago
.gitignore Added workaround for #1690. Added venv/ to .gitignore 3 years ago
.whitesource Add .whitesource configuration file 2 years ago
AUTHORS Adjust AUTHORS. 7 years ago
CHANGELOG Release v2.2.33.1 2 months ago Merge branch 'master' into 1.5 6 years ago
Dockerfile chore : use --no-cache-dir flag to pip in dockerfiles to save space 11 months ago
LICENSE Project structure & tools (pytest, tox etc.) 9 years ago Include conf file in Ref #2044 5 months ago
README.rst Fix dead link in README.rst Fixes #2022 7 months ago Create 5 months ago
appveyor.yml Remove not working trigger of nightly build 5 years ago
dev-requirements.txt Upgrade dependencies 6 months ago
gns3server.bat Made the gns3server.bat successfully start the server independent of the CWD at the time of running. It's now relative to the location of the .bat file itself. 7 years ago
mac-requirements.txt Move jsonschema 2.6.0 requirement in build repository. 2 years ago
pytest.ini pytest.ini for ignoring files and recording DEBUG level in tests 5 years ago
readthedocs.yml Use Python3.6 to build the API documentation. 4 years ago
requirements.txt Upgrade sentry-sdk and psutil 2 months ago Early support for Python3.10 Fixes #1940 1 year ago
win-requirements.txt Upgrade dependencies 6 months ago



.. image::

.. image::

.. image::

This is the GNS3 server repository.

The GNS3 server manages emulators such as Dynamips, VirtualBox or Qemu/KVM.
Clients like the `GNS3 GUI <>`_ and the `GNS3 Web UI <>`_ control the server using a HTTP REST API.

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.
* mtools is recommended to support data transfer to/from QEMU VMs using virtual disks.
* i386-libraries of libc and libcrypto are optional (Linux only), they are only needed to run IOU based nodes.


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.3 for example)
Next major release

*Never* use this branch for production. Pull requests for major new features go here.


GNS3 is perhaps packaged for your distribution:

* Gentoo:
* Alpine:
* NixOS:

Linux (Debian based)

The following instructions have been tested with Ubuntu and Mint.
You must be connected to the Internet in order to install the dependencies.


- Python 3.6, setuptools and the ones listed `here <>`_

The following commands will install some of these dependencies:

.. code:: bash

sudo apt-get install python3-setuptools

Finally these commands will install the server as well as the rest of the dependencies:

.. code:: bash

cd gns3-server-master
sudo python3 install

To run tests use:

.. code:: bash

py.test -v

Docker container

For development you can run the GNS3 server in a container

.. code:: bash

bash scripts/

Run as daemon (Unix only)

You will find init sample scripts for various systems
inside the init directory.

Usefull options:

* --daemon: start process as a daemon
* --log logfile: store output in a logfile
* --pid pidfile: store the pid of the running process in a file and prevent double execution

All init scripts require the creation of a GNS3 user. You can change it to another user.

.. code:: bash

sudo adduser gns3


For ubuntu < 15.04

You need to copy init/gns3.conf.upstart to /etc/init/gns3.conf

.. code:: bash

sudo chown root /etc/init/gns3.conf
sudo service gns3 start


You need to copy init/gns3.service.systemd to /lib/systemd/system/gns3.service

.. code:: bash

sudo chown root /lib/systemd/system/gns3.service
sudo systemctl start gns3


Please use our `all-in-one installer <>`_ to install the stable build.

If you install via source you need to first install:

- Python (3.3 or above) -
- Pywin32 -

Then you can call

.. code:: bash

python install

to install the remaining dependencies.

To run the tests, you also need to call

.. code:: bash

pip install pytest pytest-capturelog

before actually running the tests with

.. code:: bash

python test

or with

.. code:: bash

py.test -v

Mac OS X

Please use our DMG package for a simple installation.

If you want to test the current git version or contribute to the project,
you can follow these instructions with virtualenwrapper:
and homebrew:

.. code:: bash

brew install python3
mkvirtualenv gns3-server --python=/usr/local/bin/python3.5
python3 install


If you want enable SSL support on GNS3 you can generate a self signed certificate:

.. code:: bash

bash gns3server/cert_utils/

This command will put the files in ~/.config/GNS3/ssl

After you can start the server in SSL mode with:

.. code:: bash

python gns3server/ --certfile ~/.config/GNS3/ssl/server.cert --certkey ~/.config/GNS3/ssl/server.key --ssl

Or in your gns3_server.conf by adding in the Server section:

.. code:: ini


Running tests

Just run:

.. code:: bash

py.test -vv

If you want test coverage:

.. code:: bash

py.test --cov-report term-missing --cov=gns3server

Security issues
Please contact us using contact form available here: