[mxbb-commits] core/doc index.xml,NONE,1.1

[Andrew <men...@us...>]

Update of /cvsroot/mxbb/core/doc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv16200/doc

Added Files:
	index.xml 
Log Message:
Preparing for DocBook... watch out for more commits regarding this!

--- NEW FILE: index.xml ---
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V5.0//EN"
               "http://www.oasis-open.org/docbook/xml/5.0/docbook.dtd">

<book>

<info>
<author>MHobbit, on behalf of the Documentation Team</author>
<type>mxBB Core Documentation</type>
<package>Core</package>
<version>2.7.6</version>
</info>

<section number="1" title="Introduction">

		<chapter title="About the mxBB-Portal/CMS" value="a">
			<data>Welcome to the MX System Portal. You have made the right choice. The MX-System Portal is the only fully modular portal system that works with the free phpBB forums software. This means that it functions without ever touching your forums data! It uses integrated features without touching phpBB, which the MX-System Portal requires to run, and currently supports the mySQL and postgreSQL databases. The system is still in development and as such may be unsuitable for novices. MX was founded by Marc Moris, but the MX site is currently supervised by Haplo and Drift. The Development Team is a bunch of great coders and MX visionaries who assist in developing the portal.
			</data>
		</chapter>
				
		<chapter title="What is mxBB for?" value="b">
			<data>The MX-System Portal is a portal for your phpBB forums. A portal is a script separate from your portal that gathers/fetches, and manages, your forums information. If you want a site based around your phpBB forums, that still can maintain all of your present forums info, a portal is the solution. Thus, you have wisely chosen MX.
			</data>
		</chapter>
		
		<chapter title="Requirements" value="c">
			<data>There are a couple of minor requirements for installing and running mxBB. They are:
				<list type="number">
					<item>A phpBB forum already up and running</item>
					<item>PHP support on your server (though if you already have a phpBB forum up, then this is already set.) Versions greater than 4.3.0 of PHP are required; any PHP version 4 and up to 5.0 are recommended. As of 2.7.6, PHP5 is not fully supported.</item>
					<item>Either mySQL or postgreSQL databases</item>
					<item>An FTP client capable of uploading your content to the Internet, retaining the folders and directories. FileZilla is one of the best FTP clients (it is GPL).</item>
				</list>
			</data>
		</chapter>
		
</section>

<section number="2" title="Installation">

	<chapter title="Verification" value="a">
		<data>Now, before you attempt installing anything, make sure you have downloaded the most recent version of MX. You can always find it here:

			<link>http://www.mx-system.com/forum/viewtopic.php?t=1224</link>

If you are sure you have done that, then download this, if you haven't already, to your computer. Make sure that you know which directory on your computer you have uploaded it to.
		</data>
	</chapter>
	
		<chapter title="Uploading" value="b">
		<data>Now, once you have downloaded the whole MX Core archives, unzip it using WinZIP or some other file decompression utility onto your hard drive. Now, you must upload the folder /mxroot/, wherever it's on you hard drive, into the web. To do this you need an FTP client such as AceFTP, CuteFTP, or WS_FTP. I recommend WS_FTP for its top speeds and AceFTP for its ease of use. Whenever you've picked which one, open up your FTP client. Make sure you have the upload settings to "auto-detect" if it has it. PHP, INC, TXT, and HTML files should be uploaded in ASCII mode, while TPL, JPG, GIF, and other graphics files should be uploaded in binary mode.
	In the following screenshots of an FTP client, I will be using AceFTP freeware. This does not mean that this is the only FTP client, it just means it's the one I'm using. Below are some links to FTP clients:

			<link>http://filezilla.sourceforge.net</link> - FileZilla (GPL, free)
			<link>http://www.ipswitch.com</link> WS_FTP LE (freeware for educational purposes)

Okay, if you've set your FTP client upload mode to auto, so that all PHP, INC, TXT, and HTML files are uploaded in ASCII mode, while TPL, JPG, GIF, and other graphics files are uploaded in BINARY mode, you're set to go. Here's a picture of where you're supposed to be:

		<image title="Uploading using FileZilla"></image>

