GNS3 server
Go to file
2020-05-20 19:33:56 +09:30
conf Merge branch 'master' into 2.2 2020-01-08 13:29:21 +08:00
docs Correct typo "Snasphot" 2020-04-15 09:46:45 +01:00
gns3server Lock listing VMs. Ref 2020-05-20 19:33:56 +09:30
init Support controller reloading for templates, appliances and projects. Ref 2020-04-30 15:30:50 +09:30
scripts Support controller reloading for templates, appliances and projects. Ref 2020-04-30 15:30:50 +09:30
tests Fix tests 2020-05-05 13:19:51 +09:30
.coveragerc Fix coveralls configuration 2015-06-18 16:33:24 +02:00
.gitattributes Keep the version.py untouched when merging 2016-05-11 10:06:21 +02:00
.gitignore Added workaround for . Added venv/ to .gitignore 2019-11-10 20:41:39 +01:00
.pyup.yml Update pyup config to use 2.2 branch 2017-11-15 13:20:31 +01:00
.travis.yml Deprecate running with Python 3.5 2020-05-19 16:14:58 +09:30
appveyor.yml Check if locking version of pypiwin32==220 helps, Ref. 2018-01-29 15:16:38 +01:00
AUTHORS Adjust AUTHORS. 2015-07-12 17:25:03 -06:00
CHANGELOG Release v2.2.8 2020-05-07 18:10:57 +09:30
CONTRIBUTING.md Merge branch 'master' into 1.5 2016-06-15 19:11:26 +02:00
dev-requirements.txt Update pytest from 4.4.0 to 4.4.1 2019-04-16 03:34:57 +02:00
docker-compose.yml Tests on TravisCI with docker compose 2017-10-12 10:40:49 +02:00
Dockerfile Remove --local when starting Docker dev server. 2020-03-26 12:06:05 +10:30
DockerfileTests.tpl Tests on TravisCI with docker compose 2017-10-12 10:40:49 +02:00
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. 2015-12-24 16:45:02 +02:00
LICENSE Project structure & tools (pytest, tox etc.) 2013-10-08 11:33:51 -06:00
MANIFEST.in Remove 'include INSTALL' from MANIFEST. 2018-04-13 14:17:18 +08:00
pytest.ini pytest.ini for ignoring files and recording DEBUG level in tests 2018-02-21 11:05:50 +01:00
README.rst Update README Ref 2020-04-29 14:57:15 +09:30
readthedocs.yml Use Python3.6 to build the API documentation. 2018-11-20 15:35:46 +07:00
requirements.txt Merge branch 'master' into 2.2 2020-05-19 16:16:19 +09:30
setup.py Deprecate running with Python 3.5 2020-05-19 16:14:58 +09:30
tox.ini Increase test timeout to avoid random problems on travis 2016-02-24 15:51:51 +01:00
win-requirements.txt Early Hyper-V support to run the GNS3 VM. Ref https://github.com/GNS3/gns3-gui/issues/763. 2018-08-10 16:18:14 +07:00

GNS3-server

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.
  • i386-libraries of libc and libcrypto are optional (Linux only), they are only needed to run IOU based nodes.

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.3 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.5.3, setuptools and the ones listed here

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 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.

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

brew install python3
mkvirtualenv gns3-server --python=/usr/local/bin/python3.5
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 form available here: http://docs.gns3.com/1ON9JBXSeR7Nt2-Qum2o3ZX0GU86BZwlmNSUgvmqNWGY/index.html