0. In this document
===============================================================================
  1. General Information
  2. Installation Notes (*nix)
  3. Installation Notes (Windows)
  4. Running Dradis

Dradis 2.8 - 10th of October 2011


1. General Information
===============================================================================

Dradis is an open source tool for sharing information.

The official home of the Dradis Framework is:
    http://dradisframework.org/

Please query the website for information and documentation on the system. There 
is also a forum and a #dradis IRC channel at irc.freenode.org.

    http://dradisframework.org/community/

Release notes can be found in the RELEASE_NOTES document


1. Installation Notes (*nix)
===============================================================================
Make sure you have all the dependencies:
$ ./verify.sh

See section 4. Running Dradis


2. Installation Notes (Windows)
===============================================================================
The Dradis installation gives the users the option to install the following
components:
 - Ruby 1.9.3
 - Dradis Framework Core
 - The SQLite3 library and sqlite3 gem 
 - The Bundler gem

Note when installing as a limited access user:
The sqlite3 gem are dependent on the following dlls to be in the Windows\system32 
directory or the Ruby\bin directory: 
 - sqlite3.dll
 - msvcr71.dll
 - msvcp71.dll
 - msvcrt.dll

If the installer did not have access to the system32 then these files need to be 
copied manually. Simply copy them from the Dradis install directory to the 
%WINDIR%\system32 folder or the c:\Ruby193\bin directory.

2.1. Ruby Installer
-------------------
The ruby installation downloads the Ruby one-click installer and executes it. 
The ruby installation is independent of the Dradis installation.
For best results make sure you tick the *Add Ruby executables to your PATH* checkbox.

2.2. SQLite3
------------
The installer copies the sqlite3.dll file to the $WINDOWS\system32 folder. 
It also copies the sqlite3 gem (version 1.3.3) binary file to the installation
folder and it then installs the gem locally. 


2.4. Uninstall
--------------
The uninstaller removes the Dradis components from the local system. 

Because other applications might be dependent on the Ruby gems or the Sqlite3.dll 
it is left to the user to remove these manually. 

This can be done with by following these steps:
- run "gem uninstall sqlite3" in the command line
- run "gem uninstall RedCloth" in the command line
- run "gem uninstall bundler" in the command line


3. Running Dradis
===============================================================================

3.1 Reset the environment
-------------------------
The Dradis *reset* script will download and install all the necessary libraries 
for you the first time you run it.

In Windows, there is a reset link in the Start menu group or you can go to the 
installation folder and run:

    reset.bat 

In *NIX simply run:

    reset.sh 

The script will use Bundler to install all the dependencies listed in 
./server/Gemfile and will set up the environment for first use.

3.2 Launch the server
---------------------
In Windows use the start server link or go to the Dradis folder and run:

    start.bat 

In *NIX just run:

    start.sh 

You can verify that everything is running as it should by pointing your browser to:

https://localhost:3004/

And browse to https://localhost:3004 to start using Dradis. If you need to bind
to a different address (so others can connect to your instance) or another port
number, you can use the -b and -p switches respectively:

    $ ./start.sh -b 0.0.0.0 -p 443

For more information visit:
  http://dradisframework.org/