Home

Getting Started

MAKE SURE YOU'RE USING ONE OF THE RELEASES.

Releases are usually a little more stable than the master branch, in that some basic deployment testing for Ubuntu and CentOS has been performed using an SQLite backend.

QuickStart [Development Guide]

This assumes you have a proper Python dev already environment properly configured. If you need help getting started with this, checkout one of our installation guides.

$ tar -zxvf cif-3.x.x.tar.gz
$ cd cif-3.x.x
$ pip install -r requirements.txt
$ python setup.py develop
$ mkdir -p log && cp hacking/develop.conf hacking/local.conf
$ cif-store -d --token-create-admin cif.yml
$ cif-store -d --token-create-hunter cif-router.yml
$ cif-store -d --token-create-smrt csirtg-smrt.yml
$ supervisord -c hacking/local.conf

# new window
$ cif --config cif.yml -p
$ csirtg-smrt --client cif --config csirtg-smrt.yml -r rules/default/csirtg.yml -d
$ cif --config cif.yml --itype ipv4

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