[mxbb-commits] core/modules/mx_mod_rewrite mod_rewrite_how_to_doc.txt,NONE,1.1

[Jon O. <jon...@us...>]

Update of /cvsroot/mxbb/core/modules/mx_mod_rewrite
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv28601/modules/mx_mod_rewrite

Added Files:
	mod_rewrite_how_to_doc.txt 
Log Message:
Adding support for mod_rewrite

--- NEW FILE: mod_rewrite_how_to_doc.txt ---
mod_rewrite for mxBB
-----------------------------------------------------------------------------------------------------

"Despite the tons of examples and docs, mod_rewrite is voodoo. Damned cool voodoo, but still voodoo."

-- Brian Moore
be...@ne...

Requirements
------------

You need Apache server with module mod_rewrite enabled. 
http://httpd.apache.org/docs/1.3/mod/mod_rewrite.html

Setup instructions for mxBB
---------------------------

Located in the contrib folder are located the files .htaccess and rewrite_custom_defs.php. These files should be moved as instructed:

mxBB_root/.htaccess (required)
mxBB_root/modules/mx_mod_rewrite/rewrite_custom_defs.php (optional)

The preconfigured "rules" will transform any portal url (http://domain/index.php?page=x) to an SEO alternative (http://domain/pagex). 
All Navigation Menu urls will apply to these rules.

Custom rules (defs)
-------------------

You may (optionally) define more rules, to make your site even more SEO and user friendly. Such additional rules are defined in
rewrite_custom_defs.php (mxBB side of things) and in the .htaccess file (server side of things). 
This distribution comes with a basic set of examples. 

To see a "live" example of mod_rewrite in action with mxBB, visit www.samskolan.se

Resources
---------

You'll need some knowledge of Apache and its .htaccess usage - and mod_rewrite itself. Further you need some regex skills. 

http://mpcon.org/apacheguide/

http://www.ilovejackdaniels.com/cheat-sheets/mod_rewrite-cheat-sheet/

http://httpd.apache.org/docs/1.3/mod/mod_rewrite.html