No Description
Stoyan Atanasoff f65c77aa21 hunt: fixed dashboard block positions 2 weeks ago
accounts rules: use of unicode_literals 3 months ago
doc scirius: next version is 3.2.0 1 month ago
hunt hunt: fixed dashboard block positions 1 week ago
npm rules: import scss system 1 year ago
rules rules: add ip reputation on add public source modal 2 weeks ago
scirius scirius: next version is 3.2.0 1 month ago
scss rules: set same font size than labels on checkbox labels 2 months ago
suricata rules: use of unicode_literals 3 months ago
tests/robotframework tests: set proxy only when needed 2 years ago
viz rules: use of unicode_literals 3 months ago
.eslintrc rules: make ESlint exit with error on undef 1 year ago
.gitignore rules: add sphinx item to .gitignore 1 year ago
.gitlab-ci-rules.yml gitlab-ci-rules: add check on unicode literals import 3 months ago
.gitlab-ci.yml gitlab-ci: initial gitlab-ci.yml file 3 months ago
.travis.yml travis-ci: add check on unicode literals import 3 months ago
LICENSE Initial commit: import scirius code 5 years ago
MANIFEST.in Add viz static images to MANIFEST 1 year ago
README.rst doc: mention OISF in public sources context 1 year ago
manage.py Initial commit: import scirius code 5 years ago
package-lock.json hunt: introduce the application 9 months ago
package.json rules: add eslint to detect JS issue at build time 1 year ago
postcss.config.js rules: introduce npm and webpack 1 year ago
requirements.txt requirements: set djangorestframework < 3.9.2 1 month ago
setup.py rules: set version in setup.py 1 year ago
webpack.config.js rules: add eslint to detect JS issue at build time 1 year ago

README.rst

=======
Scirius
=======

Introduction
============

Scirius Community Edition is a web interface dedicated to Suricata ruleset management.
It handles the rules file and update associated files.

.. image:: https://github.com/StamusNetworks/scirius/raw/master/doc/images/suricata-index.png
:alt: Suricata page
:align: center

Scirius CE is developed by `Stamus Networks <https://www.stamus-networks.com/>`_ and is available under the
GNU GPLv3 license.

Features
========

Scirius can build Suricata ruleset composed of different sources. Sources or feeds can be picked from public sources
published by `OISF <https://oisf.net/>`_ or can be custom.

.. image:: https://github.com/StamusNetworks/scirius/raw/master/doc/images/public-sources.png
:alt: public sources from OISF
:align: center

Scirius will take care of refreshing the sources and composing the ruleset by applying your transformation
on it.

.. image:: https://github.com/StamusNetworks/scirius/raw/master/doc/images/ruleset.png
:alt: Ruleset with 5 sources
:align: center

Transformations like disabling a rule or applying a threshold (to lower the noise only) can be made
for each rule or at the category level.

.. image:: https://github.com/StamusNetworks/scirius/raw/master/doc/images/rule-page.png
:alt: Rule page
:align: center

Scirius also presents statistics on rules activity to give information and facilitate the tuning.

Get Help
========

Documentation
-------------

`Scirius Documentation <https://scirius.readthedocs.io/en/latest/>`_ is on readthedocs.

Support
-------

You can join IRC #SELKS channel on `irc.freenode.net <http://freenode.net/>`_ to get help.

You can also ask Scirius related questions on `SELKS Forum <https://groups.google.com/forum/#!forum/selks>`_.

Report an issue
---------------

You can report an issue on `GitHub issue page <https://github.com/StamusNetworks/scirius/issues>`_.

Contributing
============

From improving the documentation to coding new features, there is more than one way to contribute to Scirius. And for
all contributions please use a `Pull Request <https://github.com/StamusNetworks/scirius/pulls>`_ on Github.