As you can see you should highlight, on the computer/local side, the /mxroot/ folder, wherever it's located on your Hard Disk. So, simply click on the button that's circled in the screenshot, or wherever it is for your FTP client. It's a pretty big upload (a little more than 1MB) so depending on your connection, you'll have to wait a while. Once you're done, you should see the index of the location, on the right hand side (that's been uploaded), of the /mxroot/ folder. If this is confirmed, then double click on /mxroot/ to go into it. 
		</data>
	</chapter>
	
		<chapter title="CHMOD/Permissions Changing" value="c">
		<data>
		
			<emphasis>FOR LINUX/ *NIX AND APACHE SERVERS:</emphasis>
			
			Now, you must CHMOD two things: the /mxroot/cache/ directory and the mx_meta.inc file. What this means is you're giving read/write access to the MX Portal, which is required. Note: no security hazard exists with this. First, we're going to CHMOD the /mxroot/cache directory. So, to do this, depending on your FTP client, you must right click on the folder /mxroot/cache/, click on Properties, and put in the CHMOD value of 777. If a number text box doesn't exist, simply check off all "Read", "Write", and "Execute" under all users ("Owner", "Group", "Everyone"). Of course the user names vary from FTP client, but try to find something similar. So, if it's done, your little log box (if you have one) should say something like "SITE CHMOD SUCCESSFUL - 777". After that, follow the same steps to CHMOD mx_meta.inc. And you're done uploading things to your site onto the Internet.
		
			<emphasis>FOR NON-*NIX SERVERS (SUCH AS WINDOWS):</emphasis>
			
				You must change these directories' permissions:
				
				<list type="bulleted">
					<item>/mxroot/cache/</item>
					<item>/mx_meta.inc/</item>
				</list>

to:

		<quote>"Owner- Read, Write, Access", "Group- Read, Write, Access", and "All- Read, Write, Access."</quote>

		</data>
	</chapter>
	
		<chapter title="Install Configuration" value="d">
		<data>	Now, to install MX, you must visit the link in your favorite browser. Go to the URL (web address) http://www.YOURDOMAIN.com/mx . From there it will redirect you to this page:
		
			<image></image>
			
			The text fields are filled out with the descriptions of the info you're supposed to put in. At the top (it's not in the screenshot) you should select "install" if you're installing MX for the first time. Then, pick which DB software your server uses (mySQL or postgreSQL). Then, fill in the info. Here's a description of each:

			<list type="bulleted">
			
				<item>
					<emphasis>Database Server Hostname/DSN:</emphasis>
					This is the hostname of your DB server. Most of the time this is "localhost" (without the quotations), so type in that.
				</item>

				<item>
					<emphasis>Your Database Name</emphasis>
					This is pretty much self-explanatory. If you have mySQL, you probably have a DB name. Fill in the blank with the DB name.
				</item>

				<item><emphasis>Database Username</emphasis>
This usually is the username you use for your web hosting/server. Fill this out correctly... casing probably counts.
				</item>

Database Password
This is basically just the password to your DB username.

MX-Portal Prefix in DB
This is the table prefix that will appear in your DB. ie mx_blahblah. By default it should be mx_, so type that in.

phpBB prefix in DB
Now, this is very important. You must figure out what prefix your phpBB forums used, and fill it out. In most cases it's phpbb_, so use that, unless you know otherwise. MX will search in all tables preceded by "phpbb_", where it will get its info.

phpBB relative path
This is the directory path to /phpBB/ (or wherever your forums are located), relative from /mxroot/. This should be ../phpBB (or wherever your forums are located). Note the two periods. This tells MX to go back a folder, then into /yourforums/.

Full Portal URL
This is pretty much self-explanatory. Type in the whole URL location of your /mxroot/ folder. It should be something like www.YOURDOMAIN.com/mx.

Full phpBB URL
This is again pretty much self-explanatory. Type in the whole URL location of your /yourforums/ folder. It should be something like www.YOURDOMAIN.com/phpBB2/.</list>


		</data>
	</chapter>
	
</section>

</book>