• home
  • dradis framework guides

Installing Dradis on Ubuntu

This guide covers how to get the Dradis Framework up and running in Ubuntu.

1 Running on Ubuntu

We are going to assume that either Ubuntu is your base OS or you are preparing an Ubuntu-base virtual machine.

If the latter going for 10 GB of disk and 2 GB of RAM should do the trick. You can download Ubuntu from:

http://www.ubuntu.com/download/ubuntu/download

A tutorial on how to install the base OS falls out of the scope of this guide, we will leave you a few minutes to get your new OS up and running.

2 Prerequisites: curl and git

Before we begin, there are a couple of packages that we will need:


etd@host:~$ sudo apt-get install curl git

3 Installing Ruby 1.9.3

We are going to install Ruby 1.9.3 using RVM. This has the benefit of keeping everything under your `~/.rvm/` folder:


etd@host:~$ bash -s stable < <(curl -s https://raw.githubusercontent.com/wayneeseguin/rvm/master/binscripts/rvm-installer)
etd@host:~$ source ~/.profile
etd@host:~$ rvm -v

Once RVM is up and running we need to get a couple of libraries that will be required by the Ruby installation:


etd@host:~$ for package in zlib openssl libxslt libxml2; do rvm pkg install $package; done

And finally the Ruby 1.9.3 runtime:


etd@host:~$ rvm install 1.9.3
etd@host:~$ rvm 1.9.3 --default
etd@host:~$ ruby -v

There is an additional step that it’s not required but that will shorten the time required to install ruby gems:


etd@host:~$ echo "gem: --no-rdoc --no-ri" > ~/.gemrc

This tells RubyGems to not generate documentation for every library it installs.

Finally, we just need to install the Bundler gem, all other Ruby gems will be installed using Bundler:


etd@host:~$ gem install bundler
etd@host:~$ bundle -v

4 Download Dradis

We are going to work with the Git version of Dradis which is stable but contains the latest and greatest features:


etd@host:~$ mkdir dradis-git
etd@host:~$ cd dradis-git/
etd@host:~/dradis-git$ git clone https://github.com/dradis/dradisframework.git server
etd@host:~/dradis-git$ for file in verify reset start; do curl -O https://raw.githubusercontent.com/dradis/meta/master/$file.sh; done
etd@host:~/dradis-git$ chmod +x *.sh

To make sure it everything is as it should, double check the contents of the directory:


etd@host:~/dradis-git$ ls -l
total 32
-rwxr-xr-x   1 etd  staff   847 Feb 19 14:26 reset.sh*
drwxr-xr-x  26 etd  staff   884 Feb 19 14:02 server/
-rwxr-xr-x   1 etd  staff   407 Feb 19 14:26 start.sh*
-rwxr-xr-x   1 etd  staff  6775 Feb 19 14:26 verify.sh*

We are going to create a gemset to store all the Ruby gems that Dradis requires in a self-contained package. This means that the libraries won’t affect any other apps you have installed. Also if you decide to remove Dradis, you can delete this gemset and cleanup the system.

To activate the gemset just enter the `server/` directory and answer yes when RVM asks:


etd@host:~/dradis-git$ cd server/
Do you wish to trust this .rvmrc file? (/home/etd/dradis-git/server/.rvmrc)
y[es], n[o], v[iew], c[ancel]> y
Using /home/etd/.rvm/gems/ruby-1.9.3-p125 with gemset dradis
etd@host:~/dradis-git/server$ cd ..

Once you have your copy of the repo, we need to install a few Ruby dependencies:

5 Preparing Dradis

Before you can start the server you need to run ./reset.sh this will prepare the config files for first use and will re-generate the repository database.


etd@host:~/dradis-git$ ./reset.sh
Some Ruby gems are missing, do you want to install them now? [y] y

This will install the libraries that are required to run Dradis. Once that’s is done, we need to run the script again:


etd@host:~/dradis-git$ ./reset.sh
The config file [config/database.yml.template] was found not to be ready to use.
Do you want to initialize it? [y]es | [N]o | initialize [a]ll
a

If you ever want to clear your repository (e.g. a new project begins), re-runing the command above will do the trick.

The final step is to make sure all the assets (i.e. images, JavaScripts, CSS, etc.) that Dradis needs are precompiled to ensure they load at maximum speed:


etd@host:~/dradis-git$ cd server/
etd@host:~/dradis-git/server$ RAILS_ENV=production bundle exec rake assets:precompile
etd@host:~/dradis-git/server$ cd ../

6 Running Dradis

Once everything is ready, you can run the server with:


etd@host:~/dradis-git$ ./start.sh

You are ready to browse: https://127.0.0.1:3004/

The script also accepts the -h flag to help you with additional arguments to customize the binding address and port number.

For instance to bind to port 443 and listen in all interfaces you can run:


etd@host:~/dradis-git$ ./start.sh -b 0.0.0.0 -p 443