You are here

install.html in Boost 6

File

help/install.html
View source
<a name="top"></a><img src="&path&rocket.png" align="right">
<p><b>1.</b> Goto: ( Administer > Site configuration > Clean URLs ) and ensure that Drupal's clean URLs are enabled and working correctly on your site.</p>
<p><b>2.</b> Unzip and upload the module folder (as is) to the sites/all/modules folder in your Drupal installation directory.</p>
<p><b>3.</b> Goto: ( Administer > Site building > Modules ) and enable the Boost module. You will find it in the section labeled "Caching".</p>
<p><b>4.</b> Goto: ( Administer > Site configuration > Performance > Boost settings ) Specify the cache directory, which should be something like cache/normal/www.example.com (keeping the default directory is recommended) and must be writeable by the web server: you may need to create the directory, and set the permissions so it is writeable.</p>
<p><b>5.</b> On the ( Administer > Site configuration > Performance > Boost settings ) page is the Default maximum cache lifetime setting. As cached pages are created, they are given an expire by date and time, which is the current date and time plus the maximum cache lifetime. These dates and times are checked on each cron run; and if a page is expired, the cache is cleared, and a new cached version will be created the next time the page is called upon by an anonymous user (including bots). The page will be regenerated by the Boost crawler if enabled on the Boost settings page.</p>
<p><b>6. IMPORTANT:</b><br />
--- This step is easy and required for Boost to work! ---<br />
Back up the original .htaccess file from your Drupal installation directory for safe keeping. Copy the custom generated htaccess rule from ( Administer > Site configuration > Performance > htaccess rules generation ) and paste the rules into the Drupal .htaccess file as shown below.<br />
<ul>
-------------------<br />
This is a cut-away of the .htaccess file (8 lines from the bottom)<br />
-------------------<br />       
# RewriteBase /<br />
<b> paste the rules right here </b><br />
# Rewrite URLs of the form 'x' to the form 'index.php?q=x'.<br />
-------------------<br />
</ul>
</p>
<p>In the boost/htaccess/ folder, the default.txt file shows you the exact placement of the rules, in case your not sure.</p> 
<p>The module package has 3 htaccess templates included in the Boost/htaccess folder (boosted1.txt, boosted2.txt and default.txt). These templates may be helpful in some cases and are good for reference. For the technically inclined, the difference between the two .htaccess templates is due to boosted1.txt relying on SERVER_NAME versus boosted2.txt using HTTP_HOST. There are valid use cases for both in more advanced multi-site installations.</p>
<p><b>7.</b> Prepare robots.txt File for Search Engines<br />
This is needed in order to prevent the output of this from accidently getting indexed by search engines. Locate and open the robots.txt file in the Drupal root with a text editor. Add Disallow: /boost_stats.php to the file as shown below. Save the change and put the file back in the Drupal root.
<ul>
-------------------<br />
This is a cut-away of the robots.txt file(towards the bottom)<br />
-------------------<br />
User-agent: *<br />
Crawl-delay: 10<br />
# Directories<br />
[..............]<br />
# Files<br />
<b>Disallow: /boost_stats.php</b><br />
Disallow: /CHANGELOG.txt<br />
Disallow: /cron.php<br />
Disallow: /INSTALL.mysql.txt<br />
[.............]<br />
-------------------</ul>
</p>
<p><b>8.</b> Goto: ( Administer > Site configuration > Performance ) Check and set the Drupal cache settings as desired.</p>
<p><a href="#top">Back to top</a><br /></p>