GNS3 server
Clone or download
Permalink
Failed to load latest commit information.
conf New option: require KVM. If false, Qemu VMs will not be prevented to … Nov 19, 2017
docs Update documentation. Jan 31, 2018
gns3server add appliance data for Cisco Nexus 9000v NX-OS 7.0(3)I7(3) Aug 10, 2018
init Make sure upstart LANG is utf8 May 9, 2017
scripts Upgrade remote install script to use any ubuntu codename. Fixes #1393. Aug 28, 2018
tests Compatybility with controller, default_symbol and hover_symbol, Fixes… Mar 2, 2018
.coveragerc Fix coveralls configuration Jun 18, 2015
.gitattributes Keep the version.py untouched when merging May 11, 2016
.gitignore Ignore env files Oct 30, 2017
.pyup.yml Update pyup config to use 2.2 branch Nov 15, 2017
.travis.yml Fix issue with temporary travis deploy issues Mar 12, 2018
AUTHORS Adjust AUTHORS. Jul 12, 2015
CHANGELOG Release v2.1.4 Mar 12, 2018
CONTRIBUTING.md Merge branch 'master' into 1.5 Jun 15, 2016
Dockerfile Fix missing 'locales' package in base image Feb 20, 2018
DockerfileTests.tpl Tests on TravisCI with docker compose Oct 12, 2017
LICENSE Project structure & tools (pytest, tox etc.) Oct 8, 2013
MANIFEST.in Prepare 1.5.0 alpha 2 May 10, 2016
README.rst Update readme Jun 2, 2017
appveyor.yml Check if locking version of pypiwin32==220 helps, Ref. #1276 Jan 29, 2018
dev-requirements.txt Update pytest from 3.1.0 to 3.1.1 (#1056) May 31, 2017
docker-compose.yml Tests on TravisCI with docker compose Oct 12, 2017
gns3server.bat Made the gns3server.bat successfully start the server independent of … Dec 24, 2015
requirements.txt Require typing only for Python < 3.5 Jul 12, 2018
setup.py Always install typing module (compat with python 3.4 on ubuntu) May 9, 2017
tox.ini Increase test timeout to avoid random problems on travis Feb 24, 2016
win-requirements.txt Pywin32 instead of pypiwin32, Ref. #1276 Feb 26, 2018

README.rst

GNS3-server

https://travis-ci.org/GNS3/gns3-server.svg?branch=master

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.

You will need the GNS3 GUI (gns3-gui repository) to control the server.

Branches

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)

Next major release

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

Linux

GNS3 is perhaps packaged for your distribution:

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.

Dependencies:

  • Python 3.4 or above
  • aiohttp
  • setuptools
  • psutil
  • jsonschema

The following commands will install some of these dependencies:

sudo apt-get install python3-setuptools

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

cd gns3-server-master
sudo python3 setup.py install
gns3server

To run tests use:

py.test -v

Docker container

For development you can run the GNS3 server in a container

bash scripts/docker_dev_server.sh

Run as daemon (Unix only)

You will found init sample script 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 the init script require the creation of a GNS3 user. You can change it to another user.

sudo adduser gns3

upstart

For ubuntu < 15.04

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

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

systemd

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

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

Windows

Please use our all-in-one installer to install the stable build.

If you install via source you need to first install:

Then you can call

python setup.py install

to install the remaining dependencies.

To run the tests, you also need to call

pip install pytest pytest-capturelog

before actually running the tests with

python setup.py test

or with

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 this instructions with virtualenwrapper: http://virtualenvwrapper.readthedocs.org/ and homebrew: http://brew.sh/.

brew install python3
mkvirtualenv gns3-server --python=/usr/local/bin/python3.4
python3 setup.py install
gns3server

SSL

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

bash gns3server/cert_utils/create_cert.sh

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

After you can start the server in SSL mode with:

python gns3server/main.py --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:

[Server]
certfile=/Users/noplay/.config/GNS3/ssl/server.cert
certkey=/Users/noplay/.config/GNS3/ssl/server.key
ssl=True

Running tests

Just run:

py.test -vv

If you want test coverage:

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

Security issues

Please contact us using contact informations available here: http://docs.gns3.com/1ON9JBXSeR7Nt2-Qum2o3ZX0GU86BZwlmNSUgvmqNWGY/index.html