Commit 4c897a2d authored by mikeytown2's avatar mikeytown2

#640306 by dbeall: Update help folder.

parent a20aa19f
<a name="top"></a><img src="&path&rocket.png" align="right">
<p>There are 2 blocks that you can add to help with the administrative<br>
side (status, page configuration), and 1 block to support core stats.</p>
<p>Goto: (administer > Site building > Blocks > List) to place them.</p>
<p>The visibility of blocks can also be configured by role and page.<br>
On the Blocks list page, to the right of each block click 'configure'.</p>
<p><b>Status Block:</b><br>
This block shows the current status of the page as far as Boost is<br>
concerned. It will state if the page is served 'live' or by 'Boost',<br>
the expiration of the page and has a Flush Page button to clear the<br>
page from the cache manually. The block only appears if your not user<br>
0 and provides useful information about PHP errors on the page.</p>
<p><b>Page configuration Block:</b><br>
This block allows the administrator to set pages individually.<br>
Including setting for minimum cache lifetime(select box), preemptive<br>
cache(on or off), scope(page ID, content type or content container).</p>
<p><b>Stats Block:</b><br>
Drupal's core stats is supported. Configure the "Popular content" block, but<br>
then disable it. Place the "Boost: AJAX core statistics" in its place. If ajax<br>
stats are loading too slowly, copy stats/boost_stats.php to your webroot and<br>
enable "Cache Statistics Block". The cache gets updated on cron runs.</p>
<p><a href="#top">Back to top</a><br></p>
<p>There are 2 blocks that you can add to help with the administrative side (status, page configuration), and 1 block to support core stats.</p>
<p>Goto: ( Administer > Site building > Blocks > List ) to place them.</p>
<p>The visibility of blocks can also be configured by role and page. On the Blocks list page, to the right of each block click 'configure'.</p>
<p><b>Status Block:</b><br />
This block shows the current status of the page as far as Boost is concerned. It will state if the page is served 'live' or by 'Boost', the expiration of the page and has a Flush Page button to clear the page from the cache manually. The block only appears if your not user 0 and provides useful information about PHP errors on the page.</p>
<p><b>Page configuration Block:</b><br />
This block allows the administrator to set pages individually. Including setting for minimum cache lifetime(select box), preemptive cache(on or off), scope(page ID, content type or content container).</p>
<p><b>Stats Block:</b><br />
Drupal's core stats is supported. Configure the "Popular content" block, but then disable it. Place the "Boost: AJAX core statistics" in its place. If ajax stats are loading too slowly, copy stats/boost_stats.php to your webroot and enable "Cache Statistics Block". The cache gets updated on cron runs.</p>
<p><a href="#top">Back to top</a><br /></p>
\ No newline at end of file
......@@ -32,22 +32,27 @@ title = Configuration for i18n, Domain Module and Crawler
file = config
weight = -05
[blocks]
title = Boost Blocks
file = blocks
weight = -04
[notes]
title = Important Notes and Troubleshooting
file = notes
weight = -04
weight = -03
[rules]
title = Using Rules to Refresh Pages
file = rules
weight = -03
weight = -02
[works]
title = How it Works and Limitations
file = works
weight = -02
weight = -01
[links]
title = Project Links and Credits
file = links
weight = -01
\ No newline at end of file
weight = -00
<a name="top"></a><img src="&path&rocket.png" align="right">
<br>
<p><b>For the (i18n) and the (Domain) modules:</b><br>
Enable<br>
[x] Do not store the cache file path in the database<br>
[x] Flush all sites caches in this database (singe db, multi-site)<br>
Disable<br>
[ ] Only allow ASCII characters in path<br>
<p><b>Enable XML & AJAX/JSON caches</b><br>
Enable<br>
[x] Cache .xml & /feed<br>
[x] Cache ajax/json</p>
<p><b>To Use the Cron Crawler:</b><br>
Enable<br>
[x] Overwrite the cached file if it already exits<br>
[x] Expire content in DB, do not flush file.<br>
[x] Enable the cron crawler</p>
<p><a href="#top">Back to top</a><br></p>
<p><b>For the (i18n) and the (Domain) modules:</b><br />
Enable<br />
[x] Do not store the cache file path in the database<br />
[x] Flush all sites caches in this database (singe db, multi-site)<br />
Disable<br />
[ &nbsp;] Only allow ASCII characters in path<br />
<p><b>Enable XML & AJAX/JSON caches</b><br />
Enable<br />
[x] Cache .xml & /feed<br />
[x] Cache ajax/json</p>
<p><b>To Use the Cron Crawler:</b><br />
Enable<br />
[x] Overwrite the cached file if it already exits<br />
[x] Expire content in DB, do not flush file.<br />
[x] Enable the cron crawler</p>
<p><a href="#top">Back to top</a><br /></p>
\ No newline at end of file
<p><a href name="top"></a></p>
<img src="&path&rocket.png" align="right">
<p>This module provides static page caching for Drupal 6.x websites.<br>
It provides a significant performance increase as well as<br>
scalability for sites that receive mostly anonymous traffic.<br>
Web pages load very fast from the cache instead of waiting on<br>
PHP and Drupal to serve them from the database. If the page is<br>
not found in the cache, then the request is passed to Drupal.<br>
The built-in crawler makes sure expired content is quickly<br>
regenerated to insure fast page loading at all times.<br>
&bull; The guy that is writing this could brag about Boost,<br>
but he will let you do that part. Enjoy!</p>
<p><a href name="top"></a></p><img src="&path&rocket.png" align="right">
<h3>DESCRIPTION</h3>
<p>This module provides static page caching for Drupal 6.x websites. It provides a significant performance increase as well as scalability for sites that receive mostly anonymous traffic. Web pages load very fast from the cache instead of waiting on PHP and Drupal to serve them from the database. If the page is not found in the cache, then the request is passed to Drupal. The built-in crawler makes sure expired content is quickly regenerated to insure fast page loading at all times.<br />
&bull; The guy that is writing this could brag about Boost, but he will let you do that part. Enjoy !</p>
<h3>FEATURES</h3>
&bull; This is a partial list, because it could take the whole page.<br>
&bull; Fast page serving for anonymous visitors to your Drupal website.<br>
&bull; Reduces web server load and increases your site's scalability.<br>
&bull; On-demand page caching (static file created after first page request).<br>
&bull; Uses cron run to trigger cleaning of cached files.<br>
&bull; Built in crawler to automatically regenerate cached files.<br>
&bull; Adjustable cache lifetimes for different parts of the website.<br>
&bull; Supports HTML, XML, CSS, JavaScript, JSON/AJAX.<br>
&bull; Injects HTML comment to provide easy verification of Boost.<br>
&bull; Supports shared, VPS and dedicated hosting.<br>
&bull; Supports sub-directory Installations.<br>
&bull; This is a partial list, because it could take the whole page.<br />
&bull; Fast page serving for anonymous visitors to your Drupal website.<br />
&bull; Reduces web server load and increases your site's scalability.<br />
&bull; On-demand page caching (static file created after first page request).<br />
&bull; Uses cron run to trigger cleaning of cached files.<br />
&bull; Built in crawler to automatically regenerate cached files.<br />
&bull; Adjustable cache lifetimes for different parts of the website.<br />
&bull; Supports HTML, XML, CSS, JavaScript, JSON/AJAX.<br />
&bull; Injects HTML comment to provide easy verification of Boost.<br />
&bull; Supports shared, VPS and dedicated hosting.<br />
&bull; Supports sub-directory Installations.<br />
&bull; Full support for multi-site Drupal installations.
<p><a href="#top">Back to top</a><br></p>
<p><a href="#top">Back to top</a><br /></p>
\ No newline at end of file
<a name="top"></a><img src="&path&rocket.png" align="right">
<p>The cached files are stored (by default) in the cache/normal/ directory<br>
under your Drupal installation directory. The Drupal pages' URL paths<br>
are translated into file system names in the following manner:</p>
<p>The cached files are stored (by default) in the cache/normal/ directory under your Drupal installation directory. The Drupal pages' URL paths are translated into file system names in the following manner:</p>
<ul>
<p>http://example.com/<br>
=> cache/normal/example.com/_.html</p>
<p>http://example.com/about<br>
=> cache/normal/example.com/about_.html</p>
<p>http://example.com/about/staff<br>
=> cache/normal/example.com/about/staff_.html</p>
<p>http://example.com/node/42<br>
=> cache/normal/example.com/node/42_.html</p>
<p>http://example.com/<br />
=> cache/normal/example.com/_.html</p>
<p>http://example.com/about<br />
=> cache/normal/example.com/about_.html</p>
<p>http://example.com/about/staff<br />
=> cache/normal/example.com/about/staff_.html</p>
<p>http://example.com/node/42<br />
=> cache/normal/example.com/node/42_.html</p>
</ul>
<p>You'll note that the directory path includes the Drupal site name, enabling<br>
support for multi-site Drupal installations.</p>
<p><a href="#top">Back to top</a><br></p>
<p>You'll note that the directory path includes the Drupal site name, enabling support for multi-site Drupal installations.</p>
<p><a href="#top">Back to top</a><br /></p>
\ No newline at end of file
<a name="top"></a><img src="&path&rocket.png" align="right">
<p>1. Goto: [Administer > Site configuration > Clean URLs] and ensure that<br>
Drupal's clean URLs are enabled and working correctly on your site.</p>
<p>2. Unzip and upload the module folder (as is) to the sites/all/modules<br>
folder in your Drupal installation directory.</p>
<p>3. Goto: [Administer > Site building > Modules] and enable the Boost<br>
module. You will find it in the section labeled "Caching".</p>
<p>4. Goto: [Administer > Site configuration > Performance > Boost settings]<br>
Specify the cache directory, which should be something like<br>
cache/normal/www.example.com (keeping the default directory is recommended)<br>
and must be writeable by the web server: you may need to create the<br>
directory, and set the permissions so it is writeable.</p>
<p>5. On the [Administer > Site configuration > Performance > Boost settings]<br>
page is the Default maximum cache lifetime setting. As cached pages are<br>
created, they are given an expire by date and time, which is the current<br>
date and time plus the maximum cache lifetime. These dates and times are<br>
checked on each cron run; and if a page is expired, the cache is cleared,<br>
and a new cached version will be created the next time the page is<br>
called upon by an anonymous user (including bots). The page will be<br>
regenerated by the Boost crawler if enabled on the Boost settings page.</p>
<p>6. IMPORTANT:<br>
--- This step is easy and required for Boost to work! ---<br>
Back up the original .htaccess file from your Drupal installation directory<br>
for safe keeping. Copy the custom generated htaccess rule from<br>
[Administer > Site configuration > Performance > htaccess rules generation]<br>
page and paste the rules into the Drupal htaccess file as shown below.</p>
<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>
<p># RewriteBase /<br>
-------paste the rules right here--------<br>
# Rewrite URLs of the form 'x' to the form 'index.php?q=x'.</p>
-------------------<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>In the boost/htaccess/ folder, the default.txt file shows you<br>
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<br>
folder (boosted1.txt, boosted2.txt and default.txt). These templates may<br>
be helpful in some cases and are good for reference. For the technically<br>
inclined, the difference between the two .htaccess templates is due<br>
to boosted1.txt relying on SERVER_NAME versus boosted2.txt using HTTP_HOST.<br>
There are valid use cases for both in more advanced multi-site installations.</p>
<p>7. Goto: [Administer > Site configuration > Performance]<br>
Check and set the Drupal cache settings as desired.</p>
<p><a href="#top">Back to top</a><br></p>
</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>
\ No newline at end of file
<a name="top"></a><img src="&path&rocket.png" align="right">
<a href="#hbook">Boost Handbook Links</a> | <a href="#proj">Boost Project & Drupal Links</a> | <a href="#cred">Credits</a> | <a href="#donat">Help Boost</a>
<a href name="hbook"></a>
<h4>BOOST HANDBOOK PAGES</h4>
<p><a href="http://drupal.org/node/545664">Boost handbook Main Page</a><br>
<a href="http://drupal.org/node/545908">Installation & Settings</a><br>
<a href="http://drupal.org/node/583264">Boost Tips & Tricks</a><br>
<a href="http://drupal.org/node/546134">FAQ & Future Features</a><br>
<p><a href="http://drupal.org/node/545664">Boost handbook Main Page</a><br />
<a href="http://drupal.org/node/545908">Installation & Settings</a><br />
<a href="http://drupal.org/node/583264">Boost Tips & Tricks</a><br />
<a href="http://drupal.org/node/546134">FAQ & Future Features</a><br />
<a href="http://drupal.org/node/546834">Using Boost and Blogging About It</a>
<a href name="proj"></a>
<h4>BOOST PROJECT & DRUPAL LINKS</h4>
<a href="http://drupal.org/project/boost">Boost project page</a><br>
<a href="http://drupal.org/project/issues/boost">Post feature requests and bug reports</a><br>
<a href="http://drupal.org/forum/22">Drupal Help Forum</a><br>
<a href="http://drupal.org/project/boost">Boost project page</a><br />
<a href="http://drupal.org/project/issues/boost">Post feature requests and bug reports</a><br />
<a href="http://drupal.org/forum/22">Drupal Help Forum</a><br />
<a href="http://bendiken.net/2006/05/28/static-page-caching-for-drupal">The original blog post about Boost</a></p>
<a href name="cred"></a>
<h4>CREDITS</h4>
<p>6.x Developer and Maintainer, Mike Carper(<a href="http://drupal.org/user/282446">mikeytown2</a>) of <a href="http://316solutions.net">316solutions</a><br>
&bull; Originally Developed by Arto Bendiken(arto) <a href="http://bendiken.net/">bendiken.net</a><br>
&bull; Ported to Drupal 5.x by Alexander I. Grafov(axel) <a href="http://drupal.ru/">drupal.ru</a><br>
&bull; Ported to Drupal 6.x by Ben Lavender(bhuga) <a href="http://bhuga.net/">bhuga.net</a><br>
<p>6.x Developer and Maintainer, Mike Carper(<a href="http://drupal.org/user/282446">mikeytown2</a>) of <a href="http://316solutions.net">316solutions</a><br />
&bull; Originally Developed by Arto Bendiken(arto) <a href="http://bendiken.net/">bendiken.net</a><br />
&bull; Ported to Drupal 5.x by Alexander I. Grafov(axel) <a href="http://drupal.ru/">drupal.ru</a><br />
&bull; Ported to Drupal 6.x by Ben Lavender(bhuga) <a href="http://bhuga.net/">bhuga.net</a><br />
&bull; Miscellaneous contributions by Jacob Peddicord, Justin Miller & Barry Jaspan.</p>
<a href name="donat"></a>
<h4>Help Make Boost Better</h4>
<p>Consider the amount of money this module saves, in comparison to a more expensive hosting solution.<br>
I (Mike Carper) accept <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=mikecarper%40gmail%2ecom&lc=US&item_name=6%2ex%20Boost%20Module&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted">Donations</a> to offset endless hours of development time.
<p><a href="#top">Back to top</a><br></p>
<p>Consider the amount of money this module saves, in comparison to a more expensive hosting solution. I (Mike Carper) accept <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=mikecarper%40gmail%2ecom&lc=US&item_name=6%2ex%20Boost%20Module&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted">Donations</a> to offset endless hours of development time.
<p><a href="#top">Back to top</a><br /></p>
\ No newline at end of file
<a name="top"></a><img src="&path&rocket.png" align="right">
<h3>If cron is not clearing the cache as expected.</h3>
<p>
Set $base_url variable in /sites/default/settings.php (line 125 or so)<br />
so cron runs error free and clears the cache properly when invoked like<br />
'php /path/to/cron.php' or 'drush cron'. This should be something like<br />
http://www.example.com</p>
Prepare Settings.php File for Cron
<p>Set $base_url variable in /sites/default/settings.php (line 125 or so) so cron runs error free and clears the cache properly when invoked like 'php /path/to/cron.php' or 'drush cron'. This should be something like http://www.example.com</p>
<dt>Prepare Settings.php File for Cron</dt>
<dd>Set $base_url variable in /sites/default/settings.php so cron will run error free and clear the cache properly.<br />
-------------------<br />
<em>This is a cut away of the settings.php file</em>(about half way down)<br />
-------------------<br />
* Examples:<br />
* $base_url = 'http://www.example.com';<br />
......@@ -19,21 +12,15 @@ Prepare Settings.php File for Cron
* $base_url = 'http://www.example.com/drupal';<br />
* $base_url = 'https://www.example.com:8888/drupal';<br />
*<br />
* It is not allowed to have a trailing slash; Drupal will add it<br />
* for you.<br />
*/<br />
# $base_url = 'http://www.example.com'; // NO trailing slash!<br />
# $base_url = 'http://www.example.com' ; // NO trailing slash!<br />
-------------------<br />
Add the website URL between the ( &#039; &#039; ) as in the example above.<br />
Remove or delete the # so it will work.<br />
-------------------</dd>
</p>
<h3>URL paths that contain non-ASCII characters</h3>
<p>If your Drupal URL paths contain non-ASCII characters, you may have to<br>
tweak your locate settings on the server in order to ensure the URL paths<br>
get correctly translated into directory paths in the file system.<br>
You can also turn off the ASCII filter in the Boost Advanced Settings.<br>
OR install the <a href="http://drupal.org/project/transliteration">Transliteration</a> module to help fix the characters.</p>
<p><a href="#top">Back to top</a><br></p>
<p>If your Drupal URL paths contain non-ASCII characters, you may have to tweak your locate settings on the server in order to ensure the URL paths get correctly translated into directory paths in the file system. You can also turn off the ASCII filter in the Boost Advanced Settings. OR install the <a href="http://drupal.org/project/transliteration">Transliteration</a> module to help fix the characters.</p>
<p><a href="#top">Back to top</a><br /></p>
\ No newline at end of file
<a name="top"></a><img src="&path&rocket.png" align="right">
<p>Boost is designed for Drupal 6.x served by Apache on any platform.</p>
<p>Drupal's clean URLs MUST be enabled and working properly.</p>
<p>If the cached files and pages must be cleared at their expired time,<br>
the cron run for Drupal must be correctly setup to execute more often than,<br>
or as often as the cache lifetime you specify in the settings.</p>
<p>Since the static page caching is implemented with mod_rewrite directives,<br>
Apache version 1.3 or 2.x with mod_rewrite enabled is required (if Drupal's<br>
clean URLs work for you, you're fine; if not, get them working first).</p>
<p>Other web servers, such as Lighttpd, are NOT officially supported at present.<br>
&bull; <a href="http://drupal.org/node/150909">Lighttpd</a> &bull; <a href="http://drupal.org/node/244072">Nginx</a></p>
<p><br><a href name="rm"></a><a href="#top">Back to top</a></p>
<h3>REQUIREMENTS</h3>
<p><ul>
<li> Boost is designed for Drupal 6.x served by Apache on any platform.</li>
<li> Drupal's clean URLs MUST be enabled and working properly.</li>
<li> If the cached files and pages must be cleared at their expired time, the cron run for Drupal must be correctly setup to execute more often than, or as often as the cache lifetime you specify in the settings.</li>
<li> Since the static page caching is implemented with mod_rewrite directives, Apache version 1.3 or 2.x with mod_rewrite enabled is required (if Drupal's clean URLs work for you, you're fine; if not, get them working first).</li>
<li> Other web servers, such as Lighttpd, are NOT officially supported at present.<br />
&bull; <a href="http://drupal.org/node/150909">Lighttpd</a> &bull; <a href="http://drupal.org/node/244072">Nginx</a></li>
</ul>
<h3>RECOMMENDED MODULES</h3>
<p>Path (Drupal Core)</p>
<p><a href="http://drupal.org/project/globalredirect">Global Redirect</a></p>
<p><a href="http://drupal.org/project/transliteration">Transliteration</a></p>
<p><a href="http://drupal.org/project/pathauto">Pathauto</a></p>
<p><a href="http://drupal.org/project/token">Token</a></p>
<p><a href="http://drupal.org/project/poormanscron">Poormanscron -dev</a> if cron configuration is not available on your server.<br>
</p>
<p>If enabled [x] Clear all cached pages referenced via CCK with a node...<br>
The <a href="http://drupal.org/project/nodereferrer">Node Referrer</a> module is recommended.<br>
</p>
<p><a href="#top">Back to top</a><br></p>
<p><a href="http://drupal.org/project/poormanscron">Poormanscron 1.1 or 2.0</a> if cron configuration is not available on your server.</p>
<p>If enabled [x] Clear all cached pages referenced via CCK with a node... The <a href="http://drupal.org/project/nodereferrer">Node Referrer</a> module is recommended.</p>
<p><a href="#top">Back to top</a><br /></p>
<img src="&path&rocket.png" align="right">
<p><b>Case:</b> The website has mostly anonymous visitors and a few content changes every so often. Waiting on cron to run may not be the best solution if you want changes to be available for anonymous visitors immediately. On a website such as this you are taking advantage of the Boost timestamp function to rebuild only pages that have changed at each cron run. This rules setup works outside of that Boost function as it will immediately refresh the cache with the one page that has has changed.</p>
<p><b>Solution:</b> Download the <a href="http://ftp.drupal.org/files/projects/rules-6.x-1.1.tar.gz">rules</a> module, unzip it and upload it to sites/all/modules. Goto: (Administer > Site building > Modules > List) to enable Rules, save the changes. Goto: (Administer > Rules > Triggered rules > Add a new rule). Give the new rule a label or name, choose an Event that will trigger the rule from the select list (Content is going to be saved), check mark the box [X] This rule is active and should be evaluated when the associated event occurs. and save the changes. In the next section, choose (Add an action). Use the select list and choose (Clear a page from the boost cache), Next, then Save.</p>
\ No newline at end of file
<a name="top"></a><img src="&path&rocket.png" align="right">
<p>1. Log out from Drupal (or use another browser) to browse around your site<br>
as the anonymous user. Ensure that static files are indeed being<br>
generated into the Boost cache directory you specified above (#4); and if<br>
you opt to use gzip, likewise check gzipped files are being generated in<br>
the directory you specified for this.<br>
The Administer > Performance > Boost settings page shows how many pages<br>
are cached by Boost.</p>
<p>2. Check the Drupal status page [Administer > Reports > Status report]<br>
for any errors or notices.</p>
<p>3. To check whether you have a cached or dynamic version of a page,<br>
look at the very end of the page's HTML source. You have the cached<br>
version if the last line looks like this:<br>
<p><b>1.</b> Log out from Drupal (or use another browser) to browse around your site as the anonymous user. Ensure that static files are indeed being generated into the Boost cache directory; and if you opt to use gzip, likewise check gzipped files are being generated in the directory you specified for this. The ( Administer > Performance > Boost settings ) page shows how many pages are cached by Boost.</p>
<p><b>2.</b> Check the Drupal status page ( Administer > Reports > Status report ) for any errors or notices.</p>
<p><b>3.</b> To check whether you have a cached or dynamic version of a page, look at the very end of the page's HTML source. You have the cached version if the last line looks like this:</p>
<code><--Page cached by Boost @ 2009-08-11 06:19:58,expires @ 2009-08-11 09:19:58--></code>
</p>
<p><a href="#top">Back to top</a><br></p>
<p><a href="#top">Back to top</a><br /></p>
\ No newline at end of file
<a name="top"></a><img src="&path&rocket.png" align="right">
<a href="#works">How Boost Works</a> | <a href="#disp">Dispatch Mechanism</a> | <a href="#limit">Limitations</a>
<h4>HOW BOOST WORKS</h4>
<p>Once Boost has been installed and enabled, page requests by anonymous<br>
visitors will be cached as static HTML pages in the server's file system.<br>
Periodically (when the Drupal cron runs) stale or expired pages<br>
(i.e. files or pages exceeding the maximum cache lifetime setting)<br>
will be purged, allowing them to be recreated the first time that the<br>
next anonymous visitor requests that page again. If the Cron Crawler<br>
is enabled, the files and pages will be regenerated automatically.</p>
<p>New rewrite rules are added to the .htaccess file supplied with Drupal,<br>
directing the web server to try and fulfill page requests by anonymous<br>
visitors first and foremost from the static page cache, and to only pass the<br>
request through to Drupal if the requested page is not cacheable or hasn't yet<br>
been cached.</p>
<p><br><a href name="disp"></a><a href="#top">Back to top</a></p>
<p>Once Boost has been installed and enabled, page requests by anonymous visitors will be cached as static HTML pages in the server's file system. Periodically (when the Drupal cron runs) stale or expired pages (i.e. files or pages exceeding the maximum cache lifetime setting) will be purged, allowing them to be recreated the first time that the next anonymous visitor requests that page again. If the Cron Crawler is enabled, the files and pages will be regenerated automatically.</p>
<p>New rewrite rules are added to the .htaccess file supplied with Drupal, directing the web server to try and fulfill page requests by anonymous visitors first and foremost from the static page cache, and to only pass the request through to Drupal if the requested page is not cacheable or hasn't yet been cached.</p>
<p><a href name="disp"></a></p>
<h4>DISPATCH MECHANISM</h4>
<p> For each incoming page request, the new Apache mod_rewrite directives in<br>
.htaccess will check if a cached version of the requested page should be<br>
served as per the following simple rules:</p>
<p>1. First, we check that the HTTP request method being used is GET.<br>
POST requests are not cacheable, and are passed through to Drupal.</p>
<p>2. Since only anonymous visitors can benefit from the static page cache at<br>
present, we check that the page request doesn't include a cookie that<br>
is set when a user logs in to the Drupal site. If the cookie is<br>
present, we simply let Drupal handle the page request dynamically.</p>
<p>3. Now, for the important bit: we check whether we actually have a cached<br>
HTML file for the request URL path available in the file system cache.<br>
If we do, we direct the web server to serve that file directly and to<br>
terminate the request immediately after; in this case, Drupal (and<br>
indeed PHP) is never invoked, meaning the page request will be served<br>
by the web server itself at full speed.</p>
<p>4. If, however, we couldn't locate a cached version of the page, we just<br>
pass the request on to Drupal, which will serve it dynamically in the<br>
normal manner.</p>
<p><br><a href name="limit"></a><a href="#top">Back to top</a></p>
<p> For each incoming page request, the new Apache mod_rewrite directives in .htaccess will check if a cached version of the requested page should be served as per the following simple rules:</p>
<p><b>1.</b> First, we check that the HTTP request method being used is GET. POST requests are not cacheable, and are passed through to Drupal.</p>
<p><b>2.</b> Since only anonymous visitors can benefit from the static page cache at present, we check that the page request doesn't include a cookie that is set when a user logs in to the Drupal site. If the cookie is present, we simply let Drupal handle the page request dynamically.</p>
<p><b>3.</b> Now, for the important bit: we check whether we actually have a cached HTML file for the request URL path available in the file system cache. If we do, we direct the web server to serve that file directly and to<br>
terminate the request immediately after; in this case, Drupal (and indeed PHP) is never invoked, meaning the page request will be served by the web server itself at full speed.</p>
<p><b>4.</b> If, however, we couldn't locate a cached version of the page, we just pass the request on to Drupal, which will serve it dynamically in the normal manner.</p>
<p><a href name="limit"></a><a href="#top">Back to top</a></p>
<h4>LIMITATIONS</h4>
<p>Only anonymous visitors will be served cached versions of pages;<br>
authenticated users will get dynamic content. This will limit the<br>
usefulness of this module for those community sites that require user<br>
registration and login for active participation.</p>
<p>In contrast to Drupal's built-in caching, static caching will lose any<br>
additional HTTP headers set for an HTML page by a module. This is unlikely<br>
to be problem except for some very specific modules and rare use cases.</p>
<p>Web server software other than Apache is not supported at the moment.<br>
Adding Lighttpd support would be desirable but is not a high priority for<br>
the developer at present (see TODO.txt). (Note that while the LiteSpeed web<br>
server has not been specifically tested by the developer, it may, in fact,<br>
work, since they claim to support .htaccess files and to have mod_rewrite<br>
compatibility. Feedback on this would be appreciated.)</p>
<p><a href="#top">Back to top</a><br></p>
<p>Only anonymous visitors will be served cached versions of pages; authenticated users will get dynamic content. This will limit the usefulness of this module for those community sites that require user registration and login for active participation.</p>
<p>In contrast to Drupal's built-in caching, static caching will lose any additional HTTP headers set for an HTML page by a module. This is unlikely to be problem except for some very specific modules and rare use cases.</p>
<p>Web server software other than Apache is not supported at the moment. Adding Lighttpd support would be desirable but is not a high priority for the developer at present (see TODO.txt). (Note that while the LiteSpeed web server has not been specifically tested by the developer, it may, in fact, work, since they claim to support .htaccess files and to have mod_rewrite compatibility. Feedback on this would be appreciated.)</p>
<p><a href="#top">Back to top</a><br /></p>
\ No newline at end of file
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment