1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-23 23:38:21 +00:00
GNS3 server
Go to file
grossmj c5412bf970 Allocate application IDs for IOU nodes on the controller.
An application ID is used by IOU to generate its interface Mac addresses. They must be unique across all opened projects sharing the same computes to avoid Mac address collisions.
2020-02-10 15:20:49 +08:00
conf Merge branch 'master' into 2.2 2020-01-08 13:29:21 +08:00
docs Sync documentation 2020-01-08 10:52:15 +08:00
gns3server Allocate application IDs for IOU nodes on the controller. 2020-02-10 15:20:49 +08:00
init Make sure upstart LANG is utf8 2017-05-09 18:54:01 +02:00
scripts Add LimitNOFILE=16384 to GNS3 service. Ref #1678 2019-11-07 16:28:47 +08:00
tests Allocate application IDs for IOU nodes on the controller. 2020-02-10 15:20:49 +08:00
.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 #1690. 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 Python3.8 support. Ref https://github.com/GNS3/gns3-gui/issues/2895 2019-11-11 12:44:31 +08:00
appveyor.yml Check if locking version of pypiwin32==220 helps, Ref. #1276 2018-01-29 15:16:38 +01:00
AUTHORS Adjust AUTHORS. 2015-07-12 17:25:03 -06:00
CHANGELOG Release v2.2.5 2020-01-09 23:52:40 +08:00
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 Update Dockerfile to Ubuntu 18.04 2019-05-18 20:19:34 +07:00
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.rst 2019-07-03 20:30:10 +02:00
readthedocs.yml Use Python3.6 to build the API documentation. 2018-11-20 15:35:46 +07:00
requirements.txt Require VirtualBox >= 6.0 on AMD and >= 6.1 on Intel processors (for GNS3 VM only). Fixes #1610 2020-01-26 18:23:17 +08:00
setup.py Python3.8 support. Ref https://github.com/GNS3/gns3-gui/issues/2895 2019-11-11 12:44:31 +08:00
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:: https://travis-ci.org/GNS3/gns3-server.svg?branch=master
    :target: https://travis-ci.org/GNS3/gns3-server

.. image:: https://img.shields.io/pypi/v/gns3-server.svg
    :target: https://pypi.python.org/pypi/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.

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:

* Gentoo: https://packages.gentoo.org/package/net-misc/gns3-server
* Alpine: https://pkgs.alpinelinux.org/package/v3.10/community/x86_64/gns3-server


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:

.. 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 setup.py install
   gns3server

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

.. code:: bash

    sudo adduser gns3

upstart
-------

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


systemd
-------

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

Windows
-------


Please use our `all-in-one installer <https://community.gns3.com/community/software/download>`_ to install the stable build.

If you install via source you need to first install:

- Python (3.3 or above) - https://www.python.org/downloads/windows/
- Pywin32 - https://sourceforge.net/projects/pywin32/

Then you can call

.. code:: bash

    python setup.py 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 setup.py 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: http://virtualenvwrapper.readthedocs.org/
and homebrew: http://brew.sh/.

.. code:: bash

   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:

.. code:: bash

    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:

.. code:: bash

    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:

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

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:
http://docs.gns3.com/1ON9JBXSeR7Nt2-Qum2o3ZX0GU86BZwlmNSUgvmqNWGY/index.html