[ReleaseInfo] mx_errordocs module for MX-System (1.0.0)

[markus]

mx_errordocs module for MX-System
Current version: mx_errordocs 1.0.0
Download: http://www.phpmix.org/projects/mxbb

• CONTENTS:
  
  
  1. DESCRIPTION.
     
  2. INSTALLATION.
     
  3. ERRORDOCS PARAMETERS.
     
  4. APACHE COMMANDS SAMPLES.
     
  5. SCREENSHOTS.
     
  6. HISTORY OF CHANGES.
     
  7. TIPS & TRICKS.
     
     
  8. BUGS

---

[markus]

---

DESCRIPTION:

• mx_errordocs is an addon module for MX-System which allows you to easilly integrate web server HTTP Error Documents (ie. 404 Not Found, etc.) with your portal pages.
  
• Other ErrorDocuments implementations (written by other well known sites)?
  http://www.mx-system.com/page_not_found, http://www.php.com/page_not_found, http://www.apache.org/page_not_found, http://www.google.com/page_not_found, http://www.yahoo.com/page_not_found, http://sourceforge.net/page_not_found
  
• More Information on HTTP Error Codes:
  RFC2616 - Hypertext Transfer Protocol -- HTTP/1.1 -- Status Code Definitions

Features:

• Displays information about HTTP error codes.
  
• Can be run as a block or standalone.
  
• Optionally, log relevant information about the HTTP errors (time, errno, user, IP, request_uri, referer) into DB for later analisys.
  
• AdminCP applet to customize module settings (see screenshot below).
  
• AdminCP applet to review/maintain Log records (see screenshot below).
  
• Error messages customizable through language files.

Languages:

• English (included in the package itself).
  
• Catalan and Spanish (attached in this post).

< Back to Top >

---

[markus]

---

INSTALLATION:

• Remove possible old installation:
  In the Administration Panel -> Module Administration, delete previous instance of this module.
  Delete all module files within /modules/mx_errordocs.
  
  
• Copy and upload new files:
  Unzip the distributed files into your portal modules directory: /modules/mx_errordocs.
  
  
• Import the module definition file:
  In the Administration Panel -> Module Administration, import Module Pack for this module.
  
  
• Configure Module Settings:
  In the Administration Panel, select the new module options.
  
  
• Add module block ErrorDocs to any Portal page (*):
  In the Administration Panel -> Block Administration (or Page Administration).
  
  (*) Note: This step is optional since you may run this module standalone.
  As Block : http://www.example.com/index.php?page=15&errno=404
  Standalone: http://www.example.com/modules/mx_errordocs/errordocs.php?errno=404

< Back to Top >

---

[markus]

---

ERRORDOCS PARAMETERS:

• To set runtime parameters for ErrorDocs block you may use the following variables:
  
  
  • errno: any HTTP error code, from 400 to 417 and from 500 to 505.
    
  • errlog: setting this to yes, records relevant information into DB for later analisys.
  
  
  
• See below for some Apache commands samples.

< Back to Top >

---

[markus]

---

APACHE COMMANDS SAMPLES:

• Running mx_errordocs as a block (where # is your page identifier):

  Code:

  ErrorDocument 400 /index.php?page=#&errno=400&errlog=yes ErrorDocument 403 /index.php?page=#&errno=403&errlog=yes ErrorDocument 404 /index.php?page=#&errno=404&errlog=yes ErrorDocument 500 /index.php?page=#&errno=500&errlog=yes

  
  
  
• Running mx_errordocs standalone:

  Code:

  ErrorDocument 400 /modules/mx_errordocs/errordocs.php?errno=400&errlog=yes ErrorDocument 403 /modules/mx_errordocs/errordocs.php?errno=403&errlog=yes ErrorDocument 404 /modules/mx_errordocs/errordocs.php?errno=404&errlog=yes ErrorDocument 500 /modules/mx_errordocs/errordocs.php?errno=500&errlog=yes

  
  
  
• Please, visit Apache site for more information:
  http://httpd.apache.org/docs
  http://httpd.apache.org/docs/mod/core.html#errordocument

< Back to Top >

---

[markus]

---

SCREENSHOTS:

• ErrorDocs Log Settings:
  
  
  
  
• ErrorDocs Log Management:
  
  
  

< Back to Top >

---

[markus]

---

HISTORY OF CHANGES:

• New in v.1.0.0 (2003/09/22):
  • First time released.

< Back to Top >

---