diff options
| author | Yusuke Iwase <iwase.yusuke0@gmail.com> | 2015-08-20 16:16:30 +0900 |
|---|---|---|
| committer | FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> | 2015-08-21 09:39:48 +0900 |
| commit | 1fc4ec6d8adcf379d3eaf8e9ad2b34f848ac1c2c (patch) | |
| tree | 8b3b4e4e4baa8fed88b9a6e234c4e3d71ed800b6 /doc | |
| parent | ad4613d7dbb0872899a47498b9bb381f20c669fd (diff) | |
doc: Include snort_integrate page into toctree
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.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/index.rst | 1 | ||||
| -rw-r--r-- | 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 cfe256b8..bb26e3aa 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 bec56195..c7601b37 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``: :: |