Skip to content
GitLab

Installation · Changes

Page history
Updated Installation (markdown) authored by Zapotek's avatar Zapotek
Hide whitespace changes
Inline Side-by-side
guides/user/Installation.md
View page @ 4ee7c53b
# Installation instructions -- v1.0
**Per-platform instructions:**
* [Linux](#linux)
* [OSX](#osx)
* [*nix](#nix)
* [Build scripts](#nix-build-scripts)
* [Source based](#nix-source-based)
* [Gem](#nix-gem)
* [Source](#nix-source)
## <a name="linux" href="#linux">Linux</a>
Linux users can download the latest self-contained archive for their system from the
website's [download](http://arachni-scanner.com/latest#Linux) page.
## <a name="osx" href="#osx">Mac OSX</a>
OSX users can download the latest self-contained archive for their system from the
website's [download](http://arachni-scanner.com/latest#Mac-OSX) page.
## <a name="nix" href="#nix">*nix</a>
### <a name="nix-build-scripts" href="#nix-build-scripts">Build scripts</a>
You can use the project's [[ build-scripts | Development-environment]] to
automatically setup a self-contained environment which will include Arachni and
all its dependencies.
### <a name="nix-source-based" href="#nix-source-based">Source based</a>
Arachni will run in any *nix environment that satisfies the following dependencies:
* Ruby 1.9.3 or higher (preferrably 2.1.2).
* libcurl with OpenSSL support.
* C/C++ compilers and GNU make in order to build the necessary extensions.
* Optionally [PhantomJS 1.9.2](https://code.google.com/p/phantomjs/downloads/list) to enable support for browser analysis of pages.
<em>This is about installing the [Arachni Framework](https://github.com/Arachni/arachni)
only and does not include the [WebUI](https://github.com/Arachni/arachni-ui-web).</em>
To work with the source or install the Gem you'll need the dependencies listed above.
Please take into consideration that it is assumed that your system is suitably configured
and that you will run the test suite in order to ensure that Arachni operates properly under
your environment.
If you are not comfortable with the above, please try the [build script](#nix-build-scripts)
approach instead.
Users of Debian-based distributions can run the following to install them:
sudo apt-get install build-essential curl libcurl3 libcurl4-openssl-dev ruby
#### <a name="nix-gem" href="#nix-gem">Gem</a>
To install Arachni:
gem install arachni # Use sudo if you get permission errors.
#### <a name="nix-source" href="#nix-source">Source</a>
If you want to clone the repository and work with the source code then you'll need to run the following to install all gem dependencies and Arachni:
git clone git://github.com/Arachni/arachni.git
cd arachni
gem install bundler # Use sudo if you get permission errors.
bundle install # To resolve possible dev dependencies.
rake install # To install to PATH, use sudo if you get permission errors.
# Installation instructions -- v1.0
**Per-platform instructions:**
* [Linux](#linux)
* [OSX](#osx)
* [*nix](#nix)
* [Build scripts](#nix-build-scripts)
* [Source based](#nix-source-based)
* [Gem](#nix-gem)
* [Source](#nix-source)
## <a name="linux" href="#linux">Linux</a>
Linux users can download the latest self-contained archive for their system from the
website's [download](http://arachni-scanner.com/latest#Linux) page.
## <a name="osx" href="#osx">Mac OSX</a>
OSX users can download the latest self-contained archive for their system from the
website's [download](http://arachni-scanner.com/latest#Mac-OSX) page.
## <a name="nix" href="#nix">*nix</a>
### <a name="nix-build-scripts" href="#nix-build-scripts">Build scripts</a>
You can use the project's [[ build-scripts | Development-environment]] to
automatically setup a self-contained environment which will include Arachni and
all its dependencies.
### <a name="nix-source-based" href="#nix-source-based">Source based</a>
Arachni will run in any *nix environment that satisfies the following dependencies:
* Ruby 1.9.3 or higher (preferrably 2.1.2).
* libcurl with OpenSSL support.
* C/C++ compilers and GNU make in order to build the necessary extensions.
* Optionally [PhantomJS 1.9.2](https://code.google.com/p/phantomjs/downloads/list) to enable support for browser analysis of pages.
<em>This is about installing the [Arachni Framework](https://github.com/Arachni/arachni)
only and does not include the [WebUI](https://github.com/Arachni/arachni-ui-web).</em>
To work with the source or install the Gem you'll need the dependencies listed above.
Please take into consideration that it is assumed that your system is suitably configured
and that you will run the test suite in order to ensure that Arachni operates properly under
your environment.
If you are not comfortable with the above, please try the [build script](#nix-build-scripts)
approach instead.
Users of Debian-based distributions can run the following to install them:
sudo apt-get install build-essential curl libcurl3 libcurl4-openssl-dev ruby
#### <a name="nix-gem" href="#nix-gem">Gem</a>
To install Arachni:
gem install arachni # Use sudo if you get permission errors.
#### <a name="nix-source" href="#nix-source">Source</a>
If you want to clone the repository and work with the source code then you'll need to run the following to install all gem dependencies and Arachni:
git clone git://github.com/Arachni/arachni.git
cd arachni
gem install bundler # Use sudo if you get permission errors.
bundle install --without prof # To resolve possible dev dependencies.
rake install # To install to PATH, use sudo if you get permission errors.