From: Brett Porter <brett@apache.org>
Date: Thu, 20 Nov 2008 06:15:40 +0000 (+0000)
Subject: [MRM-937] document the audit log file and the name change
X-Git-Tag: archiva-1.2~192
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=ef748c8526e8dc732a020eaf21c00771d2ceec4d;p=archiva.git

[MRM-937] document the audit log file and the name change


git-svn-id: https://svn.apache.org/repos/asf/archiva/trunk@719175 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/archiva-docs/src/site/apt/adminguide/audit-logs.apt b/archiva-docs/src/site/apt/adminguide/audit-logs.apt
new file mode 100644
index 000000000..26d41d4d1
--- /dev/null
+++ b/archiva-docs/src/site/apt/adminguide/audit-logs.apt
@@ -0,0 +1,51 @@
+ ------
+ Audit Logs
+ ------
+
+Audit Logs
+
+  Archiva's log directory contains an audit log file named <<<archiva-audit.log>>>, which tracks events that occur in the server.
+
+  A typical record looks like this:
+
+----
+2008-11-20 14:52:38 releases guest 127.0.0.1 "org/mortbay/jetty/jetty/6.1.12/jetty-6.1.12-sources.jar" "Created File (proxied)"
+----
+
+  The space delimited records are:
+
+    * date and time (server local time)
+
+    * repository affected
+
+    * user that enacted the change (or guest if none)
+
+    * IP address of the user
+
+    * the path of the artifact within the repository
+
+    * the event that occured
+
+  Currently, the following events are logged:
+
+    * creation of a directory
+
+    * creation of a file
+
+    * removal of a directory
+
+    * removal of a file
+
+    * modification of a directory
+
+    * move/rename of a file
+
+    * copy of a file
+
+    * move/rename of a directory
+
+    * copy of a directory
+
+    * uploaded file via the web interface
+
+~~TODO: link to configuration files, might want it to be configurable for different levels/events, later add GUI instructions
diff --git a/archiva-docs/src/site/apt/adminguide/index.apt b/archiva-docs/src/site/apt/adminguide/index.apt
index 771f900cb..2ae481f0a 100644
--- a/archiva-docs/src/site/apt/adminguide/index.apt
+++ b/archiva-docs/src/site/apt/adminguide/index.apt
@@ -19,6 +19,8 @@ System Administrators Guide to Apache Archiva
 
     * {{{configuration-files.html} The configuration files available for Archiva}}
 
+    * {{{audit-logs.html} Audit logging}}
+
     * {{{reports.html} Repository health reports}}
 
     []
diff --git a/archiva-docs/src/site/apt/release-notes.apt b/archiva-docs/src/site/apt/release-notes.apt
index 62492cf6d..db487e8ec 100644
--- a/archiva-docs/src/site/apt/release-notes.apt
+++ b/archiva-docs/src/site/apt/release-notes.apt
@@ -15,7 +15,11 @@ Release Notes for Archiva 1.2-M1
 
     * the archiva-user mailing list: {{http://archiva.apache.org/mail-lists.html}}
 
-* New in Archiva 1.2-M1
+* Compatibility Changes
+
+  * The Audit log filename has been renamed to <<<archiva-audit.log>>> instead of <<<audit.log>>> so that the log directory can be shared with other applications.
+
+* New in Archiva 1.2
 
 ** Struts 2
 
diff --git a/archiva-docs/src/site/site.xml b/archiva-docs/src/site/site.xml
index 7e7a5b084..d7870c291 100644
--- a/archiva-docs/src/site/site.xml
+++ b/archiva-docs/src/site/site.xml
@@ -64,6 +64,7 @@
         <item name="Consumers"               href="/adminguide/consumers.html" />
       </item>
       <item name="Configuration Files"       href="/adminguide/configuration-files.html" />
+      <item name="Audit Logs"                href="/adminguide/audit-logs.html" />
       <item name="Reports"                   href="/adminguide/reports.html" />
     </menu>