1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-04 22:28:12 +00:00
gns3-server/README.rst

122 lines
2.6 KiB
ReStructuredText
Raw Normal View History

2013-10-04 23:45:15 +00:00
GNS3-server
===========
2015-02-05 09:36:39 +00:00
.. image:: https://travis-ci.org/GNS3/gns3-server.svg?branch=master
:target: https://travis-ci.org/GNS3/gns3-server
2015-02-05 09:49:27 +00:00
.. image:: https://img.shields.io/pypi/v/gns3-server.svg
:target: https://pypi.python.org/pypi/gns3-server
2014-10-27 21:58:13 +00:00
This is the GNS3 server repository.
The GNS3 server manages emulators such as Dynamips, VirtualBox or Qemu/KVM.
2015-01-15 23:50:36 +00:00
Clients like the GNS3 GUI controls the server using a HTTP REST API.
2014-10-27 21:58:13 +00:00
You will need the GNS3 GUI (gns3-gui repository) to control the server.
2015-03-27 09:32:29 +00:00
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 goes here.
unstable
********
*Never* use this branch for production. Major new features pull requests goes here.
2015-04-22 15:13:39 +00:00
Linux
-----
GNS3 is perhaps packaged for your distribution:
* Gentoo: https://packages.gentoo.org/package/net-misc/gns3-server
2015-03-27 09:32:29 +00:00
2014-10-27 21:58:13 +00:00
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:
2014-10-27 21:58:13 +00:00
- Python 3.3 or above
2015-01-22 21:39:20 +00:00
- aiohttp
- setuptools
- netifaces
- jsonschema
2014-10-27 21:58:13 +00:00
The following commands will install some of these dependencies:
.. code:: bash
sudo apt-get install python3-setuptools
sudo apt-get install python3-netifaces
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
2015-04-22 15:13:39 +00:00
2015-04-23 09:00:21 +00:00
Run as daemon (Unix only)
**************************
2015-04-22 15:13:39 +00:00
You will found init sample script for various systems
inside the init directory.
2015-04-23 09:00:21 +00:00
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
2015-04-22 15:13:39 +00:00
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
Windows
-------
Please use our all-in-one installer.
2015-04-27 13:09:42 +00:00
If you install it via source you need to install also:
https://sourceforge.net/projects/pywin32/
Mac OS X
--------
2014-09-27 17:56:45 +00:00
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/.
.. code:: bash
brew install python3
mkvirtualenv gns3-server --python=/usr/local/bin/python3.4
python3 setup.py install
gns3server