Permalink
Browse files

DOC: Convert README back to rst

fixes #1292
and apply changes in readme to copy in docs/
  • Loading branch information...
wagner-certat committed Aug 14, 2018
1 parent 93b3b18 commit 83ed03f527c1f1bad85448137da5ae1a10bbc14e
Showing with 123 additions and 116 deletions.
  1. +0 −108 README.md
  2. +117 −0 README.rst
  3. +5 −6 docs/README.md
  4. +1 −2 setup.py
View
108 README.md

This file was deleted.

Oops, something went wrong.
View
@@ -0,0 +1,117 @@
Welcome to IntelMQ!
===================
.. figure:: https://raw.githubusercontent.com/certtools/intelmq/master/docs/images/Logo_Intel_MQ.png
:alt: IntelMQ
IntelMQ
|Build Status| |codecov.io|
**IntelMQ** is a solution for IT security teams (CERTs, CSIRTs, abuse
departments,...) for collecting and processing security feeds (such as
log files) using a message queuing protocol. It's a community driven
initiative called **IHAP** (Incident Handling Automation Project) which
was conceptually designed by European CERTs/CSIRTs during several
InfoSec events. Its main goal is to give to incident responders an easy
way to collect & process threat intelligence thus improving the incident
handling processes of CERTs.
IntelMQ's design was influenced by
`AbuseHelper <https://github.com/abusesa/abusehelper>`__ however it was
re-written from scratch and aims at:
- Reducing the complexity of system administration
- Reducing the complexity of writing new bots for new data feeds
- Reducing the probability of events lost in all process with
persistence functionality (even system crash)
- Use and improve the existing Data Harmonization Ontology
- Use JSON format for all messages
- Integration of the existing tools (AbuseHelper, CIF)
- Provide easy way to store data into Log Collectors like
ElasticSearch, Splunk, databases (such as PostgreSQL)
- Provide easy way to create your own black-lists
- Provide easy communication with other systems via HTTP RESTFUL API
It follows the following basic meta-guidelines:
- Don't break simplicity - KISS
- Keep it open source - forever
- Strive for perfection while keeping a deadline
- Reduce complexity/avoid feature bloat
- Embrace unit testing
- Code readability: test with unexperienced programmers
- Communicate clearly
Table of Contents
-----------------
1. `How to Install <#how-to-install>`__
2. `Developers Guide <#developers-guide>`__
3. `User Guide <#user-guide>`__
4. `IntelMQ Manager <#intelmq-manager>`__
5. `Incident Handling Automation
Project <#incident-handling-automation-project>`__
6. `Data Harmonization <#data-harmonization>`__
7. `How to Participate <#how-to-participate>`__
8. `Licence <#licence>`__
How to Install
--------------
See `INSTALL <docs/INSTALL.md>`__.
Developers Guide
----------------
See `Developers Guide <docs/Developers-Guide.md>`__.
User Guide
----------
See `User Guide <docs/User-Guide.md>`__.
For support questions please use the intelmq-users mailing list:
https://lists.cert.at/cgi-bin/mailman/listinfo/intelmq-users
IntelMQ Manager
---------------
Check out this graphical
`tool <https://github.com/certtools/intelmq-manager>`__ and easily
manage an IntelMQ system.
Incident Handling Automation Project
------------------------------------
- **URL:**
http://www.enisa.europa.eu/activities/cert/support/incident-handling-automation
- **Mailing-list:** ihap@lists.trusted-introducer.org
Data Harmonization
------------------
IntelMQ use the Data Harmonization. Please read `this
document <docs/Data-Harmonization.md>`__ for more details.
How to participate
------------------
- Subscribe to the Intelmq-dev Mailing list:
https://lists.cert.at/cgi-bin/mailman/listinfo/intelmq-dev (for
developers)
- Watch out for our regular developers conf call
- IRC: server: irc.freenode.net, channel: #intelmq
- Via github issues
- Via Pull requests (please do read help.github.com first)
Licence
-------
This software is licensed under GNU Affero General Public License
version 3
.. |Build Status| image:: https://travis-ci.org/certtools/intelmq.svg?branch=master
:target: https://travis-ci.org/certtools/intelmq
.. |codecov.io| image:: https://codecov.io/github/certtools/intelmq/coverage.svg?branch=master
:target: https://codecov.io/github/certtools/intelmq?branch=master
View
@@ -20,9 +20,9 @@ IntelMQ's design was influenced by
[AbuseHelper](https://github.com/abusesa/abusehelper)
however it was re-written from scratch and aims at:
- Reduce the complexity of system administration
- Reduce the complexity of writing new bots for new data feeds
- Reduce the probability of events lost in all process with
- Reducing the complexity of system administration
- Reducing the complexity of writing new bots for new data feeds
- Reducing the probability of events lost in all process with
persistence functionality (even system crash)
- Use and improve the existing Data Harmonization Ontology
- Use JSON format for all messages
@@ -69,7 +69,7 @@ User Guide
See [User Guide](User-Guide.md).
For support use the intelmq-users mailing list: <https://lists.cert.at/cgi-bin/mailman/listinfo/intelmq-users>
For support questions please use the intelmq-users mailing list: <https://lists.cert.at/cgi-bin/mailman/listinfo/intelmq-users>
IntelMQ Manager
---------------
@@ -88,8 +88,7 @@ Incident Handling Automation Project
Data Harmonization
------------------
IntelMQ use the Data Harmonization. Check the following
[document](Data-Harmonization.md).
IntelMQ use the Data Harmonization. Please read [this document](docs/Data-Harmonization.md) for more details.
How to participate
------------------
View
@@ -47,7 +47,7 @@
module = bot['module']
BOTS.append('{0} = {0}:BOT.run'.format(module))
with open(os.path.join(os.path.dirname(__file__), 'README.md')) as handle:
with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as handle:
README = handle.read().replace('<docs/',
'<https://github.com/certtools/intelmq/blob/master/docs/')
@@ -76,7 +76,6 @@
description='IntelMQ is a solution for IT security teams for collecting and '
'processing security feeds using a message queuing protocol.',
long_description=README,
long_description_content_type="text/markdown",
classifiers=[
'Development Status :: 5 - Production/Stable',
'Environment :: Console',

0 comments on commit 83ed03f

Please sign in to comment.