Before you start...

... make sure you have all the prerequisites as detailed in the install and setup page.

Download, configure and launch

  1. download dradis
  2. configure the database
  3. initialise the database
  4. launch the server
  5. launch the client

download dradis

This is an easy one, go to the download page and get the latest version. Unpack in a directory of your choice and cd to that directory.

back to top

configure the database

If you are using SQLite3 (as recommended), there is nothing to configure, jump to the next step: initialise the database.

Otherwise, if you want to configure dradis to connect to a different engine, for example MySQL, open ./dradis/server/config/database.yml in the dradis server folder and adjust the following values:

example config for MySQL
adapter: mysql
database: dradis
username: root
password:
# You may need to adjust the value below to your platform/distribution default.
# See MySQL documentation for more information.
socket: /var/run/mysqld/mysqld.sock

More information on how to configure different database drivers using Ruby on Rails (RoR) can be found at the HowtosDatabase page of the RoR wiki.

back to top

initialise the database

In order to populate the database we will use the rake tool. In the server directory (cd ./dradis/server/) run:

rake db:migrate

This should initialize the database schema and populate the default values required by the application.

back to top

launch the server

Using the -p switch you can specify the port number. By default the dradis client will try to reach the server at port 3004, if you modify this value, you will need to modify the client's configuration accordingly.

ruby ./script/server -p 3004

back to top

launch the client

command line picture Move to the client directory (cd ./dradis/client/), then you will need to choose between the command line interface:

ruby dradis.rb -c

command line picture Or the graphical interface:

ruby dradis.rb -g

back to top

If you need more information try the full user manual or the documentation page.