Skip to content

Commit

Permalink
updated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
allinurl committed Jun 4, 2012
1 parent 34eecc5 commit f5bf73c
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 23 deletions.
2 changes: 1 addition & 1 deletion AUTHORS
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
Copyright (C) 2010
Copyright (C) 2009-2012
Gerardo Orellana <[email protected]>
12 changes: 12 additions & 0 deletions ChangeLog
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
Changes to GoAccess 0.5 - Monday, June 04, 2012

* Added the ability to parse a custom format string.
* Added ability to output a full stats report to a file.
* Added support for IPv6
* Fixed issue on Opera agents where version was not recognized correctly.
* Fixed issue on empty Google query strings.
* Fixed google cache key-phrases.
* Added a new include sys/socket.h - BSD
* Added a key shortcut to scroll top/bottom.
* Fixed other minor fixes and changes.

Changes to GoAccess 0.4.2 - Monday, January 03, 2011

* Fixed a minor bug when adding monthly totals on visitors subwin.
Expand Down
4 changes: 3 additions & 1 deletion NEWS
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
Copyright (C) 2010
Copyright (C) 2009-2012
Gerardo Orellana <[email protected]>

* Version history:
- 0.5 [Monday, June 04, 2012]
. GoAccess 0.5 Released. See ChangeLog for new features/bug-fixes.
- 0.4.2 [Monday, January 03, 2011]
. GoAccess 0.4.2 Released. See ChangeLog for new features/bug-fixes.
- 0.4.1 [Monday, December 13, 2010]
Expand Down
39 changes: 23 additions & 16 deletions README
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
Copyright (C) 2010
Copyright (C) 2009-2012
Gerardo Orellana <[email protected]>
http://goaccess.prosoftcorp.com/

Thursday, September 09 2010
Monday, June 04 2012

INTRODUCTION
-------------
GoAccess is an open source real-time Apache web log analyzer and
interactive viewer that runs in a terminal and provides fast and
valuable HTTP statistics for system administrators that require a
visual report on the fly.
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.

How it works and what it does?
-------------------------------
Essentially, the way GoAccess works is that it will parse the
well-known Apache access log file, from there, GoAccess will collect data
from the parsed file and it will display it to the console or the X terminal.
The collected information or generated reports will be displayed to the
user/sysadmin in a visual/interactive window. Reports include:
Essentially, GoAccess will parse the specified web log file;
from there, it will collect data from the parsed log
and it will display it to the console or the X terminal.
The collected information or generated reports will be
displayed to the user/sysadmin in a visual/interactive window.
Reports include:

* General Statistics, Bandwidth etc.
* General Statistics, bandwidth etc.
* Top Visitors
* Requested files
* Requested static files, images, swf, js, etc.
Expand All @@ -31,15 +32,21 @@ user/sysadmin in a visual/interactive window. Reports include:
* HTTP Status Codes
* Referring Sites
* Keyphrases
* Support for IPv6
* Different Color Schemes
* Unlimited log file size
* Custom log format
* Output statistics to a file. See report.

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 huge web reports. You can see it more as a monitor
command tool than anything else. (or at least that's the intended purpose)
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.
Although it is possible to generate an HTML report,
by default it outputs to a terminal.

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

Keys
----
Expand Down
6 changes: 1 addition & 5 deletions TODO
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
Copyright (C) 2010
Copyright (C) 2009-2012
Gerardo Orellana <[email protected]>

This is the TODO list for GoAccess.
If you are interested in working on any of these,
email [email protected].

* General:
- Better support for UTF-8 (Done, run ./configure --enable-utf8)
- Support for parsing IPv6
- Increase the performance when parsing the log file.
- Resize child windows when term is resized.
- Add command-line parameters.
- Filtering data by date. (Done, see `man goaccess`)
- Add more reports to it.

* Documentation:
Expand Down

0 comments on commit f5bf73c

Please sign in to comment.