What is it?
-------------
GoAccess is an open source real-time web log analyzer
and interactive viewer that runs in a terminal in *nix systems.
It provides fast and valuable HTTP statistics for system
administrators that require a visual server report on the fly.

Features
-------------------------------
GoAccess parses the specified web log file and
outputs the data to the X terminal. Features include:

  * General statistics, bandwidth, etc.
  * Time taken to serve the request (useful to track pages that are slowing down your site)
  * Top visitors
  * Requested files & static files
  * 404 or Not Found
  * Hosts, Reverse DNS, IP Location
  * Operating Systems
  * Browsers and Spiders
  * Referring Sites & URLs
  * Keyphrases
  * Geo Location - Continent/Country/City
  * Visitors Time Distribution
  * HTTP Status Codes
  * Ability to output JSON and CSV
  * Different Color Schemes
  * Support for large datasets + data persistence
  * Support for IPv6
  * Output statistics to HTML. See report
  * and more...

Nearly all web log formats...

GoAccess allows any custom log format string.
Predefined options include, but not limited to:

  * Amazon CloudFront (Download Distribution).
  * Google Cloud Storage
  * Apache virtual hosts
  * Combined Log Format (XLF/ELF) Apache & Nginx
  * Common Log Format (CLF) Apache
  * W3C format (IIS).

Why GoAccess?
-------------
The main idea behind GoAccess is being able to quickly analyze and view web
server statistics in real time without having to generate an HTML report (great
if you want to do a quick analysis of your access log via SSH).

Although it is possible to generate an HTML, JSON, CSV report, by default it
outputs to a terminal.

You can see it more of a monitor command tool than anything else.

Keys
----
The user can make use of the following keys:

   * ^F1^  or ^h^    Main help,
   * ^F5^            Redraw [main window],
   * ^q^             Quit the program, current window or module,
   * ^o^ or ^ENTER^  Expand selected module,
   * ^[Shift]0-9^    Set selected module to active,
   * ^Up^ arrow      Scroll up main dashboard,
   * ^Down^ arrow    Scroll down main dashboard,
   * ^j^             Scroll down within expanded module,
   * ^k^             Scroll up within expanded module,
   * ^c^             Set or change scheme color,
   * ^CTRL^ + ^f^    Scroll forward one screen within,
   *                 active module,
   * ^CTRL^ + ^b^    Scroll backward one screen within,
   *                 active module,
   * ^TAB^           Iterate modules (forward),
   * ^SHIFT^ + ^TAB^ Iterate modules (backward),
   * ^s^             Sort options for current module,
   * ^/^             Search across all modules,
   * ^n^             Find position of the next occurrence,
   * ^g^             Move to the first item or top of screen,
   * ^G^             Move to the last item or bottom of screen,

Examples can be found by running `man goaccess`.