Currently, snort_integrate page is not included into toctree,
and it is difficult for user to find this page.
This patch adds snort_integrate page into toctree,
and removes warnings when building this page.
Signed-off-by: IWASE Yusuke <iwase.yusu...@gmail.com>
---
doc/source/index.rst | 1 +
doc/source/snort_integrate.rst | 12 +++++-------
2 files changed, 6 insertions(+), 7 deletions(-)
diff --git a/doc/source/index.rst b/doc/source/index.rst
index cfe256b..bb26e3a 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -17,6 +17,7 @@ Contents:
configuration.rst
tests.rst
using_with_openstack.rst
+ snort_integrate.rst
app.rst
Indices and tables
diff --git a/doc/source/snort_integrate.rst b/doc/source/snort_integrate.rst
index bec5619..c7601b3 100644
--- a/doc/source/snort_integrate.rst
+++ b/doc/source/snort_integrate.rst
@@ -5,7 +5,7 @@ Snort Intergration
This document describes how to integrate Ryu with Snort.
Overview
-====
+========
There are two options can send alert to Ryu controller. The Option 1 is easier
if you just want to demonstrate or test. Since Snort need very large
computation power for analyzing packets you can choose Option 2 to separate
them.
@@ -49,15 +49,15 @@ The above depicts Ryu and Snort architecture. Ryu receives
Snort alert packet vi
Installation Snort
-====
+==================
Snort is an open source network intrusion prevention and detectionsystem
developed by Sourcefire. If you are not familiar with installing/setting up
Snort, please referto snort setup guides.
-http://www.snort.org/docs
+http://www.snort.org/documents
Configure Snort
-====
+===============
The configuration example is below:
- Add a snort rules file into ``/etc/snort/rules`` named ``Myrules.rules`` ::
@@ -75,7 +75,7 @@ Configure NIC as a promiscuous mode. ::
Usage
-====
+=====
**[Option 1]**
1. Modify the ``simple_switch_snort.py``: ::
@@ -103,8 +103,6 @@ The incoming packets will all mirror to **port 3** which
should be connect to Sn
5. You can see the result under next section.
-=====
-
**[Option 2]**
1. Modify the ``simple_switch_snort.py``: ::
--
1.9.1
------------------------------------------------------------------------------
_______________________________________________
Ryu-devel mailing list
Ryu-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/ryu-devel
