Location: PHPKode > scripts > Particle Gallery > docs/readme.htm
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Particle Gallery Readme</title>
<link rel="stylesheet" type="text/css" href="../shared/backend.css" />
</head>
<body>
<a name="top"></a>
<table width="75%" cellpadding="0" cellspacing="0" border="0" bgcolor="#FFFFFF" align="center" style="border: #666666 1px solid;"><tr><td>
<table width="100%" cellpadding="5" cellspacing="0" border="5">
<tr>
	<td>
		<p class="sub1">Welcome<p>
		<p>Welcome to the Particle Gallery readme.htm file, the hub of all documentation for Particle Gallery. There is a seperate readme with <strong><a href="upgrade.htm">upgrade</a></strong> instructions. If you have any problems, feature requests, bug reports and so forth, drop by the <a href="http://forums.particlesoft.net/">forums</a>.</p>
		<p><span class="sub2">Contents</span></p>
		<ul>
			<li><a href="#licence">Licence</a></li>
			<li><a href="#requirements">Requirements</a></li>
			<ul>
				<li><a href="#isrequired">What is Required</a></li>
				<li><a href="#isntrequired">What isn't Required</a></li>
			</ul>
			<li><a href="#installation">Installation</a></li>
			<ul>
				<li><a href="#testing">Testing Your Server</a></li>
				<li><a href="#dbconfig">Database Configuration</a></li>
				<li><a href="#installer">The Installer</a></li>
				<li><a href="#installfolder">Delete Folder</a></li>
			</ul>
			<li><a href="#userguide">User Guide</a></li>
			<ul>
				<li><a href="#adminpanel">Admin Panel</a></li>
				<li><a href="#moderationpanel">Moderation Panel</a></li>
				<li><a href="#usingskins">Using Skins</a></li>
				<li><a href="#userpanel">User Panel</a></li>
				<li><a href="#cache">Cache System</a></li>
			</ul>
			<li><a href="#credits">Credits</a></li>
		</ul>
		
		<p><span class="sub2"><a name="licence"></a>Licence</span><br />
		By using this software you show you have read and agree to the licence and terms of use. You can find them <strong><a href="licence.htm">here</a></strong>. It is worth noting that although this script may be free it is not open source.</p>
		
		<p><span class="sub2"><a name="licence"></a>Requirements</span><br />
		Here contains information on what you will need to run the script.</p>
		<p><a href="#top">Back to Top</a></p>
		<p><strong><a name="isrequired"></a>What is required</strong><br />
		You will need the following things:<br />
		&#8226; PHP - the script is written in the <a href="http://www.php.net/">PHP</a> language<br />
		&#8226; MySQL - currently only <a href="http://www.mysql.com/">MySQL</a> databases are supported
		<p><a href="#top">Back to Top</a></p>
		<p><strong><a name="isntrequired"></a>What isn't required</strong><br />
		Things that you will not need:<br />
		&#8226; Linux - the script has been tested on Windows and should run on all servers<br />
		&#8226; Apache - the script works fine on IIS and should on other servers<br />
		&#8226; JavaScript - although it improved usability, all the features work just fine for those who don't have JavaScript<br />
		&#8226; GD library - while highly recommended, the script can run without it</p>
		<p><a href="#top">Back to Top</a></p>
		
		<p><span class="sub2"><a name="Installation"></a>Installation</span><br />
		Installing the software is pretty simple. This section will guide you through the steps to have your blog up and running in minutes.
		<p><a href="#top">Back to Top</a></p>
		<p><strong><a name="testing"></a>Testing your server</strong><br />
		You may want to test your server to see how compatible it is before going ahead with the script (though this only tests the advanced features that you can run the script even if you don't have). To do this upload test.php and open the URL in your browser (ie www.example.com/test.php). This will then test the server's features.</p>
		<p><strong><a name="dbconfig"></a>Database configuration</strong><br />
		In order to install the software you will need to create a MySQL database and a user which has permissions to access this database.</p>
		<p>Once you have these, open up includes/config.php. Here you will need to enter your information. Usually you should be able to leave $dbhost and $dbprefix as default. You don't need to change these unless you know what your doing.</p>
		<p>You will however need to change:</p>
		<p>$dbuser = "";<br />
		$dbpass = "";<br />
		$dbname = "";</p>
		<p>Enter the name of your database into $dbname such as $dbname = "mydatabase";. You also need to enter the username for the user who can access this database into $dbuser and the password for that user into $dbpass.</p>
		<p>Once you have entered these values, save config.php and upload it to your web server. You may want to remove write permissions to it so that you do not overwrite it in future (although make sure it still has read permissions so the script can read it!).</p>
		<p><a href="#top">Back to Top</a></p>
		<p><strong><a name="installer"></a>Running the installer</strong><br />
		Once you have uploaded the file you can access the installer and run the script:</p>
		<p><a href="../install/install.php">install/install.php</a></p>
		<p>If you are reading this on the website you will be able to click the above link but if not simply type the address into your web browser. The installer will then take you through each step.</p>
		<p><a href="#top">Back to Top</a></p>
		<p><strong><a name="installfolder"></a>Delete /install/</strong><br />
		For security reasons, once you have run the installer you will need to delete the install folder from the web server. The rest of the script will not be accessable until you have done this.</p>
		<p><a href="#top">Back to Top</a></p>
		
		<p><span class="sub2"><a name="userguide"></a>User Guide</span><br />
		Here is a quick guide on how to use and admin your new site.
		<p><a href="#top">Back to Top</a></p>
		<p><strong><a name="adminpanel"></a>Admin Panel</strong><br />
		To reach the admin panel visit admin.php and enter your username and password. Here you can edit the site configuration. Use the edit config page to change the sites configuration. The maintenance page has tasks to keep the script running smoothly. The user manager allows you to create, edit and delete users.</p>
		<p><a href="#top">Back to Top</a></p>
		
		<p><strong><a name="moderationpanel"></a>Moderation Panel</strong><br />
		Admins and moderators have access to the moderation panel. This gives you information on what albums need moderating and what images have been reported. You can also use re-order albums to easily change the order the albums are listed and use recent comments to find the last comments posted to check they are acceptable (it is recommended you drop by to read them occasionally).</p>
		<p>Finally you can also use the moderate albums page to mass moderate images in an album. Using thumbnail mode, the images will display as they do in the album with a checkbox under each to move or delete them. Or using list mode, you can display the captions and image information only which is faster and allows you to view more at one time.</p>
		<p><a href="#top">Back to Top</a></p>
		
		<p><strong><a name="usingskins"></a>Using Skins</strong><br />
		You can have multiple skins for your site. These are all controled via the skin editor which you can reach from the admin panel (you musted be logged in as a user who has admin rights). Particle Blue (ID #1) is the default.</p>
		<p>You don't need a full set of templates for each skin - any uncustomised templates will default to the base templates which are updated automatically. So if you haven't customised any templates (customised templates will appear bold on the drop down menu), you will not have to make any template changes.</p>
		<p>If you want to customise a template, select it from the drop-down menu and click edit. This will allow you to customise the template on that skin. You will notice it is now in bold on the drop-down menu to show it has been customised from the base template and therefore will no longer update automatically. To remove the changes, go to the skin overview page, select the template from the drop-down menu and delete it. It will then update with the base template automatically. You can also use revert to update it to the base template as a one off.</p>
		<p>You can control the default skin shown to users by entering the skin's ID number into the config. Users can then change the skin via the skin selector box at the bottom of the page (unless it's been moved by the skin your using). If you don't want users doing this, disable it from the site config.</p>
		<p><a href="#top">Back to Top</a></p>
		
		<p><strong><a name="userpanel"></a>User Panel</strong><br />
		Every user has access to their own user panel. Here they can update their profile, read system messages (for example, if an image they have uploaded is approved or rejected, the system will send them a message to let them know) as well as certain other information.</p>
		<p><a href="#top">Back to Top</a></p>
		
		<p><strong><a name="cache"></a>Cache System</strong><br />
		Each time an image is generated it requires the script to get the file information from the database, process it and output the result. So to help cut down on the system resources needed, Particle Gallery has a cache  system which allows the script to save copies of the files in the file system so that it can just deliver them rather than having to generate them.</p>
		<p>The cache system requires more disk space but will speed your script up and cut down on system resources. So on the whole, it's recommended. You can enable the cache system by logging in as an admin and going to edit config and setting enablecache to true. To disable it, set it to false.</p>
		<p>You also need to alter permissions on the cache folder to allow the script to write to it. On a Windows system you won't need to do anything but on a Unix system you will need to alter the folder permissions to 0777 (read, write, execute for everyone). This can usually done via FTP, file manager in a control panel or from the command line.</p>
		<p><a href="#top">Back to Top</a></p>
		
		<p><span class="sub2"><a name="credits"></a>Credits</span><br />
		Particle Gallery was created and developed by <a href="http://www.particlesoft.net/">Particle Soft</a>.</p>
		<p><a href="#top">Back to Top</a></p>
	</td>
</tr>
</table>
</td></tr></table>
<center>&nbsp;<br />&copy; <a href="http://www.particlesoft.net/">Particle Soft</a></center>
</body>
</html>
Return current item: Particle Gallery