Snorby is a ruby on rails web application for network security monitoring that interfaces with current popular intrusion detection systems (Snort, Suricata and Saga). The basic fundamental concepts behind Snorby are simplicity, organization and power. The project goal is to create a free, open source and highly competitive application for network monitoring for both private and enterprise use.
NOTE For the full packet capture HTTP basic AUTH use the same credentials.
- Ruby >= 1.9.2
- Rails >= 3.0.0
- ImageMagick >= 6.6.4-5
brew install imagemagick
apt-get install imagemagick
Install Gem Dependencies (make sure you have bundler installed:
gem install bundler)
pdfkit --install-wkhtmltopdf # If this fails - visit http://code.google.com/p/wkhtmltopdf/ for more information
Get Snorby from the download section or use the latest edge release via git.
git clone git://github.com/Snorby/snorby.git
Install Gem Dependencies (inside the root Snorby directory)
$ bundle install
Run The Snorby Setup
** Note ** If you get the following error:
No such file or directory - /root/snorby/tmp/snorby_packaged_uncompressed.jsCreate the following directories in the Snorby root dir:
Edit The Snorby Configuration File
Edit The Snorby Mail Configurations
Once all options have been configured and snorby is up and running
- Make sure you start the Snorby Worker from the Administration page.
- Make sure that both the
SensorCachejobs are running.
Default User Credentials
- E-mail: firstname.lastname@example.org
- Password: snorby
In the root Snorby directory type the following command:
Once the pull has competed successfully run the snorby update rake task:
You can open the rails console at anytime and interact with the Snorby environment. Below are a few helpful commands that may be useful:
- Open the rails console by typing
rails cin the Snorby root directory
- You should never really need to run the below commands. They are all available within the Snorby interface but documented here just in case.
Snorby::Worker.stop # Stop The Snorby Worker Snorby::Worker.start # Start The Snorby Worker Snorby::Worker.restart # Restart The Snorby Worker
Snorby Cache Jobs
# This will manually run the sensor cache job - pass true or false for verbose output Snorby::Jobs::SensorCacheJob.new(true).perform` # This will manually run the daily cache job - once again passing true or false for verbose output Snorby::Jobs::DailyCacheJob.new(true).perform # Clear All Snorby Cache - You must pass true to this method call for confirmation. Snorby::Jobs.clear_cache # If the Snorby worker is running this will start the cache jobs and set the run_at time for the current time. Snorby::Jobs.run_now!
- Dustin Willis Webber (Design, Backend Code)
- Jason Meller (InstaSnorby VM)
- JJ Cummings (QC, Testing and Support)
Snorby - All About Simplicity.
Copyright (c) 2010 Dustin Willis Webber (dustin.webber at gmail.com)
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA