README.md in wmap-2.6.7 vs README.md in wmap-2.6.8

- old
+ new

@@ -13,16 +13,17 @@ # OWASP Web Mapper README ## What's this program for? -This program is designed for the web application asset discovery and tracking. It was originally developed to -to cover the gaps of a similar commercial product. Over the time it grows to be a more capable and complete replacement (IMHO). +This program is part of the [OWASP Web Mapper Project](https://www.owasp.org/index.php/OWASP_Web_Mapper_Project). It's designed for the web application asset discovery and tracking. It was originally developed to cover the gaps of a similar commercial offering. Over the time it grows to be a more capable and complete replacement (IMHO). +Note that program is mainly operating on Command Line Interface (CLI). For better user experience, you might want to use the [Web Mapper Portal Application](https://github.com/yangsec888/www_wmap) instead. + ## WMAP in Motion -Use the demo web app build on top of wmap gem: http://wmap.io +You can try out the complete [demo web app](http://wmap.io/) deployed in the DigitalOcean cloud: http://wmap.io/ ## Installation To take full power of this program, you would need an *nix flavor machine with direct Internet access. I have installed it successfully on both Mac and Linux machines. You'll also need the Ruby environment being setup properly. The easiest way to install OWASP Web Mapper is by using Ruby Gems. You can install it from command line: ```sh @@ -33,11 +34,12 @@ Nokogiri is a native xml/html parser used by the project. It's fast and powerful. However, it comes with pitfall of installation problem around building native extension for your environment. Please refer to this page for trouble-shooting tip (http://www.nokogiri.org/tutorials/installing_nokogiri.html). ### Dependency You need the Ruby 2.1.0 or above in order to use this program. In my test environment, I was able to set it up with <a href="https://rvm.io/">RVM</a>. Please refer to this page for more installation information: https://www.ruby-lang.org/en/documentation/installation/ -In addition, the following Ruby GEM dependency are needed by different components of this software. The should be installed automatically: +In addition, the following Ruby GEM dependency are needed by different features of this software. They should be installed automatically when you install the 'wmap' gem above. +``` require "dnsruby" require "geoip" require "minitest/autorun" require "net/ping" require "netaddr" @@ -46,16 +48,18 @@ require "openssl" require "open_uri_redirections" require "parallel" require "whois" require 'httpclient' +``` - In case you want to install the above gems separately, use the command below: - +```sh gem install dnsruby geoip minitest net-ping netaddr nokogiri css_parser open_uri_redirections openssl parallel whois httpclient +``` + ### Ruby-whois Gem Patches This software depends on a patched version of Ruby gem ruby-whois (http://www.ruby-whois.org/) for the domain whois lookup feature. For better result, you could manually add the patches into your local whois gem installation directory as shown below: ```sh cp whois_patches/* [Your_ruby_whois_gem_path]/whois/lib/whois/record/parser/ ``` @@ -104,10 +108,10 @@ If you need additional documentation / information other than this README file and the Ruby document package, please be patient - as I'm still working on it :) ## Program Version -The latest release is version [2.5.5+](version.txt). as of fall 2018. Please refer to the [CHANGELOG.md](CHANGELOG.md) for more history information. +The latest release is version [2.6.5+](version.txt). as of fall 2019. Please refer to the [CHANGELOG.md](CHANGELOG.md) for more history information. ## Author Contact This program is designed and developed by Yang Li. You can reach him by Email: <yang.li@owasp.org> ## Bug Report or Feature Request?