• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..03-May-2022-

bin/H01-Jul-2018-414

debian/H01-Jul-2018-301214

doc/H01-Jul-2018-8,0535,588

etc/ryu/H01-Jul-2018-91

ryu/H01-Jul-2018-500,744454,444

tools/H01-Jul-2018-480272

.gitignoreH A D01-Jul-2018128 1816

.pylintrcH A D01-Jul-2018597 1615

.travis.ymlH A D01-Jul-2018475 2720

CONTRIBUTING.rstH A D01-Jul-20183.9 KiB11586

LICENSEH A D01-Jul-201811.1 KiB203169

MANIFEST.inH A D01-Jul-2018310 1413

README.rstH A D01-Jul-20181.9 KiB7046

run_tests.shH A D01-Jul-20185.3 KiB197152

setup.cfgH A D01-Jul-20181.3 KiB5549

setup.pyH A D01-Jul-2018956 3110

tox.iniH A D01-Jul-20181.8 KiB6859

README.rst

1What's Ryu
2==========
3Ryu is a component-based software defined networking framework.
4
5Ryu provides software components with well defined API that make it
6easy for developers to create new network management and control
7applications. Ryu supports various protocols for managing network
8devices, such as OpenFlow, Netconf, OF-config, etc. About OpenFlow,
9Ryu supports fully 1.0, 1.2, 1.3, 1.4, 1.5 and Nicira Extensions.
10
11All of the code is freely available under the Apache 2.0 license. Ryu
12is fully written in Python.
13
14
15Quick Start
16===========
17Installing Ryu is quite easy::
18
19   % pip install ryu
20
21If you prefer to install Ryu from the source code::
22
23   % git clone git://github.com/osrg/ryu.git
24   % cd ryu; pip install .
25
26If you want to write your Ryu application, have a look at
27`Writing ryu application <http://ryu.readthedocs.io/en/latest/writing_ryu_app.html>`_ document.
28After writing your application, just type::
29
30   % ryu-manager yourapp.py
31
32
33Optional Requirements
34=====================
35
36Some functionalities of ryu requires extra packages:
37
38- OF-Config requires lxml and ncclient
39- NETCONF requires paramiko
40- BGP speaker (SSH console) requires paramiko
41- Zebra protocol service (database) requires SQLAlchemy
42
43If you want to use the functionalities, please install requirements::
44
45    % pip install -r tools/optional-requires
46
47Please refer to tools/optional-requires for details.
48
49
50Prerequisites
51=============
52If you got some error messages at installation step, please confirm
53dependencies for building required Python packages.
54
55On Ubuntu(16.04 LTS or later)::
56
57  % apt install gcc python-dev libffi-dev libssl-dev libxml2-dev libxslt1-dev zlib1g-dev
58
59
60Support
61=======
62Ryu Official site is `<http://osrg.github.io/ryu/>`_.
63
64If you have any
65questions, suggestions, and patches, the mailing list is available at
66`ryu-devel ML
67<https://lists.sourceforge.net/lists/listinfo/ryu-devel>`_.
68`The ML archive at Gmane <http://dir.gmane.org/gmane.network.ryu.devel>`_
69is also available.
70