Actions

ComfortUpdate/en: Difference between revisions

From LimeSurvey Manual

(Updating to match new version of source page)
(Updating to match new version of source page)
(9 intermediate revisions by the same user not shown)
Line 4: Line 4:
=General=
=General=


The ComfortUpdate tool is a LimeSurvey professional service to update your installation of LimeSurvey easily from your web browser, with just a few mouse clicks - instead of having to perform [[Upgrading from a previous version|a manual update]].
''ComfortUpdate'' is a professional service from LimeSurvey GmbH to update LimeSurvey easily from your web browser with just a few mouse clicks (instead of having to perform [[Upgrading from a previous version|a manual update]]).


To use and test ComfortUpdate you will have to register [https://www.limesurvey.org/en/services#pricing with our website] to receive a free trial key. After that trial key has expired you can either [https://www.limesurvey.org/en/services#pricing buy one of our premium packages] or [[Upgrading from a previous version|update your installation manually]].
To use and test ComfortUpdate, you have to sign up [https://account.limesurvey.org on LimeSurvey] to receive a [https://community.limesurvey.org/comfort-update-extension/ free trial key]. After that trial key has expired, you can either [https://community.limesurvey.org/comfort-update-extension/ buy one of our premium packages] or [[Upgrading from a previous version|update your installation manually]].
 
 
{{Alert|To copy and use your ComfortUpdate key, access your LimeSurvey profile and check out the bottom section COMFORTUPDATE KEYS.}}


=Requirements=
=Requirements=


Your PHP installation must be compiled with support for ZLib. Check your PHPInfo to see, and contact your system administrator to confirm. [http://php.net/manual/es/book.zlib.php].
Your PHP installation must be compiled with support for [http://php.net/manual/en/book.zlib.php ZLib]. Check your PHPInfo or ask your system administrator for a confirmation.
 
Your server must be able to connect by SSL to ''update.limesurvey.org'' and ''update-data.limesurvey.org'' to use the ComfortUpdate tool. If you have problems with this and get error messages such as ''10060 could not connect to the host 'update.limesurvey.org''', you will have to tweak/edit your proxy/firewall security settings or ask your server administrator for further guidance/help.
 
=Using ComfortUpdate=
 
The LimeSurvey ComfortUpdate feature is safe to use even with active surveys. It does not delete or destroy any existing data. However, out of precaution, you should backup your current database and files manually before proceeding.
 
*Locate the ''Update'' button
**For the older LimeSurvey versions, go to the Global Settings Icon, select the first tab, and click the ''Updates'' button
**For the recent Limesurvey versions, you will find the '''ComfortUpdate''' button in the '''Configuration''' dialog, under the ''Advanced'' tab:
 
 
<center>[[File:ComfortUpdate.png]]</center>
 


Your server must be able to connect by SSL to update.limesurvey.org and update-data.limesurvey.org in order to use the ComfortUpdate tool. If you have problems with this and get error messages like
*The ComfortUpdate screen will display an update link if a new version of LimeSurvey is available. If not, click “Check now” to see if a new update is available
*If an update is found, LimeSurvey will display a link to allow you to update. Click this to begin updating
*If you have never used ComfortUpdate before or the ComfortUpdate upgrade key is not valid, you will be asked to enter an upgrade key.


  10060 could not connect to the host "update.limesurvey.org"
you should tweak/edit your proxy/firewall security settings or ask your server administrator for help.


=Using ComfortUpdate=
<center>[[File:ComfortUpdateKey.png]]</center>


The LimeSurvey ComfortUpdate feature is safe to use even with active surveys. It does not delete or destroy any existing data. However you should keep in mind that this is a beta feature and ensure you have backed up your database and files manually before proceeding.


*Go to the Global Settings Icon, select the first tab, and click the button for “Updates”
*LimeSurvey will now verify your installation directory to verify that the appropriate permissions are set to allow an update. A list of proposed changes will be displayed
*The ComfortUpdate screen will display an update link if a new version of LimeSurvey is available. If not click “Check now” to see if a new update is available.
*If there are any problems, you must correct them at this point and then proceed to the next step
*If an update is found, LimeSurvey will display a link to allow you to update. Click on this to begin updating.
*The ComfortUpdate will now make a backup of your database (if you use MySQL) and save your old installation files in the /tmp directory. If you use a different database, you should backup your database manually before proceeding
*If you have never used before or ComfortUpdate upgrade key is not valid will be asked to enter an upgrade key. During the trial period use the default key for free updates.
ComfortUpdate will now update your installation to the latest version, updating also the database in order to reflect the new (possible) changes.
*LimeSurvey will now verify your installation directory to check the appropriate permissions are set to allow an update. A list of proposed changes will be displayed.
*If there are any problems, you must correct them at this point, and then proceed to the next step.
*The ComfortUpdate will now make a backup of your database (if you use MySQL) and save your old installation files in the /tmp directory. If you use a different database, you should backup your database manually before proceeding.
ComfortUpdate will now update your installation to the latest version, including updating the database for any new changes.  


=Disabling ComfortUpdate=
=Disabling ComfortUpdate=
If you want to disable ComfortUpdate to not get the ''New release available'' popup messages after each new release you can add the following option to your "config.php" file which can be found at ''/limesurvey/application/config'' (Always create a backup first!):
To disable ComfortUpdate to avoid receving ''New release available'' popup messages after each new release, you can add the following option to your "config.php" file (which is located in /limesurvey/application/config):
'updatable' => false
<syntaxhighlight lang="php" enclose="pre">
 
'updatable' => false  
This is documented in more detail at "[http://www.limesurvey-consulting.com/how-to-disable-the-comfortupdate-updating-feature-at-limesurvey/ How to disable the Limesurvey ComfortUpdate updating feature]".
</syntaxhighlight>
'''However, we strongly recommend not disabling this, as you might miss important security updates.'''


=Known problems=
=Troubleshooting=


==Blank page on step 3==
==Blank page on step 3==


If you get a blank page on step 3 it usually means that the memory limit of your PHP configuration is set too low. During that step LimeSurvey tries to create a database backup and a file backup (of the files that will be replaced).
If you get a blank page on step 3, it usually means that the memory limit of your PHP configuration is set too low. During that step, LimeSurvey tries to create a database backup and a file backup (of the files that will be replaced).


==Using a proxy server to connect to update.limesurvey.com==
==Using a proxy server to connect to update.limesurvey.com==


If you are behind a proxy, you may have to adjust some settings to be able to use comfort update. In LimeSurvey 2.05 later than build 140404, you can set the details of your proxy server in the configuration file (see [https://manual.limesurvey.org/Optional_settings#General_settings General settings]).
If you are behind a proxy, you may have to adjust some settings to be able to use ComfortUpdate. In LimeSurvey 2.05 (later than build 140404), you can set the details of your proxy server in the configuration file (see [https://manual.limesurvey.org/Optional_settings#General_settings the general settings wiki]).


For earlier versions, you have to edit the http.php file in your LimeSurvey installation. Have a look at the variables in the first lines of this file in a text editor and add values if needed.
For earlier versions, you have to edit the http.php file in your LimeSurvey installation. Have a look at the variables in the first lines of this file in a text editor and add values if needed.


Example: Connect to a proxy server 111.111.111.111 port 1234 without authentication edit the following lines to look like
Example: Connect to a proxy server 111.111.111.111 port 1234 without authentication and edit the following lines to look like:
<syntaxhighlight lang="php" enclose="pre">
  // This code is only for versions earlier than 2.05
   var $proxy_host_name="111.111.111.111";
   var $proxy_host_name="111.111.111.111";
   var $proxy_host_port=1234;
   var $proxy_host_port=1234;
</syntaxhighlight>


Depending on your version, you will find the file in the /admin/classes/ folder or in /application/libraries/admin/http/. There are pre-coded variables within the file so only details of your proxy are needed. If your installation is running unusually slow, wrong proxy settings may be the cause.
Depending on your version, you will find the file either in /admin/classes/ or in /application/libraries/admin/http/. There are pre-coded variables within the file. Therefore, only details of your proxy are needed. If your installation is running unusually slow, wrong proxy settings may be the cause.

Revision as of 20:20, 9 August 2021

General

ComfortUpdate is a professional service from LimeSurvey GmbH to update LimeSurvey easily from your web browser with just a few mouse clicks (instead of having to perform a manual update).

To use and test ComfortUpdate, you have to sign up on LimeSurvey to receive a free trial key. After that trial key has expired, you can either buy one of our premium packages or update your installation manually.


  To copy and use your ComfortUpdate key, access your LimeSurvey profile and check out the bottom section COMFORTUPDATE KEYS.


Requirements

Your PHP installation must be compiled with support for ZLib. Check your PHPInfo or ask your system administrator for a confirmation.

Your server must be able to connect by SSL to update.limesurvey.org and update-data.limesurvey.org to use the ComfortUpdate tool. If you have problems with this and get error messages such as 10060 could not connect to the host 'update.limesurvey.org', you will have to tweak/edit your proxy/firewall security settings or ask your server administrator for further guidance/help.

Using ComfortUpdate

The LimeSurvey ComfortUpdate feature is safe to use even with active surveys. It does not delete or destroy any existing data. However, out of precaution, you should backup your current database and files manually before proceeding.

  • Locate the Update button
    • For the older LimeSurvey versions, go to the Global Settings Icon, select the first tab, and click the Updates button
    • For the recent Limesurvey versions, you will find the ComfortUpdate button in the Configuration dialog, under the Advanced tab:



  • The ComfortUpdate screen will display an update link if a new version of LimeSurvey is available. If not, click “Check now” to see if a new update is available
  • If an update is found, LimeSurvey will display a link to allow you to update. Click this to begin updating
  • If you have never used ComfortUpdate before or the ComfortUpdate upgrade key is not valid, you will be asked to enter an upgrade key.



  • LimeSurvey will now verify your installation directory to verify that the appropriate permissions are set to allow an update. A list of proposed changes will be displayed
  • If there are any problems, you must correct them at this point and then proceed to the next step
  • The ComfortUpdate will now make a backup of your database (if you use MySQL) and save your old installation files in the /tmp directory. If you use a different database, you should backup your database manually before proceeding

ComfortUpdate will now update your installation to the latest version, updating also the database in order to reflect the new (possible) changes.

Disabling ComfortUpdate

To disable ComfortUpdate to avoid receving New release available popup messages after each new release, you can add the following option to your "config.php" file (which is located in /limesurvey/application/config):

'updatable' => false

However, we strongly recommend not disabling this, as you might miss important security updates.

Troubleshooting

Blank page on step 3

If you get a blank page on step 3, it usually means that the memory limit of your PHP configuration is set too low. During that step, LimeSurvey tries to create a database backup and a file backup (of the files that will be replaced).

Using a proxy server to connect to update.limesurvey.com

If you are behind a proxy, you may have to adjust some settings to be able to use ComfortUpdate. In LimeSurvey 2.05 (later than build 140404), you can set the details of your proxy server in the configuration file (see the general settings wiki).

For earlier versions, you have to edit the http.php file in your LimeSurvey installation. Have a look at the variables in the first lines of this file in a text editor and add values if needed.

Example: Connect to a proxy server 111.111.111.111 port 1234 without authentication and edit the following lines to look like:

  // This code is only for versions earlier than 2.05
  var $proxy_host_name="111.111.111.111";
  var $proxy_host_port=1234;

Depending on your version, you will find the file either in /admin/classes/ or in /application/libraries/admin/http/. There are pre-coded variables within the file. Therefore, only details of your proxy are needed. If your installation is running unusually slow, wrong proxy settings may be the cause.