Home

Getting Started

Current master build status:

QuickStart

$ pip install -r requirements.txt supervisor==3.2.1
$ python setup.py develop
$ cp hacking/develop.conf hacking/local.conf
$ cif-storage -d --store sqlite --token-create-admin cif.yml
$ cif-storage -d --store sqlite --token-create-smrt cif-smrt.yml
$ cif-storage -d --store sqlite --token-create-hunter cif-hunter.yml
$ supervisord -c hacking/local.conf
$ cif --config cif.yml -p
$ cif-smrt --config cif-smrt.yml --test -r rules/default/csirtg.yml --feed port-scanners -d
$ cif --config cif.yml --itype ipv4

Getting Help

• the Wiki
• Known Issues
• FAQ

Getting Involved

There are many ways to get involved with the project. If you have a new and exciting feature, or even a simple bugfix, simply fork the repo, create some simple test cases, generate a pull-request and give yourself credit!

If you've never worked on a GitHub project, this is a good piece for getting started.

• How To Contribute
• Mailing List
• Project Page

Development

Some of the tools we use:

• PyCharm
• VirtualenvWrapper
• Ansible
• Vagrant
• Docker

Some useful books:

• Ansible Up & Running
• Vagrant Up & Running
• Docker Up & Running