Skip to content

Commit

Permalink
changed doc index page
Browse files Browse the repository at this point in the history
Signed-off-by: Peng Xiao <[email protected]>
  • Loading branch information
xiaopeng163 committed Jan 29, 2016
1 parent 3234792 commit 3ea9acb
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 47 deletions.
36 changes: 36 additions & 0 deletions doc/source/feature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Features
========

- It can establish BGP session based on IPv4 address (TCP Layer) in
active mode(as TCP client);

- Support TCP MD5 authentication(IPv4 and does not support Windows
now);

- BGP capabilities support: 4 Bytes ASN, Route Refresh(Cisco Route Refresh), Add Path send/receive;

- Address family support:

- IPv4 unicast

- IPv4 Flowspec(limited)

- IPv6 unicast

- IPv4 MPLSVPN

- EVPN (partially supported)

- Decode all BGP messages to json format and write them into files in local disk(configurable);

- Support basic RESTFUL API for getting running information and sending BGP messages.

- Platform support: Linux/Unix(recommended), Mac OS and Windows.

.. note::

yabgp is a light weight BGP agent used for connecting network devices. It only can be
TCP client in one BGP peering connection and can't send any update messages by itself(send through REST API).
We recommend that each yabgp process connect only one BGP neighbor, so each process is independent with each other,
we can start many yabgp processes within the same machine or in different machines. There can be a central controller
which can controll all yabgp processes through REST API to send BGP update messages.
53 changes: 6 additions & 47 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,58 +14,14 @@ future analysis.
Support sending BGP messages(route refresh/update) to the peer through RESTful API. YABGP can't send any BGP update messages
by itself, it's just a agent, so there can be many agents and they can be controlled by a contoller.

We write it in strict accordance with the specifications of RFCs.

This software can be used on Linux/Unix, Mac OS and Windows systems.

Features
========

- It can establish BGP session based on IPv4 address (TCP Layer) in
active mode(as TCP client);

- Support TCP MD5 authentication(IPv4 and does not support Windows
now);

- BGP capabilities support: 4 Bytes ASN, Route Refresh(Cisco Route Refresh), Add Path send/receive;

- Address family support:

- IPv4 unicast

- IPv4 Flowspec(limited)

- IPv6 unicast

- IPv4 MPLSVPN

- EVPN (partially supported)

- Decode all BGP messages to json format and write them into files in local disk(configurable);

- Support basic RESTFUL API for getting running information and sending BGP messages.

.. note::

yabgp is a light weight BGP agent used for connecting network devices. It only can be
TCP client in one BGP peering connection and can't send any update messages by itself(send through REST API).
We recommend that each yabgp process connect only one BGP neighbor, so each process is independent with each other,
we can start many yabgp processes within the same machine or in different machines. There can be a central controller
which can controll all yabgp processes through REST API to send BGP update messages.

Application
===========

There are many jobs need to do in future.

We are working hardly on that. So any of your ideas is welcome.

Quickstarts
===========
Table of Contents
=================

.. toctree::
:maxdepth: 2

feature
install
tutorial
msg_format
Expand All @@ -76,6 +32,9 @@ Quickstarts
Support
=======

There are many jobs need to do in future.
We are working hardly on that. So any of your ideas is welcome.

Please use GitHub issue system or submit pull request.


Expand Down

0 comments on commit 3ea9acb

Please sign in to comment.