• home
  • dradis framework guides

Installing Dradis on MacOS

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

1 Prerequisites: 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 .bash_profile
etd@host:~$ rvm -v

Next, in order to be able to compile Ruby 1.9, we need to install XCode from: http://developer.apple.com/xcode/

Now we are ready to install and configure Ruby 1.9.3:

etd@host:~$ rvm install 1.9.3

The next step is not required but is recommended. We are going to make 1.9.3 the default Ruby environment with:

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

If you decide not to do this, Ruby 1.8 will be the default.

2 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 /Users/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:

3 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

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 ../

4 Running Dradis

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

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

You are ready to browse:

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 -p 443