Update to the way CiviCRM templates are compiled. This is a small but important change to the settings file. There are no database changes.

herbdool · herbdool · commit 8b2391403a60 · 2018-03-02T15:53:47.000-05:00
We have removed the patch to optionally store compiled templates in Redis. This approach is no longer recommended. Instead, based on Pantheon's recommendations, you should store compiled templates in the `/tmp` folder. You will need to update your `civicrm.settings.php` file to assign `CIVICRM_TEMPLATE_COMPILEDIR` to the `/tmp` directory. Compare your live settings file to `sites/default/default.civicrm.settings.php`. You can read the full explanation in the README.md file. Specifically `CIVICRM_TEMPLATE_COMPILEDIR` should look like this: ``` if (isset($pantheon_conf)) { define('CIVICRM_TEMPLATE_COMPILEDIR', '/srv/bindings/' . $pantheon_conf['pantheon_binding'] . '/tmp/civicrm/templates_c/'); } ``` Fully test on a dev environment before upgrading on live. Don't merge this code yet if you've got other updates which are urgent. If you have questions contact http://civicrmstarterkit.org/contact. We provide some basic general support for the public. If you require help with your specific website there will likely be a cost.
diff --git a/README.md b/README.md
@@ -5,17 +5,35 @@ CiviCRM Starterkit is a Drupal 7 distribution that makes it easy to start with t
 
 The [CiviCRM Starterkit](http://civicrmstarterkit.org/) project is not intended to be installed on its own. Instead, you can quickly get started with CiviCRM by [spinning it up on Pantheon](https://dashboard.pantheon.io/products/civicrm_starterkit/spinup). This Pantheon upstream keeps up to date with Pantheon's core Drupal 7 repository, with basic Drupal module security updates, and with updates to the core CiviCRM project.
 
-Upgrading to CiviCRM 4.7
-----------------
+Support
+-------
+
+If you are stuck, confused or run into trouble please [contact us](http://civicrmstarterkit.org/contact) and we'll see how we can help. We provide some basic general support for the public. If you require help with your specific website there will likely be a cost.
+
+Updates to Starterkit
+---------------------
+
+### Update to CiviCRM templates compiling. March 2, 2018
+
+We have removed the patch to optionally store compiled templates in Redis. This approach is no longer recommended. Instead, based on Pantheon's recommendations, you should store compiled templates in the `/tmp` folder. You will need to update your `civicrm.settings.php` file to assign `CIVICRM_TEMPLATE_COMPILEDIR` to the `/tmp` directory. Compare your live settings file to `sites/default/default.civicrm.settings.php`. Specifically `CIVICRM_TEMPLATE_COMPILEDIR` should look like this:
+
+```
+if (isset($pantheon_conf)) {
+    define('CIVICRM_TEMPLATE_COMPILEDIR', '/srv/bindings/' . $pantheon_conf['pantheon_binding'] . '/tmp/civicrm/templates_c/');
+  }
+```
+
+The technical reason for the change. Storing templates in Redis seemed to help with performance because it avoided writing generated PHP files to a network file system. However, storing in Redis meant we couldn't take advantage of "opcache" by PHP since the PHP wasn't written to files. Pantheon recommends writing generated PHP files to the local machine in something like the temp directory. This is a good recommendation for any setup that needs to support multiple webservers. [Read more](https://lab.civicrm.org/dev/cloud-native/issues/1#note_3120)
+
+### Upgrading to CiviCRM 4.7. September, 2017
 
 If you require support in upgrading from CiviCRM 4.6 to 4.7 please contact us at [CiviCRM Starterkit](http://civicrmstarterkit.org/contact).
 
 You will see the update in the Pantheon dashboard. Make sure to make a backup of your database if you don't already have a regular backup schedule.
 
 Testing the upgrade is super important. We recommend testing it on the dev environment with a clone of the live database, or if you have access to Multidev, then a fresh environment and branch so that you don't bottleneck other code updates while you're testing this major upgrade.
 
-Required changes for 4.7
-------------------------
+#### Required changes for 4.7
 
 There are a number of changes to the settings file so we've included a template at `sites/default/default.civicrm.settings.php` with instructions on what to copy over if you've got an existing site. New sites will still have a settings file automatically created.
 
@@ -42,8 +60,6 @@ When you are ready to deploy the upgrade to live, put the live site into mainten
 
 It is also useful to consult the [guide on upgrading CiviCRM on Drupal 7](https://wiki.civicrm.org/confluence/display/CRMDOC/Upgrading+CiviCRM+for+Drupal+7). On Pantheon the above steps overrule some of the steps in the latter guide but it is still useful to reference.
 
-Finally, if you are stuck, confused or run into trouble please [contact us](http://civicrmstarterkit.org/contact) and we'll see how we can help.
-
 Alternative approach to CiviCRM on Pantheon
 -------------------------------------------
 
diff --git a/profiles/civicrm_starterkit/civicrm_starterkit.make b/profiles/civicrm_starterkit/civicrm_starterkit.make
@@ -66,10 +66,6 @@ libraries[civicrm][patch][1849424-pass] = ./patches/pass-vars-in-install-link.pa
 ; If concerned can set it to skip caching the container. In civicrm.settings.php set:
 ; define('CIVICRM_CONTAINER_CACHE', 'never');
 
-; [OPTIONAL IF USING REDIS] Use CiviCRM cache functions to use Redis for storing compiled Smarty templates (Based on github.com/ojkelly commit 85e04b6)
-; Unconventional but CiviCRM works faster and fewer errors in trying to load templates
-; libraries[civicrm][patch][smartyredis] = ./patches/smarty-redis-civi-cache-47.patch
-
 ; [OPTIONAL] SMTP patch for PHP 5.6+
 ; https://civicrm.stackexchange.com/questions/16628/outgoing-mail-settings-civismtp-php-5-6-x-problem
 libraries[civicrm][patch][smtpverify] = ./patches/smtp-disable-peer-verification.patch
diff --git a/profiles/civicrm_starterkit/modules/civicrm/pantheon-settings-starterkit-47.patch b/profiles/civicrm_starterkit/modules/civicrm/pantheon-settings-starterkit-47.patch
@@ -69,7 +69,7 @@
  if (!defined('CIVICRM_TEMPLATE_COMPILEDIR')) {
 -  define( 'CIVICRM_TEMPLATE_COMPILEDIR', '%%templateCompileDir%%');
 +  if (isset($pantheon_conf)) {
-+    define('CIVICRM_TEMPLATE_COMPILEDIR', '/srv/bindings/' . $pantheon_conf['pantheon_binding'] . '/files/private/civicrm/templates_c/');
++    define('CIVICRM_TEMPLATE_COMPILEDIR', '/srv/bindings/' . $pantheon_conf['pantheon_binding'] . '/tmp/civicrm/templates_c/');
 +  }
 +  else {
 +    define( 'CIVICRM_TEMPLATE_COMPILEDIR', '/full/path/to/files/private/civicrm/templates_c');
diff --git a/profiles/civicrm_starterkit/modules/civicrm/templates/CRM/common/civicrm.settings.php.template b/profiles/civicrm_starterkit/modules/civicrm/templates/CRM/common/civicrm.settings.php.template
@@ -213,7 +213,7 @@ else {
 
 if (!defined('CIVICRM_TEMPLATE_COMPILEDIR')) {
   if (isset($pantheon_conf)) {
-    define('CIVICRM_TEMPLATE_COMPILEDIR', '/srv/bindings/' . $pantheon_conf['pantheon_binding'] . '/files/private/civicrm/templates_c/');
+    define('CIVICRM_TEMPLATE_COMPILEDIR', '/srv/bindings/' . $pantheon_conf['pantheon_binding'] . '/tmp/civicrm/templates_c/');
   }
   else {
     define( 'CIVICRM_TEMPLATE_COMPILEDIR', '/full/path/to/files/private/civicrm/templates_c');
diff --git a/profiles/civicrm_starterkit/patches/pantheon-settings-starterkit-47.patch b/profiles/civicrm_starterkit/patches/pantheon-settings-starterkit-47.patch
@@ -69,7 +69,7 @@
  if (!defined('CIVICRM_TEMPLATE_COMPILEDIR')) {
 -  define( 'CIVICRM_TEMPLATE_COMPILEDIR', '%%templateCompileDir%%');
 +  if (isset($pantheon_conf)) {
-+    define('CIVICRM_TEMPLATE_COMPILEDIR', '/srv/bindings/' . $pantheon_conf['pantheon_binding'] . '/files/private/civicrm/templates_c/');
++    define('CIVICRM_TEMPLATE_COMPILEDIR', '/srv/bindings/' . $pantheon_conf['pantheon_binding'] . '/tmp/civicrm/templates_c/');
 +  }
 +  else {
 +    define( 'CIVICRM_TEMPLATE_COMPILEDIR', '/full/path/to/files/private/civicrm/templates_c');
diff --git a/profiles/civicrm_starterkit/patches/smarty-redis-civi-cache-47.patch b/profiles/civicrm_starterkit/patches/smarty-redis-civi-cache-47.patch
diff --git a/sites/default/default.civicrm.settings.php b/sites/default/default.civicrm.settings.php
@@ -211,7 +211,7 @@
 
 if (!defined('CIVICRM_TEMPLATE_COMPILEDIR')) {
   if (isset($pantheon_conf)) {
-    define('CIVICRM_TEMPLATE_COMPILEDIR', '/srv/bindings/' . $pantheon_conf['pantheon_binding'] . '/files/private/civicrm/templates_c/');
+    define('CIVICRM_TEMPLATE_COMPILEDIR', '/srv/bindings/' . $pantheon_conf['pantheon_binding'] . '/tmp/civicrm/templates_c/');
   }
   else {
     define( 'CIVICRM_TEMPLATE_COMPILEDIR', '/full/path/to/files/private/civicrm/templates_c');

Original file line number	Diff line number	Diff line change
`@@ -213,7 +213,7 @@ else {`
`213`	`213`
`214`	`214`	`if (!defined('CIVICRM_TEMPLATE_COMPILEDIR')) {`
`215`	`215`	`if (isset($pantheon_conf)) {`
`216`		`- define('CIVICRM_TEMPLATE_COMPILEDIR', '/srv/bindings/' . $pantheon_conf['pantheon_binding'] . '/files/private/civicrm/templates_c/');`
	`216`	`+ define('CIVICRM_TEMPLATE_COMPILEDIR', '/srv/bindings/' . $pantheon_conf['pantheon_binding'] . '/tmp/civicrm/templates_c/');`
`217`	`217`	`}`
`218`	`218`	`else {`
`219`	`219`	`define( 'CIVICRM_TEMPLATE_COMPILEDIR', '/full/path/to/files/private/civicrm/templates_c');`
Original file line number	Diff line number	Diff line change
`@@ -211,7 +211,7 @@`
`211`	`211`
`212`	`212`	`if (!defined('CIVICRM_TEMPLATE_COMPILEDIR')) {`
`213`	`213`	`if (isset($pantheon_conf)) {`
`214`		`- define('CIVICRM_TEMPLATE_COMPILEDIR', '/srv/bindings/' . $pantheon_conf['pantheon_binding'] . '/files/private/civicrm/templates_c/');`
	`214`	`+ define('CIVICRM_TEMPLATE_COMPILEDIR', '/srv/bindings/' . $pantheon_conf['pantheon_binding'] . '/tmp/civicrm/templates_c/');`
`215`	`215`	`}`
`216`	`216`	`else {`
`217`	`217`	`define( 'CIVICRM_TEMPLATE_COMPILEDIR', '/full/path/to/files/private/civicrm/templates_c');`