summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMathieu Lutfy2012-04-25 14:29:49 (GMT)
committerMathieu Lutfy2012-04-25 14:29:49 (GMT)
commitc97c4788108cbc3a655ae1c7a54455eee143fa39 (patch)
tree02e1b0b6170e93f29438da7a3e5818876111849c
parentf821f8364d73433861bd1a9040485946e430e8f1 (diff)
Issue #1146226 : added README.txt file7.x-1.0-beta16.x-1.19
-rw-r--r--README.txt121
1 files changed, 121 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..d314b57
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,121 @@
+
+BOOST MODULE FOR DRUPAL 7.x
+---------------------------
+
+CONTENTS OF THIS README
+-----------------------
+
+ * Description
+ * Requirements
+ * Installation
+ * Support
+ * Credits
+
+DESCRIPTION
+-----------
+
+This module provides static page caching for Drupal 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.
+
+More information: http://drupal.org/project/boost
+
+For information on supported features (as well as those deprecated
+since 7.x-1.x), please read: https://drupal.org/node/1434362
+
+
+REQUIREMENTS
+------------
+
+Drupal's clean URLs MUST be enabled and working properly.
+
+
+INSTALLATION
+------------
+
+Handbook page: http://drupal.org/node/1459690
+
+1. Goto: [Administer > Configuration > Search and metadata > Clean URLs]
+ and ensure that Drupal's clean URLs are enabled and working correctly
+ on your site.
+
+2. Unzip and upload the module folder (as is) to the sites/all/modules
+ folder in your Drupal installation directory.
+
+3. Goto: [Administer > Configuration > System > Boost > Boost Settings]
+ and review the default settings.
+
+4. Goto: [Administer > Configuration > System > Boost > File System]
+ 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.
+
+ Ideally, the cache directory should be owned by your user and be in
+ the group of your web server ("www-data" on Debian/Ubuntu), with a
+ unix permission of 0775 (read/write/exec owner, read/write/exec group,
+ read/exec others).
+
+5. Review the other default Boost settings.
+
+6. IMPORTANT - This step is easy and required for Boost to work!
+ Backup the original .htaccess file from your Drupal installation
+ directory for safe keeping.
+ Copy the custom generated htaccess rule from [Administer > Configuration
+ > System > Boost > .htaccess > .htaccess Generation] page and paste
+ the rules into the Drupal htaccess file as shown below.
+
+ # RewriteBase /
+ -------paste the rules right here--------
+ # Rewrite URLs of the form 'x' to the form 'index.php?q=x'.
+ # Pass all requests not referring directly to files in the filesystem to
+ # index.php. Clean URLs are handled in drupal_environment_initialize().
+ RewriteCond %{REQUEST_FILENAME} !-f
+ RewriteCond %{REQUEST_FILENAME} !-d
+ RewriteCond %{REQUEST_URI} !=/favicon.ico
+ RewriteRule ^ index.php [L]
+
+Note: If you get "400 Bad Request" responses from Apache server, make sure you have configured the RewriteBase. For example when using VirtualHost configurations it is necessary to define as:
+
+ RewriteBase /
+
+For more information, please read the handbook page:
+http://drupal.org/node/1459690
+
+
+SUPPORT
+-------
+
+Project issue queue:
+http://drupal.org/project/issues/boost
+
+Please take the time to review other support issues before posting a new one.
+It can be hard to debug boost support issues without access to the server.
+Provide as much information as possible in order to reproduce the issue.
+
+Feel free to post install tips in the installation handbook page:
+https://drupal.org/node/1459690
+
+Paid support is possible by contacting the module maintainers via their
+user contact page (see below). We also accept donations, see:
+https://drupal.org/node/1434362 (support section).
+
+
+CREDITS
+-------
+
+4.7 Originally developed by Arto Bendiken.
+5.x Port by Alexander I. Grafov, developed by Mike Carper.
+6.x Port by Ben Lavender.
+6.x Developed & Maintained by
+ Mike Carper https://drupal.org/user/282446
+ since 2012, minimal maintenance by Mathieu Lutfy
+7.x Port by Mike Carper
+7.x Developed & Maintained by
+ Mike Carper (mikeytown2) https://drupal.org/user/282446
+ Mathieu Lutfy (bgm) https://drupal.org/user/89461
+