@@ -20,22 +20,34 @@ Installation Installing Achilles is similar to any other Rails-based application. You can play around with Achilles locally using a sqlite3 database but is recommended to use MySQL in production. -To play around with Achilles you must first edit the `config/environment.rb` file. There are several things you will want to change: +To play around with Achilles you must first edit the `config/config.yml` file. There are several things you will want to change: - 1. The session secret (`config.action_controller.session[:secret]`, use `rake secret` to generate a new secret) - 2. The nmap executable path (`config.app_config.nmap_path`) - 3. Where results from nmap should be stored (`config.app_config.nmap_path_results`) - 4. The nessus executable path (`config.app_config.nessus_path`) - 5. Where nessus results should be stored (`config.app_config.nessus_results_path and config.app_config.nessus_plugins_path`) + 1. The nmap executable path, `nmap_path`. + 2. Where results from nmap should be stored, `nmap_results_path`. + 4. The nessus executable path, `nessus_path`. + 5. Where nessus results should be stored, `nessus_results_path` and `nessus_plugins_path`. -Then run the following commands: +You might also want to change the secret that Rails uses to encrypt session cookies: + + rake secret + +The following commands will create, migrate, and populate the a SQLite3 database and start the HTTP server: rake db:create rake db:migrate rake db:populate ./script/server -Once the server is running locally, you can open your web browser to <http://0.0.0.0:3000>. +Once the server is running, you can open your web browser to <http://0.0.0.0:3000>. + +Scheduling Nessus Scans +----------------------- + +Achilles can schedule nessus scans. In order for this to work, it is advisable to setup a cronjob that executes the following: + + ./script/runner Scan.run! + +This will run exactly 1 scan. Dependencies ------------ @@ -48,7 +60,7 @@ Achilles is also dependent on the follow ruby gems: - haml - libxml-ruby -Run the following command to install: +The following command should install the gem dependencies: rake gems:install README.markdown @@ -10,7 +10,7 @@ module ApplicationHelper def nav_link(name) haml_tag(:li, {:class => (controller.kind_of?("#{name.to_s.camelize}Controller".constantize) ? 'active' : 'inactive' )}) do - puts link_to(name.to_s.titleize, self.send("#{name.to_s.tableize}_path")) + haml_concat link_to(name.to_s.titleize, self.send("#{name.to_s.tableize}_path")) end end @@ -60,7 +60,7 @@ module ApplicationHelper haml_tag(:h1) do case header when String - puts header + haml_concat header when Array haml_tag(:ul) do header.each do |item| @@ -71,7 +71,7 @@ module ApplicationHelper end end - puts capture_haml(name, &block) if block_given? + haml_concat capture_haml(name, &block) if block_given? end end end app/helpers/application_helper.rb @@ -5,7 +5,7 @@ # ENV['RAILS_ENV'] ||= 'production' # Specifies gem version of Rails to use when vendor/rails is not present -RAILS_GEM_VERSION = '2.1.0' unless defined? RAILS_GEM_VERSION +RAILS_GEM_VERSION = '>= 2.2.2' unless defined? RAILS_GEM_VERSION # Bootstrap the Rails environment, frameworks, and default configuration require File.join(File.dirname(__FILE__), 'boot') @@ -26,10 +26,10 @@ Rails::Initializer.run do |config| # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net" # config.gem "aws-s3", :lib => "aws/s3" - config.gem "haml", :version => '2.0.0' - config.gem "chronic", :version => '0.2.3' - config.gem "netaddr", :version => '1.4.0' - config.gem "libxml-ruby", :version => '0.5.4', :lib => "xml/libxml" + config.gem 'haml', :version => '>= 2.0.6' + config.gem 'chronic', :version => '>= 0.2.3' + config.gem 'netaddr', :version => '>= 1.5.0' + config.gem 'libxml-ruby', :version => '>= 0.9.7', :lib => 'xml/libxml' # Only load the plugins named here, in the order given. By default, all plugins # in vendor/plugins are loaded in alphabetical order. config/environment.rb 3730ec2078a2f4e7d9f0e05f5d858e346d40105c Cory T. Cornelius Cory.T.Cornelius@Dartmouth.edu http://github.com/dxoigmn/achilles/commit/ad414893dbd0403b6b505d2ce47077a4adb2f000 ad414893dbd0403b6b505d2ce47077a4adb2f000 2009-01-28T16:27:59-08:00 2009-01-28T16:27:59-08:00 Fix haml deprecation notice of puts. Bump version dependencies up. 7324fd81b1d6c2cc54c2032448a72cb51fd547a5 Cory T. Cornelius Cory.T.Cornelius@Dartmouth.edu